Введение в API активности Google Диска

В этом документе представлен обзор API активности Google Drive.

API активности Google Диска позволяет запрашивать информацию о последних событиях. Вы можете получить подробную историю всех действий, включая детальную информацию о каждом событии. Это полезно для таких задач, как аудит, поскольку вы можете получить точные данные о действиях, включая информацию ActionDetail , Actor и Target .

API активности Google Диска состоит из ресурса DriveActivity , который отображает изменения, внесенные в объекты в Google Диске пользователя, и метода activity.query , который позволяет получить информацию об этих изменениях.

Запрос

Ваше приложение запрашивает данные об активности пользователя с помощью метода activity.query . Вы можете запросить данные об активности либо для конкретного элемента Google Диска, либо для всего содержимого папки в Google Диска. Для каждого запроса вы можете ограничить ответ, используя фильтр , например, по временному диапазону или типу действия, а также выбрать, чтобы данные об активности были объединены в ответе. Для получения дополнительной информации см. раздел «Выполнение запросов в API активности Google Диска» .

Ответ

В ответе содержится список действий, соответствующих заданным параметрам, где каждое действие представлено ресурсом DriveActivity :

Пояснение к содержимому тела ответа API Drive Activity.
Рисунок 1. Объяснение тела сообщения ответа API активности диска.

Ресурс DriveActivity представляет собой набор объектов Action , каждый из которых является самодостаточным, подобно событию . Объект Action включает в себя ActionDetail (например, Create или Edit ), Actor (например, User или Administrator ), Target (например, DriveItem или Drive ) и либо Timestamp , либо TimeRange .

Ресурс DriveActivity также содержит сводную информацию, такую ​​как все Actor и Target из всех действий, единую Timestamp или TimeRange , а также наиболее важную или репрезентативную ActionDetail о Action .

Для получения более подробной информации см. модель данных API активности диска .

Видимость истории активности

При использовании API активности Google Диска некоторые действия могут не отображаться в отчете. Будет ли API сообщать об изменении объекта, зависит от того, видно ли это изменение или информация об изменении авторизованному пользователю в вашем приложении.

Видимость определяется правами доступа, установленными для объекта. Существует несколько сценариев, когда файлы и папки предоставляются в общий доступ в Google Диск:

  • Если автор делится документом, история действий с этим документом видна как создателю, так и пользователям, с которыми он был предоставлен.

  • Если документ был предоставлен пользователю в общий доступ, а затем сделан приватным, пользователь сможет видеть всю историю действий за период, когда у него был доступ, но не после ограничения прав доступа.

  • Если документ никогда не был предоставлен пользователю, пользователь не сможет просмотреть историю своей активности.

  • Чтобы максимально эффективно использовать API активности Google Диска, сначала интегрируйте свое приложение с API Google Диска.
  • Чтобы узнать о разработке с использованием API Google Workspace, включая создание проекта или обработку аутентификации и авторизации, обратитесь к разделу «Разработка в Google Workspace» .
  • Для получения информации о доступных видах деятельности см. справочник по API .