您可以使用许可名单指定您的脚本或插件可以访问的预先批准的特定网址。许可名单有助于保护用户数据;定义许可名单后,脚本项目将无法访问未添加到许可名单中的网址。
在安装测试部署时,此字段为可选字段,但在创建版本化部署时,此字段为必填字段。
当您的脚本或插件执行以下操作时,您可以使用许可名单:
- 使用 Apps Script
UrlFetch
服务从外部位置(例如 HTTPS 端点)检索或提取信息。如需将网址列入许可名单以供提取,请在清单文件中添加urlFetchWhitelist
字段。 - 响应用户操作打开或显示网址(对于打开或显示 Google 外部网址的 Google Workspace 插件,此方法是必需的)。如需将网址列入许可名单以供打开,请在清单文件中添加
addOns.common.openLinkUrlPrefixes
字段。
向许可名单添加前缀
在清单文件中指定许可名单(通过添加 addOns.common.openLinkUrlPrefixes
或 urlFetchWhitelist
字段)时,您必须添加网址前缀列表。您添加到清单中的前缀必须满足以下要求:
- 每个前缀都必须是有效的网址。
- 每个前缀都必须使用
https://
,而不是http://
。 - 每个前缀都必须包含完整网域。
- 每个前缀都必须具有非空路径。例如,
https://www.google.com/
有效,但https://www.google.com
无效。 - 您可以使用通配符来匹配网址子网域前缀。
- 您可以在
addOns.common.openLinkUrlPrefixes
字段中使用单个*
通配符来匹配所有链接,但不建议这样做,因为这可能会使用户的数据面临风险,并延长插件审核流程。仅在您的插件功能需要时使用通配符。
在确定网址是否与许可名单中的前缀匹配时,请遵循以下规则:
- 路径匹配区分大小写。
- 如果前缀与网址完全相同,则表示匹配。
- 如果网址与前缀相同或为前缀的子网址,则属于匹配网址。
例如,前缀 https://example.com/foo
与以下网址匹配:
https://example.com/foo
https://example.com/foo/
https://example.com/foo/bar
https://example.com/foo?bar
https://example.com/foo#bar
使用通配符
您可以使用一个通配符 (*
) 来匹配 urlFetchWhitelist
和 addOns.common.openLinkUrlPrefixes
字段中的子网域。您不能使用多个通配符来匹配多个子网域,并且通配符必须表示网址的前缀。
例如,前缀 https://*.example.com/foo
与以下网址匹配:
https://subdomain.example.com/foo
https://any.number.of.subdomains.example.com/foo
前缀 https://*.example.com/foo
不与以下网址匹配:
https://subdomain.example.com/bar
(后缀不匹配)https://example.com/foo
(必须至少包含一个子网域)
当您尝试保存清单时,系统会强制执行一些前缀规则。例如,如果您在尝试保存时清单中存在以下前缀,则会导致错误:
https://*.*.example.com/foo
(禁止使用多个通配符)https://subdomain.*.example.com/foo
(通配符必须用作前置前缀)