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

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

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

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

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

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

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

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

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

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

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

Чтобы получить отчёт об активности конкретного пользователя на Google Диске, используйте HTTP-запрос GET с токеном авторизации, описанным в руководстве по авторизации . Поле userKey — это основной адрес электронной почты пользователя в отчёте или all для всех пользователей.

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

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

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

Вы можете получить отчёт об активности 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 Workspace Admin . Сведения о eventName см. в справочнике по именам событий Диска . Подробнее о строках запроса и свойствах ответа см. в справочнике 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"
      }
      ]
     }
    ]
   },
  ]
 }