Creare un'app Google Chat HTTP

Questa pagina spiega come creare un'app di chat HTTP. Esistono diversi modi per implementare questa architettura. Su Google Cloud puoi utilizzare Cloud Run e App Engine. In questa guida rapida, scrivi ed esegui il deployment di una funzione Cloud Run che l'app Chat utilizza per rispondere al messaggio di un utente.

Con questa architettura, configuri Chat in modo che si integri con Google Cloud o un server on-premise utilizzando HTTP, come mostrato nel seguente diagramma:

Architettura di un'app di chat che utilizza un servizio web in un server on-premise.

Nel diagramma precedente, un utente che interagisce con un'app di chat HTTP ha il seguente flusso di informazioni:

Un utente invia un messaggio in Chat a un'app di chat, tramite un messaggio diretto o in uno spazio di Chat.
Viene inviata una richiesta HTTP a un server web, che è un sistema cloud o on-premise che contiene la logica dell'app di chat.
Se vuoi, la logica dell'app di chat può integrarsi con i servizi Google Workspace (come Calendar e Fogli), altri servizi Google (come Maps, YouTube e Vertex AI) o altri servizi web (come un sistema di gestione dei progetti o uno strumento di gestione dei ticket).
Il server web invia una risposta HTTP al servizio dell'app di Chat in Chat.
La risposta viene inviata all'utente.
Se vuoi, l'app di Chat può chiamare l'API Chat per pubblicare messaggi in modo asincrono o eseguire altre operazioni.

Questa architettura ti offre la flessibilità di utilizzare librerie e componenti esistenti già presenti nel tuo sistema, perché queste app di Chat possono essere progettate utilizzando linguaggi di programmazione diversi.

Obiettivi

Configurare l'ambiente.
Creare ed eseguire il deployment di una funzione Cloud Run.
Pubblicare l'app su Chat.
Testare l'app.

Prerequisiti

Un account Google Workspace Business o Enterprise con accesso a Google Chat.
Un progetto Google Cloud con la fatturazione abilitata. Per verificare che la fatturazione sia abilitata per un progetto esistente, consulta Verifica lo stato di fatturazione dei progetti. Per creare un progetto e configurare la fatturazione, consulta Crea un progetto Google Cloud.

Configurare l'ambiente

Prima di utilizzare le API di Google, devi attivarle in un progetto Google Cloud. Puoi attivare una o più API in un singolo progetto Google Cloud.

Nella console API di Google, abilita l'API Google Chat, l'API Cloud Build, l'API Cloud Functions, l'API Cloud Pub/Sub, l'API Cloud Logging, l'API Artifact Registry e l'API Cloud Run.

Abilita le API

Creare ed eseguire il deployment di una funzione Cloud Run

Crea ed esegui il deployment di una funzione Cloud Run che genera una scheda di chat con il nome visualizzato e l'immagine dell'avatar del mittente. Quando l'app di Chat riceve un messaggio, esegue la funzione e risponde con la scheda.

Per creare ed eseguire il deployment della funzione per la tua app di Chat, completa i seguenti passaggi:

Node.js

Nella console API di Google, vai alla pagina Cloud Run:

Vai a Cloud Run

Assicurati che il progetto per l'app di Chat sia selezionato.
Fai clic su Scrivi una funzione.
Nella pagina Crea servizio, configura la funzione:
1. Nel campo Nome servizio, inserisci quickstartchatapp.
2. Nell'elenco Regione, seleziona una regione.
3. Nell'elenco Runtime, seleziona la versione più recente di Node.js.
4. Nella sezione Autenticazione, seleziona Richiedi autenticazione.
5. Fai clic su Crea e attendi che Cloud Run crei il servizio. La console ti reindirizza alla scheda Origine.

Nella scheda Origine:

In Punto di ingresso, elimina il testo predefinito e inserisci avatarApp.

Sostituisci i contenuti di index.js con il seguente codice:

node/avatar-app/index.js

Visualizza su GitHub

const functions = require('@google-cloud/functions-framework');

// Command IDs (configure these in Google Chat API)
const ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
const HELP_COMMAND_ID = 2; // ID for the "Help" quick command

/**
 * Google Cloud Function that handles HTTP requests from Google Chat.
 *
 * @param {Object} req - The HTTP request object sent from Google Chat.
 * @param {Object} res - The HTTP response object.
 */
functions.http('avatarApp', (req, res) => {
  const event = req.body;

  if (event.appCommandMetadata) {
    handleAppCommands(event, res);
  } else {
    handleRegularMessage(event, res);
  }
});

/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

/**
 * Handles regular messages (not commands).
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleRegularMessage(event, res) {
  const messageData = createMessage(event.user);
  res.send(messageData);
}

/**
 * Creates a card message with the user's avatar.
 *
 * @param {Object} user - The user who sent the message.
 * @param {string} user.displayName - The user's display name.
 * @param {string} user.avatarUrl - The URL of the user's avatar.
 * @return {Object} - The card message object.
 */
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}},
          ],
        }],
      },
    }],
  };
}

Fai clic su Salva ed esegui di nuovo il deployment.

Python

Nella console API di Google, vai alla pagina Cloud Run:

Vai a Cloud Run

Assicurati che il progetto per l'app di Chat sia selezionato.
Fai clic su Scrivi una funzione.
Nella pagina Crea servizio, configura la funzione:
1. Nel campo Nome servizio, inserisci quickstartchatapp.
2. Nell'elenco Regione, seleziona una regione.
3. Nell'elenco Runtime, seleziona la versione più recente di Python.
4. Nella sezione Autenticazione, seleziona Richiedi autenticazione.
5. Fai clic su Crea e attendi che Cloud Run crei il servizio. La console ti reindirizza alla scheda Origine.

Nella scheda Origine:

In Punto di ingresso, elimina il testo predefinito e inserisci avatar_app.

Sostituisci i contenuti di main.py con il seguente codice:

python/avatar-app/main.py

Visualizza su GitHub

from typing import Any, Mapping

import flask
import functions_framework

# Command IDs (configure these in Google Chat API)
ABOUT_COMMAND_ID = 1  # ID for the "/about" slash command
HELP_COMMAND_ID = 2  # ID for the "Help" quick command


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

    Args:
        flask.Request: the request

    Returns:
        Mapping[str, Any]: the response
    """
    event = req.get_json(silent=True)

    if event and "appCommandMetadata" in event:
        return handle_app_commands(event)
    else:
        return handle_regular_message(event)


def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}




def handle_regular_message(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles regular messages (not commands).

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """

    if not event or "user" not in event:
        return "Invalid request."

    message_data = create_message(event["user"])
    return message_data


def create_message(user: Mapping[str, Any]) -> Mapping[str, Any]:
    """Creates a card message with the user's avatar.

    Args:
        Mapping[str, Any] user: The user who sent the message.

    Returns:
        Mapping[str, Any]: a card with the user's avatar.
    """
    display_name = user.get("displayName", "")
    avatar_url = user.get("avatarUrl", "")

    return {
        "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}},
                            ]
                        }
                    ],
                },
            }
        ],
    }

Fai clic su Salva ed esegui di nuovo il deployment.

Java

Nella console API di Google, vai alla pagina Cloud Run:

Vai a Cloud Run

Assicurati che il progetto per l'app di Chat sia selezionato.
Fai clic su Scrivi una funzione.
Nella pagina Crea servizio, configura la funzione:
1. Nel campo Nome servizio, inserisci quickstartchatapp.
2. Nell'elenco Regione, seleziona una regione.
3. Nell'elenco Runtime, seleziona la versione più recente di Java.
4. Nella sezione Autenticazione, seleziona Richiedi autenticazione.
5. Fai clic su Crea e attendi che Cloud Run crei il servizio. La console ti reindirizza alla scheda Origine.

Nella scheda Origine:

In Punto di ingresso, elimina il testo predefinito e inserisci App.
Rinomina src/main/java/com/example/Example.java in src/main/java/AvatarApp.java.

Sostituisci i contenuti di AvatarApp.java con il seguente codice:

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

Visualizza su GitHub

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;
import java.util.List;

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

  // Command IDs (configure these in Google Chat API)
  private static final int ABOUT_COMMAND_ID = 1; // ID for the "/about" slash command
  private static final int HELP_COMMAND_ID = 2; // ID for the "Help" quick command

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

    if (event.has("appCommandMetadata")) {
      handleAppCommands(event, response);
    } else {
      handleRegularMessage(event, response);
    }
  }

  /**
   * Handles slash and quick commands.
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
    int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

    switch (appCommandId) {
      case ABOUT_COMMAND_ID:
        Message aboutMessage = new Message();
        aboutMessage.setText("The Avatar app replies to Google Chat messages.");
        aboutMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(aboutMessage));
        return;
      case HELP_COMMAND_ID:
        Message helpMessage = new Message();
        helpMessage.setText("The Avatar app replies to Google Chat messages.");
        helpMessage.setPrivateMessageViewer(new User()
            .setName(event.getAsJsonObject("user").get("name").getAsString()));
        response.getWriter().write(gson.toJson(helpMessage));
        return;
    }
  }

  /**
   * Handles regular messages (not commands).
   *
   * @param event    The Google Chat event.
   * @param response The HTTP response object.
   */
  private void handleRegularMessage(JsonObject event, HttpResponse response) throws Exception {

    if (!event.has("user")) {
      response.getWriter().write("Invalid request.");
      return;
    }

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

  /**
   * Creates a card message with the user's avatar.
   *
   * @param displayName The user's display name.
   * @param avatarUrl   The URL of the user's avatar.
   * @return The card message object.
   */
  private Message createMessage(String displayName, String avatarUrl) {
    return new Message()
        .setText("Here's your avatar")
        .setCardsV2(List.of(new CardWithId()
            .setCardId("avatarCard")
            .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)))))))));
  }
}

Sostituisci i contenuti di pom.xml con il seguente codice:

java/avatar-app/pom.xml

Visualizza su 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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>gcfv2</groupId>
  <artifactId>avatar-app</artifactId>
  <version>0.0.1</version>
  <name>Avatar App</name>

  <properties>
    <maven.compiler.release>21</maven.compiler.release>
  </properties>

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

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.12.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-rev20250116-2.0.0</version>
    </dependency>

  </dependencies>

</project>

Fai clic su Salva ed esegui di nuovo il deployment.

Autorizzare Google Chat a richiamare la funzione

Per autorizzare Google Chat a richiamare la funzione, aggiungi il service account di Google Chat con il ruolo Invoker di Cloud Run.

Nella console API di Google, vai alla pagina Cloud Run:

Vai a Cloud Run
Nell'elenco dei servizi Cloud Run, seleziona la casella di controllo accanto alla funzione di ricezione. (Non fare clic sulla funzione stessa.)
Fai clic su Autorizzazioni. Si apre il riquadro Autorizzazioni.
Fai clic su Aggiungi entità.
In Nuove entità, inserisci chat@system.gserviceaccount.com.
In Seleziona un ruolo, seleziona Cloud Run > Invoker di Cloud Run.
Fai clic su Salva.

Configurare l'app di Chat

Dopo aver eseguito il deployment della funzione Cloud Run, segui questi passaggi per trasformarla in un'app Google Chat:

Nella console API di Google, vai alla pagina Cloud Run:

Vai a Cloud Run

Assicurati che sia selezionato il progetto per il quale hai attivato Cloud Run.
Nell'elenco dei servizi, fai clic su quickstartchatapp.
Nella pagina Dettagli servizio, copia l'URL della funzione.
Cerca "API Google Chat", fai clic su API Google Chat e poi su Gestisci.

Vai all'API Chat
Fai clic su Configurazione e configura l'app Google Chat:
1. Deseleziona Crea questa app di chat come componente aggiuntivo di Google Workspace. Si apre una finestra di dialogo in cui ti viene chiesto di confermare. Nella finestra di dialogo, fai clic su Disattiva.
2. In Nome app, inserisci Quickstart App.
3. In URL avatar, inserisci https://developers.google.com/chat/images/quickstart-app-avatar.png.
4. In Descrizione, inserisci Quickstart app.
5. In Funzionalità, seleziona Partecipa a spazi e conversazioni di gruppo.
6. In Impostazioni di connessione, seleziona URL endpoint HTTP.
7. In Trigger, seleziona Utilizza un URL dell'endpoint HTTP comune per tutti i trigger e incolla l'URL del trigger della funzione Cloud Run nella casella.
8. In Visibilità, seleziona Rendi disponibile l'app di chat a utenti e gruppi specifici nel tuo dominio e inserisci il tuo indirizzo email.
9. In Log, seleziona Registra gli errori in Logging.
Fai clic su Salva.

L'app di Chat è pronta a ricevere e rispondere ai messaggi su Chat.

Testare l'app di Chat

Per testare l'app di Chat, apri uno spazio di messaggi diretti con l'app di Chat e invia un messaggio:

Apri Google Chat utilizzando l'account Google Workspace che hai fornito quando ti sei aggiunto come tester di fiducia.

Vai a Google Chat
Fai clic su Nuova chat.
Nel campo Aggiungi una o più persone, digita il nome della tua app di Chat.
Seleziona l'app di Chat dai risultati. Si apre un messaggio diretto.

Nota: se non vedi la tua app di Chat nell'elenco dei risultati, assicurati di aver incluso il tuo account Google Workspace nelle impostazioni di visibilità della pagina di configurazione dell'API Chat nella console API di Google.
Nel nuovo messaggio diretto con l'app, digita Hello e premi enter.

La risposta dell'app di Chat contiene un messaggio con scheda che mostra il nome e l'immagine dell'avatar del mittente, come illustrato nell' immagine seguente:

L'app di chat risponde con una scheda contenente il nome visualizzato e l'immagine dell'avatar del mittente

Per aggiungere tester di fiducia e scoprire di più sui test delle funzionalità interattive, consulta Testare le funzionalità interattive per le app Google Chat.

Risoluzione dei problemi

Quando un'app o scheda di Google Chat restituisce un errore, l' interfaccia di Chat mostra un messaggio che indica che si è verificato un problema. o "Impossibile elaborare la richiesta." A volte l'interfaccia utente di Chat non mostra alcun messaggio di errore, ma l'app o la scheda di Chat produce un risultato imprevisto; ad esempio, un messaggio con scheda potrebbe non essere visualizzato.

Anche se un messaggio di errore potrebbe non essere visualizzato nell'interfaccia utente di Chat, sono disponibili messaggi di errore descrittivi e dati di log per aiutarti a correggere gli errori quando la registrazione degli errori per le app di Chat è attivata. Per assistenza nella visualizzazione, nel debug e nella correzione degli errori, consulta Risolvere e correggere gli errori di Google Chat.

Libera spazio

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, ti consigliamo di eliminare il progetto Cloud.

Nella console API di Google, vai alla pagina Gestisci risorse. Fai clic su Menu > IAM e amministrazione > Gestisci risorse.
Vai a Resource Manager
Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare e poi fai clic su Elimina .
Nella finestra di dialogo, digita l'ID progetto, quindi fai clic su Chiudi per eliminare il progetto.

Argomenti correlati

Per aggiungere altre funzionalità alla tua app di Chat, consulta le seguenti sezioni:
Scegliere un'architettura dell'app di Chat
Verificare le richieste di Google Chat

Creare un'app Google Chat HTTP Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Obiettivi

Prerequisiti

Configurare l'ambiente

Creare ed eseguire il deployment di una funzione Cloud Run

Node.js

Python

Java

Autorizzare Google Chat a richiamare la funzione

Configurare l'app di Chat

Testare l'app di Chat

Risoluzione dei problemi

Libera spazio

Argomenti correlati

Creare un'app Google Chat HTTP