利用高级 Google Workspace 事件服务,您可以在 Apps 脚本中使用 Google Workspace Events API。借助此 API Google Workspace 资源,以便您收到符合自己需求的相关活动 。事件表示对资源的更改,例如当资源被 创建、更新或删除
前提条件
- 使用标准 Google Cloud 项目(而非由 Apps 脚本自动创建的默认项目)的 Apps 脚本项目。
- 在同一项目中创建的 Pub/Sub 主题 用于接收订阅事件的 Google Cloud 项目。 如需创建 Pub/Sub 主题,请参阅 创建并订阅 Pub/Sub 主题。
- 要订阅 Chat 事件,您必须拥有 在 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 Script 项目的代码中:
获取订阅
如需获取有关订阅的信息,请将以下函数添加到 Apps 脚本项目的代码:
更新订阅
要更新或续订订阅,请将以下函数添加到 Apps 脚本项目的代码:
重新激活订阅
要重新激活订阅,请将以下函数添加到 Apps 脚本项目的代码:
删除订阅
要删除订阅,请将以下函数添加到 Apps 脚本项目的代码:
获取操作
大多数 Google Workspace Events API 方法都会返回一个
长时间运行的操作。
如需确定操作的状态,您可以使用 operations.get()
方法。
如需获取操作的相关信息,请添加以下函数 添加到 Apps 脚本项目的代码中:
如需获取操作的名称,请使用返回的 name
字段中的值
(如
subscriptions.create()
或
subscriptions.patch()
。