插件清单资源

用于定义 Google Workspace 插件 内容和行为的资源配置。插件清单必须包含所有 标记为 必需 的组件。

AddOns

Google Workspace 插件清单配置的顶级。

JSON 表示法 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  },
  "meet": {
    object (Meet)
  }
}
字段
common

object (Common)

必需。为每个宿主应用通用的 Google Workspace 插件定义值。如果省略特定宿主的特定 值，系统会使用此处定义的值作为默认值。

calendar

object (Calendar)

如果 Google Workspace 插件扩展了 日历，则为必需字段。Google 日历宿主应用中的外观和行为配置 。如果省略，则 插件在 Google 日历中处于停用状态。

chat

object ()

如果 Google Workspace 插件扩展了 Chat，则为必需字段。Google Chat 应用的配置。如果省略，则插件在 Google Chat 中处于停用状态。

addOns.chat 对象必须为空。如需在 Chat 中配置插件行为和外观，请参阅配置 Google Chat 应用。
drive

object (Drive)

如果 Google Workspace 插件扩展了 云端硬盘，则为必需字段。云端硬盘宿主应用中的外观和行为配置 在云端硬盘宿主应用中。如果省略，则 插件在云端硬盘中处于停用状态。

gmail

object (Gmail)

如果 Google Workspace 插件扩展了 Gmail，则为必需字段。Gmail 宿主应用中的外观和行为配置。 如果省略，则 插件在 Gmail 中处于停用状态。

docs

object (Docs)

如果 Google Workspace 插件扩展了 文档，则为必需字段。文档宿主应用中的外观和行为配置 如果省略，则 插件在文档中处于停用状态。

sheets

object (Sheets)

如果 Google Workspace 插件扩展了 表格，则为必需字段。表格宿主应用中的外观和行为配置 。如果省略，则 插件在表格中处于停用状态。

slides

object (Slides)

如果 Google Workspace 插件扩展了 幻灯片，则为必需字段。幻灯片宿主应用中的外观和行为配置 。如果省略，则 插件在幻灯片中处于停用状态。

meet

object (Meet)

如果 Google Workspace 插件扩展了 Meet，则为必需字段。Meet 宿主应用中的外观和行为配置 。如果省略，则 插件在 Meet 中处于停用状态。

Common

针对每个 宿主应用通用的参数的清单配置。 如果省略宿主的特定值，系统会使用此处定义的值作为默认值。

JSON 表示法 
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
字段
homepageTrigger

object (HomepageTrigger)

插件首页的默认触发器函数。如果未定义特定于宿主的首页触发器，则使用此 规范。如果省略，则使用通用首页卡片。
layoutProperties

object (LayoutProperties)

插件工具栏和按钮中使用的颜色的配置。
logoUrl

string

必需。工具栏图片的公开网址。
name

string

必需。工具栏中显示的插件名称 。
openLinkUrlPrefixes[]

string

如果插件使用 OpenLink 在小部件内显示出站链接，或者使用 HTML 锚标记在文本小部件内显示出站链接，则为必需字段。HTTPS 网址前缀列表。为了保护用户数据，插件呈现的链接必须与此列表中的前缀匹配。

如需了解详情，请参阅 将网址列入许可名单。

universalActions[]

object (UniversalAction)

插件界面中始终可用的通用 操作列表。
useLocaleFromApp

boolean

如果为 true，则传递给插件事件对象操作回调函数或触发器函数的插件事件对象会包含用户语言区域和时区。默认为 false。

如需了解详情，请参阅 访问用户语言区域和时区。

LayoutProperties

Google Workspace 插件工具栏和按钮外观的配置。

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

string

工具栏颜色。默认为灰色 (#424242)。
secondaryColor

string

默认按钮颜色。如果设置了主颜色，则默认为主颜色； 否则默认为蓝色 (#2196F3)。

UniversalAction

通用操作的配置。 选择通用操作后，系统会打开网址或运行 Apps 脚本函数。

JSON 表示法 
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
字段
label

string

每个通用操作都必须提供此字段。此操作的界面菜单文本。
runFunction

string

如果缺少 openLink，则每个通用操作都必须提供此字段。选择后执行的 Apps 脚本函数的名称。

如需了解详情，请参阅 通用操作指南。