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 » недоступны.
  • Предупреждение, что доступны частичные данные. Данные на дату гггг-мм-дд для приложения « application name » сейчас недоступны, повторите попытку через несколько часов.

warnings[].data[]

object

Пары ключ-значение для предоставления подробной информации о предупреждении.

warnings[].data[].key

string

Ключ, связанный с парой ключ-значение, чтобы предоставить подробную информацию о предупреждении.

warnings[].data[].value

string

Значение, связанное с парой ключ-значение, для предоставления подробной информации о предупреждении.

usageReports[]

object ( UsageReport )

Различные записи параметров приложения.

nextPageToken

string

Токен для указания следующей страницы. Отчет с несколькими страницами имеет свойство nextPageToken в ответе. Чтобы ваши последующие запросы получали все страницы отчета, введите значение nextPageToken в строке запроса pageToken .

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

 Извлекает отчет, который представляет собой набор свойств и статистики для учетной записи определенного клиента.