Applications Web

Si vous créez une interface utilisateur pour un script, vous pouvez publier le script en tant qu'application Web. Par exemple, un script qui permet aux utilisateurs de planifier des rendez-vous avec des membres d'une équipe d'assistance serait mieux présenté sous forme d'application Web afin que les utilisateurs puissent y accéder directement depuis leur navigateur.

Les scripts autonomes et les scripts associés aux applications Google Workspace peuvent être transformés en applications Web, à condition qu'ils répondent aux exigences ci-dessous.

Exigences concernant les applications Web

Un script peut être publié en tant qu'application Web s'il répond aux exigences suivantes :

• Il contient une fonction doGet(e) ou doPost(e).
• La fonction renvoie un objet service HTML HtmlOutput ou un objet service de contenu TextOutput.

Paramètres de requête

Lorsqu'un utilisateur consulte une application ou qu'un programme envoie une requête HTTP GET à l'application, Apps Script exécute la fonction doGet(e). Lorsqu'un programme envoie une requête HTTP POST à l'application, Apps Script exécute doPost(e) à la place. Dans les deux cas, l'argument e représente un paramètre d'événement qui peut contenir des informations sur n'importe quel paramètre de requête. La structure de l'objet d'événement est présentée dans le tableau ci-dessous :

Champs
e.queryString	Valeur de la partie chaîne de requête de l'URL, ou null si aucune chaîne de requête n'est spécifiée name=alice&n=1&n=2
e.parameter	Objet de paires clé/valeur correspondant aux paramètres de la requête. Seule la première valeur est renvoyée pour les paramètres comportant plusieurs valeurs. {"name": "alice", "n": "1"}
e.parameters	Objet semblable à e.parameter, mais avec un tableau de valeurs pour chaque clé {"name": ["alice"], "n": ["1", "2"]}
e.pathInfo	Chemin d'URL après /exec ou /dev. Par exemple, si le chemin d'URL se termine par /exec/hello, les informations sur le chemin d'accès sont hello.
e.contextPath	Non utilisé, toujours la chaîne vide.
e.contentLength	Longueur du corps de la requête pour les requêtes POST ou -1 pour les requêtes GET 332
e.postData.length	Même chose que pour e.contentLength 332
e.postData.type	Type MIME du corps POST text/csv
e.postData.contents	Texte du contenu du corps POST Alice,21
e.postData.name	Toujours la valeur "postData" postData

Par exemple, vous pouvez transmettre des paramètres tels que username et age à une URL, comme indiqué ci-dessous :

https://script.google.com/.../exec?username=jsmith&age=21

Vous pouvez ensuite afficher les paramètres comme suit :

function doGet(e) {
  var params = JSON.stringify(e);
  return ContentService.createTextOutput(params).setMimeType(ContentService.MimeType.JSON);
}

Dans l'exemple ci-dessus, doGet(e) renvoie le résultat suivant :

{
  "queryString": "username=jsmith&age=21",
  "parameter": {
    "username": "jsmith",
    "age": "21"
  },
  "contextPath": "",
  "parameters": {
    "username": [
      "jsmith"
    ],
    "age": [
      "21"
    ]
  },
  "contentLength": -1
}

Avertissement : Les noms de paramètres suivants sont réservés par le système et ne doivent pas être utilisés dans les paramètres d'URL ni dans les corps POST :

• c
• sid

L'utilisation de ces paramètres peut entraîner une réponse HTTP 405 avec le message d'erreur "Désolé, le fichier que vous avez demandé n'existe pas." Si possible, mettez à jour votre script pour utiliser d'autres noms de paramètres.

Déployer un script en tant qu'application Web

Pour déployer un script en tant qu'application Web, procédez comme suit :

1. En haut à droite du projet de script, cliquez sur Déployer > Nouveau déploiement.
2. En regard de "Sélectionner le type", cliquez sur Activer les types de déploiement  > Application Web.
3. Saisissez les informations sur votre application Web dans les champs sous "Configuration du déploiement".
4. Cliquez sur Déployer.

Vous pouvez partager l'URL de l'application Web avec les personnes qui doivent l'utiliser, à condition de leur avoir accordé l'accès.

Remarque : Les applications Web déployées dans un domaine cessent de fonctionner si leur propriété est transférée vers un drive partagé ou un compte dans un autre domaine. Pour résoudre ce problème, le nouveau propriétaire ou collaborateur doit redéployer l'application Web dans le nouveau domaine. Vous pouvez également déplacer l'application Web vers son domaine d'origine. Elle recommencera alors à fonctionner pour ce domaine sans avoir besoin d'être redéployée.

Tester le déploiement d'une application Web

Pour tester votre script en tant qu'application Web, procédez comme suit :

1. En haut à droite du projet de script, cliquez sur Déployer > Tester les déploiements.
2. En regard de "Sélectionner le type", cliquez sur Activer les types de déploiement > Application Web.
3. Sous l'URL de l'application Web, cliquez sur Copier.

4. Collez l'URL dans votre navigateur et testez votre application Web.

   Cette URL se termine par /dev et n'est accessible qu'aux utilisateurs disposant d'un accès en écriture au script. Cette instance de l'application exécute toujours le code enregistré le plus récemment et n'est destinée qu'aux tests pendant le développement.

Avertissement : Lorsque vous déployez des applications Web pour qu'elles s'exécutent en tant que développeur, vous devez faire très attention lorsque vous manipulez des jetons OAuth obtenus via ScriptApp.getOAuthToken(). Ces jetons peuvent accorder à d'autres applications l'accès à vos données. Ne les transmettez jamais au client.

Autorisations

Les autorisations d'une application Web diffèrent selon la façon dont vous choisissez d'exécuter l'application :

• Exécuter l'application en tant que moi : dans ce cas, le script s'exécute toujours en tant que vous, le propriétaire du script, quel que soit l'utilisateur qui accède à l'application Web.
• Exécuter l'application en tant qu'utilisateur accédant à l'application Web : dans ce cas, le script s'exécute sous l'identité de l'utilisateur actif qui utilise l'application Web. Cette approche d'autorisation entraîne l'affichage de l'adresse e-mail du propriétaire du script lorsque l'utilisateur autorise l'accès.

Avertissement : Pour éviter les utilisations abusives, Apps Script impose des limites sur la fréquence à laquelle les nouveaux utilisateurs peuvent autoriser une application Web qui s'exécute en tant qu'utilisateur. Ces limites dépendent, entre autres, du fait que le compte de publication fasse partie d'un domaine Google Workspace.

Remarque : Vous pouvez collaborer sur des applications Web à l'aide d'un lecteur partagé. Lorsqu'une application Web dans un Drive partagé est déployée, le fait de choisir de l'exécuter en tant que vous-même entraîne l'exécution de l'application Web sous l'autorité de l'utilisateur qui l'a déployée (puisqu'il n'y a pas de propriétaire du script).

Intégrer votre application Web dans Google Sites

Avertissement : Les applications Web intégrées sont toujours soumises à des autorisations d'accès pour éviter toute utilisation malveillante. Si votre application Web intégrée ne semble pas fonctionner, vérifiez si les autorisations définies par le propriétaire de l'application Web et l'administrateur du domaine permettent son utilisation.

Pour intégrer une application Web dans Google Sites, vous devez d'abord la déployer. Vous avez également besoin de l'URL de la version déployée dans la boîte de dialogue Deploy.

Pour intégrer une application Web à une page Sites, procédez comme suit :

1. Ouvrez la page Sites sur laquelle vous souhaitez ajouter l'application Web.
2. Sélectionnez Insérer > URL d'intégration.
3. Collez l'URL de l'application Web, puis cliquez sur AJOUTER.

L'application Web s'affiche dans un frame dans l'aperçu de la page. Lorsque vous publiez la page, les visiteurs de votre site devront peut-être autoriser l'application Web avant qu'elle ne s'exécute normalement. Les applications Web non autorisées présentent des invites d'autorisation à l'utilisateur.

Applications Web et historique du navigateur

Il peut être souhaitable qu'une application Web Apps Script simule une application multipage ou une application avec une UI dynamique contrôlée par des paramètres d'URL. Pour ce faire, vous pouvez définir un objet d'état pour représenter l'UI ou la page de l'application, et transférer l'état dans l'historique du navigateur lorsque l'utilisateur navigue dans votre application. Vous pouvez également écouter les événements d'historique afin que votre application Web affiche la bonne UI lorsque l'utilisateur navigue en arrière et en avant avec les boutons du navigateur. En interrogeant les paramètres d'URL au moment du chargement, vous pouvez faire en sorte que votre application crée dynamiquement son interface utilisateur en fonction de ces paramètres, ce qui permet à l'utilisateur de démarrer l'application dans un état particulier.

Apps Script fournit deux API JavaScript asynchrones côté client pour vous aider à créer des applications Web associées à l'historique du navigateur :

• google.script.history fournit des méthodes permettant une réponse dynamique aux modifications de l'historique du navigateur. Cela inclut l'envoi d'états (objets simples que vous pouvez définir) dans l'historique du navigateur, le remplacement de l'état supérieur dans la pile d'historique et la définition d'une fonction de rappel d'écouteur pour répondre aux modifications de l'historique.

• google.script.url permet de récupérer les paramètres et le fragment d'URL de la page actuelle, le cas échéant.

Ces API d'historique ne sont disponibles que pour les applications Web. Elles ne sont pas compatibles avec les barres latérales, les boîtes de dialogue ni les modules complémentaires. Cette fonctionnalité n'est pas non plus recommandée pour une utilisation dans des applications Web intégrées à un site Google Sites.