Créer une application Google Chat à l'aide de Google Apps Script

Créez une application Google Chat à laquelle vous pouvez envoyer un message directement et qui y répond en renvoyant vos messages.

Le schéma suivant illustre l'architecture et le modèle de messagerie:

Dans le schéma précédent, un utilisateur qui interagit avec une application Chat Apps Script présente le flux d'informations suivant:

1. Un utilisateur envoie un message à une application Chat, dans un message privé ou dans un espace Chat.
2. La logique de l'application Chat mise en œuvre dans Apps Script, qui réside dans Google Cloud, reçoit et traite le message.
3. La logique de l'application Chat peut éventuellement s'intégrer aux services Google Workspace, tels qu'Agenda ou Sheets, ou à d'autres services Google tels que Google Maps ou YouTube.
4. La logique de l'application Chat renvoie une réponse au service d'application Chat dans Chat.
5. La réponse est transmise à l'utilisateur.

Objectifs

• configurer votre environnement ;
• Configurez le script.
• Publiez l'application Chat.
• Testez l'application Chat.

Prérequis

• Un compte Google Workspace ayant accès à Chat
• un projet Google Cloud ;

Configurer votre environnement

Ouvrir votre projet Cloud dans la console Google Cloud

S'il n'est pas déjà ouvert, ouvrez le projet Cloud que vous souhaitez utiliser pour cet exemple:

1. Dans la console Google Cloud, accédez à la page Sélectionner un projet.

   Sélectionner un projet Cloud

2. Sélectionnez le projet Google Cloud que vous souhaitez utiliser. Vous pouvez également cliquer sur Créer un projet et suivre les instructions à l'écran. Si vous créez un projet Google Cloud, vous devrez peut-être activer la facturation pour ce projet.

Activer l'API Chat

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

• Dans la console Google Cloud, activez l'API Google Chat.

  Activer l'API

Configurer l'écran de consentement OAuth

Toutes les applications utilisant OAuth 2.0 nécessitent la configuration d'un écran de consentement. La configuration de l'écran de consentement OAuth de votre application définit ce qui sera présenté aux utilisateurs et aux examinateurs d'applications, et enregistre votre application pour que vous puissiez la publier ultérieurement.

1. Dans la console Google Cloud, accédez à Menu > API et services > Écran de consentement OAuth.

   Accéder à l'écran de consentement OAuth

2. Pour Type d'utilisateur, sélectionnez Interne, puis cliquez sur Créer.
3. Remplissez le formulaire d'enregistrement de l'application, puis cliquez sur Save and Continue (Enregistrer et continuer).

4. Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. Par la suite, lorsque vous créerez une application destinée à être utilisée en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe, puis ajouter les niveaux d'autorisation requis par votre application.

5. Consultez le résumé d'enregistrement de votre application. Pour apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Back to Dashboard (Revenir au tableau de bord).

Configurer le script

Pour configurer le script, utilisez un modèle, puis définissez votre projet Cloud dans Apps Script.

Créer le script à partir du modèle

1. Accédez à la page Premiers pas d'Apps Script.
2. Cliquez sur le modèle Application Chat. Vous devrez peut-être faire défiler vers le bas pour voir ce modèle.
3. Cliquez sur Projet sans titre, saisissez Quickstart app, puis cliquez sur Renommer.

Copier le numéro du projet Cloud

1. Dans la console Google Cloud, accédez à Menu > IAM et administration > Paramètres.

   Accéder à la page Paramètres de la section IAM et administration

2. Dans le champ Numéro de projet, copiez la valeur.

Définir le projet Cloud du projet Apps Script

1. Dans le projet Apps Script de l'application Chat, cliquez sur Paramètres du projet .
2. Sous Projet Google Cloud Platform (GCP), cliquez sur Changer de projet.
3. Dans Numéro de projet GCP, collez le numéro du projet Google Cloud.
4. Cliquez sur Définir un projet.

Vous disposez maintenant d'un code d'application fonctionnel que vous pouvez tester (comme décrit dans les étapes suivantes), puis personnaliser en fonction de vos besoins.

Assurez-vous d'être connecté au bon compte Google lorsque vous ouvrez le modèle Apps Script. Le compte actuel peut parfois basculer vers votre compte par défaut sans que vous vous en rendiez compte.

Créer un déploiement test

Vous avez besoin d'un ID de déploiement pour ce projet Apps Script afin de pouvoir l'utiliser à l'étape suivante.

Pour obtenir l'ID de déploiement "head", procédez comme suit:

1. Dans le projet Apps Script de l'application Chat, cliquez sur Déployer > Tester les déploiements.
2. Copiez l'ID de déploiement Head. Vous en aurez besoin lors d'une prochaine étape, puis cliquez sur OK.

Publier l'application Chat

Publiez l'application Chat à partir de la console Google Cloud.

1. Dans la console Google Cloud, recherchez Google Chat API, puis cliquez sur API Google Chat.
2. Cliquez sur Gérer.

3. Cliquez sur Configuration et configurez l'application Chat:

   1. Dans le champ Nom de l'application, saisissez Quickstart app.
   2. Dans le champ URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. Dans le champ Description, saisissez Quickstart app.
   4. Sous "Fonctionnalité", sélectionnez Recevoir des messages privés et Rejoindre des espaces et des conversations de groupe.
   5. Sous "Paramètres de connexion", sélectionnez Projet Apps Script.
   6. Dans le champ ID de déploiement, collez l'ID de déploiement Head que vous avez copié précédemment.
   7. Sous "Visibilité", sélectionnez Utilisateurs et groupes spécifiques de votre domaine, puis saisissez votre adresse e-mail.

4. Cliquez sur Enregistrer.

L'application Chat est prête à répondre aux messages.

Tester l'application Chat

Pour tester votre application Chat, ouvrez un espace de messagerie privée avec l'application Chat et envoyez un message:

1. Ouvrez Google Chat avec le compte Google Workspace que vous avez indiqué lorsque vous vous avez ajouté en tant que testeur de confiance.

   Accéder à Google Chat

2. Cliquez sur Nouveau chat.
3. Dans le champ Ajouter une ou plusieurs personnes, saisissez le nom de votre application Chat.

4. Sélectionnez votre application Chat dans les résultats. Un message privé s'affiche.

   Remarque:Si vous ne voyez pas votre application Chat dans la liste des résultats, assurez-vous d'avoir inclus votre compte Google Workspace dans les paramètres de visibilité de la page Configuration de l'API Chat dans la console Google Cloud.

5. Dans le nouveau message privé contenant l'application, saisissez Hello, puis appuyez sur enter.

   L'application Chat vous remercie de l'avoir ajoutée et répète votre message.

Pour ajouter des testeurs de confiance et en savoir plus sur le test des fonctionnalités interactives, consultez la page Tester les fonctionnalités interactives pour les applications Google Chat.

Résoudre les problèmes

Lorsqu'une application ou une fiche Google Chat renvoie une erreur, l'interface Chat affiche un message indiquant "Une erreur s'est produite". ou "Impossible de traiter votre demande". Parfois, l'UI Chat n'affiche aucun message d'erreur, mais l'application ou la carte Chat produit un résultat inattendu. Par exemple, il est possible qu'un message de fiche ne s'affiche pas.

Bien qu'aucun message d'erreur ne s'affiche dans l'UI Chat, des messages d'erreur descriptifs et des données de journal sont disponibles pour vous aider à corriger les erreurs lorsque la journalisation des erreurs est activée pour les applications Chat. Pour obtenir de l'aide sur l'affichage, le débogage et la correction des erreurs, consultez Résoudre les problèmes dans Google Chat.

Effectuer un nettoyage

Pour éviter que les ressources utilisées dans ce tutoriel soient facturées sur votre compte Google Cloud, nous vous recommandons de supprimer le projet Cloud.

Attention:La suppression d'un projet aura les effets suivants:

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour ce tutoriel et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, comme une URL sur appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à éviter de dépasser les limites de quotas des projets.

1. Dans la console Google Cloud, accédez à la page Gérer les ressources. Cliquez sur Menu > IAM et administration > Gérer les ressources.

   Accéder à Resource Manager

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer .
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Étapes suivantes

• Créez des cartes interactives : les messages sous forme de fiches sont compatibles avec une mise en page définie, des éléments d'interface utilisateur interactifs comme des boutons et des éléments rich media comme des images. Utilisez des messages de fiche pour présenter des informations détaillées, recueillir des informations auprès des utilisateurs et les inciter à passer à l'étape suivante.
• Prenez en charge les commandes à barre oblique : les commandes à barre oblique vous permettent d'enregistrer et d'annoncer des commandes spécifiques que les utilisateurs peuvent fournir à votre application en saisissant une commande commençant par une barre oblique (/), comme /help.
• Boîtes de dialogue de lancement : il s'agit d'interfaces sous forme de fenêtres, sous forme de cartes, que votre application peut ouvrir pour interagir avec un utilisateur. Plusieurs fiches peuvent être associées de manière séquentielle, ce qui aide les utilisateurs à effectuer des processus en plusieurs étapes, comme remplir des données de formulaire.