API отчетов: отчет об активности на диске

Отчет об активности в Google Диск предоставляет информацию о действиях пользователей при управлении, изменении и совместном использовании файлов в Google Диск в Google Рабочем пространстве. Например, вы можете использовать отчет об активности в Google Диск, чтобы получить список всех новых документов, созданных конкретным пользователем за указанный период времени. Эта информация поможет вам улучшить управление контентом и выявить возможные утечки данных. Для получения отчета используйте базовый запрос конечной точки отчета с параметрами, специфичными для отчета, такими как адрес электронной почты пользователя или определенный тип изменений в Google Диске. Отчеты могут содержать данные за последние 180 дней.

Отчет об активности в Google Диске может использоваться только в законных целях в учетных записях, которым назначена лицензия.

Информацию о параметрах запроса и свойствах ответа см. в справочнике API . Информацию о конкретных событиях, связанных с Google Drive, см. в разделе «Названия событий Drive» .

Получение событий Google Диска для домена

Вы можете использовать отчет об активности в Google Диске, чтобы получить информацию о ваших документах. Например, вы можете запросить отчет со списком 25 последних событий в Google Диске за период до 180 дней. Чтобы получить этот отчет, получите токен авторизации, как описано в руководстве по авторизации , а затем используйте следующий HTTP GET запрос:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?maxResults=25

Вы можете увидеть пример ответа на этот вызов API.

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

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive

Получение событий Google Диска по пользователю

Чтобы получить отчет об активности конкретного пользователя в Google Drive, используйте HTTP GET запрос с токеном авторизации, описанным в руководстве по авторизации . Поле userKey содержит основной адрес электронной почты пользователя, фигурирующего в отчете, или all для всех пользователей.

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

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/drive

Получение событий Google Диска для общих дисков.

Вы можете получить отчет об активности в Google Диске для определенного общего диска, используя HTTP GET запрос с токеном авторизации, описанным в руководстве по авторизации . Укажите адрес электронной почты пользователя, для которого вы хотите создать отчет, в поле userKey , или укажите all чтобы создать отчет для всех пользователей.

В следующем примере получен отчет обо всех изменениях для конкретного общего диска. Пример ответа API см. в образце JSON-ответа .

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=shared_drive_id==<id of shared drive>

Чтобы получить события для общего диска, используйте фильтр doc_type ). Следующий пример извлекает события, затрагивающие все общие диски:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=doc_type=shared_drive

Для получения событий, связанных с изменениями членства, укажите событие shared_drive_membership_change . Следующий пример получает все данные о добавлении участников на общие диски:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?evetName=shared_drive_membership_change&
filters=membership_change_type==add_to_shared_drive

Получение событий Google Диска по типу события

Для получения отчета обо всех случаях определенного типа событий, например, создания или редактирования документа, используйте HTTP GET запрос с токеном авторизации, описанным в руководстве по авторизации . Поле userKey содержит основной адрес электронной почты пользователя, фигурирующего в отчете, или all для всех пользователей.

В следующем примере получен отчет обо всех действиях по созданию документации для учетной записи. Пример ответа API см. в образце JSON-ответа :

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?eventName=create

Пример JSON-ответа

При отправке HTTP GET запроса к API успешный ответ возвращает код состояния HTTP 200. Вместе с кодом состояния ответ возвращает отчет по Google Диску. Эти отчеты также доступны в консоли администратора. Для получения дополнительной информации см. справочный центр администратора Google Рабочего пространства . Информацию об eventName см. в справочнике по именам событий Google Диска . Дополнительную информацию о параметрах запроса и свойствах ответа см. в справочнике API .

{
 "kind": "reports#auditActivities",
 "nextPageToken": "next page's token",
 "items": [
  {
   "kind": "audit#activity",
   "id": {
    "time": "2014-03-17T15:39:18.460Z",
    "uniqQualifier": "report's unique ID",
    "applicationName": "drive",
    "customerId": "ABC123xyz"
   },
   "actor": {
   "callerType": "USER",
   "email": "kim@example.com",
   "profileId": "user's unique Google Workspace profile ID",
   "key": "consumer key of requestor in an OAuth 2LO request"
   },
   "ownerDomain": "domain of the source owner",
   "ipAddress": "user's IP address",
   "events": [
    {
     "type": "access",
     "name": "edit",
     "parameters": [
      {
        "name": "primary_event",
        "boolValue": true
      },
      {
        "name": "owner_is_shared_drive",
        "boolValue": false
      },      {
        "name": "doc_id",
        "value": "1DWuYM3ot_sAyEQqOz0xWJ9bVMSYzOmRNeBqbgtSwuK8"
      },
      {
        "name": "doc_title",
        "value": "Meeting notes"
      },
      {
        "name": "doc_type",
        "value": "document"
      },
      {
        "name": "owner",
        "value": "mary@example.com"
      }
      ]
     }
    ]
   },
  ]
 }