Creare un'app Google Chat HTTP con Cloud Functions

Questa pagina spiega come creare un'app di chat HTTP. Esistono diversi modi per implementare questa architettura. In Google Cloud, puoi utilizzare Cloud Functions, Cloud Run e App Engine. In questa guida rapida, scriverai ed eseguirai il deployment di una funzione Cloud Functions utilizzata dall'app Chat per rispondere al messaggio di un utente.

Con questa architettura, puoi configurare Chat per l'integrazione con Google Cloud o un server on-premise mediante HTTP, come mostrato nel diagramma seguente:

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 prevede il seguente flusso di informazioni:

  1. Un utente invia un messaggio in Chat a un'app Chat, in un messaggio diretto o in uno spazio di Chat.
  2. Una richiesta HTTP viene inviata a un server web che è un sistema cloud o on-premise che contiene la logica dell'app Chat.
  3. Facoltativamente, la logica dell'app 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).
  4. Il server web invia una risposta HTTP al servizio app Chat in Chat.
  5. La risposta viene recapitata all'utente.
  6. Facoltativamente, l'app Chat può chiamare l'API Chat per pubblicare i messaggi in modo asincrono o eseguire altre operazioni.

Questa architettura offre la flessibilità di utilizzare librerie e componenti esistenti già presenti nel tuo sistema, poiché 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 Functions.
  • Pubblicare l'app in Chat.
  • Testa l'app.

Prerequisiti

  • Un account Google Workspace con accesso a Google Chat in un'organizzazione Google Workspace che consente chiamate di funzioni Google Cloud Functions non autenticate.

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 Google Cloud, 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

Crea ed esegui il deployment di una funzione Cloud

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

Per creare ed eseguire il deployment della funzione per l'app di chat, completa questi passaggi:

Node.js

  1. Nella console Google Cloud, vai alla pagina Cloud Functions:

    Vai a Cloud Functions

    Assicurati che sia selezionato il progetto per l'app di Chat.

  2. Fai clic su Crea funzione.

  3. Nella pagina Crea funzione, configura la funzione:

    1. In Ambiente, seleziona 2a generazione.
    2. In Nome funzione, inserisci QuickStartChatApp.
    3. In Regione, seleziona una regione.
    4. In Autenticazione, seleziona Consenti chiamate non autenticate.
    5. Tocca Next (Avanti).
  4. In Runtime, seleziona Node.js 20.

  5. In Codice sorgente, seleziona Editor incorporato.

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

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

    nodo/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. Fai clic su Esegui il deployment.

Python

  1. Nella console Google Cloud, vai alla pagina Cloud Functions:

    Vai a Cloud Functions

    Assicurati che sia selezionato il progetto per l'app di Chat.

  2. Fai clic su Crea funzione.

  3. Nella pagina Crea funzione, configura la funzione:

    1. In Nome funzione, inserisci QuickStartChatApp.
    2. In Tipo di trigger, seleziona HTTP.
    3. In Autenticazione, seleziona Consenti chiamate non autenticate.
    4. Fai clic su Salva.
    5. Tocca Next (Avanti).
  4. In Runtime, seleziona Python 3.10.

  5. In Codice sorgente, seleziona Editor incorporato.

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

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

    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. Fai clic su Esegui il deployment.

Java

  1. Nella console Google Cloud, vai alla pagina Cloud Functions:

    Vai a Cloud Functions

    Assicurati che sia selezionato il progetto per l'app di Chat.

  2. Fai clic su Crea funzione.

  3. Nella pagina Crea funzione, configura la funzione:

    1. In Nome funzione, inserisci QuickStartChatApp.
    2. In Tipo di trigger, seleziona HTTP.
    3. In Autenticazione, seleziona Consenti chiamate non autenticate.
    4. Fai clic su Salva.
    5. Tocca Next (Avanti).
  4. In Runtime, seleziona Java 11.

  5. In Codice sorgente, seleziona Editor incorporato.

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

  7. Rinomina src/main/java/com/example/Example.java in src/main/java/HelloChat.java.

  8. Sostituisci i contenuti di HelloChat.java con il seguente codice:

    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. Sostituisci i contenuti di pom.xml con il seguente codice:

    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. Fai clic su Esegui il deployment.

Si apre la pagina dei dettagli di Cloud Functions e la funzione viene visualizzata con due indicatori di avanzamento: uno per la build e uno per il servizio. Quando entrambi gli indicatori di avanzamento scompaiono e vengono sostituiti da un segno di spunta, il deployment della funzione è stato eseguito ed è pronta.

Pubblicare l'app su Google Chat

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

  1. Nella console Google Cloud, fai clic su Menu > Cloud Functions.

    Vai a Cloud Functions

    Assicurati che sia selezionato il progetto per cui hai abilitato Cloud Functions.

  2. Nell'elenco delle funzioni, fai clic su QuickStartChatApp.

  3. Nella pagina dei dettagli della funzione, fai clic su Attivatore.

  4. In URL trigger, copia l'URL.

  5. Cerca "API Google Chat" e fai clic su API Google Chat, quindi fai clic su Gestisci.

    Vai all'API Chat

  6. Fai clic su Configurazione e configura l'app Google Chat:

    1. In Nome app, inserisci Quickstart App.
    2. In URL avatar, inserisci https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. In Descrizione, inserisci Quickstart app.
    4. In Funzionalità, seleziona Ricevi messaggi 1:1 e Partecipa a spazi e conversazioni di gruppo.
    5. In Impostazioni di connessione, seleziona URL app e incolla l'URL dell'attivatore della funzione Cloud Functions nella casella.
    6. In Visibilità, seleziona Rendi disponibile l'app Google Chat a persone e gruppi specifici nel tuo dominio e inserisci il tuo indirizzo email.
    7. In Log, seleziona Registra errori in Logging.
  7. Fai clic su Salva.

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

Testare l'app Chat

Per testare la tua app Chat, invia all'app un messaggio diretto:

  1. Apri Google Chat.
  2. Per inviare un messaggio diretto all'app, fai clic su Avvia una chat e, nella finestra visualizzata, fai clic su Trova app.
  3. Nella finestra di dialogo Trova app, cerca Quickstart App.
  4. Per aprire un messaggio diretto con l'app, trova l'app Guida rapida e fai clic su Aggiungi > Chat.
  5. Nel messaggio diretto, 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 mostrato nell'immagine seguente:

L&#39;app di chat risponde con una scheda con il nome visualizzato e l&#39;immagine dell&#39;avatar del mittente

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

Risolvi il problema

Quando un'app o una scheda Google Chat restituisce un errore, nell'interfaccia di Chat viene visualizzato il messaggio "Si è verificato un problema" o "Impossibile elaborare la richiesta". A volte nell'interfaccia utente di Chat non vengono visualizzati messaggi di errore, ma l'app o la scheda Chat produce un risultato imprevisto; ad esempio, è possibile che non venga visualizzato un messaggio di scheda.

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 informazioni su visualizzazione, debug e correzione degli errori, consulta l'articolo Risolvere gli errori di Google Chat.

Esegui la pulizia

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.

  1. Nella console Google Cloud, vai alla pagina Gestisci risorse. Fai clic su Menu > IAM e amministrazione > Gestisci risorse.

    Vai a Resource Manager

  2. Nell'elenco dei progetti, seleziona quello da eliminare e fai clic su Elimina .
  3. Nella finestra di dialogo, digita l'ID progetto e fai clic su Arresta per eliminare il progetto.