Cette page a été traduite par l'API Cloud Translation.

Créer une application Google Chat HTTP

Cette page explique comment créer une application HTTP Chat. Il existe différentes manières d'implémenter cette architecture. Sur Google Cloud, vous pouvez utiliser Cloud Functions, Cloud Run et App Engine. Dans ce guide de démarrage rapide, vous allez écrire et déployer une fonction Cloud que l'application Chat utilise pour répondre au message d'un utilisateur.

Avec cette architecture, vous configurez Chat pour l'intégrer à Google Cloud ou à un serveur sur site à l'aide de HTTP, comme illustré dans le schéma suivant :

Architecture d'une application Chat utilisant un service Web sur un serveur sur site.

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

Un utilisateur envoie un message dans Chat à une application Chat, soit par message privé, soit dans un espace Chat.
Une requête HTTP est envoyée à un serveur Web, qui est un système cloud ou sur site contenant la logique de l'application Chat.
La logique de l'application Chat peut éventuellement s'intégrer à des services Google Workspace (comme Agenda et Sheets), à d'autres services Google (comme Maps, YouTube et Vertex AI) ou à d'autres services Web (comme un système de gestion de projets ou un outil de gestion des tickets).
Le serveur Web renvoie une réponse HTTP au service de l'application Chat dans Chat.
La réponse est envoyée à l'utilisateur.
L'application Chat peut éventuellement appeler l'API Chat pour publier des messages de manière asynchrone ou effectuer d'autres opérations.

Cette architecture vous permet d'utiliser les bibliothèques et composants existants de votre système, car ces applications Chat peuvent être conçues à l'aide de différents langages de programmation.

Objectifs

configurer votre environnement ;
Créez et déployez une fonction Cloud.
Publiez l'application dans Chat.
Tester l'application

Prérequis

Un compte Google Workspace Business ou Enterprise ayant accès à Google Chat.
Un projet Google Cloud avec facturation activée. Pour vérifier si la facturation est activée pour un projet existant, consultez la section Vérifier l'état de la facturation de vos projets. Pour créer un projet et configurer la facturation, consultez la section Créer un projet Google Cloud.

Configurer l'environnement

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 les API Google Chat, Cloud Build, Cloud Functions, Cloud Pub/Sub, Cloud Logging, Artifact Registry et Cloud Run.

Activer les API

Créer et déployer une fonction Cloud

Créez et déployez une fonction Cloud qui génère une fiche Chat avec le nom à afficher et l'image de l'avatar de l'expéditeur. Lorsque l'application Chat reçoit un message, elle exécute la fonction et répond avec la fiche.

Pour créer et déployer la fonction pour votre application Chat, procédez comme suit:

Node.js

Dans la console Google Cloud, accédez à la page Cloud Functions.

Accéder à Cloud Functions

Assurez-vous que le projet de votre application Chat est sélectionné.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction :
1. Dans Environnement, sélectionnez Fonction Cloud Run.
2. Dans Nom de la fonction, saisissez QuickStartChatApp.
3. Dans Région, sélectionnez une région.
4. Sous "Authentification", sélectionnez Exiger l'authentification.
5. Cliquez sur Suivant.
Dans Environnement d'exécution, sélectionnez la version la plus récente de Node.js.
Dans Code source, sélectionnez Éditeur intégré.
Dans Point d'entrée, supprimez le texte par défaut et saisissez avatarApp.

Remplacez le contenu du fichier index.js par le code suivant :

node/avatar-app/index.js

Afficher sur GitHub

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You need to
// use the same ID as set in the Google Chat API configuration.
const ABOUT_COMMAND_ID = "";

/**
 * Google Cloud Function that responds to messages sent from a
 * Google Chat space.
 *
 * @param {Object} req Request sent from Google Chat space
 * @param {Object} res Response to send back
 */
exports.avatarApp = function avatarApp(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    return res.send('Hello! This function is meant to be used ' +
      'in a Google Chat Space.');
  }

  // Stores the Google Chat event as a variable.
  const event = req.body;

  // Checks for the presence of a slash command in the message.
  if (event.message.slashCommand) {
    // Executes the slash command logic based on its ID.
    // Slash command IDs are set in the Google Chat API configuration.
    switch (event.message.slashCommand.commandId) {
      case ABOUT_COMMAND_ID:
        return res.send({
          privateMessageViewer: event.user,
          text: 'The Avatar app replies to Google Chat messages.'
        });
    }
  }

  const sender = req.body.message.sender.displayName;
  const image = req.body.message.sender.avatarUrl;
  const data = createMessage(sender, image);
  res.send(data);
};

/**
 * Creates a card with two widgets.
 * 
 * @param {string} displayName the sender's display name
 * @param {string} avatarUrl the URL for the sender's avatar
 * @return {Object} a card with the user's avatar.
 */
function createMessage(displayName, avatarUrl) {
  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: {
          title: `Hello ${displayName}!`,
        },
        sections: [{ widgets: [{
          textParagraph: { text: 'Your avatar picture: ' }
        }, {
          image: { imageUrl: avatarUrl }
        }]}]
      }
    }]
  };
}

Cliquez sur Déployer.

Python

Dans la console Google Cloud, accédez à la page Cloud Functions.

Accéder à Cloud Functions

Assurez-vous que le projet de votre application Chat est sélectionné.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction :
1. Dans Environnement, sélectionnez Fonction Cloud Run.
2. Dans Nom de la fonction, saisissez QuickStartChatApp.
3. Dans Région, sélectionnez une région.
4. Sous "Authentification", sélectionnez Exiger l'authentification.
5. Cliquez sur Suivant.
Dans Environnement d'exécution, sélectionnez la version la plus récente de Python.
Dans Code source, sélectionnez Éditeur intégré.
Dans Point d'entrée, supprimez le texte par défaut et saisissez avatar_app.

Remplacez le contenu du fichier main.py par le code suivant :

python/avatar-app/main.py

Afficher sur GitHub

from typing import Any, Mapping

import flask
import functions_framework

# The ID of the slash command "/about".
# It's not enabled by default, set to the actual ID to enable it. You need to
# use the same ID as set in the Google Chat API configuration.
ABOUT_COMMAND_ID = ""

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Google Cloud Function that handles requests from Google Chat

  Args:
      flask.Request: the request

  Returns:
      Mapping[str, Any]: the response
  """
  if req.method == "GET":
    return "Hello! This function must be called from Google Chat."

  request_json = req.get_json(silent=True)

  # Checks for the presence of a slash command in the message.
  if "slashCommand" in request_json["message"]:
    # Executes the slash command logic based on its ID.
    # Slash command IDs are set in the Google Chat API configuration.
    if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
      return {
        "privateMessageViewer": request_json["user"],
        "text": 'The Avatar app replies to Google Chat messages.'
      }

  display_name = request_json["message"]["sender"]["displayName"]
  avatar = request_json["message"]["sender"]["avatarUrl"]
  response = create_message(name=display_name, image_url=avatar)
  return response


def create_message(name: str, image_url: str) -> Mapping[str, Any]:
  """Google Cloud Function that handles requests from Google Chat

  Args:
      str name: the sender's display name.
      str image_url: the URL for the sender's avatar.

  Returns:
      Mapping[str, Any]: a card with the user's avatar.
  """
  return {
    "text": "Here's your avatar",
    "cardsV2": [{
      "cardId": "avatarCard",
      "card": {
          "name": "Avatar Card",
          "header": { "title": f"Hello {name}!" },
          "sections": [{
            "widgets": [{
              "textParagraph": { "text": "Your avatar picture:" }
            }, {
              "image": { "imageUrl": image_url }
            }]
          }]
      }
    }]
  }

Cliquez sur Déployer.

Java

Dans la console Google Cloud, accédez à la page Cloud Functions.

Accéder à Cloud Functions

Assurez-vous que le projet de votre application Chat est sélectionné.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction :
1. Dans Environnement, sélectionnez Fonction Cloud Run.
2. Dans Nom de la fonction, saisissez QuickStartChatApp.
3. Dans Région, sélectionnez une région.
4. Sous "Authentification", sélectionnez Exiger l'authentification.
5. Cliquez sur Suivant.
Dans Environnement d'exécution, sélectionnez la version la plus récente de Java.
Dans Code source, sélectionnez Éditeur intégré.
Dans Point d'entrée, supprimez le texte par défaut et saisissez App.
src/main/java/com/example/Example.java a été renommé src/main/java/App.java.

Remplacez le contenu du fichier App.java par le code suivant :

java/avatar-app/src/main/java/App.java

Afficher sur GitHub

import java.util.List;

import com.google.api.services.chat.v1.model.CardWithId;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
import com.google.api.services.chat.v1.model.Message;
import com.google.api.services.chat.v1.model.User;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.JsonObject;

public class App implements HttpFunction {
  private static final Gson gson = new Gson();

  // The ID of the slash command "/about".
  // It's not enabled by default, set to the actual ID to enable it. You need to
  // use the same ID as set in the Google Chat API configuration.
  private static final String ABOUT_COMMAND_ID = "";

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);

    if (request.getMethod().equals("GET") || !body.has("message")) {
      response.getWriter().write("Hello! This function must be called from Google Chat.");
      return;
    }

    // Checks for the presence of a slash command in the message.
    if (body.getAsJsonObject("message").has("slashCommand")) {
      // Executes the slash command logic based on its ID.
      // Slash command IDs are set in the Google Chat API configuration.
      JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
      switch (slashCommand.get("commandId").getAsString()) {
        case ABOUT_COMMAND_ID:
          Message aboutMessage = new Message();
          aboutMessage.setText("The Avatar app replies to Google Chat messages.");
          aboutMessage.setPrivateMessageViewer(new User()
            .setName(body.getAsJsonObject("user").get("name").getAsString()));
          response.getWriter().write(gson.toJson(aboutMessage));
          return;
      }
    }

    JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
    String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
    String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
    Message message = createMessage(displayName, avatarUrl);
    response.getWriter().write(gson.toJson(message));
  }

  Message createMessage(String displayName, String avatarUrl) {
    return new Message()
      .setText("Here's your avatar")
      .setCardsV2(List.of(new CardWithId()
        .setCardId("previewLink")
        .setCard(new GoogleAppsCardV1Card()
          .setName("Avatar Card")
          .setHeader(new GoogleAppsCardV1CardHeader()
            .setTitle(String.format("Hello %s!", displayName)))
          .setSections(List.of(new GoogleAppsCardV1Section().setWidgets(List.of(
            new GoogleAppsCardV1Widget()
              .setTextParagraph(new GoogleAppsCardV1TextParagraph()
                .setText("Your avatar picture: ")),
            new GoogleAppsCardV1Widget()
              .setImage(new GoogleAppsCardV1Image().setImageUrl(avatarUrl)))))))));
  }
}

Remplacez le contenu du fichier pom.xml par le code suivant :

Java/avatar-app/pom.xml

Afficher sur GitHub

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.google.chat</groupId>
  <artifactId>avatar-app</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <maven.compiler.target>17</maven.compiler.target>
    <maven.compiler.source>17</maven.compiler.source>
  </properties>

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.0.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.9.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-chat</artifactId>
      <version>v1-rev20241008-2.0.0</version>
    </dependency>
  </dependencies>

  <!-- Required for Java 11 functions in the inline editor -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <excludes>
            <exclude>.google/</exclude>
          </excludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Cliquez sur Déployer.

La page des détails de Cloud Functions s'ouvre et votre fonction s'affiche avec deux indicateurs de progression: un pour la compilation et un pour le service. Lorsque les deux indicateurs de progression disparaissent et sont remplacés par une coche, votre fonction est déployée et prête.

Autoriser Google Chat à appeler votre fonction

Pour autoriser Google Chat à appeler votre fonction, ajoutez le compte de service Google Chat avec le rôle Demandeur Cloud Run.

Dans la console Google Cloud, accédez à la page Cloud Run :

Accédez à Cloud Run
Dans la liste des services Cloud Run, cochez la case à côté de la fonction de réception. (Ne cliquez pas directement sur la fonction.)
Cliquez sur Autorisations. Le panneau Autorisations s'ouvre.
Cliquez sur Ajouter un compte principal.
Dans Nouveaux comptes principaux, saisissez chat@system.gserviceaccount.com.
Dans Sélectionner un rôle, sélectionnez Cloud Run > Demandeur Cloud Run.
Cliquez sur Enregistrer.

Publier l'application dans Google Chat

Une fois la fonction Cloud déployée, procédez comme suit pour la transformer en application Google Chat:

Dans la console Google Cloud, cliquez sur Menu > Cloud Functions (Fonctions cloud).

Accéder à Cloud Functions

Vérifiez que le projet pour lequel vous avez activé Cloud Functions est sélectionné.
Dans la liste des fonctions, cliquez sur QuickStartChatApp.
Cliquez sur l'onglet Triggers (Déclencheurs).
Sous HTTPS, copiez l'URL.
Recherchez "API Google Chat", puis cliquez sur API Google Chat, puis sur Gérer.

Accéder à l'API Chat
Cliquez sur Configuration et configurez l'application Google Chat :
1. Dans le champ Nom de l'application, saisissez Quickstart App.
2. Dans URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
3. Dans Description, saisissez Quickstart 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 URL du point de terminaison HTTP et collez l'URL du déclencheur de la fonction Cloud dans le champ.
6. Dans Audience de l'authentification, sélectionnez URL du point de terminaison HTTP.
7. Sous Visibilité, sélectionnez Rendre cette application Google Chat accessible à certains utilisateurs et groupes de votre domaine, puis saisissez votre adresse e-mail.
8. Sous Journaux, sélectionnez Consigner les erreurs dans Logging.
Cliquez sur Enregistrer.

L'application Chat est prête à recevoir des messages et à y répondre dans Chat.

Tester votre application Chat

Pour tester votre application Chat, ouvrez un espace de message privé avec l'application Chat et envoyez un message:

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
Cliquez sur Nouveau chat.
Dans le champ Ajouter une ou plusieurs personnes, saisissez le nom de votre application Chat.
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.
Dans le nouveau message privé avec l'application, saisissez Hello, puis appuyez sur enter.

La réponse de l'application Chat contient un message sous forme de fiche qui affiche le nom et l'image de l'expéditeur, comme illustré dans l'image suivante:

Application de chat qui répond avec une fiche présentant le nom à afficher et l'avatar de l'expéditeur

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 "Une erreur s'est produite". 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.

Même s'il est possible 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 journaux sont disponibles pour vous aider à corriger les erreurs lorsque la journalisation des erreurs est activée pour les applications Chat. 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.

Dans la console Google Cloud, accédez à la page Gérer les ressources. Cliquez sur Menu > IAM et administration > Gérer les ressources.
Accéder à Resource Manager
Dans la liste des projets, sélectionnez celui que vous souhaitez supprimer, puis cliquez sur Supprimer .
Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

Articles associés

Pour ajouter des fonctionnalités à votre application Chat, consultez les pages suivantes:
Choisir une architecture d'application Chat
Valider les requêtes provenant de Google Chat