- 资源:部署
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- 方法
资源:部署
Google Workspace 插件部署
JSON 表示法 |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
字段 | |
---|---|
name |
部署资源名称。示例: |
oauthScopes[] |
Google OAuth 范围列表,在执行插件端点之前,需要征得最终用户的同意。 |
addOns |
Google Workspace 插件配置。 |
etag |
此值由服务器根据存储空间中的部署版本计算,可能会在更新和删除请求时发送,以确保客户端在继续操作之前具有最新的值。 |
AddOns
Google Workspace 插件配置。
JSON 表示法 |
---|
{ "common": { object ( |
字段 | |
---|---|
common |
所有 Google Workspace 插件通用的配置。 |
gmail |
Gmail 插件配置。 |
drive |
云端硬盘插件配置。 |
calendar |
日历插件配置。 |
docs |
Google 文档插件配置。 |
sheets |
表格插件配置。 |
slides |
Google 幻灯片插件配置。 |
httpOptions |
用于向插件 HTTP 端点发送请求的选项 |
CommonAddOnManifest
在所有插件主机应用之间共享的插件配置。
JSON 表示法 |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
字段 | |
---|---|
name |
必需。插件的显示名称。 |
logoUrl |
必需。插件工具栏中显示的徽标图片的网址。 |
layoutProperties |
插件卡片的常见布局属性。 |
addOnWidgetSet |
插件中使用的微件。如果未指定此字段,则使用默认集合。 |
useLocaleFromApp |
是否从托管应用传递语言区域信息。 |
homepageTrigger |
定义将在任何上下文中、任何主机中执行的端点。该功能生成的所有卡片都始终可供用户使用,但当该插件声明更具针对性的触发器时,上下文内容可能会无法看到。 |
universalActions[] |
在通用操作菜单中定义一系列扩展点,该菜单可用作插件的设置菜单。扩展点可以是要打开的链接网址,也可以是作为表单提交内容执行的端点。 |
openLinkUrlPrefixes |
OpenLink 操作只能使用采用 |
LayoutProperties
在所有插件托管应用之间共享的卡片布局属性。
JSON 表示法 |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
字段 | |
---|---|
primaryColor |
插件的主要颜色。用于设置工具栏的颜色。如果未设置主要颜色,则使用框架提供的默认值。 |
secondaryColor |
插件的次要颜色。用于设置按钮的颜色。如果设置了主要颜色,但未设置次要颜色,则次要颜色与主要颜色相同。如果主要颜色和次要颜色均未设置,系统将使用框架提供的默认值。 |
useNewMaterialDesign |
为卡片启用 Material Design。 |
AddOnWidgetSet
插件使用的微件子集。
JSON 表示法 |
---|
{
"usedWidgets": [
enum ( |
字段 | |
---|---|
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 插件操作。 |
HomepageExtensionPoint
声明插件首页视图的常用格式。
JSON 表示法 |
---|
{ "runFunction": string, "enabled": boolean } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
enabled |
可选。如果设置为 如果未设置,则默认为 如果插件的自定义首页视图停用,系统会改为向用户显示通用概览卡片。 |
UniversalActionExtensionPoint
用于声明通用操作菜单项扩展点的格式。
JSON 表示法 |
---|
{ "label": string, // Union field |
字段 | |
---|---|
label |
必需。描述激活该扩展点所执行的操作的用户可见文本,例如“添加新联系人”。 |
联合字段 action_type 。必需。通用操作菜单项支持的操作类型。它可以是要打开的链接,也可以是要执行的端点。action_type 只能是下列其中一项: |
|
openLink |
UniversalAction 将要打开的网址。 |
runFunction |
将由 UniversalAction 运行的端点。 |
GmailAddOnManifest
用于自定义 Gmail 插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
定义将在与声明的上下文触发器不匹配的上下文中执行的端点。该功能生成的所有卡片始终对用户可用,但当该插件声明更具针对性的触发器时,上下文内容可能会掩盖。 如果存在,它会替换 |
contextualTriggers[] |
定义触发该插件的一组条件。 |
universalActions[] |
为该插件定义一组通用操作。用户通过插件工具栏菜单触发通用操作。 |
composeTrigger |
定义撰写时间插件的撰写时间触发器。此触发器会使插件在用户撰写电子邮件时执行操作。所有撰写时间插件都必须具有 |
authorizationCheckFunction |
端点名称,可通过探测第三方 API 来验证插件是否具备所有必需的第三方授权。如果探测失败,该函数应抛出异常以启动授权流程。每次调用该插件前都会调用此函数,以确保用户体验顺畅。 |
ContextualTrigger
定义当打开的电子邮件满足特定条件时触发的触发器。当触发器触发时,它会执行特定的端点,通常是为了创建新卡片和更新界面。
JSON 表示法 |
---|
{ "onTriggerFunction": string, // Union field |
字段 | |
---|---|
onTriggerFunction |
必需。当消息与触发器匹配时要调用的端点的名称。 |
联合字段 trigger 。触发器类型决定了 Gmail 用于显示插件的条件。trigger 只能是下列其中一项: |
|
unconditional |
无条件触发器会在打开任何邮件时执行。 |
UnconditionalTrigger
此类型没有任何字段。
任一电子邮件打开时触发的触发器。
UniversalAction
无论邮件的上下文如何,该操作始终在插件工具栏菜单中可用。
JSON 表示法 |
---|
{ "text": string, // Union field |
字段 | |
---|---|
text |
必需。说明相应操作的用户可见文本,例如“添加新联系人”。 |
联合字段 action_type 。操作类型决定了当用户调用相应操作时 Gmail 的行为。action_type 只能是下列其中一项: |
|
openLink |
用户触发操作时 Gmail 打开的链接。 |
runFunction |
在用户触发操作时调用的端点。如需了解详情,请参阅通用操作指南。 |
ComposeTrigger
在用户撰写电子邮件时激活的触发器。
JSON 表示法 |
---|
{ "actions": [ { object ( |
字段 | |
---|---|
actions[] |
定义撰写时间插件的一组操作。这些操作是用户可对撰写时间插件触发的操作。 |
draftAccess |
定义触发撰写时间插件时的数据访问权限级别。 |
MenuItemExtensionPoint
声明在托管应用中显示的菜单项或按钮的常用格式。
JSON 表示法 |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
label |
必需。描述激活该扩展点所执行的操作的用户可见文本。例如,“插入账单”。 |
logoUrl |
插件工具栏中显示的徽标图片的网址。 如果未设置此政策,则默认使用该插件的主徽标网址。 |
DraftAccess
用于定义 Compose 触发器所需的数据访问权限级别的枚举。
枚举 | |
---|---|
UNSPECIFIED |
没有为草稿访问权限设置任何设置时的默认值。 |
NONE |
触发 Compose 插件时,撰写触发器无法访问草稿的任何数据。 |
METADATA |
向撰写触发器授予在触发撰写插件时访问草稿元数据的权限。其中包括受众群体名单,例如邮件草稿的“收件人”和“抄送”名单。 |
DriveAddOnManifest
用于自定义云端硬盘插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
如果存在,它会替换 |
onItemsSelectedTrigger |
对应于在相关云端硬盘视图(例如“我的云端硬盘”文档列表)中选择项目时执行的行为。 |
DriveExtensionPoint
声明云端硬盘插件触发器的常用格式。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
必需。激活扩展点时要执行的端点。 |
CalendarAddOnManifest
用于自定义日历插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
定义在与声明的上下文触发器不匹配的上下文中执行的端点。该功能生成的所有卡片都始终可供用户使用,但当该插件声明更具针对性的触发器时,上下文内容可能会无法看到。 如果存在,它会替换 |
conferenceSolution[] |
定义此插件提供的会议解决方案。 |
createSettingsUrlFunction |
一个要执行的端点,用于创建指向插件设置页面的网址。 |
eventOpenTrigger |
一个端点,在有活动打开以供查看或修改时触发。 |
eventUpdateTrigger |
在打开事件更新时触发的端点。 |
currentEventAccess |
指定事件插件触发时的数据访问权限级别。 |
ConferenceSolution
定义与会议相关的值。
JSON 表示法 |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
字段 | |
---|---|
onCreateFunction |
必需。应创建会议数据时调用的端点。 |
id |
必需。ID 应在一个插件中跨视频会议解决方案进行唯一分配,否则当插件触发时,系统可能会使用错误的会议解决方案。虽然您可以更改插件的显示名称,但无法更改 ID。 |
name |
必需。会议解决方案的显示名称。 |
logoUrl |
必需。会议解决方案的徽标图片的网址。 |
CalendarExtensionPoint
声明日历插件触发器的常用格式。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
EventAccess
用于定义数据访问事件触发器所需的级别的枚举。
枚举 | |
---|---|
UNSPECIFIED |
没有为 eventAccess 设置任何内容时的默认值。 |
METADATA |
向事件触发器授予访问活动元数据(例如活动 ID 和日历 ID)的权限。 |
READ |
向事件触发器授予对所有提供的事件字段的访问权限,包括元数据、参加者和会议数据。 |
WRITE |
向活动触发器授予对活动元数据的访问权限,以及执行所有操作(包括添加参加者和设置会议数据)的权限。 |
READ_WRITE |
向事件触发器授予对提供的所有事件字段(包括元数据、参加者和会议数据)的访问权限,以及执行所有操作的权限。 |
DocsAddOnManifest
用于自定义 Google 文档插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
如果存在,它会替换 |
onFileScopeGrantedTrigger |
为此文档/用户对授予文件范围授权时要执行的端点。 |
linkPreviewTriggers[] |
用于预览 Google 文档中链接的扩展点列表。有关详情,请参阅预览包含智能条状标签的链接。 |
createActionTriggers[] |
一系列扩展点,可用于在 Google Workspace 应用内创建第三方资源。 |
DocsExtensionPoint
声明 Google 文档插件触发器的常用格式。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
LinkPreviewExtensionPoint
触发器的配置,用于在用户将第三方或非 Google 服务中的链接输入或粘贴到 Google 文档、表格或幻灯片文件中时触发。
JSON 表示法 |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
字段 | |
---|---|
labelText |
必需。提示用户预览链接的示例智能条状标签的文本,例如 |
localizedLabelText |
可选。要本地化为其他语言的 如果用户的语言区域出现在地图的键中,则用户会看到 包含一系列 |
patterns[] |
必需。一组网址格式,可触发插件预览链接。 |
runFunction |
必需。触发链接预览时要执行的端点。 |
logoUrl |
可选。智能条状标签和预览卡片中显示的图标。如果省略,该插件会使用其工具栏图标 |
UriPattern
触发链接预览的每种网址格式的配置。
JSON 表示法 |
---|
{ "hostPattern": string, "pathPrefix": string } |
字段 | |
---|---|
hostPattern |
对要预览的每种网址格式都是必需的。网址格式的网域。该插件会预览网址中包含此域名的链接。若要预览特定子网域(如 例如, |
pathPrefix |
可选。附加 例如,如果网址主机格式为 如需匹配主机格式网域中的所有网址,请将 |
CreateActionExtensionPoint
在用户调用 Google Workspace 应用中的创建工作流时触发的触发器配置。
JSON 表示法 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
字段 | |
---|---|
id |
必需。用于区分此扩展点的唯一 ID。ID 最多可包含 64 个字符,且应采用 |
labelText |
必需。显示在资源创建入口点图标旁边的文本,例如 |
localizedLabelText |
可选。要本地化为其他语言的 如果用户的语言区域出现在地图的键中,则用户会看到 包含一系列 |
runFunction |
必需。在触发资源创建工作流创建关联时要执行的端点。 |
logoUrl |
可选。为资源创建入口点显示的图标。如果省略此选项,菜单将使用插件的工具栏图标 |
SheetsAddOnManifest
用于自定义 Google 表格插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
如果存在,它会替换 |
onFileScopeGrantedTrigger |
为此文档/用户对授予文件范围授权时要执行的端点。 |
linkPreviewTriggers[] |
用于预览 Google 表格文档中链接的扩展点列表。有关详情,请参阅预览包含智能条状标签的链接。 |
SheetsExtensionPoint
声明 Google 表格插件触发器的常用格式。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
SlidesAddOnManifest
用于自定义 Google 幻灯片插件外观和执行的属性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
字段 | |
---|---|
homepageTrigger |
如果存在,它会替换 |
onFileScopeGrantedTrigger |
为此文档/用户对授予文件范围授权时要执行的端点。 |
linkPreviewTriggers[] |
用于预览 Google 幻灯片文档中链接的扩展点列表。有关详情,请参阅预览包含智能条状标签的链接。 |
SlidesExtensionPoint
声明幻灯片插件触发器的常用格式。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
必需。激活此扩展点时要执行的端点。 |
HttpOptions
用于向插件 HTTP
端点发送请求的选项。
JSON 表示法 |
---|
{
"authorizationHeader": enum ( |
字段 | |
---|---|
authorizationHeader |
|
HttpAuthorizationHeader
在插件“HTTP
”请求中发送授权标头。
枚举 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
默认值,等同于 SYSTEM_ID_TOKEN 。 |
SYSTEM_ID_TOKEN |
发送项目专属 Google Workspace 插件的系统服务帐号的 ID 令牌(默认)。 |
USER_ID_TOKEN |
向最终用户发送 ID 令牌。 |
NONE |
不要发送 Authentication 标头。 |
方法 |
|
---|---|
|
创建具有指定名称和配置的部署。 |
|
删除具有给定名称的部署。 |
|
获取具有指定名称的部署。 |
|
获取测试部署的安装状态。 |
|
为您的账号安装部署以进行测试。 |
|
列出特定项目中的所有部署。 |
|
创建或替换具有指定名称的部署。 |
|
从用户的帐号中卸载测试部署。 |