插件清单资源

用于定义 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 日历的功能,则必须提供。 配置 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 Workspace 插件在 Google 表格托管应用中的外观和行为。如果省略此字段,则 Google 表格将停用该插件。

slides

object (Slides)

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

常见

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

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

object (HomepageTrigger)

用于创建插件 homepage 的默认触发器函数规范。如果未定义主机专属首页触发器,则可以使用此规范。如果也省略,则系统会根据需要构建和使用通用首页卡片。
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 脚本函数的名称(如果提供)。

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