Reports API: отчет об использовании пользователями

Отчет об использовании сервисов Google Workspace пользователями содержит информацию об использовании сервисов Google Workspace определенным пользователем в вашем домене. Эти отчеты можно настраивать и фильтровать, чтобы получать нужную информацию об использовании. По умолчанию в каждом отчете показываются данные за последние 450 дней. Это максимальный период времени.

Отчеты об использовании могут применяться только в законных целях в соответствии с Соглашением с клиентом. Эти отчеты относятся к Google Workspace и Education.

Как получить данные обо всех действиях пользователей

Чтобы получить отчет обо всех действиях пользователей в вашем аккаунте, используйте следующий HTTP-запрос GET и включите в него токен авторизации, описанный в документации по авторизации. Для удобства восприятия пример кода разделен на строки. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

Значение dates – это дата использования, а временная метка указана в формате ISO 8601 (ГГГГ-ММ-ДД). Дополнительную информацию о параметрах строки запроса и свойствах ответа можно найти в документации по API. Подробные сведения о параметрах отчета об активности пользователей приведены в справочнике по параметрам отчета об активности пользователей.

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

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

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

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

В примере ниже показано, как получить отчет о временных метках последнего входа пользователей в аккаунт. Пример ответа API приведен в разделе Пример ответа JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

В примере ниже показано, как получить отчет о временных метках последнего входа пользователей в аккаунт, отфильтрованный по пользователям, которые вошли в систему после определенного времени. Пример ответа API приведен в разделе Пример ответа JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

В примере ниже показано, как получить отчет о временных метках последнего входа и статусе блокировки пользователей в аккаунте. Пример ответа API приведен в разделе Пример ответа JSON. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

Получение данных о действиях определенного пользователя

Чтобы получить отчет о действиях определенного пользователя в вашем аккаунте, используйте следующий HTTP-запрос GET и включите в него токен авторизации, описанный в документации по авторизации. Для удобства восприятия пример кода разделен на строки. 

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

userKey может быть основным адресом электронной почты пользователя в отчете или уникальным profileId пользователя Google Workspace. Значение dates – это дата использования, а временная метка указана в формате ISO 8601 (ГГГГ-ММ-ДД). Дополнительную информацию о параметрах строки запроса и свойствах ответа можно найти в документации по API. Подробные сведения о параметрах отчета об активности пользователей приведены в справочнике по параметрам отчета об активности пользователей.

В следующем примере показано, как получить отчет об использовании для пользователя john@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

Пример ответа JSON для отчета об использовании

При успешном выполнении запроса будет получен код статуса HTTP 200. Наряду с кодом статуса ответ возвращает отчет.

Ответ JSON для отчета о пользователях

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
{
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}