插件清单资源

用于定义 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 加购服务扩展了 Google 文档，则为必需属性。Google 文档宿主应用中的外观和行为配置。如果省略，则在 Google 文档中停用该插件。

sheets

object (Sheets)

如果 Google Workspace 加购服务扩展了 Google 表格，则为必需属性。Google 表格宿主应用中的外观和行为配置。如果省略，则在 Google 表格中停用该插件。

slides

object (Slides)

如果 Google Workspace 加购项扩展了 Google 幻灯片，则为必需项。幻灯片宿主应用中的外观和行为配置。如果省略，则在 Google 幻灯片中停用该插件。

meet

object (Meet)

如果 Google Workspace 加购项扩展了 Meet，则为必需项。Meet 主持人应用中的外观和行为配置。如果省略，则在 Meet 中停用该插件。

常见

适用于每个宿主应用的通用参数的清单配置。 如果省略了主机的特定值，此处定义的值将用作默认值。

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 锚标记的文本 widget 在 widget 内显示出站链接，则为必需属性。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 脚本函数的名称。

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