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 请求有关用户的特定信息。

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

后续步骤