Gmail 清单资源

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

Gmail

Google Workspace Gmail 扩展程序的插件清单配置。如需了解详情,请参阅使用 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

Compose 触发器

撰写操作的配置。如需了解详情,请参阅扩展 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 指定。

内容相关触发器

在用户打开 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

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