编辑器清单资源

资源配置,用于在编辑器中定义 Google Workspace 插件内容和行为。如果 Google Workspace 加购项清单扩展了编辑器,则必须将所有组件都标记为必需

编辑

适用于编辑器扩展程序的 Google Workspace 插件清单配置。如需了解详情,请参阅使用 Google Workspace 插件扩展编辑器

JSON 表示法
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
字段
homepageTrigger

object (HomepageTrigger)

此触发器函数会在托管应用中创建插件首页。这会替换 addOns.common.homepageTrigger

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

如果您的插件包含在用户授权 drive.file 范围时触发的特定于当前编辑器文档的行为,则必须提供此属性。

linkPreviewTriggers[]

object (LinkPreviewTriggers)

对于链接预览来说是必填项。用于在 Google 文档、表格或幻灯片文件中预览链接的触发器列表。如需了解详情,请参阅包含智能条状标签的预览链接

createActionTriggers[]

object (createActionTriggers)

创建第三方资源时必须提供。用于通过“@”菜单在第三方服务中创建资源的触发器列表。 如需了解详情,请参阅使用智能条状标签创建第三方资源

OnFileScopeGrantedTrigger

上下文触发器的配置,当使用 CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); 请求文件范围对话框且用户授予 drive.file 范围授权时触发。

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

string

如果授予 drive.file 范围,则要运行的函数的名称。如果指定了此参数,您必须实现此函数,以构建并返回 Card 对象的数组,以便在插件界面中显示。

LinkPreviewTriggers

当用户在文档、表格或幻灯片文件中输入或粘贴第三方或非 Google 服务中的链接时触发的触发器的配置。

如需为 Google Workspace 插件设置此触发器,请参阅包含智能条状标签的预览链接

JSON 表示法
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
字段
labelText

string

必需。提示用户预览链接的示例智能条状标签的文本,例如 Example: Support case。此文本是静态文本,会在用户执行插件之前显示。
localizedLabelText

map (key: string, value: string)

可选。要本地化为其他语言的 labelText 的映射。以 ISO 639 格式设置语言,以 ISO 3166 格式设置国家/地区,并以连字符 - 分隔。例如 en-US

如果映射的键中包含用户的语言区域,用户会看到本地化的 labelText 版本。

patterns[]

object (UriPattern)

必需。用于触发该插件预览链接的一组网址模式。
runFunction

string

必需。当用户授权 https://www.googleapis.com/auth/workspace.linkpreview 范围时要运行的函数的名称。 如果指定了此参数,您必须实现此函数,以接受包含 EDITOR_NAME.matchedUrl.url 的事件对象作为参数,并返回一个 Card 对象,用于在插件界面中显示链接预览。
logoUrl

string

可选。在智能条状标签和预览卡片中显示的图标。如果省略,该插件将使用其工具栏图标 logoUrl

UriPattern

触发链接预览的每个网址格式的配置。

JSON 表示法
{
  "hostPattern": string,
  "pathPrefix" : string
}
字段
hostPattern

string

每个网址格式都必须提供此属性,才能进行预览。网址格式的域名。该插件会预览网址中包含此网域的链接。如需预览特定子网域(例如 subdomain.example.com)的链接,请添加该子网域。 如需预览整个网域的链接,请将星号 (*) 作为子网域指定为通配符。

例如,*.example.comsubdomain.example.comanother.subdomain.example.com 匹配。

pathPrefix

string

可选。用于附加 hostPattern 网域的路径。

例如,如果网址主机模式为 support.example.com,如需匹配在 support.example.com/cases/ 上托管的支持请求的网址,请使用 cases

如需匹配主机模式网域中的所有网址,请将 pathPrefix 留空。

CreateActionTriggers

当用户从 Google 文档“@”菜单中选择第三方集成菜单项时触发的触发器的配置。

如需为 Google Workspace 插件设置此触发器,请参阅使用智能条状标签创建第三方资源

JSON 表示法
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
字段
id

string

必需。用于区分此扩展点的唯一 ID。ID 不得超过 64 个字符,并且应采用 [a-zA-Z0-9-]+. 格式。
labelText

string

必需。@ 菜单中显示的文本,例如 Create support case
localizedLabelText

map (key: string, value: string)

可选。要本地化为其他语言的 labelText 的映射。以 ISO 639 格式设置语言,以 ISO 3166 格式设置国家/地区,并以连字符 - 分隔。例如 en-US

如果映射的键中包含用户的语言区域,用户会看到本地化的 labelText 版本。

runFunction

string

必需。当用户从 @ 菜单中选择扩展点时要运行的函数的名称。 该函数应返回包含用于创建第三方资源的输入的表单卡片。
logoUrl

string

可选。显示在“@”菜单中的图标。如果省略,该插件将使用其工具栏图标 logoUrl