术语表

本文档中会用到以下术语。

日历会议插件

一种特殊的插件,可让会议服务提供商在 Google 日历活动中展示会议选项。这些插件需要完善的会议解决方案才能连接。由于此要求,大多数开发者都不需要创建 Google 日历会议插件。

如需了解详情,请参阅日历会议插件。另请参阅升级已发布的插件,了解如何将 Google 日历会议插件转换为 Google Workspace 插件。

卡片

插件界面的单个“页面”。卡片由不同的 widget 对象(按钮、文本字段、标题等)组成。

如需了解详情,请参阅卡片

卡片式

一个插件,其界面显示为边栏中的窗格(在移动设备上,显示为通过菜单访问的另一个 activity 窗口)。该插件有一个顶部工具栏,用于标识该插件并显示一张卡片 - 实际上是该插件界面的一个“页面”。

Google Workspace 插件是基于卡片的。

会议数据

Google 日历需要的一组信息才能允许用户创建和加入由 Google Workspace 插件或日历会议插件启用的第三方会议。

如需了解详情,请参阅会议数据

会议解决方案

表示可以使用 Google Workspace 插件或日历会议插件通过 Google 日历创建的第三方会议。

如需了解详情,请参阅会议解决方案

上下文

主机应用的当前状态。例如,当前在 Gmail 中打开的哪封邮件、您正在修改的日历活动或您选择的云端硬盘文件都包含在托管应用的当前上下文中。上下文以及其他信息会被收集到事件对象中,该对象以参数形式传递给触发器函数。

内容相关触发

定义在用户进入特定上下文时触发的触发器的做法,例如当用户在 Gmail 中打开电子邮件会话时。上下文触发功能可让您的插件提供与该上下文相关的界面。上下文触发器在插件脚本项目的清单中配置,因此是一种清单触发器

编辑器插件

一组仅允许使用 Google 文档、表格、表单或幻灯片扩展程序的插件类型。编辑器插件不是基于卡片的;而是要求开发者基于原始 HTML 和 CSS 创建界面。每个编辑器插件只能扩展一个主机应用。

如需了解详情,请参阅编辑器插件

事件对象

系统会在请求首页时、插件进入需要响应的上下文时或因用户与插件界面中的微件互动而自动创建的 JSON 对象。创建后,事件对象会传递到指定的触发器函数或回调函数。事件对象的用途是将信息从用户的客户端环境(例如他们在插件界面 widget 中输入的信息)传递给插件的服务器端代码,然后代码可对这些信息执行操作,并返回相应响应。

如需了解详情,请参阅事件对象

Gmail 插件

仅扩展 Gmail 的插件。Gmail 插件是基于卡片的。用于创建 Gmail 插件的许多功能、行为和开发细节都与创建 Google Workspace 插件时所用的详细信息相同。

如需了解详情,请参阅 Gmail 插件。另请参阅升级已发布的插件,了解如何将 Gmail 插件转换为 Google Workspace 插件。

首页

插件的根界面卡片。当用户打开插件时,系统会显示首页,并让您的插件显示特定上下文之外的内容(例如,当用户在 Gmail 中查看电子邮件会话,但尚未打开它时)。您可以像定义任何其他卡片一样定义插件首页的外观和行为。

如需了解详情,请参阅首页

托管或托管应用

作为 Google Workspace 插件扩展的 Google Workspace 应用,例如 Gmail 或 Google 日历。

基于 HTML

一个插件,其界面是使用 HTML 和 CSS(而不是 Apps 脚本的内置 Card 服务)定义的。只有旧版编辑器插件是基于 HTML 的。

当用户在 Google 托管应用(例如 Google 文档)中与第三方或非 Google 网址进行互动时,就会触发“链接预览”触发器。借助链接预览触发功能,您可以定义要从服务或 API 预览的网址格式,并配置预览内容,包括智能条状标签和预览卡片。链接预览触发器在插件脚本项目的清单中配置,因此是一种清单触发器。

如需了解详情,请参阅在 Google 文档中预览链接

清单

附加到 Apps 脚本项目的 JSON 文件。清单用于定义脚本正常运行所需的项目信息。对于 Google Workspace 插件,清单用于指定插件可以扩展的主机并提供特定的界面控制设置。

清单触发器

在项目清单中定义的触发器,例如首页触发器或内容相关触发器。清单触发器专门用于在系统请求插件首页或插件进入需要更新显示内容的上下文时创建和显示新卡片。

清单触发器与 Apps 脚本中的其他触发器不同,因为前者不是内置触发器(如简单触发器),无法使用 Apps 脚本的脚本服务(如可安装的触发器)以编程方式创建。

非内容相关卡片

当用户在特定上下文之外(例如,在 Gmail 中查看电子邮件会话但未打开任何会话)时显示内容的卡片。首页是一种与内容无关的卡片,

主机界面右侧的部分,其中显示了 Google Workspace 插件界面。Gmail 和编辑器插件还可以定义边栏。

智能条状标签

智能条状标签提及了 Google Workspace 应用中的人员、文件、日历活动或其他实体。当用户将光标悬停在条状标签上时,还可以预览有关文件或链接的其他内容。例如,当用户将鼠标悬停在某个 Google 幻灯片演示文稿的条状标签上时,他们会看到该幻灯片的屏幕截图、该演示文稿的所有者,以及他们之前是否曾查看过该演示文稿。

您可以将插件配置为使用智能条状标签来预览第三方服务或非 Google 服务的链接。请参阅在 Google 文档中预览链接

触发器

由 Apps 脚本项目或插件定义的条件和自动事件响应。触发器会在其关联事件发生(例如,打开插件)时触发,并导致指定的 Apps 脚本函数(触发器函数)自动执行。对于 Google Workspace 插件,触发函数通常会构建新的卡片,以便控制显示插件界面的哪个部分。只有特定事件类型可以有触发器。

如需了解详情,请参阅插件触发器

触发函数

项目中的 Apps 脚本函数,该函数为响应被触发的触发器而执行。

widget

界面元素,例如按钮、文本字段或复选框。卡片由一系列微件对象(由 Apps 脚本的内置 Card 服务定义)构建而成。

如需了解详情,请参阅微件

widget 处理程序函数

用于将特定 widget 与特定操作对象相关联的函数。每种 widget 类型都有一组已定义的 widget 处理程序函数,该函数可用于连接到操作。widget 处理程序函数定义了哪种类型的用户互动会触发所生成的操作,是 widget 互动的关键组成部分。

如需了解详情,请参阅微件处理程序函数