Reports API:云端硬盘活动报告

云端硬盘活动报告提供有关用户在 Google Workspace 中管理、修改和共享 Google 云端硬盘中的文件时的活动信息。 例如,您可以使用云端硬盘活动报告获取特定用户在指定日期范围内创建的所有新云端硬盘文档的列表。您可以利用这些信息深入了解如何更好地管理内容以及可能的数据泄露情况。如需获取报告,您可以使用基本报告端点请求以及报告专用参数,例如用户的电子邮件地址或特定类型的 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 天(最长期限)内的所有 Google 云端硬盘事件的报告。

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 云端硬盘事件

您可以使用 HTTP GET 请求(附带授权指南中所述的授权令牌)检索特定共享云端硬盘的 Google 云端硬盘活动报告。在 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 响应示例

当您向 API 发出 HTTP GET 请求时,成功的响应会返回 HTTP 200 状态代码。除了状态代码以外,响应还会返回 Google 云端硬盘的报告。您还可以在管理控制台中查看这些报告。如需了解详情,请参阅 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"
      }
      ]
     }
    ]
   },
  ]
 }