Reports API 概览

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

Reports API 是一个 RESTful API,可用于访问用户的 Google Workspace 活动相关信息。Reports API 是 Google Workspace 管理控制台 SDK 的一部分。

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 问题跟踪器Google Workspace 开发者博客Google Workspace 管理员帮助中心