本文档中会用到以下术语。
Google 日历会议插件
一种特殊的插件,可让会议服务提供商在 Google 日历活动中显示会议选项。这些插件需要完善的会议解决方案才能连接。由于此要求,大多数开发者都不需要创建日历会议插件。
如需了解详情,请参阅 Google 日历会议插件。另请参阅升级已发布的插件,了解如何将 Google 日历会议插件转换为 Google Workspace 插件。
卡片
插件界面的单个“页面”。卡片由不同的 widget 对象(按钮、文本字段、标题等)组成。
如需了解详情,请参阅卡片。
基于卡片
其界面显示为侧边栏中的窗格(在移动设备上,显示为通过菜单访问的另一个 activity 窗口)的插件。该插件有一个顶部工具栏,用于标识插件并显示卡片,这实际上是插件界面的“页面”。
Google Workspace 插件采用卡片式付款。
会议数据
Google 日历需要的一组信息,以便用户创建和加入由 Google Workspace 插件或 Google 日历视频会议插件启用的第三方会议。
如需了解详情,请参阅会议数据。
会议解决方案
第三方会议的表示法,可通过 Google Workspace 插件或 Google 日历会议插件在 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(而非 Google Apps 脚本内置的卡片服务)定义的插件。只有较早的编辑器插件是基于 HTML 的。
链接预览触发器
当用户在 Google 托管应用(例如 Google 文档)中与第三方或非 Google 网址互动时,系统会触发链接预览触发器。借助链接预览触发器,您可以定义要从服务或 API 中预览的网址模式,并配置预览内容,包括智能条状标签和预览卡片。链接预览触发器在插件脚本项目的清单中进行配置,因此是一种清单触发器。
如需了解详情,请参阅包含智能条状标签的预览链接。
清单
附加到 Apps 脚本项目的 JSON 文件。清单用于定义脚本正常运行所需的项目信息。对于 Google Workspace 插件,该清单用于指定插件可以扩展的托管服务器,并提供特定的界面控件设置。
清单触发器
在项目清单中定义的触发器,例如首页触发器或内容相关触发器。清单触发器仅用于在请求插件首页或插件进入需要显示更新的上下文时创建和显示新卡片。
清单触发器与 Apps Script 中的其他触发器不同,因为它们不是内置的(例如简单触发器),也无法使用 Apps Script 脚本服务以编程方式创建(例如可安装的触发器)。
非情境卡片
在用户不在特定情境下时显示内容的卡片;例如,在 Gmail 中查看电子邮件会话,但尚未打开某个会话时。首页是一种非情境卡片。
边栏
托管应用界面右侧的部分,Google Workspace 插件的界面会显示在此部分。Gmail 和编辑器插件也可以定义边栏。
智能条状标签
智能条状标签是指在 Google Workspace 应用中提及的人员、文件、日历活动或其他实体。当用户将鼠标悬停在条状标签上时,还可以预览与文件或链接相关的其他内容。例如,当用户将鼠标悬停在 Google 幻灯片演示文稿的条状标签上时,会看到幻灯片的屏幕截图、演示文稿的所有者,以及他们是否之前查看过该演示文稿。
您可以配置您的插件,以使用智能条状标签预览第三方或非 Google 服务的链接。请参阅在 Google 文档中预览链接。
触发器
由 Apps 脚本项目或插件定义的条件和自动事件响应。触发器会在其关联的事件发生时(例如,在打开插件时)触发,并导致指定的 Apps 脚本函数(触发器函数)自动执行。对于 Google Workspace 插件,触发器函数通常会构建新的卡片,以控制显示插件界面的哪个部分。只有特定类型的事件可以设置触发器。
如需了解详情,请参阅插件触发器。
触发器函数
项目中的一个 Apps 脚本函数,用于响应触发器触发而执行。
微件
界面元素,例如按钮、文本字段或复选框。卡片由一组由 Apps 脚本内置卡片服务定义的 widget 对象构建而成。
如需了解详情,请参阅微件。
微件处理程序函数
用于将特定微件与特定操作对象相关联的函数。每个 widget 类型都有一组已定义的 widget 处理程序函数,可用于连接到操作。微件处理脚本函数用于定义哪种用户互动会触发最终操作,是微件互动的重要组成部分。
如需了解详情,请参阅widget 处理脚本函数。