- 资源:Deployment
- 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
- MeetAddOnManifest
- Web
- 状态
- DisplayFlow
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- GranularOauthPermissionSupport
- 方法
资源:Deployment
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 文档插件配置。 | 
| meet | 
 Meet 插件配置。 | 
| sheets | 
 Google 表格插件配置。 | 
| slides | 
 Google 幻灯片插件配置。 | 
| httpOptions | 
 用于向插件 HTTP 端点发送请求的选项 | 
CommonAddOnManifest
在所有插件宿主应用之间共享的插件配置。
| JSON 表示法 | 
|---|
| { "name": string, "logoUrl": string, "layoutProperties": { object ( | 
| 字段 | |
|---|---|
| name | 
 必需。插件的显示名称。 | 
| logoUrl | 
 必需。插件工具栏中显示的徽标图片的网址。 | 
| layoutProperties | 
 插件卡片的常见布局属性。 | 
| addOnWidgetSet | 
 插件中使用的 widget。如果未指定此字段,则使用默认集。 | 
| useLocaleFromApp | 
 是否从宿主应用传递语言区域信息。 | 
| homepageTrigger | 
 定义将在任何主机上的任何上下文中执行的端点。此函数生成的任何卡片始终可供用户使用,但当此插件声明更具针对性的触发条件时,可能会被上下文相关内容遮盖。 | 
| universalActions[] | 
 定义了通用操作菜单中的扩展点列表,该列表用作插件的设置菜单。扩展点可以是用于打开的链接网址,也可以是作为表单提交执行的端点。 | 
| openLinkUrlPrefixes | 
 OpenLink 操作只能使用具有  | 
LayoutProperties
在所有插件宿主应用中共享的卡片布局属性。
| JSON 表示法 | 
|---|
| { "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } | 
| 字段 | |
|---|---|
| primaryColor | 
 插件的主色调。它用于设置工具栏的颜色。如果未设置任何主色调,则使用框架提供的默认值。 | 
| secondaryColor | 
 附加服务的辅助颜色。用于设置按钮的颜色。如果设置了主要颜色,但未设置次要颜色,则次要颜色与主要颜色相同。如果未设置主色调和次色调,则使用框架提供的默认值。 | 
| useNewMaterialDesign | 
 为卡片启用 Material Design。 | 
AddOnWidgetSet
插件使用的 widget 子集。
| JSON 表示法 | 
|---|
| {
  "usedWidgets": [
    enum ( | 
| 字段 | |
|---|---|
| usedWidgets[] | 
 插件中使用的 widget 的列表。 | 
WidgetType
微件类型。WIDGET_TYPE_UNSPECIFIED 是基本 widget 集。
| 枚举 | |
|---|---|
| WIDGET_TYPE_UNSPECIFIED | 默认 widget 集。 | 
| DATE_PICKER | 日期选择器。 | 
| STYLED_BUTTONS | 样式化按钮包括填充按钮和已停用的按钮。 | 
| PERSISTENT_FORMS | 持久表单允许在操作期间保留表单值。 | 
| FIXED_FOOTER | 修复了卡片中的页脚。 | 
| UPDATE_SUBJECT_AND_RECIPIENTS | 更新草稿的主题和收件人。 | 
| GRID_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
一种枚举,用于定义撰写触发器所需的数据访问权限级别。
| 枚举 | |
|---|---|
| UNSPECIFIED | 未针对 draftaccess 设置任何内容时的默认值。 | 
| NONE | 当撰写插件被触发时,撰写触发器无法访问草稿的任何数据。 | 
| METADATA | 当撰写插件触发时,向撰写触发器授予访问草稿元数据的权限。这包括受众群体名单,例如草稿邮件的“收件人”和“抄送”名单。 | 
DriveAddOnManifest
用于自定义云端硬盘插件的外观和执行的属性。
| JSON 表示法 | 
|---|
| { "homepageTrigger": { object ( | 
| 字段 | |
|---|---|
| homepageTrigger | 
 如果存在,则会覆盖  | 
| onItemsSelectedTrigger | 
 对应于在相关云端硬盘视图(例如“我的云端硬盘”文档列表)中选择内容时执行的行为。 | 
DriveExtensionPoint
用于声明云端硬盘插件触发器的常见格式。
| JSON 表示法 | 
|---|
| { "runFunction": string } | 
| 字段 | |
|---|---|
| runFunction | 
 必需。在扩展点激活时要执行的端点。 | 
CalendarAddOnManifest
用于自定义日历插件的外观和执行的属性。
| JSON 表示法 | 
|---|
| { "homepageTrigger": { object ( | 
| 字段 | |
|---|---|
| homepageTrigger | 
 定义在与声明的上下文触发器不匹配的上下文中执行的端点。此函数生成的任何卡片始终可供用户使用,但当此插件声明更具针对性的触发条件时,可能会被上下文相关内容遮盖。 如果存在,则会覆盖  | 
| conferenceSolution[] | 
 定义此插件提供的会议解决方案。第三方会议插件只能在 Apps 脚本中构建。 | 
| createSettingsUrlFunction | 
 用于执行的端点,可创建指向插件设置页面的网址。 | 
| eventOpenTrigger | 
 在打开活动以供查看或修改时触发的端点。 | 
| eventUpdateTrigger | 
 在打开事件更新时触发的端点。 | 
| eventAttachmentTrigger | 
 一种上下文触发器的配置,当用户点击日历下拉菜单中的插件附件提供方时触发。 | 
| currentEventAccess | 
 定义触发活动插件时的数据访问权限级别。 | 
ConferenceSolution
定义与会议相关的值。第三方会议插件只能在 Apps 脚本中构建。
| 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 | 
 可选。资源创建入口点显示的图标。如果省略此元素,菜单将使用插件的工具栏图标  | 
MeetAddOnManifest
Meet 插件清单。
| JSON 表示法 | 
|---|
| { "homepageTrigger": { object ( | 
| 字段 | |
|---|---|
| homepageTrigger | 
 如果存在,则会覆盖  | 
| web | 
 用于增强 Meet Web 客户端的插件的详细信息。 | 
| supportsCollaboration | 
 插件是否支持协作或邀请他人加入插件体验。 | 
| termsUri | 
 指向相应插件的服务条款的链接(如有)。 | 
Web
用于增强 Meet Web 客户端的插件的详细信息。
| JSON 表示法 | 
|---|
| { "sidePanelUri": string, "sidePanelUrl": string, "mainStageUri": string, "supportsScreenSharing": boolean, "supportsCollaboration": boolean, "supportsPopOut": boolean, "hostOrigins": [ string ], "addOnOrigins": [ string ], "openState": enum ( | 
| 字段 | |
|---|---|
| sidePanelUri | 
 侧边栏 iframe 的 URI。 | 
| sidePanelUrl | 
 侧边栏 iframe 的网址。 | 
| mainStageUri | 
 “主舞台”iframe 的 URI。 | 
| supportsScreenSharing | 
 插件是否支持在主舞台上共享屏幕。 | 
| supportsCollaboration | 
 插件是否支持协作或邀请他人加入插件体验。此字段现已弃用,请改用 MeetAddOnManifest 中的顶级字段。 | 
| supportsPopOut | 
 插件是否支持弹出到浏览器画中画体验。 | 
| hostOrigins[] | 
 已弃用的旧版名称。应添加到包含第三方网站的 iframe 的 frame-src 属性中的来源。请改用 addonorigins。 | 
| addOnOrigins[] | 
 应添加到包含第三方网站的 iframe 的 frame-src 属性中的来源。 | 
| openState | 
 打开插件时的初始状态。 | 
| supportsCollaborationHostControls | 
 协作插件是否支持主持人控件。 | 
| logoUrl | 
 要为插件显示的徽标的网址。如果未指定,徽标默认采用清单的通用部分中的徽标。 | 
| darkModeLogoUrl | 
 logourl 的深色模式版本。 | 
| displayFlow | 
 启动时,插件将遵循的显示流程。 | 
州
用于指定初始插件打开状态的枚举。
| 枚举 | |
|---|---|
| STATE_UNSPECIFIED | 未通过插件指定初始状态。 | 
| SIDE_PANEL_ONLY | 该插件会打开,但只有侧边栏处于活动状态。 | 
| MAIN_STAGE_ONLY | 插件打开时,只有主舞台处于活动状态。 | 
| SIDE_PANEL_AND_MAIN_STAGE | 插件打开后,侧边栏和主屏幕都会处于活动状态。 | 
DisplayFlow
用于指定插件启动时将遵循的显示流程的枚举
| 枚举 | |
|---|---|
| DISPLAY_FLOW_UNSPECIFIED | 未指定显示流程。 | 
| FOCUS | 插件应在“焦点”显示流程中启动。 | 
| AUGMENT | 插件应在“增强”显示流程中启动。 | 
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
用于声明 Google 幻灯片插件触发器的常见格式。
| JSON 表示法 | 
|---|
| { "runFunction": string } | 
| 字段 | |
|---|---|
| runFunction | 
 必需。激活此扩展点时要执行的端点。 | 
HttpOptions
用于向插件 HTTP 端点发送请求的选项。
| JSON 表示法 | 
|---|
| { "authorizationHeader": enum ( | 
| 字段 | |
|---|---|
| authorizationHeader | 
 
 | 
| granularOauthPermissionSupport | 
 插件是否已启用精细的 OAuth 意见征求。 | 
HttpAuthorizationHeader
在插件 HTTP 请求中发送的授权标头。
| 枚举 | |
|---|---|
| HTTP_AUTHORIZATION_HEADER_UNSPECIFIED | 默认值,相当于 SYSTEM_ID_TOKEN。 | 
| SYSTEM_ID_TOKEN | 发送项目专用 Google Workspace 加载项的系统服务账号(默认)的 ID 令牌。 | 
| USER_ID_TOKEN | 发送最终用户的 ID 令牌。 | 
| NONE | 不发送身份验证标头。 | 
GranularOauthPermissionSupport
插件是否已启用精细的 OAuth 意见征求。
| 枚举 | |
|---|---|
| GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED | 默认值,不应使用。 | 
| OPT_IN | 该插件已选择启用精细 OAuth 许可。 | 
| OPT_OUT | 相应插件已选择停用精细的 OAuth 许可。 | 
| 方法 | |
|---|---|
| 
 | 创建具有指定名称和配置的部署。 | 
| 
 | 删除具有指定名称的部署。 | 
| 
 | 获取具有指定名称的部署。 | 
| 
 | 获取测试部署的安装状态。 | 
| 
 | 将部署安装到您的账号以进行测试。 | 
| 
 | 列出特定项目中的所有部署。 | 
| 
 | 创建或替换具有指定名称的部署。 | 
| 
 | 从用户账号中卸载测试部署。 |