Créer une application de chat avec Google Cloud Functions

Cette page explique comment créer une application de chat et interagir avec elle à l'aide de Google Cloud Functions.

Pour créer l'application, vous devez écrire et déployer une fonction Cloud qu'elle utilise pour traiter une réponse à un événement de message depuis Google Chat. La réponse est une fiche qui affiche le nom de l'expéditeur et l'image de l'avatar, comme illustré dans l'image suivante:

Application de chat répondant avec une fiche incluant le nom à afficher et l'avatar de l'expéditeur

Objectifs

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

Prérequis

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 et Cloud Pub/Sub.

    Activer les API

Créer et déployer une fonction Cloud

Créez et déployez une fonction Cloud qui génère une carte Chat avec le nom à afficher et l'image d'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 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.

      Pour en savoir plus sur l'authentification dans Google Workspace, consultez Authentifier et autoriser les applications de chat et les requêtes API.

    4. Cliquez sur Enregistrer.

    5. Cliquez sur Suivant.

  4. Dans Environnement d'exécution, sélectionnez Node.js 10.

  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 :

    nœud/avatar-bot/index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Hangouts Chat room.
     *
     * @param {Object} req Request sent from Hangouts 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 Hangouts 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 {
        cardsV2: [{
          cardId: 'avatarCard',
          card: {
            name: 'Avatar Card',
            header: cardHeader,
            sections: [avatarSection],
          }
        }],
      };
    }

  8. Cliquez sur 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 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.

      Pour en savoir plus sur l'authentification dans Google Workspace, consultez Authentifier et autoriser les applications de chat et les requêtes API.

    4. Cliquez sur Enregistrer.

    5. Cliquez sur Suivant.

  4. Dans 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-bot/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 = {
          "cardsV2": [
              {
                  "cardId": "avatarCard",
                  "card": {
                      "name": "Avatar Card",
                      "header": header,
                      "sections": [avatar_section],
                  },
              }
          ]
      }
    
      return cards
    
    

  8. Cliquez sur 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 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.

      Pour en savoir plus sur l'authentification dans Google Workspace, consultez Authentifier et autoriser les requêtes d'application et d'API Chat.

    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-bot/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.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

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

    java/avatar-bot/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 Déployer.

La page Cloud Functions s'ouvre, et un indicateur de progression du déploiement s'affiche à côté du nom de la fonction. Lorsque l'indicateur de progression disparaît et qu'une coche apparaît, cela signifie que votre fonction est déployée.

Publier l'application sur 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 des détails de la fonction, cliquez sur Déclencheur.

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

  5. Recherchez l'API Google Chat, puis cliquez sur API Google Chat.

  6. Cliquez sur Gérer.

  7. Cliquez sur Configuration et configurez l'application Google Chat:

    1. Dans le champ Nom de l'application, saisissez Quickstart App.
    2. Dans le champ URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. Dans Description, saisissez Quickstart app.
    4. Sous Fonctionnement, sélectionnez Recevoir des messages privés, Rejoindre des espaces et des conversations de groupe, et Consigner les erreurs dans Cloud Logging.
    5. Sous Paramètres de connexion, sélectionnez URL de l'application et collez dans le champ l'URL du déclencheur de la fonction Cloud.
    6. Sous Autorisations, sélectionnez Personnes et groupes spécifiques dans votre domaine, puis saisissez votre adresse e-mail.
  8. Cliquez sur Enregistrer.

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

Tester votre application Chat

Pour tester votre application Chat, envoyez un message privé:

  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 Rechercher des applications, recherchez "Application de démarrage rapide".
  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 et appuyez sur enter.

L'application affiche une carte contenant le nom à afficher et l'image de votre avatar.

Étapes suivantes

Pour résoudre les problèmes et déboguer votre application Chat, consultez ces pages:

  • Lorsque vous créez l'application Chat, vous pouvez être amené à la déboguer en lisant les journaux d'erreurs de l'application. Pour lire les journaux, accédez à l'explorateur de journaux dans la console Google Cloud.
  • Résoudre les problèmes

Pour ajouter des fonctionnalités à l'application Chat, consultez les guides suivants:

  • Créez des fiches interactives : les messages des fiches acceptent une mise en page définie, des éléments d'interface utilisateur interactifs tels que des boutons, et des éléments rich media tels que des images. Les messages de fiche présentent des informations détaillées, recueillent les informations des utilisateurs et les guident dans la prochaine étape.
  • Prise en charge des commandes à barre oblique : les commandes à barre oblique vous permettent d'enregistrer et d'annoncer des commandes spécifiques que les utilisateurs peuvent fournir à votre application en saisissant une commande commençant par une barre oblique (/), comme /help.
  • Lancement des boîtes de dialogue : les boîtes de dialogue sont des interfaces encadrées et basées sur des cartes que votre application peut ouvrir pour interagir avec un utilisateur. Plusieurs fiches peuvent être regroupées ensemble, ce qui permet aux utilisateurs de réaliser des processus en plusieurs étapes, comme le remplissage des données de formulaire.

Pour en savoir plus sur l'API Google Chat, consultez la documentation de référence.