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 de l'application Chat, y compris le nom, l'avatar, le déploiement et les fonctionnalités interactives que vous souhaitez utiliser.
Prérequis
HTTP
- Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.
- Créez un projet Google Cloud.
- Configurez l'écran de consentement OAuth.
- Activez les API Google Workspace suivantes :
- API Google Chat
- API Google Workspace Add-ons
- Point de terminaison HTTP qui héberge l'architecture de service de votre application Chat.
Apps Script
- 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.
- Créez un projet Apps Script autonome et activez le service Chat avancé.
- Configurez Chat dans le fichier manifeste en ajoutant l'objet
addons.chat
et les portées (oauthScopes
) ou les préfixes d'URL HTTPS (urlFetchWhitelist
) requis.
Choisir un nom à afficher, un avatar et une description pour votre application Chat
Le nom, l'avatar et la description de l'application Chat sont présentés aux utilisateurs dans l'interface utilisateur de Chat. Pour interagir avec les applications de 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 et lancez un message privé avec l'application Chat. 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 votre application Chat. | URL HTTPS pointant vers une image graphique 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 maximum |
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
Une fois que vous avez obtenu les informations sur votre application Chat, ouvrez votre projet Cloud et configurez l'API Chat:
Dans la console Google Cloud, accédez à la page de l'API Chat, puis cliquez sur Configuration:
Sous Informations sur l'application, remplissez les champs Nom de l'application, URL de l'avatar et Description.
Sous Fonctionnalités interactives, activez l'option Activer les fonctionnalités interactives, puis procédez comme suit:
Sous Fonctionnalités, cochez une ou plusieurs cases pour rendre votre application Chat disponible à l'installation et à l'utilisation:
Recevoir des messages privés : les utilisateurs peuvent installer l'application Chat et lui envoyer des messages dans un espace dédié entre eux et l'application Chat.
Rejoindre des espaces et des conversations de groupe: les utilisateurs peuvent ajouter l'application Chat dans des espaces avec plusieurs personnes et interagir avec elle.
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.
Facultatif: Pour recevoir des objets d'événement sur plusieurs points de terminaison ou fonctions, accédez à Paramètres avancés > Déclencheurs, puis fournissez ou mettez à jour les fonctions de rappel pour les déclencheurs Chat suivants:
- ADDED_TO_SPACE : 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 message privé ou une @mention dans un espace avec plusieurs personnes).
- REMOVED_FROM_SPACE: un utilisateur désinstalle ou supprime l'application Chat d'un espace.
Facultatif: Ajoutez d'autres fonctionnalités interactives telles que les commandes avec barre oblique ou les aperçus de liens.
Sous Visibilité, indiquez votre adresse e-mail afin de 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.
Facultatif: sous Journaux, cochez la case Enregistrer les erreurs dans Logging pour utiliser Google Cloud Logging. Pour en savoir plus, consultez la section Journals d'erreur de requête pour les applications Chat dans la documentation de l'API Chat.
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 la section 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 utilisateurs individuels et les administrateurs Google Workspace doivent pouvoir installer votre module complémentaire depuis la place de marché. Vous configurez ces paramètres d'installation dans le SDK Google Workspace Marketplace.
- Les applications Chat n'utilisent pas le nom et le logo que vous configurez pour d'autres applications Google Workspace dans l'objet
addons.common
du manifest. - 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 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 plutôt les installer directement depuis l'interface utilisateur de Chat.
Si vous avez créé votre module complémentaire à l'aide d'un service HTTP, omettez toute information 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.
Articles associés
- Pour gérer l'accès à l'API Chat, consultez la section Configurer l'API Google Chat dans la documentation de l'API Google Chat.
- Tester les fonctionnalités interactives des applications Google Chat
- Publier des applications Google Chat