Google Drive Activity API 简介

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

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

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

请求

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

响应

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

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

DriveActivity 资源是 Action 对象的集合,每个对象都是自成一体的,就像一个事件。Action 包含 ActionDetail(例如 Create 或 Edit)、Actor(例如 User 或 Administrator)、Target(例如 DriveItem 或 Drive),以及 Timestamp 或 TimeRange。

DriveActivity 资源还包含摘要信息,例如所有操作的每个 Actor 和 Target、统一的 Timestamp 或 TimeRange,以及 Action 的最重要或最具代表性的 ActionDetail。

如需了解详情,请参阅 Drive Activity API 数据模型。

活动记录的可见性

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

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

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

  • 如果某个文档曾与用户共享,后来又设为私密,那么该用户可以查看其拥有访问权限期间的所有活动记录,但无法查看权限受限后的活动记录。

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