术语库

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

本文档中使用了以下术语。

Google 日历会议插件

一种特殊插件,可让会议服务提供商在 Google 日历活动中显示会议选项。这些插件需要一款精心设计的会议解决方案,才能将插件连接到会议。由于此要求,大多数开发者从而无需创建日历会议插件。

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

卡片

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

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

卡片式

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

Google Workspace 插件是基于卡片的。

会议数据

Google 日历为用户提供一组通过 Google Workspace 插件或日历会议插件启用的第三方会议所需的信息。

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

会议解决方案

可通过 Google Workspace 插件或日历会议插件在 Google 日历中创建的第三方会议的表示形式。

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

背景信息

主机应用的当前状态。例如,目前在 Gmail 中打开了哪些邮件、您正在修改哪些日历活动,或您选择的哪些云端硬盘文件属于主应用的当前上下文的一部分。上下文以及其他信息会收集到事件对象中,然后作为参数传递给触发器函数。

内容相关触发

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

编辑器插件

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

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

事件对象

当请求首页时,当插件进入需要响应的上下文时,或者由于用户与插件界面中的微件互动时,自动创建的 JSON 对象。创建后,事件对象会传递到指定的触发器函数或回调函数。事件对象的用途是将信息从用户的客户端环境(例如,用户在插件界面微件中输入的信息)传递到插件的服务器端代码,以便客户端处理该信息并返回相应的响应。

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

Gmail 插件

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

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

首页

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

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

主机或主机应用

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

基于 HTML

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

清单

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

清单触发器

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

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

非内容相关卡片

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

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

触发器

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

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

触发器函数

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

微件

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

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

微件处理程序函数

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

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