术语库

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

日历会议插件

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

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

卡片

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

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

基于卡片

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

Google Workspace 插件基于卡片。

会议数据

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

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

会议解决方案

一种第三方会议的表示形式,可以使用 Google Workspace 加购项或日历会议加购项从 Google 日历中创建。

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

上下文

宿主应用的当前状态。例如,Gmail 中当前打开的邮件、您正在修改的日历活动或您选择的云端硬盘文件都属于宿主应用的当前上下文。上下文与其他信息一起收集到事件对象中,并作为参数传递给触发函数。

情境触发

定义在用户进入特定情境(例如在 Gmail 中打开电子邮件会话)时触发的触发器的实践。借助情境触发,您的插件可以提供与相应情境相关的界面。上下文触发器在插件脚本项目的清单中配置,因此属于清单触发器

编辑器插件

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

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

事件对象

在请求首页时、当插件进入需要响应的上下文时,或作为用户与插件界面中的 widget 互动的结果而自动创建的 JSON 对象。创建后,事件对象会传递给指定的触发函数或回调函数。事件对象的目的是将信息从用户的客户端环境(例如用户在插件界面 widget 中输入的信息)传递到插件的服务器端代码,然后服务器端代码可以根据该信息采取行动并返回相应的响应。

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

Gmail 插件

仅扩展 Gmail 的插件。Gmail 插件基于卡片。用于创建 Gmail 加载项的许多功能、行为和开发细节与用于创建 Google Workspace 加载项的细节相同。

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

首页

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

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

宿主或宿主应用

Google Workspace 加购项所扩展的 Google Workspace 应用,例如 Gmail 或 Google 日历。

基于 HTML

一种使用 HTML 和 CSS(而非 Apps 脚本内置的卡片服务)定义界面插件。只有旧版编辑器插件是基于 HTML 的。

当用户在 Google 宿主应用(例如 Google 文档)中与第三方或非 Google 网址互动时,链接预览触发器会触发。通过链接预览触发,您可以定义要从服务或 API 预览的网址模式,并配置预览内容,包括智能条状标签和预览卡片。链接预览触发器在插件脚本项目的清单中配置,因此属于清单触发器。

如需了解详情,请参阅包含智能条状标签的预览链接

清单

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

清单触发器

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

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

非情境卡片

当用户不在特定情境中时显示内容的卡片;例如,当用户在 Gmail 中查看电子邮件会话,但尚未打开任何会话时。首页是一种非情境卡片。

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

智能条状标签

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

您可以配置插件,使其使用智能芯片预览第三方服务或非 Google 服务的链接。请参阅在 Google 文档中预览链接

触发器

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

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

触发函数

项目中的一个 Apps 脚本函数,在触发器触发时执行。

微件

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

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

微件处理函数

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

如需了解详情,请参阅widget 处理函数