Method: entityUsageReports.get

Получает отчет, который представляет собой набор свойств и статистики для объектов, используемых пользователями в учетной записи. Дополнительные сведения см. в руководстве «Отчет об использовании сущностей» . Дополнительные сведения о параметрах отчета об сущностях см. в справочных руководствах по параметрам использования сущностей .

HTTP-запрос

GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
entityType

enum ( EntityType )

Представляет тип сущности для отчета.

entityKey or all

string

Представляет ключ объекта для фильтрации данных. Это строка, которая может принимать значение all для получения событий активности для всех пользователей или любое другое значение для сущности, специфичной для приложения. Подробные сведения о том, как получить entityKey для определенного entityType , см. в справочных руководствах по параметрам использования сущностей .

date

string

Представляет дату, когда произошло использование, по UTC-8:00 (стандартное тихоокеанское время). Временная метка имеет формат ISO 8601 , yyyy-mm-dd .

Параметры запроса

Параметры
customerId

string

Уникальный идентификатор клиента, для которого требуется получить данные.

filters

string

Строка запроса filters представляет собой список параметров событий приложения, разделенных запятыми, где значением параметра управляет оператор отношения. Строка запроса filters включает имя приложения, использование которого возвращается в отчете. Значения приложения для отчета об использовании Entities включают accounts , docs и gmail .

Фильтры имеют вид [application name]:[parameter name][relational operator][parameter value],... .

В этом примере оператор <> «не равно» закодирован в URL-адресе в строке запроса запроса (%3C%3E):

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

К операторам отношения относятся:

  • == - 'равно'.
  • <> - 'не равно'. Он имеет URL-кодировку (%3C%3E).
  • < - 'меньше чем'. Он закодирован в URL-адресе (%3C).
  • <= - 'меньше или равно'. Он закодирован в URL-адресе (%3C=).
  • > - 'больше чем'. Он закодирован в URL-адресе (%3E).
  • >= - 'больше или равно'. Он закодирован в URL-адресе (%3E=).
Фильтры можно применять только к числовым параметрам.

maxResults

integer ( uint32 format)

Определяет, сколько записей активности отображается на каждой странице ответа. Например, если запрос устанавливает <span>maxResults=1</span> и в отчете есть два действия, отчет будет состоять из двух страниц. Свойство <span>nextPageToken</span> ответа содержит токен второй страницы.

pageToken

string

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

parameters

string

Строка запроса parameters представляет собой разделенный запятыми список параметров событий, которые уточняют результаты отчета. Параметр связан с конкретным приложением. Значениями приложения для отчета об использовании Entities являются только gplus .
Строка запроса parameter имеет формат CSV [app_name1:param_name1], [app_name2:param_name2]... .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр UsageReports .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Дополнительную информацию см. в руководстве по авторизации .

Тип объекта

Перечисления
gplus_communities Возвращает отчет о сообществах Google+.