Configurer l'API Google Chat

Chaque application Google Chat que vous créez nécessite son propre projet Google Cloud avec l'API Chat activée et configurée.

Pour effectuer des appels d'API en lecture seule avec l'authentification des utilisateurs, comme obtenir des espaces et lister des messages, il vous suffit d'activer l'API et de créer un client OAuth.

Pour effectuer des appels d'API de création, de mise à jour et de suppression, ou pour déployer et tester une application Chat interactive (créée en tant que module complémentaire Google Workspace qui étend Chat), vous devez également configurer l'API Chat. Les paramètres de configuration de l'API Chat vous permettent de spécifier tous les détails concernant l'application Chat, y compris son nom à afficher, son avatar, ses points de terminaison de déploiement et ses fonctionnalités interactives.

Prérequis

• Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.
• Créez un projet Google Cloud.
• Configurez l'écran de consentement OAuth.
• Activez l'API Google Chat.

Choisir un nom à afficher, un avatar et une description pour votre application Chat

Lorsque vous activez l'API Chat, vous configurez les informations sur votre application Chat qui s'affichent pour les utilisateurs dans Chat, y compris un nom à afficher, un avatar et une description. Ces informations n'apparaissent que dans Chat. Pour publier votre application Chat sur le Marketplace, vous devez également spécifier les informations qui s'affichent dans la fiche Marketplace de votre application Chat.

Avant de configurer une application Chat, préparez les informations suivantes :

Champ	Description	Format
Nom de l'application	Nom à afficher de l'application Chat.	25 caractères alphanumériques maximum
URL de l'avatar	Image qui s'affiche comme avatar de votre application Chat.	URL HTTPS pointant vers une image carrée (PNG ou JPEG). La taille recommandée est de 256 x 256 pixels ou plus.
Description	Brève description de l'objectif de l'application Chat.	40 caractères alphanumériques au maximum

Le nom, l'avatar et la description de l'application Chat sont affichés dans l'interface utilisateur de Chat. Pour certaines requêtes d'écriture de l'API Chat, Chat utilise ces informations pour attribuer les actions qu'une application Chat effectue dans Chat.

Par exemple, si vous appelez la méthode spaces.create(), Chat inclut le nom de l'application Chat dans la description de la personne qui a créé l'espace, comme illustré dans l'image suivante :

Figure 1. Message d'attribution que Chat affiche lorsque la méthode spaces.create() est utilisée pour créer un espace au nom d'un utilisateur.

Pour interagir avec les applications Chat, les utilisateurs voient ou utilisent également ces informations de différentes manières :

• @mentionnez l'application Chat pour l'ajouter à un espace ou lui envoyer un message.
• Recherchez l'application Chat et envoyez-lui un message privé. Dans le menu Applications, les messages privés affichent le nom et l'avatar de l'application Chat.
• Dans la barre de rédaction, les utilisateurs peuvent parcourir les applications Chat et voir leur nom, leur avatar et leur description.

Configurer votre application Chat dans la console Google Cloud

Une fois que vous avez les informations sur votre application Chat, ouvrez votre projet Cloud et configurez l'API Chat :

1. Dans la console Google Cloud, accédez à la page de l'API Chat, puis cliquez sur la page Configuration :

   Accéder à la page de configuration de l'API Chat

2. Sous Informations sur l'application, remplissez les champs Nom de l'application, URL de l'avatar et Description.

3. Sous Fonctionnalités interactives, configurez la façon dont votre application Chat répond aux interactions utilisateur :

   Remarque : Si votre application Chat n'appelle que l'API Chat et ne reçoit pas d'interactions utilisateur ni n'y répond pas, laissez l'option Activer les fonctionnalités interactives désactivée et passez à l'étape suivante.

   Pour créer une application Chat interactive, activez l'option Activer les fonctionnalités interactives et procédez comme suit :

   1. Sous Fonctionnalité :
      • Facultatif : Sélectionnez Accueil de l'application d'assistance pour afficher une fiche de page d'accueil dans l'onglet Accueil des messages privés (1:1) avec l'application Chat.
      • Sélectionnez Rejoindre des espaces et des conversations de groupe pour rendre votre application Chat disponible à l'installation et à l'utilisation. Par défaut, les utilisateurs peuvent installer l'application Chat et échanger des messages avec elle dans un espace dédié. Ils peuvent également ajouter l'application Chat à des espaces comportant plusieurs personnes et interagir avec elle.

   2. Sous Paramètres de connexion, sélectionnez l'architecture que vous souhaitez utiliser pour recevoir les objets d'événement de Chat :

      • Pour utiliser un service HTTP, sélectionnez URL du point de terminaison HTTP et fournissez une URL.
      • Pour utiliser un projet Google Apps Script, sélectionnez Apps Script et fournissez un ID de déploiement pour le projet.
      • Pour utiliser un agent Dialogflow, sélectionnez Dialogflow, puis Dialogflow CX ou Dialogflow ES, et indiquez le nom de ressource de l'agent.
      • Pour utiliser Pub/Sub, sélectionnez Cloud Pub/Sub et saisissez le nom du sujet.
      Avertissement : Si un ID de déploiement Apps Script est déjà renseigné, le projet Cloud est connecté à un module complémentaire Google Workspace existant. Si vous mettez à jour l'ID de déploiement dans l'API Chat, il est mis à jour pour votre module complémentaire et peut affecter votre fiche sur Google Workspace Marketplace. Pour examiner la configuration de votre module complémentaire, consultez Configurer votre application dans le SDK Google Workspace Marketplace.

   3. Facultatif : Pour acheminer les objets d'événement vers des points de terminaison ou des fonctions spécifiques, accédez à Paramètres de connexion > Déclencheurs, puis fournissez ou mettez à jour les points de terminaison ou les fonctions de rappel pour les déclencheurs de chat suivants :

      Remarque : Pour Apps Script, si vous ne mettez pas à jour les déclencheurs, vous devez implémenter les fonctions de rappel par défaut qui sont renseignées dans cette section (comme onMessage, onAddedToSpace, onRemovedFromSpace, onAppCommand et onAppHome).
      • Accueil de l'application (si l'option Assistance pour l'accueil de l'application est activée) : un utilisateur ouvre l'onglet Accueil dans un message privé avec l'application Chat.
      • Ajoutée à un espace : un utilisateur ajoute l'application Chat à une conversation de groupe ou à un espace, ou installe l'application Chat pour les messages privés.
      • Message : un utilisateur envoie un message à l'application Chat. Par exemple, un utilisateur envoie un message privé à l'application Chat ou @mentionne l'application Chat dans un espace avec plusieurs personnes.
      • Retiré de l'espace : un utilisateur désinstalle ou supprime l'application Chat d'un espace.
      • Commande d'application : un utilisateur appelle une commande rapide, une commande à barre oblique ou une action sur un message depuis l'application Chat.

   4. Facultatif : Ajoutez d'autres fonctionnalités interactives telles que des prompts de démarrage, des commandes (commandes rapides, commandes à barre oblique et actions liées au message) ou des aperçus des liens.

   5. Sous Visibilité, spécifiez votre adresse e-mail pour pouvoir installer et tester l'application Chat avant de la publier sur Google Workspace Marketplace. Vous pouvez spécifier jusqu'à cinq personnes ou un ou plusieurs groupes Google de votre organisation Google Workspace.

4. Facultatif : Sous Journaux, cochez la case Enregistrer les erreurs dans Logging pour utiliser Google Cloud Logging. Pour en savoir plus, consultez Interroger les journaux d'erreurs pour les applications Chat.

5. Cliquez sur Enregistrer.

Une fois la configuration enregistrée, toute personne que vous avez spécifiée dans le paramètre Visibilité de l'API Chat peut installer, tester ou utiliser l'application Chat. Pour commencer à tester et à déboguer votre application Chat, consultez Tester les fonctionnalités interactives des applications Google Chat.

Points à prendre en compte pour les modules complémentaires Google Workspace existants

Les applications Chat nécessitent une configuration différente de celle des modules complémentaires Google Workspace qui étendent d'autres applications Google Workspace. Si votre module complémentaire étend d'autres applications Google Workspace, tenez compte des exigences suivantes pour configurer l'application Chat :

• Les particuliers et les administrateurs Google Workspace doivent pouvoir installer votre module complémentaire depuis le Marketplace. Vous configurez ces paramètres d'installation dans le SDK Google Workspace Marketplace.
• Les applications Chat n'utilisent pas le nom ni le logo que vous configurez pour les autres applications Google Workspace dans l'objet addons.common du fichier manifeste.
• Pour les modules complémentaires publiés sur Google Workspace Marketplace, vous ne pouvez pas enregistrer de brouillon des modifications apportées aux paramètres de configuration de l'API Google Chat. Une fois que vous avez mis à jour et enregistré les paramètres de configuration de l'API Chat, l'application Chat mise à jour est immédiatement disponible pour tous les utilisateurs existants. Pour modifier votre fiche Marketplace, vous pouvez créer un brouillon avant d'envoyer les modifications.
• Si vous avez créé votre module complémentaire à l'aide d'Apps Script :
  • Vous devez utiliser le même ID de déploiement Apps Script que celui que vous utilisez pour le reste de la configuration de votre module complémentaire.
  • Vous ne pouvez pas utiliser l'éditeur Apps Script pour installer des déploiements de test dans Chat. Vous devez les installer directement depuis l'interface utilisateur de Chat.
• Si vous avez créé votre module complémentaire à l'aide d'un service HTTP, omettez les détails de configuration de l'application Chat dans le fichier manifeste et les déploiements que vous créez à l'aide de l'API Google Workspace Add-ons. Les déploiements HTTP que vous spécifiez dans le SDK Google Workspace Marketplace ne sont utilisés que pour d'autres applications Google Workspace.

Accorder à d'autres personnes l'autorisation de configurer l'API Chat

Vous pouvez autoriser des utilisateurs spécifiques à accéder à la page de configuration de l'application Chat en leur attribuant le rôle IAM (Identity and Access Management) Google Cloud Propriétaire des applications Chat ou Lecteur des applications Chat. Les utilisateurs disposant de ces rôles ne peuvent pas accéder à la page de configuration des applications Chat à l'aide du tableau de bord API et services, mais peuvent accéder à la page de configuration en accédant à la console Google Cloud pour le projet Cloud hôte de l'application Chat comme suit :

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

où PROJECT_ID correspond à l'ID du projet Google Cloud hébergeant l'application Chat.

Les utilisateurs disposant de rôles Projet peuvent également accéder à la page de configuration de l'application.

Les utilisateurs disposant de rôles personnalisés contenant les autorisations resourcemanager.projects.(get|update) ne peuvent pas accéder à la configuration de l'application Chat. Pour les rôles personnalisés, utilisez plutôt les autorisations chat.bots.(get|update).

Articles associés

• Choisir une architecture d'application Chat
• Recevoir des interactions utilisateur et y répondre
• Tester les fonctionnalités interactives des applications Google Chat

Applications Chat qui ne sont pas des modules complémentaires : configurer l'API Google Chat

Si vous gérez une application Chat qui n'est pas un module complémentaire Google Workspace, votre configuration utilise un point de terminaison unique pour tous les événements d'interaction plutôt que des déclencheurs par événement :

1. Dans la console Google Cloud, accédez à la page Configuration de l'API Chat :

   Accéder à la page de configuration de l'API Chat

2. Sous Fonctionnalités interactives, activez l'option Activer les fonctionnalités interactives.

3. Décochez la case Créer cette application Chat en tant que module complémentaire Google Workspace. Une boîte de dialogue s'ouvre pour vous demander de confirmer. Dans la boîte de dialogue, cliquez sur Désactiver.

4. Sous Fonctionnalité, sélectionnez Prise en charge de l'accueil de l'application ou Rejoindre des espaces et des conversations de groupe, selon vos besoins.

5. Sous Paramètres de connexion, spécifiez un point de terminaison unique pour votre application Chat (URL du point de terminaison HTTP, ID de déploiement Apps Script, nom de sujet Cloud Pub/Sub ou Dialogflow).

6. Configurez les commandes, les aperçus des liens, la visibilité et les journaux (facultatif), puis cliquez sur Enregistrer.

Pour mettre à niveau une application Chat qui n'est pas un module complémentaire vers un module complémentaire Google Workspace qui étend Google Chat, consultez Convertir une application Google Chat en module complémentaire Google Workspace.