索引
AddOnWidgetSet
(消息)AddOnWidgetSet.WidgetType
(枚举)CommonAddOnManifest
(消息)CreateActionExtensionPoint
(消息)HomepageExtensionPoint
(消息)HttpAuthorizationHeader
(枚举)HttpOptions
(消息)LayoutProperties
(消息)LinkPreviewExtensionPoint
(消息)MenuItemExtensionPoint
(消息)UniversalActionExtensionPoint
(消息)UriPattern
(消息)
AddOnWidgetSet
插件使用的微件子集。
字段 | |
---|---|
usedWidgets[] |
插件中使用的微件列表。 |
WidgetType
微件类型。WIDGET_TYPE_UNSPECIFIED
是基本的 widget 集。
枚举 | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
已设置默认微件。 |
DATE_PICKER |
日期选择器。 |
STYLED_BUTTONS |
样式按钮包括已填充的按钮和已停用的按钮。 |
PERSISTENT_FORMS |
持久性表单允许在操作期间持久保留表单值。 |
FIXED_FOOTER |
修复了卡片中的页脚。 |
UPDATE_SUBJECT_AND_RECIPIENTS |
更新草稿的主题和收件人。 |
GRID_WIDGET |
“网格”widget。 |
ADDON_COMPOSE_UI_ACTION |
适用于插件撰写界面的 Gmail 插件操作。 |
CommonAddOnManifest
在所有插件主机应用之间共享的插件配置。
字段 | |
---|---|
name |
必需。插件的显示名称。 |
logoUrl |
必需。插件工具栏中显示的徽标图片的网址。 |
layoutProperties |
插件卡片的常见布局属性。 |
addOnWidgetSet |
插件中使用的微件。如果未指定此字段,将使用默认集。 |
useLocaleFromApp |
是否从托管应用传递语言区域信息。 |
homepageTrigger |
定义将在任何上下文、任何主机中执行的端点。用户始终可以查看此函数生成的任何卡片,但当该插件声明更有针对性的触发器时,上下文内容可能会掩盖相关内容。 |
universalActions[] |
在通用操作菜单中定义一系列扩展点,该菜单将用作插件的设置菜单。扩展点可以是要打开的链接网址,也可以是作为表单提交执行的端点。 |
openLinkUrlPrefixes |
OpenLink 操作只能使用采用 |
CreateActionExtensionPoint
在用户调用 Google Workspace 应用中的资源创建工作流时触发的触发器的配置。如需了解详情,请参阅通过“@”菜单创建第三方资源。
字段 | |
---|---|
id |
必需。用于区分此扩展点的唯一 ID。ID 不得超过 64 个字符,且应采用 |
labelText |
必需。显示在资源创建入口点图标旁边的文本,例如 |
localizedLabelText |
可选。要本地化为其他语言的 如果地图的键中存在用户的语言区域,则用户会看到 |
runFunction |
必需。触发资源创建工作流创建链接时要执行的端点。 |
logoUrl |
可选。针对资源创建入口点显示的图标。如果省略此选项,菜单将使用您插件的工具栏图标 |
HomepageExtensionPoint
声明插件首页视图的常用格式。
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
enabled |
可选。如果设置为 如果未设置,则默认为 如果插件的自定义首页视图被停用,系统会改为为用户提供通用概览卡片。 |
HttpAuthorizationHeader
在插件 HTTP
请求中发送的授权标头。
枚举 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
默认值,相当于 SYSTEM_ID_TOKEN 。 |
SYSTEM_ID_TOKEN |
发送项目特定 Google Workspace 插件的系统服务帐号的 ID 令牌(默认)。 |
USER_ID_TOKEN |
为最终用户发送 ID 令牌。 |
NONE |
不要发送 Authentication 标头。 |
HttpOptions
用于向插件“HTTP
”端点发送请求的选项。
字段 | |
---|---|
authorizationHeader |
|
LayoutProperties
在所有插件宿主应用之间共享的卡片布局属性。
字段 | |
---|---|
primaryColor |
插件的主要颜色。用于设置工具栏的颜色。如果未设置主要颜色,则会使用框架提供的默认值。 |
secondaryColor |
插件的次要颜色。用于设置按钮的颜色。如果设置了主要颜色但未设置次要颜色,则次要颜色与主要颜色相同。如果主要颜色和次要颜色均未设置,系统将使用框架提供的默认值。 |
useNewMaterialDesign |
为卡片启用 Material Design。 |
LinkPreviewExtensionPoint
当用户将第三方服务或非 Google 服务中的链接输入或粘贴到 Google 文档、表格或幻灯片文件中时触发触发器的配置。
字段 | |
---|---|
labelText |
必需。提示用户预览链接的示例智能条状标签的文本,例如 |
localizedLabelText |
可选。要本地化为其他语言的 如果地图的键中存在用户的语言区域,则用户会看到 |
patterns[] |
必需。一组网址格式,可触发插件预览链接。 |
runFunction |
必需。触发链接预览时要执行的端点。 |
logoUrl |
可选。智能条状标签和预览卡片中显示的图标。如果省略此参数,该插件会使用其工具栏图标 |
MenuItemExtensionPoint
声明托管应用中显示的菜单项或按钮的常用格式。
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
label |
必需。描述激活该扩展点所执行的操作的用户可见文本。例如,“插入账单”。 |
logoUrl |
插件工具栏中显示的徽标图片的网址。 如果此政策未设置,系统会默认使用该插件的主徽标网址。 |
UniversalActionExtensionPoint
用于声明通用操作菜单项扩展点的格式。
字段 | |
---|---|
label |
必需。用户可见文字,用于描述激活该扩展点后执行的操作,例如“添加新联系人”。 |
联合字段 action_type 。必需。通用操作菜单项支持的操作类型。它可以是一个要打开的链接,也可以是要执行的端点。action_type 只能是下列其中一项: |
|
openLink |
要由 UniversalAction 打开的网址。 |
runFunction |
将由 UniversalAction 运行的端点。 |
UriPattern
触发链接预览的每种网址格式的配置。
字段 | |
---|---|
hostPattern |
对于要预览的每种网址格式而言都是必填项。网址格式的域名。网址中包含此域名的插件预览链接。若要预览特定子网域(如 例如, |
pathPrefix |
可选。附加 例如,如果网址的主机格式为 如要匹配主机格式网域中的所有网址,请将 |