Method: userUsageReport.get

Извлекает отчет, который представляет собой набор свойств и статистики для набора пользователей с учетной записью. Для получения дополнительной информации см. руководство User Usage Report . Для получения дополнительной информации о параметрах пользовательского отчета см. справочные руководства Users Usage Parameters .

HTTP-запрос

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

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

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

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

string

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

date

string

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

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

Параметры
customerId

string

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

filters

string

Строка запроса filters — это разделенный запятыми список параметров событий приложения, где значение параметра обрабатывается реляционным оператором. Строка запроса filters включает имя приложения, использование которого возвращается в отчете. Значения приложения для отчета об использовании пользователей включают accounts , chat , 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 , calendar , chat , classroom , cros , docs , gmail , gplus , device_management , meet и sites .
Строка запроса 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

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