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 操作扩展 Compose 界面。

contextualTriggers[]

object (ContextualTrigger)

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

object (HomepageTrigger)

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

ComposeTrigger

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

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

string

定义了可供撰写触发器函数使用的数据访问权限级别。有效选项如下：

  • NONE，默认设置。这会导致传递给 Compose 触发器函数的事件对象几乎为空。
  • METADATA，用于填充传递给撰写触发器函数的事件对象，其中包含消息收件人列表。此设置要求插件包含 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

撰写操作配置，用于定义当用户选择撰写操作时要运行的函数。

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

string

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

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

text

string

对于撰写操作是必需的。相应撰写操作的简短文字说明。