AddOns 清单资源

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

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

插件

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 日历,则是必需的。 针对 Google 日历宿主应用中的插件外观和行为的配置。 Google Workspace 如果省略此字段,则 Google 日历中会停用该插件。

drive

object (Drive)

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

gmail

object (Gmail)

如果 Google Workspace 插件扩展了 Gmail,则必须提供。 针对 Gmail 宿主应用中的 Google Workspace 插件外观和行为的配置。如果省略此字段,则插件会在 Gmail 中停用。

docs

object (Docs)

如果 Google Workspace 插件扩展了 Google 文档,则是必需的。 在 Google 文档托管应用中配置插件 Google Workspace 的外观和行为。如果省略此字段,则插件会在 Google 文档中停用。

sheets

object (Sheets)

如果 Google Workspace 插件扩展了 Google 表格,则为必需。 插件在 Google 表格托管应用中的呈现效果和行为。 Google Workspace 如果省略此字段,则插件会在 Google 表格中停用。

slides

object (Slides)

如果 Google Workspace 插件扩展了 Google 幻灯片,则是必需的。 插件在 Google 幻灯片托管应用的外观和行为方面的配置。 Google Workspace 如果省略此字段,则幻灯片中的插件会被停用。

常见

所有主机应用通用的参数清单配置。当省略了特定主机的特定值时,此处定义的一些值将用作默认值。

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

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

布局属性

用于控制 Google Workspace插件工具栏和按钮颜色及外观的配置。

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

string

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

string

按钮的默认颜色。默认为主要颜色(如果已设置);否则默认为蓝色 (#2196F3)。

通用操作

通用操作的配置。 选择此选项后,通用操作要么打开指定的网址链接,要么运行指定的 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 脚本函数的名称,系统会在用户选择此操作时执行。

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