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

suivant suivant suivant suivant

Cette page explique comment créer un module complémentaire Google Workspace qui fonctionne dans Google Chat à l'aide de Google Apps Script. Dans Google Chat, les modules complémentaires apparaissent aux utilisateurs comme des applications Google Chat. Pour en savoir plus, consultez la présentation de l'extension Google Chat.

L'application Chat vous permet d'envoyer des messages directement et répond en renvoyant vos messages.

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

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

1. Un utilisateur envoie un message à une application Chat, en passant par un message privé ou un espace Chat.
2. La logique de l'application Chat implémentée dans Apps Script, qui se trouve dans Google Cloud, reçoit et traite le message.
3. La logique de l'application Chat peut éventuellement s'intégrer à des 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 de l'application Chat dans Chat.
5. La réponse est transmise à l'utilisateur.

Objectifs

• configurer votre environnement ;
• Configurez le script.
• Configurez un module complémentaire Google Workspace pour l'application Chat.
• Tester l'application Chat

Prérequis

• Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.
• Un projet Google Cloud. Pour en créer un, consultez la section Créer un projet Google Cloud.

Configurer votre environnement

Ouvrez votre projet Cloud dans la console Google Cloud.

Si ce n'est pas déjà fait, ouvrez le projet Cloud que vous prévoyez d'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 d'autorisation OAuth

Toutes les applications qui utilisent OAuth 2.0 nécessitent une configuration de l'écran de consentement. En configurant l'écran de consentement OAuth de votre application, vous définissez ce qui est affiché pour les utilisateurs et les évaluateurs de l'application, et vous enregistrez votre application pour pouvoir 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 Enregistrer et continuer.

4. Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. À l'avenir, lorsque vous créerez une application à utiliser en dehors de votre organisation Google Workspace, vous devrez remplacer le type d'utilisateur par Externe, puis ajouter les champs d'autorisation requis par votre application.

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

Configurer le script

Pour configurer le script, vous devez créer une copie du projet de démarrage rapide, puis définir votre projet Cloud dans Apps Script.

Créer une copie du projet de démarrage rapide

1. Cliquez sur le bouton suivant pour ouvrir le projet Apps Script Module complémentaire dans Google Chat.
   Ouvrir le projet
2. Cliquez sur  Vue d'ensemble.
3. Sur la page de présentation, cliquez sur  Créer une copie.

4. Nommez votre copie du projet Apps Script:

   1. Cliquez sur Copie de l'application Chat du module complémentaire.

   2. Dans Titre du projet, saisissez Add-on Chat app.

   3. Cliquez sur Renommer.

Copiez 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 du 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 désormais d'un code d'application fonctionnel que vous pouvez tester (comme décrit dans les étapes suivantes) et personnaliser pour répondre à vos exigences.

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

Créer un déploiement de 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 principal, 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 principal pour l'utiliser à une étape ultérieure, puis cliquez sur OK.

Configurer le module complémentaire

À l'aide de votre déploiement Apps Script, procédez comme suit pour créer un module complémentaire et déployer l'application Google Chat:

1. Dans la console, 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 Add-on Chat 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 Add-on Chat 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 Deployment ID (ID de déploiement), collez l'ID de déploiement principal que vous avez précédemment copié.
   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 messages privés avec l'application Chat et envoyez un message:

1. Ouvrez Google Chat avec le compte Google Workspace que vous avez fourni lorsque vous vous êtes 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'ouvre.

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

5. Dans le nouveau message privé avec 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 les tests des fonctionnalités interactives, consultez la section Tester les fonctionnalités interactives des applications Google Chat.

Résoudre les problèmes

Lorsqu'une application ou une fiche Google Chat renvoie une erreur, l'interface Chat affiche le message "Un problème s'est produit". ou "Impossible de traiter votre demande". Il arrive que l'interface utilisateur de Chat n'affiche aucun message d'erreur, mais que l'application ou la fiche Chat produise un résultat inattendu. Par exemple, un message de fiche peut ne pas s'afficher.

Bien qu'un message d'erreur ne s'affiche pas dans l'interface utilisateur de 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 pour les applications Chat est activée. Pour savoir comment afficher, déboguer et corriger les erreurs, consultez Résoudre et corriger les erreurs Google Chat.

Effectuer un nettoyage

Pour éviter que les ressources utilisées dans ce tutoriel ne 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é dont vous souhaitez vous servir par la suite. Pour conserver les URL qui utilisent l'ID du projet, telles qu'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 à ne pas 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édez au gestionnaire de ressources.

2. Dans la liste des projets, sélectionnez celui 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.