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

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

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

Получить отчет об использовании клиента

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

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

Значение dates — это дата, когда произошло использование, а отметка времени имеет формат ISO 8601 , гггг-мм-дд. Мы рекомендуем вам использовать для этого часовой пояс вашей учетной записи. Дополнительные сведения о строках запроса и свойствах ответа см. в справочнике по API и справочнике по параметрам отчета об использовании клиента .

В следующем примере возвращается отчет с общим количеством всех успешных входов в вашу учетную запись за последние 30 дней и список авторизованных приложений с указанием количества авторизаций пользователей на каждое приложение, начиная с 03.03.2013. Строка запроса maxResults показывает, что этот отчет возвращает два события на страницу отчета:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

Ответ 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": "CUSTOMER",
   
"customerId": "C03az79cb"
   
},
   
"parameters": [
   
{
     
"name": "accounts:num_1day_logins",
     
"intValue": "1"
   
},
   
{
     
"name": "accounts:num_30day_logins",
     
"intValue": "1"
   
},
   
{
     
"name": "accounts:num_7day_logins",
     
"intValue": "1"
   
},
   
{
     
"name": "accounts:num_disabled_accounts",
     
"intValue": "5"
   
},
   
{
     
"name": "accounts:authorized_apps",
     
"msgValue": [
     
{
       
"client_id": "1234.apps.googleusercontent.com",
       
"client_name": "www.example.com",
       
"num_users": 2
     
},
     
{
       
"client_id": "4567.apps.googleusercontent.com",
       
"client_name": "Example",
       
"num_users": 1
     
},
     
...
     
]
   
}
   
]
 
}
 
]
}