编辑器清单资源

用于定义编辑器中的 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 服务的链接时触发的触发器的配置。

如需为 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.com 会匹配 subdomain.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