编辑器清单资源

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

Editor

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

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

object (HomepageTrigger)

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

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

如果您的插件包含特定于当前编辑器文档的行为，系统会在用户授权 drive.file 范围时触发。

linkPreviewTriggers[]

object (LinkPreviewTriggers)

对于链接预览是必需的。用于在 Google 文档文档中预览链接的触发器列表。 有关详情，请参阅 Google 文档中的预览链接（开发者预览版）。

OnFileScopeGrantedTrigger

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

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

string

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

链接预览触发器

触发器会在用户输入第三方或非 Google 服务的链接，或者将链接粘贴到 Google 文档时触发。

如需为 Google Workspace 插件设置此触发器，请参阅 Google 文档（开发者预览版）中的预览链接。

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

string

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

map

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

如果用户的语言区域包含在地图的键中，用户将看到本地化版本的 labelText。
patterns[]

object (UriPattern)

必需。一个网址格式数组，会触发插件预览链接。
runFunction

string

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

string

可选。智能条状标签中显示的图标。如果省略，条状标签将使用插件的工具栏图标 logoUrl。

UriPattern

用于触发链接预览的每种网址格式的配置。

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

string

对于每个网址格式都需要进行预览。网址格式的网域。插件预览链接，在网址中包含此域名。如需预览特定子网域（如 subdomain.example.com）的链接，请添加该子网域。要预览整个网域的链接，请将星号 * 指定为通配符作为子网域。

例如，*.example.com 与 subdomain.example.com 和 another.subdomain.example.com 匹配。
pathPrefix

string

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

例如，如果网址格式为 support.example.com 作为网址格式，那么如需匹配 support.example.com/cases/ 上托管的支持请求的网址，请使用 cases。

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