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. Su Google Cloud, puoi usare Cloud Functions, Cloud Run e App Engine. In questa guida rapida, scrivi ed esegui il deployment di una funzione Cloud Functions che l'app Chat utilizza per rispondere al messaggio di un utente.

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

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 messaggi in modo asincrono o eseguire altre operazioni.

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

Obiettivi

• Configurare l'ambiente.
• Crea ed esegui 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.

• Un progetto Google Cloud.
• Assicurati di attivare la fatturazione per il tuo progetto Cloud. Scopri come verificare lo stato di fatturazione dei tuoi progetti.

Configura 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 generi una scheda Chat con il nome visualizzato e l'immagine avatar del mittente. Quando l'app Chat riceve un messaggio, esegue la funzione e risponde con la carta.

Per creare ed eseguire il deployment della funzione per l'app Chat, completa i seguenti passaggi:

Node.js

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

   Vai a Cloud Functions

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

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 un'area geografica.
   4. In Autenticazione, seleziona Consenti chiamate non autenticate.
   5. Fai clic su 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:

   Node/avatar-app/index.js

   Visualizza su GitHub

   /**
    * 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 il progetto per l'app di chat sia selezionato.

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

   Visualizza su GitHub

   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 il progetto per l'app di chat sia selezionato.

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

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

   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/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 con un segno di spunta, il deployment della funzione è pronto.

Pubblicare l'app su Google Chat

Dopo aver eseguito il deployment della funzione Cloud Functions, segui questi passaggi per convertirla 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 il quale hai abilitato Cloud Functions.

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

3. Nella pagina Dettagli funzione, fai clic su Attivatore.

4. Copia l'URL in URL attivatore.

5. Cerca "API Google Chat", fai clic su API Google Chat e poi 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 nella casella l'URL dell'attivatore della funzione Cloud Functions.
   6. In Visibilità, seleziona Rendi disponibile questa app Google Chat per 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 di 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 fai clic su Trova app nella finestra visualizzata.
3. Nella finestra di dialogo Trova app, cerca Quickstart App.
4. Per aprire un messaggio diretto con l'app, trova l'app 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:

Risolvere gli errori

Per risolvere i problemi dell'app Chat ed eseguirne il debug, vedi Risolvere i problemi e correggere gli errori dell'app Google Chat.

Argomenti correlati

• Per aggiungere altre funzionalità alla tua app di Chat, vedi quanto segue:

  • Creare messaggi interattivi delle schede
  • Rispondere ai comandi slash
  • Aprire e rispondere alle finestre di dialogo

• Scegliere un'architettura dell'app di Chat