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 的通知,请参阅接收推送通知指南。

后续步骤

  • 如需了解 Reports API 并查看其运作情况,请使用快速入门(按编程语言在左侧导航栏上列出)。您也可以继续浏览本部分,了解有关设置帐号的常规信息。

  • 如需使用 Reports API,请按照前提条件步骤设置您的帐号并成为管理员。您还将使用 Google API 控制台创建一个项目并注册该项目,然后您将激活 Reports API 服务。

  • 授权部分介绍了如何使用 OAuth 2.0 访问令牌从 Google Workspace 应用和服务获取用户数据。

  • 如需查找特定资源类型或方法的详细信息,请参阅 API 参考文档

  • 如需了解详情,请参阅 Admin SDK API 问题跟踪器Google Workspace 开发者博客Google Workspace 管理员帮助中心