用于定义编辑器中的 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 文档、表格或幻灯片文件中时触发。
如需为 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 。
|