编辑器清单资源

用于定义编辑器中的 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 幻灯片文件中输入或粘贴第三方服务中的链接时触发的触发器的配置。

如需为 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 格式设置国家/地区,两者之间用连字符 - 分隔。
patterns[]

object (UriPattern)

必需。触发插件预览链接的网址格式数组。
runFunction

string

必需。当用户授权 https://www.googleapis.com/auth/workspace.linkpreview 范围时要运行的函数名称。该函数必须接受一个事件对象,该对象包含一个 matchedUrl.url 属性(其中包含要预览的网址),并返回一个 Card 对象。
logoUrl

string

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

UriPattern

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

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

string

每种网址格式都必须提供。网址格式网域。该插件会预览包含相应网域的链接。 如需匹配所有子网域,请使用星号通配符 (*)。
pathPrefix

string

可选。附加网域的路径。如需匹配网域中的所有网址,请将 pathPrefix 留空。

CreateActionTriggers

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

如需为 Google Workspace 加载项设置此触发器,请参阅使用智能芯片创建第三方资源

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

string

必需。相应扩展点的唯一 ID。使用最多 64 个字符,格式为 [a-zA-Z0-9-]+.
labelText

string

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

map (key: string, value: string)

可选。要本地化的 labelText 的地图。以 ISO 639 格式表示语言,以 ISO 3166 格式表示国家/地区,两者之间用连字符 - 分隔。
runFunction

string

必需。当用户选择扩展点时要运行的函数的名称。该函数必须返回表单卡片。
logoUrl

string

可选。@ 菜单中显示的图标。如果省略,则插件会使用其工具栏图标 logoUrl