Reports API 概览

Reports API 是一个 RESTful API,可用于访问用户的 Google Workspace 活动相关信息。报告 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 管理员帮助中心