此页面由 Cloud Translation API 翻译。

插件清单资源

用于定义 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) } }

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)
  }
}

字段
`common`	`object (Common)` 必需。为每个托管应用通用的 Google Workspace 插件定义值。如果省略了特定主机的具体值，系统会使用此处定义的某些值作为默认值。
`calendar`	`object (Calendar)` 如果 Google Workspace 插件扩展了 Google 日历，则必填。针对 Google 日历托管应用中的 Google Workspace 插件外观和行为的配置。如果省略此字段，Google 日历中会停用该插件。
`chat`	`object ()` 开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。如果 Google Workspace 插件扩展了 Chat，则必须提供。 Google Chat 应用的配置。如果省略此字段，Google Chat 中会停用该插件。 `addOns.chat` 对象必须为空。如需在 Chat 中配置该插件行为和外观，请参阅配置 Chat 应用。
`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 Workspace 插件在 Google 文档托管应用中的外观和行为的配置。如果省略此字段，则 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 }

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`。如需了解详情，请参阅访问用户语言区域和时区。

LayoutProperties

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

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

字段
`primaryColor`	`string` 工具栏的颜色。默认为灰色 (#424242)。
`secondaryColor`	`string` 按钮的默认颜色。默认为主色（如果已设置）；否则默认为蓝色 (#2196F3)。

UniversalAction

通用操作的配置。选择通用操作后，系统会打开指定的网址链接或运行指定的 Apps Script 函数。

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` 每个通用 Action 都必须提供此属性。界面菜单中显示的此操作的文本。
`openLink`	`string` 如果 `runFunction` 不存在，则每个通用操作都需要此属性。用户选择此操作时，在标签页中打开的网址（如果提供）。
`runFunction`	`string` 如果 `openLink` 不存在，则每个通用操作都需要此属性。在用户选择此操作时执行的 Apps 脚本函数的名称（如果提供）。如需了解详情，请参阅通用操作指南。

label

string

每个通用 Action 都必须提供此属性。界面菜单中显示的此操作的文本。

openLink

string

如果 runFunction 不存在，则每个通用操作都需要此属性。用户选择此操作时，在标签页中打开的网址（如果提供）。

runFunction

string

如果 openLink 不存在，则每个通用操作都需要此属性。在用户选择此操作时执行的 Apps 脚本函数的名称（如果提供）。

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