Ajouter des URL à la liste d'autorisation

Vous utilisez des listes d'autorisation pour désigner des URL spécifiques qui sont pré-approuvées pour l'accès par votre script ou votre module complémentaire. Les listes d'autorisation permettent de protéger les données des utilisateurs. Lorsque vous définissez une liste d'autorisation, les projets de script ne peuvent pas accéder aux URL qui n'ont pas été ajoutées à la liste d'autorisation.

Ce champ est facultatif lorsque vous installez un déploiement de test, mais il est obligatoire lorsque vous créez un déploiement versionné.

Vous utilisez des listes d'autorisation lorsque votre script ou votre module complémentaire effectue les actions suivantes :

  • Récupère des informations à partir d'un emplacement externe (tel que des points de terminaison HTTPS ) à l'aide du service UrlFetch Apps Script. Pour autoriser les URL à être récupérées, incluez le urlFetchWhitelist dans votre fichier manifeste.
  • Ouvre ou affiche une URL en réponse à une action de l'utilisateur (obligatoire pour les modules complémentaires Google Workspace qui ouvrent ou affichent des URL externes à Google). Pour autoriser les URL à être ouvertes, incluez le addOns.common.openLinkUrlPrefixes champ dans votre fichier manifeste.

Ajouter des préfixes à votre liste d'autorisation

Lorsque vous spécifiez des listes d'autorisation dans votre fichier manifeste (en incluant le champ addOns.common.openLinkUrlPrefixes ou urlFetchWhitelist), vous devez inclure une liste de préfixes d'URL. Les préfixes que vous ajoutez au manifeste doivent répondre aux exigences suivantes :

  • Chaque préfixe doit être une URL valide.
  • Chaque préfixe doit utiliser https://, et non http://.
  • Chaque préfixe doit comporter un domaine complet.
  • Chaque préfixe doit comporter un chemin d'accès non vide. Par exemple, https://www.google.com/ est valide, mais https://www.google.com ne l'est pas.
  • Vous pouvez utiliser des caractères génériques pour faire correspondre les préfixes de sous-domaine d'URL.
  • Un seul caractère générique * peut être utilisé dans le addOns.common.openLinkUrlPrefixes champ pour faire correspondre tous les liens, mais cela n'est pas recommandé, car cela peut exposer les données d'un utilisateur à des risques et prolonger le processus d'examen du module complémentaire. N'utilisez un caractère générique que si la fonctionnalité de votre module complémentaire l'exige.

Pour déterminer si une URL correspond à un préfixe dans la liste d'autorisation, les règles suivantes s'appliquent :

  • La mise en correspondance des chemins d'accès est sensible à la casse.
  • Si le préfixe est identique à l'URL, il y a correspondance.
  • Si l'URL est identique au préfixe ou est un enfant de celui-ci, il y a correspondance.

Par exemple, le préfixe https://example.com/foo correspond aux URL suivantes :

  • https://example.com/foo
  • https://example.com/foo/
  • https://example.com/foo/bar
  • https://example.com/foo?bar
  • https://example.com/foo#bar

Utiliser des caractères génériques

Vous pouvez utiliser un seul caractère générique (*) pour faire correspondre un sous-domaine pour les champs urlFetchWhitelist et addOns.common.openLinkUrlPrefixes. Vous ne pouvez pas utiliser plus d'un caractère générique pour faire correspondre plusieurs sous-domaines, et le caractère générique doit représenter le préfixe principal de l'URL.

Par exemple, le préfixe https://*.example.com/foo correspond aux URL suivantes :

  • https://subdomain.example.com/foo
  • https://any.number.of.subdomains.example.com/foo

Le préfixe https://*.example.com/foo ne correspond pas aux URL suivantes :

  • https://subdomain.example.com/bar (suffixe non correspondant)
  • https://example.com/foo (au moins un sous-domaine doit être présent)

Certaines règles de préfixe sont appliquées lorsque vous tentez d'enregistrer votre manifeste. Par exemple, les préfixes suivants entraînent une erreur s'ils sont présents dans votre fichier manifeste lorsque vous tentez d'enregistrer :

  • https://*.*.example.com/foo (plusieurs caractères génériques sont interdits)
  • https://subdomain.*.example.com/foo (les caractères génériques doivent être utilisés comme préfixe principal)