借助高级 Google Workspace 事件服务,您可以在 Apps 脚本中使用 Google Workspace Events API。您可以使用此 API 订阅 Google Workspace 资源,以便接收感兴趣的相关事件。事件表示对资源的更改,例如创建、更新或删除资源时。
前提条件
- 使用标准 Google Cloud 项目(而不是 Apps 脚本自动创建的默认项目)的 Apps 脚本项目。
- 在同一 Google Cloud 项目中创建的 Pub/Sub 主题,用于接收订阅事件。如需创建 Pub/Sub 主题,请参阅创建和订阅 Pub/Sub 主题。
- 如需订阅 Chat 事件,您必须在 Google Cloud 控制台的 Chat API 配置页面上配置一个 Google Chat 应用。如需创建 Google Chat 应用,请参阅使用 Apps 脚本构建 Google Chat 应用。
添加到 Apps 脚本项目的
appsscript.json
文件中的必要授权范围。必要的范围取决于订阅的目标资源和事件的类型。如需了解详情,请参阅选择 Google Workspace Events API 范围。 例如:"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
参考
如需详细了解此服务,请参阅 Google Workspace Events API 参考文档。 与 Apps 脚本中的所有高级服务一样,Google Workspace 事件服务使用与公共 API 相同的对象、方法和参数。
示例代码
这些示例向您展示了如何使用高级服务执行常见的 Google Workspace Events API 操作。
创建订阅
如需创建对 Google Workspace 资源的订阅,请将以下函数添加到 Apps 脚本项目的代码中:
列出订阅
如需列出按事件类型和目标资源过滤的订阅,请在 Apps 脚本项目的代码中添加以下函数:
获取订阅
如需获取有关订阅的信息,请将以下函数添加到 Apps 脚本项目的代码中:
更新订阅
如需更新或续订订阅,请将以下函数添加到 Apps 脚本项目的代码中:
重新激活订阅
如需重新激活订阅,请将以下函数添加到 Apps 脚本项目的代码中:
删除订阅
如需删除订阅,请将以下函数添加到 Apps 脚本项目的代码中:
获取操作
大多数 Google Workspace Events API 方法都会返回长时间运行的操作。如需确定操作的状态,您可以使用 operations.get()
方法。
如需获取操作的相关信息,请将以下函数添加到 Apps 脚本项目的代码中:
如需获取操作的名称,请使用从某个 Google Workspace Events API 方法(例如 subscriptions.create()
或 subscriptions.patch()
)返回的 name
字段中的值。