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 (в качестве начального префикса необходимо использовать подстановочные знаки)