REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

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

string

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

object (AddOns)

Google Workspace 插件配置。

string

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

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

object (CommonAddOnManifest)

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

object (GmailAddOnManifest)

Gmail 插件配置。

object (DriveAddOnManifest)

云端硬盘插件配置。

object (CalendarAddOnManifest)

日历插件配置。

object (DocsAddOnManifest)

文档插件配置。

object (SheetsAddOnManifest)

表格插件配置。

object (SlidesAddOnManifest)

幻灯片插件配置。

object (HttpOptions)

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

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

string

必需。插件的显示名称。

string

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

object (LayoutProperties)

插件卡片的常见布局属性。

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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

string

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

boolean

为卡片启用 Material Design。

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

插件中使用的微件列表。

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

可选。如果设置为 false，则在这种情况下会停用首页视图。

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

如果插件的自定义首页视图被停用，系统会改为向用户显示通用的“概览”卡片。

{
  "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.
}

string

必需。用户可见文本，用于描述通过激活此扩展点执行的操作，例如“添加新联系人”。

string

要由 UniversalAction 打开的网址。

string

将由 UniversalAction 运行的端点。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object (HomepageExtensionPoint)

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

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

object (ContextualTrigger)

定义触发插件的一组条件。

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

{
  "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.
}

string

必需。当消息与触发器匹配时要调用的端点的名称。

object (UnconditionalTrigger)

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

{
  "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.
}

string

必需。描述操作的用户可见文本，例如“添加新联系人”。

string

用户触发操作时 Gmail 打开的链接。

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object (MenuItemExtensionPoint)

定义撰写时间插件的操作集。这些是用户可以在撰写时间插件上触发的操作。

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

必需。用户可见的文字，用于描述通过激活此扩展点执行的操作。例如，“插入账单”。

string

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

如果未设置，则默认为插件的主徽标网址。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

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

{
  "runFunction": string
}

string

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

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

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

定义此插件提供的会议解决方案。

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

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

string

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

string

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

string

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

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

object (UriPattern)

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

string

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

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

对于要预览的每种网址格式而言都是必填项。网址格式的域名。该插件会预览网址中包含此网域的链接。如需预览特定子网域（如 subdomain.example.com）的链接，请添加该子网域。要预览整个网域的链接，请指定以星号 (*) 作为子网域的通配符。

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

string

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

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

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

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

string

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

map (key: string, value: string)

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

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

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

string

必需。在触发资源创建工作流创建链接时要执行的端点。

string

可选。为资源创建入口点显示的图标。如果省略此设置，菜单会使用插件的工具栏图标 logourl。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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