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 de chat HTTP. Il existe différentes manières d'implémenter cette architecture. Sur Google Cloud, Cloud Functions, Cloud Run et App Engine. Dans ce guide de démarrage rapide, vous allez d'écrire et de déployer 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 via HTTP, comme indiqué 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 interagissant avec un serveur L'application Chat comporte le flux d'informations suivant:

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

Cette architecture vous offre la flexibilité d'utiliser des bibliothèques et qui existent déjà dans votre système, Les applications de 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

Une entreprise Un compte Google Workspace ayant accès à Google Chat :
Un projet Google Cloud avec facturation activée. Pour vérifier si la facturation est activée sur un projet existant, consultez la section Vérifier le l'état de facturation de vos projets. Pour créer un projet et configurer la facturation, consultez Créez 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 l'API Google Chat, l'API Cloud Build, l'API Cloud Functions, les API Cloud Pub/Sub, Cloud Logging, Artifact Registry et Cloud Run.

Activer les API

Créer et déployer une fonction Cloud

Créer et déployer une fonction Cloud qui génère une fiche Chat avec le nom à afficher et l'avatar de l'expéditeur. Lorsque L'application de chat reçoit un message, 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 : 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ée.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction:
1. Dans Environnement, sélectionnez 2e génération.
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ée.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction:
1. Dans Environnement, sélectionnez 2e génération.
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ée.
Cliquez sur Créer une fonction.
Sur la page "Créer une fonction", configurez votre fonction:
1. Dans Environnement, sélectionnez 2e génération.
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.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:
        JsonObject aboutMessage = new JsonObject();
        aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
        aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
          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) {
    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;
  }
}

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

Cliquez sur Déployer.

La page des détails de Cloud Functions s'ouvre et votre fonction apparaît avec des indicateurs de progression: un pour la compilation et un pour le service. Lorsque les deux les 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 l'application disposant du 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 située à côté du champ . (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 sur 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.

Accéder à Cloud Functions

Vérifiez que le projet pour lequel vous avez activé Cloud Functions sélectionnée.
Dans la liste des fonctions, cliquez sur QuickStartChatApp.
Cliquez sur l'onglet Triggers (Déclencheurs).
Sous HTTPS, copiez l'URL.
Recherchez "API Google Chat" et 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 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 Fonctionnalité, sélectionnez Recevoir des messages privés. Rejoindre des espaces et des conversations de groupe
5. Sous Paramètres de connexion, sélectionnez URL de l'application et collez l'URL de le déclencheur Cloud Functions.
6. Dans Authentication Audience (Audience de l'authentification), sélectionnez App URL (URL de l'application).
7. Sous Visibilité, sélectionnez Rendre cette application Google Chat accessible à des personnes et groupes de votre domaine et 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 messages 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 à l'aide du compte Google Workspace que vous 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 direct message s'ouvre.

Remarque:Si vous ne voyez pas votre application Chat dans la liste vérifiez que vous avez inclus votre compte Google Workspace dans le Paramètres de visibilité de la configuration de l'API Chat de la console Google Cloud.
Dans le nouveau message privé avec l'application, saisissez Hello et appuyez sur enter

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

L'application Chat répond avec une fiche présentant le nom à afficher et l'avatar de l'expéditeur
image

Pour ajouter des testeurs de confiance et en savoir plus sur le test des fonctionnalités interactives, consultez Testez les fonctionnalités interactives pour Applications Google Chat

Résoudre les problèmes

Lorsqu'une application ou card renvoie une erreur, la L'interface Chat affiche le message "Une erreur s'est produite". ou "Impossible de traiter votre demande." Parfois, l'interface utilisateur de Chat n'affiche aucun message d'erreur, mais que l'application ou la carte produit un résultat inattendu. Par exemple, un message de fiche peut ne pas s'affichent.

Même s'il est possible qu'aucun message d'erreur ne s'affiche 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 obtenir de l'aide, le débogage et la correction des erreurs, consultez Résoudre les problèmes liés à Google Chat

Effectuer un nettoyage

Afin d'éviter que des frais ne soient facturés sur votre compte Google Cloud pour utilisées dans ce tutoriel, nous vous recommandons de supprimer Google 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 de projet (une URL sur appspot.com, par exemple), 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 à éviter de dépasser les limites de quota des projets.

Dans la console Google Cloud, accédez à la page Gérer les ressources. Cliquez sur Menu > IAM et Administrateur > Gérer les ressources.
<ph type="x-smartling-placeholder"></ph> Accéder au gestionnaire de ressources
Dans la liste des projets, sélectionnez celui que vous souhaitez supprimer, puis cliquez sur Supprimez .
Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour le supprimer. le projet.

Articles associés

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