Google Workspace 插件的触发器

Apps 脚本触发器会在指定事件发生时执行指定的脚本函数（即触发函数）。只有特定事件才能触发触发器，并且每款 Google Workspace 应用支持的事件集各不相同。

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

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

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

清单触发器

与编辑器插件不同，Google Workspace 插件目前无法使用 Apps 脚本简单触发器，而是使用专门为 Google Workspace 插件设计的触发器：清单触发器。

清单触发器完全在 Google Workspace 插件的清单中定义。清单触发器的示例包括：

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

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

除了清单触发器之外，Google Workspace 加载项还可以使用 Apps 脚本可安装的触发器。

限制

清单触发器在使用方面存在一些限制。

• 这些触发器仅在 Google Workspace 插件项目中使用；在任何其他应用中都没有用途。
• 由于这些触发器是在插件清单中定义的，而不是在其代码中定义的，因此您无法使用 Apps 脚本 Script 服务来创建或修改这些触发器。
• Gmail 上下文触发器目前只能包含一个 unconditional 条件。 这意味着，无论电子邮件的内容如何，系统都会针对每封电子邮件触发上下文触发器。
• 每个插件只能针对每个用户、每个文档拥有一个触发器。