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

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

Этот отчет об использовании пользователя может использоваться только в законных целях в соответствии с вашим Клиентским соглашением. Эти отчеты применимы к Google Workspace и Google 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"
    }
   ]
  }
 ]
}