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 值。

UsageReport

用于使用情况报告的 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 = "OBJECT" 时相关注意:面向外部的报告名称为“实体”而不是“对象”

entity.type

string

仅限输出。项的类型。其值为 user

方法

get

检索报告,其中包含特定客户账号的属性和统计信息。