Списки разрешенных URL-адресов используются для указания определенных URL-адресов, доступ к которым предварительно одобрен вашим скриптом или дополнением. Списки разрешенных адресов помогают защитить пользовательские данные; при определении списка разрешенных адресов проекты скриптов не смогут получать доступ к URL-адресам, не добавленным в список разрешенных адресов.
Это поле необязательно при установке тестового развертывания, но является обязательным при создании версионного развертывания.
Вы используете белые списки, когда ваш скрипт или дополнение выполняет следующие действия:
- Извлекает или извлекает информацию из внешнего источника (например, конечных точек HTTPS) с помощью сервиса Apps Script
UrlFetch
. Чтобы добавить URL-адреса для извлечения, включите полеurlFetchWhitelist
в файл манифеста. - Открывает или отображает URL-адрес в ответ на действие пользователя (требуется для дополнений Google Workspace, которые открывают или отображают URL-адреса, не относящиеся к Google). Чтобы добавить URL-адреса в список разрешённых для открытия, включите поле
addOns.common.openLinkUrlPrefixes
в файл манифеста.
Добавление префиксов в ваш белый список
При указании разрешённых списков в файле манифеста (путём включения поля addOns.common.openLinkUrlPrefixes
или urlFetchWhitelist
) необходимо включить список префиксов URL. Добавляемые в манифест префиксы должны соответствовать следующим требованиям:
- Каждый префикс должен быть допустимым URL-адресом.
- Каждый префикс должен использовать
https://
, а неhttp://
. - Каждый префикс должен иметь полный домен.
- Каждый префикс должен иметь непустой путь. Например,
https://www.google.com/
допустим, аhttps://www.google.com
— нет. - Для сопоставления префиксов поддоменов URL можно использовать подстановочные знаки .
- В поле
addOns.common.openLinkUrlPrefixes
можно использовать один подстановочный знак*
для сопоставления всех ссылок, но это не рекомендуется, так как это может подвергнуть данные пользователя риску и увеличить время проверки дополнения . Используйте подстановочный знак только в том случае, если это требуется для функциональности вашего дополнения.
При определении соответствия URL-адреса префиксу в разрешенном списке применяются следующие правила:
- Сопоставление путей чувствительно к регистру.
- Если префикс идентичен URL-адресу, это совпадение.
- Если URL-адрес совпадает с префиксом или является его дочерним, то это совпадение.
Например, префикс https://example.com/foo
соответствует следующим URL-адресам:
-
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
можно использовать один подстановочный символ ( *
). Для сопоставления нескольких поддоменов можно использовать только один подстановочный символ, который должен представлять собой начальный префикс URL-адреса.
Например, префикс https://*.example.com/foo
соответствует следующим URL-адресам:
-
https://subdomain.example.com/foo
-
https://any.number.of.subdomains.example.com/foo
Префикс https://*.example.com/foo
не соответствует следующим URL-адресам:
-
https://subdomain.example.com/bar
(несовпадение суффикса) -
https://example.com/foo
(должен присутствовать хотя бы один поддомен)
Некоторые правила префиксов применяются при попытке сохранить манифест. Например, следующие префиксы вызывают ошибку, если они присутствуют в манифесте при попытке сохранить его:
-
https://*.*.example.com/foo
(нельзя использовать несколько подстановочных знаков) -
https://subdomain.*.example.com/foo
(в качестве начального префикса необходимо использовать подстановочные знаки)