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 Диска для общих дисков

Вы можете получить отчет о действиях на 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 . Информацию о 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"
      }
      ]
     }
    ]
   },
  ]
 }