插件清单资源

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

AddOns

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

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

object (Common)

必需。为 Google Workspace 插件定义对每个主机应用通用的值。 当省略特定主机的特定值时，此处定义的某些值将用作默认值。
calendar

object (Calendar)

如果 Google Workspace 插件扩展日历功能，则此为必填。 Google Workspace 插件在 Google 日历托管应用中的外观和行为的配置。如果省略此字段，则 Google 日历中的插件会停用。

drive

object (Drive)

如果 Google Workspace 插件扩展 Google 云端硬盘，则必须使用此插件。 Google Workspace 插件在 Google 云端硬盘主机应用中的外观和行为的配置。如果省略此字段，则会在 Google 云端硬盘中停用该插件。
gmail

object (Gmail)

如果 Google Workspace 插件扩展 Gmail 的功能，则为必需项。 Google Workspace 插件在 Gmail 托管应用中的外观和行为的配置。如果省略此字段，则会在 Gmail 中停用该插件。

docs

object (Docs)

如果 Google Workspace 插件扩展 Google 文档功能，则必须提供此插件。 Google Workspace 插件在文档托管应用中的外观和行为的配置。如果省略此字段，则会在 Google 文档中停用该插件。

sheets

object (Sheets)

如果 Google Workspace 插件扩展 Google 表格，则必须提供此值。 Google Workspace 插件在 Google 表格托管应用中的外观和行为的配置。如果省略此字段，则会在 Google 表格中停用该插件。
slides

object (Slides)

如果 Google Workspace 插件扩展 Google 幻灯片，则必须使用此插件。 Google Workspace 插件在幻灯片托管应用中的外观和行为的配置。如果省略此字段，则会在 Google 幻灯片中停用该插件。

常见

每个主机应用通用参数的清单配置。当省略特定主机的特定值时，此处定义的某些值将用作默认值。

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 的 widget 还是使用 HTML 锚标记的文本 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 脚本函数的名称（如果提供）。

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