Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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.
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 :
Dans la console Google Cloud, accédez à la page de l'API Chat, puis cliquez sur la page Configuration :
Sous Informations sur l'application, remplissez les champs Nom de l'application, URL de l'avatar et Description.
Sous Fonctionnalités interactives, cliquez sur le bouton Activer les fonctionnalités interactives pour l'activer, puis procédez comme suit :
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.
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 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.
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.
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.
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 :
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.
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.
Articles associés
Pour gérer l'accès à l'API Chat, consultez Configurer l'API Google Chat dans la documentation de l'API Google Chat.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/04 (UTC).
[null,null,["Dernière mise à jour le 2025/08/04 (UTC)."],[[["\u003cp\u003eThis guide explains how to set up a Google Chat app as a Google Workspace add-on using either Apps Script or an HTTP service.\u003c/p\u003e\n"],["\u003cp\u003eYou'll need a Google Workspace account, a Google Cloud project, and necessary API configurations to get started.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves choosing a display name, avatar, and description for your app, and configuring its interactive features in the Google Cloud console.\u003c/p\u003e\n"],["\u003cp\u003eFor existing Google Workspace add-ons, specific considerations apply when integrating Chat app functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is part of the Google Workspace Developer Preview Program, granting early access before public release.\u003c/p\u003e\n"]]],["To configure a Chat app, use the Google Cloud console to access the Chat API page. Input the app's name, avatar URL, and description. Enable interactive features, choosing to receive 1:1 messages or join group conversations. Select either an HTTP endpoint URL or an Apps Script deployment ID for connection settings. Optionally, set triggers, add quick/slash commands, and specify visibility. Save configurations; users listed in \"Visibility\" can then test the Chat app.\n"],null,["# Configure a Google Chat app\n\nThis page explains how to configure and deploy a Google Chat app\nas a Google Workspace add-on.\n\nTo deploy and test a Google Workspace add-on that extends Chat,\nyou must enable and configure a Chat app using the\nGoogle Chat API. The Chat API configuration settings are where you\nspecify all the details about the Chat app, including\nthe name, avatar, deployment, and interactive features that you want to use.\n| **Note:** This page explains how to configure a Chat app using Apps Script or an HTTP service. [Dialogflow](/workspace/chat/build-dialogflow-chat-app-natural-language) and [Pub/Sub](/workspace/chat/quickstart/pub-sub) are unavailable. For details, see [Limitations and known issues](/workspace/add-ons/chat#limitations-known-issues).\n\nPrerequisites\n-------------\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n- A Google Cloud project. To create one, see\n [Create a Google Cloud project](/workspace/guides/create-project).\n\n- [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n- [Enable the Google Chat API](/workspace/guides/enable-apis).\n\nChoose a display name, avatar, and description for your Chat app\n----------------------------------------------------------------\n\nThe Chat app's name, avatar, and description are\ndisplayed to users in the Chat UI. To interact with\nChat apps, users see or use this information in the following\nways:\n\n- @mention the Chat app to add it to a space or send it a message.\n- Find and start a direct message with the Chat app. In the **Apps** menu, direct messages display the Chat app's name and avatar.\n- From the compose bar, users can browse Chat apps and see their name, avatar, and description.\n\nBefore you configure a Chat app, you must prepare the\nfollowing information:\n\n| Field | Description | Format |\n|-------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| App name | The display name for the Chat app. | Up to 25 alphanumeric characters |\n| Avatar URL | The image that displays as your Chat app's avatar. | An HTTPS URL pointing to a square graphics image (PNG or JPEG). Recommended size is 256 by 256 pixels or more. |\n| Description | A brief description of the purpose of the Chat app. | Up to 40 alphanumeric characters |\n\nIn the following section, you specify this information in the configurations\nsettings in the Chat API.\n\nConfigure your Chat app in the Google Cloud console\n---------------------------------------------------\n\nIn the Google Cloud console, you configure the details about your\nChat app that appear to users in Chat,\nincluding a display name, avatar, and description. These details only appear\nin Chat. To publish your Chat app to the\nMarketplace, you must also specify the details that\nappear in your Chat app's\n[Marketplace listing](/workspace/marketplace/create-listing).\n\nWhen you have your Chat app details, open your\nCloud project and configure the Chat API:\n\n1. In the Google Cloud console, go to the Chat API page and click the\n **Configuration** page:\n\n [Go to the Chat API Configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat)\n2. Under **Application info** , fill out the **App name** , **Avatar URL** ,\n and **Description** fields.\n\n3. Under **Interactive features** , click the **Enable interactive features**\n to the on position and complete the following:\n\n 1. Under **Functionality** , select **Join spaces and group conversations**\n to make your Chat app available to install and use.\n\n By default, Users can install and message with the\n Chat app in a dedicated space between\n the user and Chat app. Users can also add and interact\n with the Chat app in spaces with multiple\n people.\n 2. Under **Connection settings** , select the architecture that you want to\n use to receive\n [event objects from Chat](/workspace/add-ons/chat/build#event-objects):\n\n - To use an HTTP service, select **HTTP endpoint URL** and provide a URL.\n - To use a Google Apps Script project, select **Apps Script** and provide a [deployment ID](/apps-script/concepts/deployments) for the project.\n\n | **Warning:** If an Apps Script deployment ID is already populated, the Cloud project is connected to an existing Google Workspace add-on. If you update the deployment ID in the Chat API, the deployment ID is updated for your add-on and could affect your listing in the Google Workspace Marketplace. To review your add-on configuration, see [Configure your app in the Google Workspace Marketplace SDK](/workspace/marketplace/enable-configure-sdk) in the Google Workspace Marketplace documentation.\n 3. Optional: To receive event objects to more than one endpoint or\n function, go to **Connection settings**\n \\\u003e **Triggers** and provide or\n update the callback functions for the following\n [Chat triggers](/workspace/add-ons/chat/build#triggers):\n\n | **Note:** For Apps Script, if you don't update the triggers, you must use the corresponding callback functions that are populated in this section (such as `onMessage`, `onAddedToSpace`, and `onRemovedFromSpace`).\n - **Added to space**: A user adds the Chat app to a group conversation or space, or installs the Chat app for 1:1 messages.\n - **Message**: A user sends a message to the Chat app. For example, sends a direct message to the Chat app or @mentions the Chat app in a space with multiple people.\n - **Removed from space**: A user uninstalls or removes the Chat app from a space.\n - **App command**: A user uses a quick command or slash command from the Chat app.\n 4. Optional: Add other interactive features such as\n [quick commands](/workspace/add-ons/chat/quick-commands),\n [slash commands](/workspace/add-ons/chat/slash-commands),\n or [link previews](/workspace/add-ons/chat/preview-links).\n\n 5. Under **Visibility** , specify your email so that you can\n [install and test the Chat app](/workspace/chat/test-interactive-features)\n before you publish to the Google Workspace Marketplace. You can specify\n up to five individuals, or one or more Google Groups from your\n Google Workspace organization.\n\n4. Optional: Under **Logs** , select the **Log errors to Logging** checkbox to\n use Google Cloud Logging. For more information, see\n [Query error logs for Chat apps](/workspace/chat/query-logs)\n in the Chat API documentation.\n\n5. Click **Save**.\n\nAfter you save the configuration, anyone that you specified in the\nChat API's **Visibility** setting can install, test, or use the\nChat app. To start testing and debugging your\nChat app, see\n[Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)\nin the Chat API documentation.\n\nConsiderations for existing Google Workspace add-ons\n----------------------------------------------------\n\nChat apps require a different configuration compared to\nGoogle Workspace add-ons that extend other Google Workspace applications.\nIf your add-on extends other\nGoogle Workspace applications, consider the following requirements\nfor configuring the Chat app:\n\n- Both individuals and Google Workspace administrators must be able to install your add-on from the Marketplace. You configure these installation settings in the Google Workspace Marketplace SDK.\n- Chat apps don't use the name and logo that you configure for other Google Workspace applications in the `addons.common` object of the [manifest](/workspace/add-ons/concepts/workspace-manifests).\n- For add-ons that are published to the Google Workspace Marketplace, you can't save a draft of any changes to the [Google Chat API configuration settings](/workspace/add-ons/chat/configure). After you update and save the Chat API configuration settings, the updated Chat app is available to all existing users. To update your Marketplace listing, you can [create a draft](/workspace/marketplace/manage-app-listing#draft-app-listing) before submitting any changes.\n- If you built your add-on using\n Apps Script:\n\n - You must use the same Apps Script deployment ID that you use for the rest of your add-on configuration.\n - You can't use the Apps Script editor to install [test deployments](/workspace/add-ons/how-tos/testing-workspace-addons#install_an_unpublished) in Chat. Instead, you must [install them directly from the\n Chat UI](/workspace/chat/test-interactive-features).\n- If you built your add-on using an HTTP service,\n omit any Chat app configuration details in the\n manifest and deployments that you create using the Google Workspace add-ons API. The\n HTTP deployments that you specify in the Google Workspace Marketplace SDK are\n only used for other Google Workspace applications.\n\nRelated topics\n--------------\n\n- To manage access to the Chat API, see [Configure the Google Chat API](/workspace/chat/configure-chat-api#grant-access) in the Google Chat API documentation.\n- [Test interactive features for Google Chat apps](/workspace/chat/test-interactive-features)"]]
