Method: userUsageReport.get

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Получает отчет, который представляет собой набор свойств и статистики для набора пользователей с учетной записью. Дополнительные сведения см. в руководстве по отчету об использовании пользователями . Дополнительные сведения о параметрах пользовательского отчета см. в справочных руководствах по параметрам использования пользователей .

HTTP-запрос

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

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

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

Параметры
userKey or all

string

Представляет идентификатор профиля или адрес электронной почты пользователя, для которого должны быть отфильтрованы данные. Может быть all для всей информации или userKey для уникального идентификатора профиля пользователя Google Workspace или его основного адреса электронной почты. Не должен быть удаленным пользователем. Для удаленного пользователя вызовите users.list в Directory API с помощью showDeleted=true , а затем используйте возвращенный ID в качестве userKey .

date

string

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

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

Параметры
customerId

string

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

filters

string

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

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

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

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

Реляционные операторы включают в себя:

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

maxResults

integer ( uint32 format)

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

orgUnitId

string

Идентификатор организационного подразделения , по которому нужно составить отчет. Действия пользователей будут отображаться только для пользователей, принадлежащих к указанному организационному подразделению.

pageToken

string

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

parameters

string

Строка запроса parameters представляет собой список разделенных запятыми параметров событий, которые уточняют результаты отчета. Параметр связан с конкретным приложением. Значения приложений для отчета об использовании клиентов включают accounts , app_maker , apps_scripts , meet , sites , device_management , gplus , gmail , docs , calendar , classroom и cros .
Строка запроса parameters находится в формате CSV app_name1:param_name1, app_name2:param_name2 .

groupIdFilter

string

Идентификаторы групп, разделенные запятыми (запутанные), по которым фильтруются действия пользователей, т. е. ответ будет содержать действия только для тех пользователей, которые являются частью хотя бы одного из упомянутых здесь идентификаторов групп. Формат: "id:abc123,id:xyz456"

Тело запроса

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

Тело ответа

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

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

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

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

Дополнительные сведения см. в обзоре OAuth 2.0 .