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

Представляет дату, когда произошло использование, по UTC-8: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 , calendar , classroom , cros , docs , gmail , gplus , device_management , meet и sites .
Строка запроса parameters имеет формат CSV app_name1:param_name1, app_name2:param_name2 .

groupIdFilter

string

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

Тело запроса

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

Тело ответа

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

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

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

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

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