Google Drive Activity API 简介

本文档简要介绍了 Google 云端硬盘 Activity API。

借助 Drive Activity API,您可以查询近期发生的事件。您可以提取所有活动的详细历史记录,包括每个事件的详细信息。这对于审核等任务非常有用,因为您可以检索包含 ActionDetailActorTarget 信息的精确活动。

Drive Activity API 由 DriveActivity资源(表示对用户 Google 云端硬盘中的对象所做的更改)和 activity.query方法(用于检索与这些更改相关的信息)组成。

请求

您的应用使用 activity.query 方法请求用户的活动数据。您可以请求特定云端硬盘项的活动,也可以请求云端硬盘文件夹下包含的所有内容的活动。对于给定的请求,您可以选择使用时间范围 或操作类型等过滤条件来限制 响应,也可以选择在响应中整合活动。如需了解详情, 请参阅在 Google 云端硬盘 Activity API 中发出请求

响应

响应包含与给定参数匹配的活动列表,其中 一个 DriveActivity 资源表示每个 活动:

对 Drive Activity API 响应正文消息的说明。
图 1.Drive Activity API 响应正文消息说明。

DriveActivity 资源是 Action对象的集合,每个对象都是自成一体的 ,就像一个事件一样。Action 包含 ActionDetail(例如 CreateEdit)、Actor(例如 UserAdministrator)、Target(例如 DriveItemDrive)以及 TimestampTimeRange

DriveActivity 资源还包含摘要信息,例如所有操作中的每个 ActorTarget、统一的 TimestampTimeRange, 以及 Action 的最重要或最具代表性的 ActionDetail

如需了解详情,请参阅 Drive Activity API data model

活动记录可见性

当您使用 Drive Activity API 时,系统可能不会报告云端硬盘上的某些活动。API 是否报告对给定对象的更改,取决于您的应用中经过身份验证的用户是否可以看到该更改或与该更改相关的信息。

可见性取决于为对象设置的权限。在云端硬盘中共享文件和文件夹时,有以下几种情况:

  • 如果作者共享文档,则创建者和共享对象都可以看到该文档的活动记录。

  • 如果文档已与用户共享,然后设为私密,则用户可以看到在他们拥有访问权限期间的所有活动记录,但无法看到权限受限后的活动记录。

  • 如果文档从未与用户共享,则用户无法看到任何活动记录。