Créer une application Google Chat HTTP

suivant suivant suivant

Cette page explique comment créer un module complémentaire Google Workspace qui fonctionne dans Google Chat à l'aide d'un service HTTP. Dans Google Chat, les modules complémentaires apparaissent aux utilisateurs comme des applications Google Chat. Pour en savoir plus, consultez la présentation de l'extension Google Chat.

Ce guide de démarrage rapide explique comment créer un service HTTP à l'aide des services Google Cloud. Pour créer l'application Chat, vous écrivez et déployez une fonction Cloud que l'application Chat utilise pour répondre au message d'un utilisateur.

Avec une architecture HTTP, 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:

  1. Un utilisateur envoie un message dans Chat à une application Chat, soit par message privé, soit 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 à 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).
  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 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.
  • Configurez un module complémentaire Google Workspace pour l'application Chat.
  • Tester 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, 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 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 Fonction Cloud Run.
    2. Dans le champ Nom de la fonction, saisissez AddOnChatApp.
    3. Dans Région, sélectionnez une région.
    4. Sous "Authentification", sélectionnez Exiger l'authentification.
    5. Cliquez sur Suivant.

  4. Dans Environnement d'exécution, sélectionnez la version la plus récente de Node.js.

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

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

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

    /**
 * 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.chat) {
        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 chatMessage = req.body.chat.messagePayload.message;

    // Replies with the sender's avatar in a card.
    const displayName = chatMessage.sender.displayName;
    const avatarUrl = chatMessage.sender.avatarUrl;
    res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        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 }
                    }]
                }]
            }
        }]
    }}}}});
};

  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 Environnement, sélectionnez Fonction Cloud Run.
    2. Dans le champ Nom de la fonction, saisissez AddOnChatApp.
    3. Dans Région, sélectionnez une région.
    4. Sous "Authentification", sélectionnez Exiger l'authentification.
    5. Cliquez sur Suivant.

  4. Dans Environnement d'exécution, sélectionnez la version la plus récente de Python.

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

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

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

    from typing import Any, Mapping

import flask
import functions_framework

@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)

    # Stores the Google Chat event as a variable.
    chat_message = request_json["chat"]["messagePayload"]["message"]

    # Replies with the sender's avatar in a card.
    display_name = chat_message["sender"]["displayName"]
    avatar_url = chat_message["sender"]["avatarUrl"]
    return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": { "message": {
        "text": "Here's your avatar",
        "cardsV2": [{
            "cardId": "avatarCard",
            "card": {
                "name": "Avatar Card",
                "header": { "title": f"Hello {display_name}!" },
                "sections": [{
                    "widgets": [{
                        "textParagraph": { "text": "Your avatar picture:" }
                    }, {
                        "image": { "imageUrl": avatar_url }
                    }]
                }]
            }
        }]
    }}}}}

  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 Environnement, sélectionnez Fonction Cloud Run.
    2. Dans le champ Nom de la fonction, saisissez AddOnChatApp.
    3. Dans Région, sélectionnez une région.
    4. Sous "Authentification", sélectionnez Exiger l'authentification.
    5. Cliquez sur Suivant.

  4. Dans Environnement d'exécution, sélectionnez la version la plus récente de Java.

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

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

  7. Renommez le fichier Java par défaut en src/main/java/AvatarApp.java.

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

    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.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 AvatarApp 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("chat")) {
            response.getWriter().write("Hello! This function is meant to be used " +
                "in a Google Chat Space..");
            return;
        }

        // Stores the Google Chat event as a variable.
        JsonObject chatMessage = body.getAsJsonObject("chat")
            .getAsJsonObject("messagePayload").getAsJsonObject("message");

        // Replies with the sender's avatar in a card.
        String displayName = chatMessage.getAsJsonObject("sender").get("displayName").getAsString();
        String avatarUrl = chatMessage.getAsJsonObject("sender").get("avatarUrl").getAsString();
        Message message = createMessage(displayName, avatarUrl);

        JsonObject createMessageAction = new JsonObject();
        createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));

        JsonObject chatDataAction = new JsonObject();
        chatDataAction.add("createMessageAction", createMessageAction);

        JsonObject hostAppDataAction = new JsonObject();
        hostAppDataAction.add("chatDataAction", chatDataAction);

        JsonObject dataActions = new JsonObject();
        dataActions.add("hostAppDataAction", hostAppDataAction);
        response.getWriter().write(gson.toJson(dataActions));
    }

    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("avatarCard");
        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 :

    <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.4</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 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 d'informations sur Cloud Functions s'ouvre, et votre fonction s'affiche avec deux indicateurs de progression: un pour le build 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 le module complémentaire Google Workspace à appeler votre fonction, ajoutez le compte de service du module complémentaire Google Workspace avec le rôle Demandeur Cloud Run.

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

    Accédez à Cloud Run

  2. 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.)

  3. Cliquez sur Autorisations. Le panneau Autorisations s'ouvre.

  4. Cliquez sur Ajouter un compte principal.

  5. Dans Nouveaux comptes principaux, saisissez l'adresse e-mail du compte de service du module complémentaire Google Workspace associé à votre projet.

  6. Dans Sélectionner un rôle, sélectionnez Cloud Run > Demandeur Cloud Run.

  7. Cliquez sur Enregistrer.

Configurer le module complémentaire

Une fois la fonction Cloud déployée, procédez comme suit pour créer un module complémentaire et déployer l'application Google Chat:

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

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

  3. Cliquez sur l'onglet Triggers (Déclencheurs).

  4. Sous HTTPS, copiez l'URL.

  5. Recherchez "API Google Chat", puis 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 Add-on Chat app.
    2. Dans URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. Dans Description, saisissez Add-on Chat 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 la zone.
    6. Dans Authentication Audience (Audience d'authentification), sélectionnez HTTP endpoint URL (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.

  7. Cliquez sur Enregistrer.

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

Tester votre application Chat

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

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

  2. Cliquez sur Nouveau chat.
  3. Dans le champ Ajouter une ou plusieurs personnes, saisissez le nom de votre application Chat.

  4. Sélectionnez votre application Chat dans les résultats. Un message privé s'ouvre.

  5. Dans le nouveau message privé avec l'application, saisissez Hello, puis appuyez sur enter.

Le message de l'application Chat contient une fiche qui affiche le nom et l'image de l'expéditeur, comme illustré dans l'image suivante:

Application Chat répondant avec une fiche comportant le nom à afficher et l&#39;image de l&#39;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 "Un problème s'est produit". 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.

Bien qu'un message d'erreur ne s'affiche pas dans l'UI Chat, des messages d'erreur descriptifs et des données de journal sont disponibles pour vous aider à résoudre les erreurs lorsque la journalisation des erreurs pour les applications Chat est activée. 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.

  1. Dans la console Google Cloud, accédez à la page Gérer les ressources. Cliquez sur Menu > IAM et administration > Gérer les ressources.

    Accédez au gestionnaire de ressources.

  2. Dans la liste des projets, sélectionnez celui que vous souhaitez supprimer, puis cliquez sur Supprimer .
  3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.