编辑器清单资源

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

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

Editor

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

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 对象数组,以便在插件界面中显示。

LinkPreviewTriggers

一种配置,用于在用户输入第三方或非 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/documents.readonly 范围时运行的函数名称。 如果已指定,则必须实现此函数来接受包含 docs.matchedUrl.url 作为参数的事件对象,并返回单个 Card 对象,该对象会在插件界面中显示链接预览。
logoUrl

string

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

URI 格式

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

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 留空。