编辑器清单资源

用于定义编辑器中的 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.com 和 another.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。