适用于 Google Workspace 插件的触发器

8еа39680ц8 5138ц2ц823 800е90953а 1685бдфб67

Apps 脚本触发器触发指定的脚本 函数(即触发器函数),每当有指定事件发生时,系统即会执行该函数(即触发器函数) 。只有特定事件会触发触发器,每个 Google Workspace 应用支持一组不同的事件。

当触发器触发时,系统会创建一个事件对象。此 JSON 结构 包含发生的事件的详细信息。事件中的信息 对象结构的组织方式因触发器类型而异。

创建事件对象后,Apps 脚本会将其作为参数传递给 触发函数。触发器函数是一个回调函数,您必须 实施您自己的解决方案,以采取任何适当的措施来应对 事件。例如,在 一款可扩展 Gmail 的 Google Workspace 插件,您可以 定义一个在用户打开消息时创建新的卡片界面的触发器 线程。在这种情况下,您可以实现上下文回调函数, 构成新界面的卡片 事件对象的事件。

本页面介绍了如何在 Google Workspace 插件项目。

清单触发器

与编辑器插件不同,Google Workspace 插件 目前无法使用 Apps 脚本简单触发器 而是使用专为 Google Workspace 插件:清单触发器

清单触发器完全在 Google Workspace 插件 manifest 的文件。清单触发器的示例包括 以下:

  • 构建和显示插件首页的首页触发器
  • 日历事件打开触发器,显示新卡片或 打开日历活动时的其他操作。
  • 日历 eventUpdate 触发器显示新卡片或 用户编辑和保存日历活动时的其他操作。
  • 云端硬盘 onItemsSelected 触发器,用于显示新卡片或呈现新内容 当用户选择云端硬盘中的一个或多个文件或文件夹时,还会执行其他操作。
  • Gmail 撰写触发器:当 用户在 Gmail 撰写窗口中打开插件。
  • Gmail 内容相关触发器,用于显示新卡片或使用其他 在用户打开 Gmail 邮件时执行的操作。
  • Editor onFileScopeGranted 触发器在用户执行操作时显示新卡片 在当前编辑器中为 drive.file OAuth 范围授权 文档。

在上面的列表中,只有首页触发器与上下文无关;其余的 情境触发器。请参阅清单

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

限制

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

  • 这些触发器仅用于 Google Workspace 插件项目;它们在任何其他应用中都没有任何用途
  • 由于它们是在插件清单中(而非其代码)中定义的,因此您无法 使用 Apps 脚本 Script 来创建或修改这些触发器。
  • Gmail 内容相关触发器目前只能有一个 unconditional 条件。 这意味着系统会为每封电子邮件触发上下文触发器,无论 内容。
  • 对于每位用户的每个文档,每个插件只能有一个针对每种类型的触发器。