Google Workspace 插件的触发器

Apps 脚本触发器会在指定事件 发生时执行指定的脚本 函数（即“触发器函数”）。只有某些事件才能导致触发器触发，并且每个 Google Workspace 应用支持的事件集都不同。

触发器触发时，系统会创建一个“事件对象”。 此 JSON 结构包含有关所发生事件的详细信息。事件对象结构中的信息会根据触发器类型的不同而以不同的方式进行整理。

创建事件对象后，Apps 脚本会将其作为参数传递给触发器函数。触发器函数是一个回调函数，您必须自行实现该函数，以执行适合响应事件的任何操作。例如，在扩展 Gmail 的 Google Workspace 插件中，您可以定义一个触发器，该触发器会在用户打开邮件会话时创建一个新卡片界面。在这种情况下，您可以使用 事件对象中传递的数据来实现上下文回调函数，以创建 构成新界面的卡片。

本页提供了有关在 Google Workspace 插件项目中使用触发器的指南。

清单触发器

与编辑器插件不同，Google Workspace 插件无法使用 Google Apps 脚本 简单触发器。相反，它们使用的是专门为 Google Workspace 插件设计的触发器，即“清单触发器”。

清单触发器在 Google Workspace 插件 清单中定义。例如：

  • 首页触发器 ，用于构建和显示插件首页。
  • Google 日历 eventOpen 触发器 ，用于在活动打开时显示新卡片或执行其他操作。
  • 日历 eventUpdate 触发器 ，用于在用户修改并保存活动时显示新卡片或执行其他操作。
  • Google 云端硬盘 onItemsSelected 触发器 ，用于在用户选择文件或文件夹时显示新卡片或执行其他操作。
  • Gmail 撰写触发器 ，用于在用户在撰写窗口中打开插件时显示插件卡片。
  • Gmail 上下文触发器 ，用于在用户打开邮件时显示新卡片或执行其他操作。
  • 编辑器 onFileScopeGranted 触发器 ，用于在用户在文档中授予 drive.file OAuth 范围的授权时显示新卡片。

在列表中，只有首页触发器是非上下文触发器；其余都是上下文触发器。如需详细了解清单触发器定义，请参阅清单。

除了清单触发器之外，Google Workspace 插件还可以使用 Apps 脚本 可安装触发器。

限制

清单触发器的使用存在某些限制。

  • 这些触发器仅在 Google Workspace 插件项目中使用。
  • 由于它们是在插件清单中定义的，而不是在代码中定义的，因此您无法使用 Apps 脚本 Script 服务来创建或修改它们。
  • Gmail 上下文触发器会针对每封电子邮件触发，无论内容如何。
  • 每个插件对于每个用户、每份文档，只能有一种类型的触发器。