Отчет об использовании сущностей отображает действия сервисов Google Workspace, связанные с сущностями, используемыми пользователями вашей учетной записи. Эти отчеты можно настраивать и фильтровать для получения конкретной информации об использовании. Данные доступны за последние 30 дней.
Отчет об использовании ресурсов может использоваться только в законных целях в соответствии с вашим клиентским соглашением. Эти отчеты также распространяются на Google Workspace и Education.
Получить все данные об использовании сущностей.
Единственный тип сущностей, поддерживаемый этим API, — это сообщества Google+. Чтобы получить отчет обо всех действиях, связанных с сущностями приложения в вашей учетной записи, используйте следующий HTTP-запрос GET и укажите токен авторизации, описанный в документации по авторизации . Для удобства чтения следующий пример отформатирован с помощью переносов строк:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
Значение date — это дата использования, а метка времени — в формате ISO 8601 , yyyy-mm-dd. Рекомендуем использовать часовой пояс вашей учетной записи. Дополнительную информацию о параметрах строки запроса и свойствах ответа см. в справочнике API . Информацию о параметрах отчета об использовании сущностей см. в справочнике параметров использования сущностей .
applicationParameters — это список параметров, разделенных запятыми, которые вы хотите получить. Каждый параметр имеет формат application:parameter_name , например, gplus:community_name . Доступные параметры описаны в справочнике по параметрам использования сущностей . Если параметры не указаны, возвращаются все параметры.
parameterFilters — это список фильтров, разделенных запятыми, которые следует применить к результатам. Каждый фильтр имеет формат: application:parameter_name[relational_operator]parameter_value . Например, фильтр gplus:num_total_members>100 фильтрует результаты таким образом, чтобы они содержали только те результаты, у которых параметр gplus:num_total_members имеет значение больше 100.
maxResults — это максимальное количество результатов, возвращаемых за один запрос. Если общее количество результатов превышает это значение, ответ будет усечен, и будет добавлен nextPageToken (см. пример JSON-ответа ниже).
Примеры
В следующем примере получается отчет, содержащий все параметры для всех сущностей gplus_communities .
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
В следующем примере получается отчет, содержащий параметр community_name для всех сущностей gplus_communities .
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
В следующем примере для каждой сущности gplus_communities получается отчет, содержащий значения community_name и num_total_members , отфильтрованный по сообществам с более чем 100 участниками. Пример ответа API см. в примере ответа JSON .
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
Получить отчет по конкретному объекту
Для получения отчета по конкретной сущности используйте следующий HTTP-запрос GET и укажите токен авторизации, описанный в документации по авторизации . Для удобства чтения следующий пример отформатирован с использованием переносов строк.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey — это идентификатор сущности, специфичный для приложения, в котором она находится. Подробную информацию о том, как получить entityKey для интересующей вас сущности, см. в справочнике API . Другие параметры описаны ранее в разделе «Получение всех действий по использованию сущностей» .
Для получения дополнительной информации о параметрах строки запроса и свойствах ответа см. Справочник по API . Информацию о параметрах отчета об использовании сущностей см. в Справочнике по параметрам использования сущностей .
Примеры
В следующем примере получен отчет по сущности gplus_community с ключом entityKey "1234".
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
Пример JSON-ответа к отчету об использовании
В случае успешного ответа возвращается код состояния HTTP 200. Вместе с кодом состояния ответ содержит отчет. Некоторые параметры ответа опущены для удобства чтения.
Пример JSON-ответа для отчета по сущностям.
{ "kind": "reports#usageReports", "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA", "usageReports": [ { "kind": "admin#reports#usageReport", "date": "2017-12-11", "entity": { "type": "OBJECT", "customerId": "C03az79cb", "objectType": "GPLUS_COMMUNITY", "objectId": "1234", }, "parameters": [ { "name": "gplus:community_name", "stringValue": "My Community" }, { "name": "gplus:num_total_members", "intValue": 37 }, { "name": "gplus:num_7day_active_members", "intValue": 12 }, { "name": "gplus:num_30day_active_members", "intValue": 17 }, ] } ] }
Пример JSON-ответа для отчета по сущностям с предупреждениями.
В ответе может быть возвращено одно или несколько предупреждений, если запрос не может быть выполнен. В этом примере отчет недоступен на момент отправки запроса.{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}warnings имеет следующие параметры:-
code: машиночитаемый код предупреждения -
message: удобочитаемое предупреждающее сообщение -
data: список пар ключ-значение, содержащих подробную предупреждающую информацию.