本文档中使用了以下术语。
Google 日历会议插件
一种特殊插件,可供会议服务提供商在 Google 日历活动中展示会议选项。这些插件需要精心开发的会议解决方案才能连接到这些插件。因此,大多数开发者从而无需创建日历会议插件。
如需了解详情,请参阅日历会议插件。另请参阅升级已发布的插件,了解如何将日历会议插件转换为 Google Workspace 插件。
卡片
插件界面的单个“页面”。卡片由不同的微件对象(按钮、文本字段、标题等)组成。
如需了解详情,请参阅卡片。
卡片式
一个插件,其界面在边栏中显示为窗格(在移动设备上,显示为通过菜单到达的另一个活动窗口)。该插件具有一个顶部工具栏,用于标识插件并显示卡片(实质上是插件界面的“页面”)。
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 脚本内置的卡片服务)定义的。只有旧版编辑器插件是基于 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 脚本的卡片服务定义)构成。
如需了解详情,请参阅微件。
微件处理程序函数
用于将特定 widget 与特定操作对象相关联的函数。每种 widget 类型都有一组定义的 widget 处理程序函数,可用于连接到操作。微件处理程序函数定义了哪类用户互动会触发由此产生的操作,是 widget 互动的关键组成部分。
如需了解详情,请参阅微件处理程序函数。