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 OAuth 配置示例所示。

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

定义了用于撰写触发器功能的数据访问权限级别。 有效选项包括:

  • NONE(默认):事件对象大部分为空。
  • METADATA:事件对象包含收件人列表。 这需要 gmail.addons.current.message.metadata scope
selectActions[]

object (SelectAction)

撰写操作的列表。该列表仅限每个插件执行一项操作。撰写操作在 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 界面。
text

string

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