Configurer une application Google Chat

Cette page explique comment configurer et déployer une application Google Chat en tant que module complémentaire Google Workspace.

Pour déployer et tester un module complémentaire Google Workspace qui étend Chat, vous devez activer et configurer une application Chat à l'aide de l'API Google 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 le nom, l'avatar, le déploiement et les fonctionnalités interactives que vous souhaitez utiliser.

Prérequis

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

Le nom, l'avatar et la description de l'application Chat sont affichés aux utilisateurs dans l'interface utilisateur de Chat. Pour interagir avec les applications Chat, les utilisateurs voient ou utilisent 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 composition, les utilisateurs peuvent parcourir les applications Chat et voir leur nom, leur avatar et leur description.

Avant de configurer une application Chat, vous devez préparer 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 l'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. Jusqu'à 40 caractères alphanumériques

Dans la section suivante, vous spécifiez ces informations dans les paramètres de configuration de l'API Chat.

Configurer votre application Chat dans la console Google Cloud

Dans la console Google Cloud, 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.

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, cliquez sur le bouton Activer les fonctionnalités interactives pour l'activer, puis procédez comme suit :

    1. Sous Fonctionnalité, 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.

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

      • Ajouté à 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, il 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 utilise une commande rapide ou une commande à barre oblique depuis l'application Chat.

    4. Facultatif : Ajoutez d'autres fonctionnalités interactives, comme les commandes rapides, les commandes à barre oblique ou les 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 dans la documentation de l'API 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 dans la documentation de l'API Chat.

Informations spécifiques aux 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 de chat n'utilisent pas le nom ni le logo que vous configurez pour les autres applications Google Workspace dans l'objet addons.common du 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 disponible pour tous les utilisateurs existants. Pour mettre à jour 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 :

  • Si vous avez créé votre module complémentaire à l'aide d'un service HTTP, omettez tous 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 les autres applications Google Workspace.