REST Resource: projects.deployments

资源：部署

Google Workspace 插件部署

JSON 表示法 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
字段
name

string

部署资源名称。示例：projects/123/deployments/my_deployment。
oauthScopes[]

string

在执行插件端点之前，需要向最终用户请求同意的 Google OAuth 范围的列表。
addOns

object (AddOns)

Google Workspace 插件配置。
etag

string

此值由服务器根据存储中的部署版本计算，可能会根据更新和删除请求发送，以确保客户端在继续操作之前具有最新值。

插件

Google Workspace 插件配置。

JSON 表示法 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
字段
common

object (CommonAddOnManifest)

在所有 Google Workspace 插件中通用的配置。
gmail

object (GmailAddOnManifest)

Gmail 插件配置。
drive

object (DriveAddOnManifest)

云端硬盘插件配置。
calendar

object (CalendarAddOnManifest)

日历插件配置。
docs

object (DocsAddOnManifest)

文档插件配置。
sheets

object (SheetsAddOnManifest)

Google 表格插件配置。
slides

object (SlidesAddOnManifest)

幻灯片插件配置。
httpOptions

object (HttpOptions)

用于向插件 HTTP 端点发送请求的选项

CommonAddOnManifest

在所有插件宿主应用中共享的插件配置。

JSON 表示法 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
字段
name

string

必需。插件的显示名称。
logoUrl

string

必需。插件工具栏中的徽标图片的网址。
layoutProperties

object (LayoutProperties)

插件卡的常用布局属性。
addOnWidgetSet

object (AddOnWidgetSet)

插件中使用的微件。如果未指定此字段，则使用默认集。
useLocaleFromApp

boolean

是否从托管应用传递语言区域信息。
homepageTrigger

object (HomepageExtensionPoint)

定义将在任何主机的任何上下文中执行的端点。此函数生成的任何卡片始终对用户可见，但如果此插件声明了更有针对性的触发器，则可能会被上下文内容所取代。
universalActions[]

object (UniversalActionExtensionPoint)

定义通用操作菜单中的扩展点列表，该菜单可用作插件的设置菜单。扩展点可以是要打开的链接网址，也可以是作为表单提交执行的端点。
openLinkUrlPrefixes

array (ListValue format)

OpenLink 操作只能使用采用 HTTPS、MAILTO 或 TEL 架构的网址。对于 HTTPS 链接，该网址还必须匹配许可名单中指定的某个前缀。如果前缀省略了方案，则假定为 HTTPS。HTTP 链接会自动重写为 HTTPS 链接。

LayoutProperties

在所有插件托管应用之间共享的卡片布局属性。

JSON 表示法 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
字段
primaryColor

string

插件的主色。它用于设置工具栏的颜色。如果未设置主色，则使用框架提供的默认值。
secondaryColor

string

插件的主色。它用于设置按钮的颜色。如果设置了主色但未设置辅色，则辅色与主色相同。如果未设置主色和辅色，则使用框架提供的默认值。
useNewMaterialDesign

boolean

为卡片启用 Material Design。

AddOnWidgetSet

插件使用的 widget 子集。

JSON 表示法 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
字段
usedWidgets[]

enum (WidgetType)

插件中使用的微件列表。

WidgetType

微件类型。WIDGET_TYPE_UNSPECIFIED 是基本的 widget 集。

枚举
WIDGET_TYPE_UNSPECIFIED 默认微件集。
DATE_PICKER 日期选择器。
STYLED_BUTTONS 样式按钮包括填充按钮和停用按钮。
PERSISTENT_FORMS 持久性表单允许在执行操作期间保留表单值。
UPDATE_SUBJECT_AND_RECIPIENTS 更新草稿的主题和收件人。
GRID_WIDGET 网格微件。
ADDON_COMPOSE_UI_ACTION 应用于插件撰写界面的 Gmail 插件操作。

HomepageExtensionPoint

声明插件首页浏览的常用格式。

JSON 表示法 
{
  "runFunction": string,
  "enabled": boolean
}
字段
runFunction

string

必需。启用此扩展点后要执行的端点。
enabled

boolean

可选。如果设置为 false，则会在此上下文中停用主页视图。

如果未设置，则默认为 true。

如果停用了某个插件的自定义首页视图，系统会改为为用户提供通用概览卡片。

UniversalActionExtensionPoint

用于声明通用操作菜单项扩展点的格式。

JSON 表示法 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
字段
label

string

必需。用户可见文本，用于描述通过激活此扩展点执行的操作，例如“添加新联系人”。
联合字段 action_type。必需。通用操作菜单项支持的操作类型。它可以是要打开的链接，也可以是要执行的端点。action_type 只能是下列其中一项：
runFunction

string

将由 UniversalAction 运行的端点。

GmailAddOnManifest

用于自定义 Gmail 插件的外观和执行方式的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
字段
homepageTrigger

object (HomepageExtensionPoint)

定义将在与声明的上下文触发器不匹配的上下文中执行的端点。此函数生成的任何卡片始终对用户可用，但如果此插件声明更多有针对性的触发器，则可能会被上下文内容所取代。

如果存在，则会覆盖 addons.common.homepageTrigger 中的配置。
contextualTriggers[]

object (ContextualTrigger)

定义触发插件的一组条件。
universalActions[]

object (UniversalAction)

为插件定义一组通用操作。用户从插件工具栏菜单中触发通用操作。
composeTrigger

object (ComposeTrigger)

为构建时插件定义构建时触发器。此触发器是插件在用户撰写电子邮件时导致其执行操作。所有撰写时插件必须具有 gmail.addons.current.action.compose 范围，即使它可能不会修改草稿。
authorizationCheckFunction

string

端点的名称。该端点会通过探测第三方 API 来验证插件是否拥有所有必要的第三方授权。如果探测失败，该函数应抛出异常以启动授权流程。系统会在每次调用插件之前调用此函数，以确保顺畅的用户体验。

ContextualTrigger

定义在打开的电子邮件符合特定条件时触发的触发器。当触发器触发时，会执行特定的端点，通常是为了创建新卡片并更新界面。

JSON 表示法 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
字段
onTriggerFunction

string

必需。当消息与触发器匹配时要调用的端点的名称。
联合字段 trigger。触发器类型决定了 Gmail 用于显示该插件的一些条件。trigger 只能是下列其中一项：
unconditional

object (UnconditionalTrigger)

当任一邮件被打开时，系统会执行无条件触发器。

UnconditionalTrigger

此类型没有字段。

打开任意电子邮件时触发的触发器。

UniversalAction

无论邮件上下文如何，此操作始终可在插件工具栏菜单中使用。

JSON 表示法 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
字段
text

string

必需。描述操作的用户可见文本，例如“添加新联系人”。
联合字段 action_type。操作的类型决定了用户调用操作时 Gmail 的行为。action_type 只能是下列其中一项：
runFunction

string

在用户触发操作时调用的端点。有关详情，请参阅通用操作指南。

ComposeTrigger

在用户撰写电子邮件时激活的触发器。

JSON 表示法 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
字段
actions[]

object (MenuItemExtensionPoint)

定义了 compose 时间插件的一组操作。这些是用户可以在撰写时间插件上触发的操作。
draftAccess

enum (DraftAccess)

定义触发构建时插件时的数据访问权限级别。

DraftAccess

用于定义 Compose 触发器所需的数据访问权限级别的枚举。

枚举
UNSPECIFIED 未为 draftaccess 设置任何值时的默认值。
NONE 触发 Compose 插件时，Compose 触发器无法访问草稿的任何数据。
METADATA 向 Compose 触发器授予在触发 Compose 插件时访问草稿元数据的权限。这包括受众群体名单，例如草稿邮件的“收件人”和“抄送”列表。

DriveAddOnManifest

用于自定义云端硬盘插件的外观和执行方式的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
字段
homepageTrigger

object (HomepageExtensionPoint)

如果存在，则会覆盖 addons.common.homepageTrigger 中的配置。
onItemsSelectedTrigger

object (DriveExtensionPoint)

对应于在相关的云端硬盘视图（例如“我的云端硬盘文档列表”）中选中内容时执行的行为。

DriveExtensionPoint

声明云端硬盘插件触发器的常见格式。

JSON 表示法 
{
  "runFunction": string
}
字段
runFunction

string

必需。在扩展点激活时要执行的端点。

CalendarAddOnManifest

用于自定义日历插件外观和执行的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
字段
homepageTrigger

object (HomepageExtensionPoint)

定义在与声明的上下文触发器不匹配的上下文中执行的端点。此函数生成的任何卡片始终可供用户使用，但当此插件声明更具针对性的触发器时，这些卡片可能会被内容相关内容所掩盖。

如果存在，它会替换 addons.common.homepageTrigger 中的配置。
conferenceSolution[]

object (ConferenceSolution)

定义此插件提供的会议解决方案。第三方会议插件只能在 Apps Script 中构建。
createSettingsUrlFunction

string

要执行的端点，用于创建指向该插件设置页面的网址。
eventOpenTrigger

object (CalendarExtensionPoint)

一个端点，在事件打开以供查看或修改时触发。
eventUpdateTrigger

object (CalendarExtensionPoint)

在更新打开事件时触发的端点。
eventAttachmentTrigger

object (MenuItemExtensionPoint)

上下文触发器的配置，会在用户点击日历下拉菜单中的插件附件提供程序时触发。
currentEventAccess

enum (EventAccess)

定义触发事件插件时的数据访问权限级别。

ConferenceSolution

定义与会议相关的值。第三方会议插件只能使用 Apps 脚本构建。

JSON 表示法 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
字段
onCreateFunction

string

必需。在创建会议数据时要呼叫的端点。
id

string

必需。在一个插件内，必须为所有会议解决方案分配唯一 ID，否则当插件被触发时，可能会使用错误的会议解决方案。虽然您可以更改插件的显示名称，但不应更改 ID。
name

string

必需。会议解决方案的显示名称。
logoUrl

string

必需。会议解决方案的徽标图片的网址。

CalendarExtensionPoint

声明日历插件触发器的通用格式。

JSON 表示法 
{
  "runFunction": string
}
字段
runFunction

string

必需。启用此扩展点后要执行的端点。

EventAccess

用于定义事件触发器所需的数据访问权限级别的枚举。

枚举
UNSPECIFIED 未为 eventAccess 设置任何值时的默认值。
METADATA 向事件触发器授予访问事件元数据（例如事件 ID 和日历 ID）的权限。
READ 向活动触发器授予访问提供的所有活动字段（包括元数据、参加者和会议数据）的权限。
WRITE 向事件触发器授予对事件元数据的访问权限，并允许执行所有操作，包括添加参加者和设置会议数据。
READ_WRITE 向活动触发器授予访问提供的所有活动字段（包括元数据、参加者和会议数据）的权限，并授予执行所有操作的权限。

DocsAddOnManifest

用于自定义 Google 文档插件的外观和执行的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
字段
homepageTrigger

object (HomepageExtensionPoint)

如果存在，它会替换 addons.common.homepageTrigger 中的配置。
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

授予此文档/用户对的文件范围授权时要执行的端点。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

用于在 Google 文档中预览链接的扩展点列表。有关详情，请参阅预览包含智能条状标签的链接。
createActionTriggers[]

object (CreateActionExtensionPoint)

用于在 Google Workspace 应用中创建第三方资源的扩展点列表。如需了解详情，请参阅通过“@”菜单创建第三方资源。

DocsExtensionPoint

声明 Google 文档插件触发器的通用格式。

JSON 表示法 
{
  "runFunction": string
}
字段
runFunction

string

必需。启用此扩展点后要执行的端点。

LinkPreviewExtensionPoint

触发器的配置，当用户将第三方或非 Google 服务中的链接或将链接粘贴到 Google 文档、表格或幻灯片文件中时，会触发该触发器。

JSON 表示法 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
字段
labelText

string

必需。提示用户预览链接的示例智能条状标签的文本，例如 Example: Support case。此文本是静态文本，会在用户执行插件之前显示。
localizedLabelText

map (key: string, value: string)

可选。要本地化为其他语言的 labeltext 的映射。请以 ISO 639 格式设置语言，并以 ISO 3166 格式指定国家/地区，并以连字符 - 分隔。例如 en-US。

如果地图的键中包含用户的语言区域，则用户会看到 labeltext 的本地化版本。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
patterns[]

object (UriPattern)

必需。一组网址格式，可触发插件预览链接。
runFunction

string

必需。要在触发链接预览时执行的端点。
logoUrl

string

可选。智能条状标签和预览卡片中显示的图标。如果省略，该插件会使用其工具栏图标 logourl。

UriPattern

触发链接预览的每个网址格式的配置。

JSON 表示法 
{
  "hostPattern": string,
  "pathPrefix": string
}
字段
hostPattern

string

每个网址格式都必须提供此属性，才能进行预览。网址格式的域名。该插件会预览网址中包含此网域的链接。如需预览特定子网域（如 subdomain.example.com）的链接，请添加该子网域。要预览整个网域的链接，请指定以星号 (*) 作为子网域的通配符。

例如，*.example.com 与 subdomain.example.com 和 another.subdomain.example.com 匹配。
pathPrefix

string

可选。用于附加 hostpattern 网域的路径。

例如，如果网址主机格式为 support.example.com，如需匹配托管在 support.example.com/cases/ 的支持请求的网址，请输入 cases。

如需匹配主机模式网域中的所有网址，请将 pathprefix 留空。

CreateActionExtensionPoint

在用户调用 Google Workspace 应用中的资源创建工作流时触发的触发器的配置。如需了解详情，请参阅通过“@”菜单创建第三方资源。

JSON 表示法 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
字段
id

string

必需。用于区分此扩展点的唯一 ID。此 ID 最多可包含 64 个字符，且应采用 [a-zA-Z0-9-]+ 格式。
labelText

string

必需。与资源创建入口点的图标一起显示的文本，例如 Create support case。此文本是静态的，会在用户执行该插件之前显示。
localizedLabelText

map (key: string, value: string)

可选。要本地化为其他语言的 labeltext 的映射。语言采用 ISO 639 格式，国家/地区采用 ISO 3166 格式，以连字符 - 分隔。例如 en-US。

如果地图的键中包含用户的语言区域，则用户会看到 labeltext 的本地化版本。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
runFunction

string

必需。在触发资源创建工作流以创建关联时要执行的端点。
logoUrl

string

可选。显示资源创建入口点的图标。如果省略此元素，菜单将使用您的插件工具栏图标 logourl。

SheetsAddOnManifest

用于自定义 Google 表格插件外观和执行方式的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
字段
homepageTrigger

object (HomepageExtensionPoint)

如果存在，它会替换 addons.common.homepageTrigger 中的配置。
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

为此文档/用户对授予文件级范围授权时要执行的端点。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

用于预览 Google 表格文档中的链接的扩展点列表。如需了解详情，请参阅包含智能条状标签的预览链接。

SheetsExtensionPoint

声明 Google 表格插件触发器的通用格式。

JSON 表示法 
{
  "runFunction": string
}
字段
runFunction

string

必需。启用此扩展点后要执行的端点。

SlidesAddOnManifest

用于自定义 Google 幻灯片插件外观和执行方式的属性。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
字段
homepageTrigger

object (HomepageExtensionPoint)

如果存在，它会替换 addons.common.homepageTrigger 中的配置。
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

为此文档/用户对授予文件级范围授权时要执行的端点。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

用于预览 Google 幻灯片文档中的链接的扩展点列表。如需了解详情，请参阅包含智能条状标签的预览链接。

SlidesExtensionPoint

声明 Google 幻灯片插件触发器的常用格式。

JSON 表示法 
{
  "runFunction": string
}
字段
runFunction

string

必需。激活此扩展点时要执行的端点。

HttpOptions

用于向插件 HTTP 端点发送请求的选项。

JSON 表示法 
{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}
字段
authorizationHeader

enum (HttpAuthorizationHeader)

在 HTTP Authorization 标头中发送的令牌的配置。

HttpAuthorizationHeader

在插件 HTTP 请求中发送的授权标头。

枚举
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED 默认值，等同于 SYSTEM_ID_TOKEN。
SYSTEM_ID_TOKEN 发送项目专用 Google Workspace 插件系统服务账号的 ID 令牌（默认）。
USER_ID_TOKEN 发送最终用户的 ID 令牌。
NONE 请勿发送 Authentication 标头。

方法

create

 创建具有指定名称和配置的部署。

delete

 删除具有给定名称的部署。

get

 获取具有指定名称的部署。

getInstallStatus

 获取测试部署的安装状态。

install

 将部署安装到您的账号中以进行测试。

list

 列出特定项目中的所有部署。

replaceDeployment

 创建或替换具有指定名称的部署。

uninstall

 从用户的账号中卸载测试部署。