Créer une application Google Chat HTTP avec Cloud Functions

Cette page explique comment créer une application de chat HTTP. Il existe différentes manières de mettre en œuvre cette architecture. Sur Google Cloud, vous pouvez utiliser Cloud Functions, Cloud Run et App Engine. Dans ce guide de démarrage rapide, vous allez rédiger 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 du protocole HTTP, comme illustré dans le schéma suivant:

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

Dans le schéma précédent, un utilisateur qui interagit avec une application de chat HTTP présente le flux d'informations suivant:

  1. Un utilisateur envoie un message dans Chat à une application Chat, dans un message privé ou dans un espace Chat.
  2. 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.
  3. La logique de l'application Chat peut éventuellement s'intégrer aux services Google Workspace (tels qu'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 billetterie).
  4. Le serveur Web renvoie une réponse HTTP au service de l'application Chat dans Chat.
  5. La réponse est transmise à l'utilisateur.
  6. 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 des bibliothèques et des composants existants qui existent déjà dans votre système, car ces applications Chat peuvent être conçues à l'aide de différents langages de programmation.

Objectifs

  • configurer votre environnement ;
  • Créer et déployer une fonction Cloud
  • Publiez l'application dans Chat.
  • Testez l'application.

Prérequis

  • Un compte Google Workspace ayant accès à Google Chat dans une organisation Google Workspace autorisant les appels de fonctions Google Cloud non authentifiés

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'avatar de l'expéditeur. Lorsque l'application Chat reçoit un message, elle exécute la fonction et répond avec la carte.

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

Node.js

  1. 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é.

  2. Cliquez sur Créer une fonction.

  3. Sur la page "Créer une fonction", configurez votre fonction:

    1. Dans Environnement, sélectionnez 2e génération.
    2. Dans le champ Nom de la fonction, saisissez QuickStartChatApp.
    3. Dans Région, sélectionnez une région.
    4. Sous "Authentification", sélectionnez Autoriser les appels non authentifiés.
    5. Cliquez sur Suivant.
  4. Dans le champ Environnement d'exécution, sélectionnez Node.js 20.

  5. Dans Code source, sélectionnez Éditeur intégré.

  6. Dans Point d'entrée, supprimez le texte par défaut et saisissez helloChat.

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

    node/avatar-app/index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Google Chat room.
     *
     * @param {Object} req Request sent from Google Chat room
     * @param {Object} res Response to send back
     */
    exports.helloChat = function helloChat(req, res) {
      if (req.method === 'GET' || !req.body.message) {
        res.send('Hello! This function is meant to be used in a Google Chat ' +
          'Room.');
      }
    
      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} imageUrl the URL for the sender's avatar
     * @return {Object} a card with the user's avatar.
     */
    function createMessage(displayName, imageUrl) {
      const cardHeader = {
        title: `Hello ${displayName}!`,
      };
    
      const avatarWidget = {
        textParagraph: {text: 'Your avatar picture: '},
      };
    
      const avatarImageWidget = {
        image: {imageUrl},
      };
    
      const avatarSection = {
        widgets: [
          avatarWidget,
          avatarImageWidget,
        ],
      };
    
      return {
        text: 'Here\'s your avatar',
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. Cliquez sur Deploy (Déployer).

Python

  1. 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é.

  2. Cliquez sur Créer une fonction.

  3. Sur la page "Créer une fonction", configurez votre fonction:

    1. Dans le champ Nom de la fonction, saisissez QuickStartChatApp.
    2. Dans Type de déclencheur, sélectionnez HTTP.
    3. Sous "Authentification", sélectionnez Autoriser les appels non authentifiés.
    4. Cliquez sur Enregistrer.
    5. Cliquez sur Suivant.
  4. Dans le champ Environnement d'exécution, sélectionnez Python 3.10.

  5. Dans Code source, sélectionnez Éditeur intégré.

  6. Dans Point d'entrée, supprimez le texte par défaut et saisissez hello_chat.

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

    python/avatar-app/main.py
    from typing import Any, Mapping
    
    import flask
    import functions_framework
    
    
    # Google Cloud Function that responds to messages sent in
    # Google Chat.
    #
    # @param {Object} req Request sent from Google Chat.
    # @param {Object} res Response to send back.
    @functions_framework.http
    def hello_chat(req: flask.Request) -> Mapping[str, Any]:
      if req.method == "GET":
        return "Hello! This function must be called from Google Chat."
    
      request_json = req.get_json(silent=True)
    
      display_name = request_json["message"]["sender"]["displayName"]
      avatar = request_json["message"]["sender"]["avatarUrl"]
    
      response = create_message(name=display_name, image_url=avatar)
    
      return response
    
    
    # Creates a card with two widgets.
    # @param {string} name the sender's display name.
    # @param {string} image_url the URL for the sender's avatar.
    # @return {Object} a card with the user's avatar.
    def create_message(name: str, image_url: str) -> Mapping[str, Any]:
      avatar_image_widget = {"image": {"imageUrl": image_url}}
      avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
      avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}
    
      header = {"title": f"Hello {name}!"}
    
      cards = {
          "text": "Here's your avatar",
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards

  8. Cliquez sur Deploy (Déployer).

Java

  1. 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é.

  2. Cliquez sur Créer une fonction.

  3. Sur la page "Créer une fonction", configurez votre fonction:

    1. Dans le champ Nom de la fonction, saisissez QuickStartChatApp.
    2. Dans Type de déclencheur, sélectionnez HTTP.
    3. Sous "Authentification", sélectionnez Autoriser les appels non authentifiés.
    4. Cliquez sur Enregistrer.
    5. Cliquez sur Suivant.
  4. Dans Environnement d'exécution, sélectionnez Java 11.

  5. Dans Code source, sélectionnez Éditeur intégré.

  6. Dans Point d'entrée, supprimez le texte par défaut et saisissez HelloChat.

  7. src/main/java/com/example/Example.java a été renommé src/main/java/HelloChat.java.

  8. Remplacez le contenu du fichier HelloChat.java par le code suivant :

    java/avatar-app/src/main/java/HelloChat.java
    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.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;
    import java.util.List;
    
    public class HelloChat implements HttpFunction {
      private static final Gson gson = new Gson();
    
      @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;
        }
    
        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) {
        GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
        cardHeader.setTitle(String.format("Hello %s!", displayName));
    
        GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
        textParagraph.setText("Your avatar picture: ");
    
        GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
        avatarWidget.setTextParagraph(textParagraph);
    
        GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
        image.setImageUrl(avatarUrl);
    
        GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
        avatarImageWidget.setImage(image);
    
        GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
        section.setWidgets(List.of(avatarWidget, avatarImageWidget));
    
        GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
        card.setName("Avatar Card");
        card.setHeader(cardHeader);
        card.setSections(List.of(section));
    
        CardWithId cardWithId = new CardWithId();
        cardWithId.setCardId("previewLink");
        cardWithId.setCard(card);
    
        Message message = new Message();
        message.setText("Here's your avatar");
        message.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

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

    java/avatar-app/pom.xml
    <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>cloudfunctions</groupId>
      <artifactId>http-function</artifactId>
      <version>1.0-SNAPSHOT</version>
    
      <properties>
        <maven.compiler.target>11</maven.compiler.target>
        <maven.compiler.source>11</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-rev20230115-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>

  10. Cliquez sur Deploy (Déployer).

La page d'informations 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.

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:

  1. Dans la console Google Cloud, cliquez sur Menu > Cloud Functions.

    Accéder à Cloud Functions

    Assurez-vous que le projet pour lequel vous avez activé Cloud Functions est sélectionné.

  2. Dans la liste des fonctions, cliquez sur QuickStartChatApp.

  3. Sur la page d'informations de la fonction, cliquez sur Déclencheur.

  4. Sous URL du déclencheur, copiez l'URL.

  5. Recherchez "API Google Chat" et cliquez sur API Google Chat, puis sur Gérer.

    Accéder à l'API Chat

  6. 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 de l'application et collez l'URL du déclencheur de la fonction Cloud dans le champ.
    6. Sous Visibilité, sélectionnez Rendre cette application Google Chat disponible pour des personnes et des groupes spécifiques de votre domaine et saisissez votre adresse e-mail.
    7. Sous Journaux, sélectionnez Consigner les erreurs dans Logging.
  7. 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, envoyez un message privé à l'application:

  1. Ouvrez Google Chat.
  2. Pour envoyer un message privé à l'application, cliquez sur Démarrer une discussion , puis sur Rechercher des applications dans la fenêtre qui s'affiche.
  3. Dans la boîte de dialogue Find apps (Rechercher des applications), recherchez Quickstart App.
  4. Pour ouvrir un message privé avec l'application, recherchez l'application de démarrage rapide, puis cliquez sur Ajouter > Chat.
  5. Dans le message privé, 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'avatar de l'expéditeur, comme illustré dans l'image suivante:

Application de chat répondant avec une carte sur laquelle figure le nom à afficher et l&#39;avatar de l&#39;expéditeur

Pour ajouter des testeurs de confiance et en savoir plus sur le test des fonctionnalités interactives, consultez la page Tester les fonctionnalités interactives pour les applications Google Chat.

Résoudre les erreurs

Pour dépanner et déboguer votre application Chat, consultez Résoudre les problèmes liés à l'application Google Chat.