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)

Google 文档插件配置。

object (SheetsAddOnManifest)

表格插件配置。

object (SlidesAddOnManifest)

Google 幻灯片插件配置。

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)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

定义在与声明的上下文触发器不匹配的上下文中执行的端点。该功能生成的所有卡片都始终可供用户使用，但当该插件声明更具针对性的触发器时，上下文内容可能会无法看到。

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

object (ConferenceSolution)

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

string

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

object (CalendarExtensionPoint)

一个端点，在有活动打开以供查看或修改时触发。

object (CalendarExtensionPoint)

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

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 标头中发送的令牌的配置。