Reports API 概览

Reports API 是一种 RESTful API，可用于访问有关用户 Google Workspace 活动的信息。Reports API 是 Admin SDK API 的一部分。

Reports API 提供两种报告：

  • 活动报告，用于报告特定应用或服务（例如 Google 云端硬盘或管理控制台）的事件。
  • 使用情况报告，其中列出了由用户触发的工作区事件。
    • 客户使用情况报告会列出您网域中所有用户的事件。
    • 用户使用情况报告会按用户列出事件。

以下是 Reports API 中使用的常用术语列表：

活动报告

活动报告会列出特定 Google Workspace 应用或服务中的活动信息。活动报告包含日期、时间、用户和活动类型。API 参考文档包含活动报告及其包含的信息的完整列表。以下是按应用或服务列出的部分活动报告示例：

  • 管理员活动报告会显示管理员使用管理控制台执行的活动。例如，您可以获取管理员使用管理控制台更改用户姓名所记录的所有时间。
  • Google 云端硬盘活动报告会列出贵网域用户修改和查看云端硬盘文档的方式。例如，您可以获取特定用户在云端硬盘中的活动列表。
  • 登录活动报告会提供有关您账号用户登录和退出账号的时间的信息。例如，您可以获取特定时间段内网域的所有登录记录的报告。
  • 移动设备活动报告会显示使用 Google 移动设备管理所管理的移动设备的活动。例如，您可以在用户注册新设备时收到通知。
  • OAuth 令牌活动报告会列出用户授予或撤消第三方网站和应用使用的授权令牌的事件。您可以使用 Reports API 获取有权访问用户 Google Workspace 数据的所有第三方的列表。
使用情况报告

使用情况报告会提供有关您网域中 Google Workspace 事件的信息。您可以使用此 API 请求用户的特定信息。

  • 客户使用情况报告会列出您账号中的详细应用和服务活动。此使用情况信息按应用类型整理，并包含特定于该应用的信息。
  • 用户使用情况报告会显示您账号用户的活动。您可以自定义这些报告并对其进行过滤，以查看特定的使用情况信息。此使用情况信息按应用类型整理，并包含特定于该应用的信息。
  • 实体使用情况报告会列出与您账号用户在 Google 动态中使用的实体相关的活动。
通知
Reports API 提供通知，可让您监控事件，例如资源更改。当您监控某个资源且该资源发生变化时，Reports API 会向您发送通知。如需详细了解如何设置和接收 Reports API 通知，请参阅接收推送通知指南。

后续步骤