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 permettant aux utilisateurs de planifier des rendez-vous avec les membres d'une équipe d'assistance doit être présenté comme une application Web afin que les utilisateurs puissent y accéder directement depuis leur navigateur.

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

Conditions requises pour 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 HtmlOutput du service HTML ou un objet TextOutput du service de contenu.

Paramètres de requête

Lorsqu'un utilisateur visite une application ou qu'un programme envoie à l'application une requête HTTP GET, Apps Script exécute la fonction doGet(e). Lorsqu'un programme envoie à l'application une requête HTTP POST, Apps Script exécute plutôt doPost(e). Dans les deux cas, l'argument e représente un paramètre d'événement qui peut contenir des informations sur tous les paramètres de la requête. La structure de l'objet é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 de l'URL après /exec ou /dev. Par exemple, si le chemin de l'URL se termine par /exec/hello, les informations sur le chemin sont hello.
e.contextPath	Non utilisée, 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 du message POST text/csv
e.postData.contents	Texte du contenu du corps de la requête 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 HtmlService.createHtmlOutput(params);
}

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 ou les corps des requêtes POST :

• c
• sid

Si vous utilisez ces paramètres, vous risquez de recevoir 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 différents 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. À côté de "Sélectionner un type", cliquez sur Activer les types de déploiement > Application Web.
3. Saisissez les informations concernant votre application Web dans les champs situés sous "Configuration du déploiement".
4. Cliquez sur Déployer.

Vous pouvez partager l'URL de l'application Web avec les utilisateurs de votre choix, à condition que vous leur ayez accordé l'accès.

Remarque :Les applications Web déployées dans un domaine cessent de fonctionner si leur propriété passe à un Drive partagé ou à un compte appartenant à un autre domaine. Pour résoudre ce problème, demandez au nouveau propriétaire ou collaborateur de redéployer l'application Web dans le nouveau domaine. Sinon, si l'application Web est déplacée vers son domaine d'origine, elle recommence à fonctionner pour ce domaine sans redéploiement.

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. À côté de "Sélectionner un 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 dernier code enregistré et n'est destinée qu'à des tests pendant le développement.

Avertissement: Lorsque vous déployez des applications Web à exécuter en tant que développeur, soyez prudent lorsque vous gérez des jetons OAuth obtenus via ScriptApp.getOAuthToken(). Ces jetons peuvent autoriser d'autres applications à accéder à vos données, et ne les transmettent jamais au client.

Autorisations

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

• Execute the app as me (Exécuter l'application en tant que moi) : dans ce cas, le script s'exécute toujours comme vous, en tant que 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 à l'aide de l'application Web. Cette approche oblige l'application Web à afficher l'adresse e-mail du propriétaire du script lorsque l'utilisateur autorise l'accès.

Avertissement :Pour éviter tout abus, Apps Script impose des limites à 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 appartient ou non à un domaine Google Workspace.

Remarque: Vous pouvez collaborer sur des applications Web à l'aide d'un Drive partagé. Lorsqu'une application Web dans un partage est déployée, choisir d'exécuter le projet comme vous le fait exécuter l'application Web sous l'autorité de l'utilisateur qui l'a déployée (étant donné qu'il n'y a pas de propriétaire de script).

Intégrer votre application Web à Google Sites

Vous pouvez également intégrer des applications Web à la version classique et à la nouvelle version de Google Sites.

Avertissement :Les applications Web intégrées sont toujours soumises à des autorisations d'accès permettant d'éviter une 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 l'autorisent.

Intégrer une application Web dans la nouvelle version de Sites

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

Pour intégrer une application Web à une nouvelle version de Sites, procédez comme suit:

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

L'application Web apparaît dans un cadre dans l'aperçu de la page. Lorsque vous publiez la page, les visiteurs de votre site peuvent avoir besoin d'autoriser l'application Web pour qu'elle s'exécute normalement. Des applications Web non autorisées présentent des invites d'autorisation à l'utilisateur.

Intégrer une application Web dans la version classique de Sites

Vous pouvez lier un script à un site Google classique de la même manière qu'un script peut être lié à un document ou une feuille de calcul Google. Pour créer un script lié, accédez à votre site, cliquez sur l'icône en forme de roue dentée , puis sélectionnez Gérer le site. Sur la page "Gérer le site", cliquez sur Apps Script dans le menu de navigation de gauche, puis sur le bouton Ajouter un script. Un nouveau script s'ouvre dans l'éditeur Apps Script, où vous pouvez coder et déployer votre application Web.

Vous pouvez également intégrer votre application Web dans une page. Vous pouvez lier l'application Web au site ou utiliser n'importe quelle application Web dont vous disposez de l'URL. Pour intégrer une application Web à une page Google Sites, procédez comme suit:

1. Ouvrez un site pour lequel vous disposez d'un accès en écriture, ou créez un site.
2. Accédez à la page de votre site où vous souhaitez intégrer l'application Web.
3. Cliquez sur l'icône de modification, puis sur Insertion > Google Apps Script.
4. Sélectionnez le script dans la liste qui représente votre application Web. Si votre application Web n'est pas liée à ce site, vous pouvez coller son URL.
5. Cliquez sur le bouton Sélectionner, choisissez les options souhaitées dans la boîte de dialogue suivante, puis cliquez sur Enregistrer.
6. Enregistrez les modifications apportées à la page. Votre application Web devrait alors être intégrée à votre page Sites.

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 interface utilisateur dynamique contrôlée via 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, puis transmettre l'état à l'utilisateur lorsque celui-ci parcourt l'application. Vous pouvez également écouter les événements d'historique afin que votre application Web affiche l'UI appropriée lorsque l'utilisateur passe d'un bouton à un autre. En interrogeant les paramètres d'URL au moment du chargement, vous pouvez faire en sorte que votre application crée son interface utilisateur de manière dynamique 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 côté client asynchrone pour vous aider à créer des applications Web liées à l'historique du navigateur:

• google.script.history fournit des méthodes permettant une réponse dynamique aux modifications de l'historique du navigateur. Par exemple: transférer des états (objets simples que vous pouvez définir) dans l'historique du navigateur, remplacer l'état supérieur de la pile d'historique et définir 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 d'URL et le fragment d'URL de la page actuelle, s'ils sont présents.

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 et les modules complémentaires. Il est également déconseillé d'utiliser cette fonctionnalité dans les applications Web intégrées à un site Google Sites.