REST Resource: customerUsageReports

资源:UsageReports

JSON 表示法
{
  "kind": string,
  "etag": string,
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "usageReports": [
    {
      object (UsageReport)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

API 资源类型。对于使用情况报告,值为 admin#reports#usageReports

etag

string

资源的 ETag。

warnings[]

object

警告(如果有)。

warnings[].code

string

机器可读的代码或警告类型。警告代码值为 200

warnings[].message

string

人类可读的警告消息包括:

  • “无可用数据”警告 - 抱歉,无法获取应用“application name”日期 yyyy-mm-dd 的数据。
  • 仅部分数据可用警告 - 目前无法提供应用“application name”的数据,日期为 yyyy-mm-dd,请过几个小时后重试。

warnings[].data[]

object

键值对,提供有关警告的详细信息。

warnings[].data[].key

string

与键值对关联的键,用于提供有关警告的详细信息。

warnings[].data[].value

string

与键值对关联的值,用于提供有关警告的详细信息。

usageReports[]

object (UsageReport)

各种应用参数记录。

nextPageToken

string

用于指定下一页的令牌。有多个网页的报告在响应中具有 nextPageToken 属性。对于获取报告的所有页面的后续请求,请在 pageToken 查询字符串中输入 nextPageToken 值。

使用情况报告

使用情况报告的 JSON 模板。

JSON 表示法
{
  "kind": string,
  "date": string,
  "parameters": [
    {
      "intValue": string,
      "name": string,
      "stringValue": string,
      "datetimeValue": string,
      "boolValue": boolean,
      "msgValue": [
        {
          object
        }
      ]
    }
  ],
  "etag": string,
  "entity": {
    "customerId": string,
    "userEmail": string,
    "profileId": string,
    "entityId": string,
    "type": string
  }
}
字段
kind

string

API 资源类型。对于使用情况报告,值为 admin#reports#usageReport

date

string

仅供输出。报告请求的日期。

parameters[]

object

仅供输出。各种应用的参数值对。有关实体使用情况报告的参数和值,请参阅实体使用情况参数参考

parameters[].intValue

string (int64 format)

仅供输出。参数的整数值。

parameters[].name

string

参数的名称。 有关用户使用情况报告参数的名称,请参阅用户使用情况参数参考

parameters[].stringValue

string

仅供输出。参数的字符串值。

parameters[].datetimeValue

string

参数的 RFC 3339 格式值,例如 2010-10-28T10:26:35.000Z

parameters[].boolValue

boolean

仅供输出。参数的布尔值。

parameters[].msgValue[]

object (Struct format)

仅供输出。参数的嵌套消息值。

etag

string

资源的 ETag。

entity

object

仅供输出。与商品类型相关的信息。

entity.customerId

string

仅供输出。客户帐号的唯一标识符。

entity.userEmail

string

仅供输出。用户的电子邮件地址。仅当 entity.type = "USER> 时才相关

entity.profileId

string

仅供输出。用户的不可变 Google Workspace 个人资料标识符。

entity.entityId

string

仅供输出。对象键。仅当 entity.type = &obot;OBJECT” 时才相关。注意:面向外部的报告名称为“实体”,而不是“对象”。

entity.type

string

仅供输出。商品的类型。其值为 user

方法

get

检索报告,即特定客户帐号的属性和统计信息集合。