Gmail 清单资源

用于定义 Gmail 中的 Google Workspace 插件内容和行为的资源配置。如果 Google Workspace 插件扩展了 Gmail，则必须将所有组件标记为必需。

Gmail

Gmail 扩展程序的 Google Workspace 插件清单配置。如需了解详情，请参阅使用 Google Workspace 插件扩展 Gmail。

JSON 表示法 
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
字段
authorizationCheckFunction

string

已弃用。执行第三方授权要求检查的 Apps 脚本函数的名称。此函数在每次调用 Google Workspace 插件之前调用。

为避免不必要的执行延迟，此函数已废弃。相反，该插件应在主调用中抛出异常，如此示例所示。

composeTrigger

object (ComposeTrigger)

撰写操作必需。定义用户在撰写电子邮件时可用的一组界面。

如需了解详情，请参阅 使用撰写操作扩展 Compose 界面。

contextualTriggers[]

object (ContextualTrigger)

必需。在 Gmail 中打开邮件时触发的触发器列表。当触发器触发时，它会执行特定的 Apps 脚本函数，通常用于创建新卡片和更新界面。
homepageTrigger

object (HomepageTrigger)

用于在 Gmail 主机中创建插件首页的触发器函数规范。它会替换 addOns.common.homepageTrigger。

ComposeTrigger

撰写操作的配置。如需了解详情，请参阅扩展 Compose 界面。

JSON 表示法 
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
字段
draftAccess

string

定义 Compose 触发器函数可用的数据访问权限级别。有效选项包括：

  • NONE，默认设置。这会导致传递给 Compose 触发器函数的事件对象大部分为空。
  • METADATA：使用消息的接收者列表填充传递给 Compose 触发器函数的事件对象。此设置要求该插件包含 gmail.addons.current.message.metadata 范围。
selectActions[]

object (SelectAction)

用于创建 Compose 界面的 Compose 操作列表；但是，此列表仅限于每个插件一项操作。写邮件操作在 Gmail 写邮件窗口中显示相应的图标。 该图标由 gmail.logoUrl 指定。

ContextualTrigger

用户打开 Gmail 邮件且该邮件满足特定条件时触发的触发器的配置。如需了解详情，请参阅扩展消息界面。

JSON 表示法 
{
  "onTriggerFunction": string,
  "unconditional": {},
}
字段
onTriggerFunction

string

对于每个上下文触发器而言都是必需的。触发器触发时执行的 Apps 脚本函数的名称。

如需详细了解如何定义此函数，请参阅 上下文触发器函数。

unconditional

object

对于每个上下文触发器而言都是必需的。用于指定当 Gmail 邮件被打开时，为其激活上下文触发器。这是目前唯一的选项，因此应始终为空对象。

SelectAction

Compose 操作配置，用于定义在用户选择 Compose 操作时要运行哪个函数。

JSON 表示法 
{
  "runFunction": string,
  "text": string
}
字段
runFunction

string

撰写操作必需。选择此撰写操作时执行的 Apps 脚本函数的名称。此 Compose 触发器函数用于构建插件 Compose 界面。

如需了解详情，请参阅 Compose 触发器函数。

text

string

撰写操作必需。此撰写操作的简短文本说明。