插件清单资源

用于定义 Google Workspace 插件内容和行为的资源配置。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 Workspace 插件的外观和行为的配置。如果省略此字段，则该插件在 Google 日历中处于停用状态。

chat

object ()

如果 Google Workspace 加载项扩展了 Chat，则为必需属性。 Google Chat 应用的配置。如果省略此字段，则在 Google Chat 中停用相应插件。

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

object (Drive)

如果 Google Workspace 加购服务扩展了云端硬盘，则为必需项。 Google Workspace 插件在云端硬盘宿主应用中的外观和行为配置。如果省略此字段，则在云端硬盘中停用该插件。

gmail

object (Gmail)

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

docs

object (Docs)

如果 Google Workspace 加购服务扩展了 Google 文档，则为必需属性。 Google Workspace 加载项在 Google 文档宿主应用中的外观和行为的配置。如果省略此字段，则在 Google 文档中停用相应插件。

sheets

object (Sheets)

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

slides

object (Slides)

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

meet

object object (Meet)

如果 Google Workspace 加购项扩展了 Meet，则为必需项。 Google Workspace 插件在 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 的 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 脚本函数的名称。

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