用于在编辑器中定义 Google Workspace 插件内容和行为的资源配置。如果要扩展编辑器,Google Workspace 插件清单必须将所有组件标记为必需。
编辑
编辑器扩展程序的 Google Workspace 插件清单配置。如需了解详情,请参阅使用 Google Workspace 插件扩展编辑器。
JSON 表示法 |
---|
{ "homepageTrigger": { object (HomepageTrigger) }, "onFileScopeGrantedTrigger": { object (OnFileScopeGrantedTrigger) }, "linkPreviewTriggers": [ { object (LinkPreviewTriggers) } ], "createActionTriggers": [ { object (CreateActionTriggers) } } |
字段 | |
---|---|
homepageTrigger |
此触发器函数会在托管应用中创建插件首页。它会替换
|
onFileScopeGrantedTrigger |
如果您的插件包含当前编辑器文档特有的行为(在用户向 |
linkPreviewTriggers[] |
若要使用链接预览,则必须提供此属性。用于预览 Google 文档、表格或幻灯片文件中链接的触发器列表。有关详情,请参阅预览包含智能条状标签的链接。 |
createActionTriggers[] |
创建第三方资源时必填。用于通过“@”菜单在第三方服务中创建资源的触发器列表。有关详情,请参阅使用智能条状标签创建第三方资源。 |
OnFileScopeGrantedTrigger
上下文触发器的配置,在请求文件范围对话框使用 CardService.newEditorFileScopeActionResponseBuilder()
.requestFileScopeForActiveDocument().build();
且用户授予 drive.file
范围授权时触发。
JSON 表示法 |
---|
{ "runFunction": string } |
字段 | |
---|---|
runFunction |
drive.file 范围时要运行的函数的名称。如果指定,您必须实现此函数,以构建并返回由
Card 对象组成的数组,以便在插件界面上显示。 |
LinkPreviewTriggers
当用户将第三方或非 Google 服务中的链接输入或粘贴到文档、表格或幻灯片文件中时触发的触发器的配置。
如需为 Google Workspace 插件设置此触发器,请参阅预览包含智能条状标签的链接。
JSON 表示法 |
---|
{ "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string, "patterns": [ { object(patterns) } ] } |
字段 | |
---|---|
labelText |
Example: Support case 。此文本是静态文本,会在用户执行插件之前显示。
|
localizedLabelText |
labelText 映射。语言采用 ISO 639 格式,国家/地区采用 ISO 3166 格式,以连字符 - 分隔。例如 en-US 。
如果地图的键中存在用户的语言区域,用户会看到 |
patterns[] |
|
runFunction |
https://www.googleapis.com/auth/workspace.linkpreview 范围授权时要运行的函数的名称。如果已指定,则必须实现此函数,以接受包含 EDITOR_NAME.matchedUrl.url 作为参数的事件对象,并返回单个
Card 对象(该对象会在插件界面中显示链接预览)。
|
logoUrl |
logoUrl 。 |
UriPattern
触发链接预览的每种网址格式的配置。
JSON 表示法 |
---|
{ "hostPattern": string, "pathPrefix" : string } |
字段 | |
---|---|
hostPattern |
subdomain.example.com )的链接,请添加该子网域。如需预览整个网域的链接,请指定带有星号 (* ) 的通配符作为子网域。
例如, |
pathPrefix |
hostPattern 域名的路径。
例如,如果网址的主机格式为 如要匹配主机格式网域中的所有网址,请将 |
CreateActionTriggers
在用户从 Google 文档 @ 菜单中选择第三方集成菜单项时触发的触发器的配置。
如需为 Google Workspace 插件设置此触发器,请参阅使用智能条状标签创建第三方资源。
JSON 表示法 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string, } |
字段 | |
---|---|
id |
[a-zA-Z0-9-]+. 格式。 |
labelText |
Create support case 。
|
localizedLabelText |
labelText 映射。语言采用 ISO 639 格式,国家/地区采用 ISO 3166 格式,以连字符 - 分隔。例如 en-US 。
如果地图的键中存在用户的语言区域,用户会看到 |
runFunction |
|
logoUrl |
logoUrl 。 |