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

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

Nel diagramma precedente, un utente che interagisce con un'app di chat HTTP ha 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 contenente la logica dell'app Chat.
3. Se vuoi, la logica dell'app Chat può essere integrata con i servizi Google Workspace (come Calendar e Fogli), con altri servizi Google (come Maps, YouTube e Vertex AI) o con altri servizi web (come un sistema di gestione dei progetti o uno strumento per la gestione dei ticket).
4. Il server web invia una risposta HTTP al servizio dell'app Chat in Chat.
5. La risposta viene consegnata all'utente.
6. Se vuoi, 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 librerie e componenti esistenti già esistenti nel tuo sistema, perché queste app di Chat possono essere progettate utilizzando linguaggi di programmazione diversi.

Obiettivi

• Configurare l'ambiente.
• Creare una funzione Cloud Functions ed eseguirne il deployment.
• Pubblica l'app in Chat.
• Testa 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 attivata per un progetto esistente, consulta Verificare lo stato della fatturazione dei progetti. Per creare un progetto e configurare la fatturazione, consulta Creare un progetto Google Cloud.

Configurare l'ambiente

Prima di utilizzare le API 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 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 la tua app di chat, compila 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 Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona Funzione Cloud Run.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi l'autenticazione.
   5. Fai clic su Avanti.

4. In Runtime, seleziona la versione più recente di Node.js.

5. In Codice sorgente, seleziona Editor incorporato.

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

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

   node/avatar-app/index.js

   Visualizza su 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 }
           }]}]
         }
       }]
     };
   }

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 Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona Funzione Cloud Run.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi l'autenticazione.
   5. Fai clic su Avanti.

4. In Runtime, seleziona la versione più recente di Python.

5. In Codice sorgente, seleziona Editor incorporato.

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

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
   
   # 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 }
               }]
             }]
         }
       }]
     }

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 Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona Funzione Cloud Run.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi l'autenticazione.
   5. Fai clic su Avanti.

4. In Runtime, seleziona la versione più recente di Java.

5. In Codice sorgente, seleziona Editor incorporato.

6. In Punto di contatto, elimina il testo predefinito e inserisci App.

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

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

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

   Visualizza su 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.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;
   
   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:
             Message aboutMessage = new Message();
             aboutMessage.setText("The Avatar app replies to Google Chat messages.");
             aboutMessage.setPrivateMessageViewer(new User()
               .setName(body.getAsJsonObject("user").get("name").getAsString()));
             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) {
       return new Message()
         .setText("Here's your avatar")
         .setCardsV2(List.of(new CardWithId()
           .setCardId("previewLink")
           .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)))))))));
     }
   }

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>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-rev20241008-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 compilazione e uno per il servizio. Quando entrambi gli indicatori di avanzamento scompaiono e vengono sostituiti da un segno di spunta, la funzione è dispiattata e pronta.

Autorizza Google Chat a richiamare la funzione

Per autorizzare Google Chat a richiamare la tua funzione, aggiungi l'account di servizio Google Chat con il ruolo Invoker di Cloud Run.

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

   Vai a Cloud Run

2. Nell'elenco dei servizi Cloud Run, seleziona la casella di controllo accanto alla funzione di ricezione. Non fare clic sulla funzione stessa.

3. Fai clic su Autorizzazioni. Viene visualizzato il riquadro Autorizzazioni.

4. Fai clic su Aggiungi entità.

5. In Nuove entità, inserisci [e-mail].

6. In Seleziona un ruolo, seleziona Cloud Run > Cloud Run Invoker.

7. Fai clic su Salva.

Pubblicare l'app in Google Chat

Dopo aver eseguito il deployment della funzione Cloud, 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 il progetto per cui hai attivato Cloud Functions sia selezionato.

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

3. Fai clic sulla scheda Trigger.

4. In HTTPS, copia l'URL.

5. Cerca "API Google Chat" e fai clic su API Google Chat, poi 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 endpoint HTTP e incolla l'URL per l'attivatore della funzione Cloud nella casella.
   6. In Authentication Audience (Pubblico di autenticazione), seleziona HTTP endpoint URL (URL endpoint HTTP).
   7. In Visibilità, seleziona Rendi disponibile questa app Google Chat a utenti e gruppi specifici nel tuo dominio e inserisci il tuo indirizzo email.
   8. In Log, seleziona Errori di log 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 l'app Chat, apri uno spazio di messaggi diretti con l'app Chat e invia un messaggio:

1. Apri Google Chat utilizzando l'account Google Workspace fornito quando hai aggiunto te stesso come tester attendibile.

   Vai a Google Chat

2. Fai clic su Nuova chat.
3. Nel campo Aggiungi 1 o più persone, digita il nome della tua app Chat.

4. Seleziona l'app Chat dai risultati. Viene visualizzato 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 Visibilità della pagina Configurazione API Chat nella console Google Cloud.
5. Nel nuovo messaggio diretto con l'app, digita Hello e premi enter.

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

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

Risoluzione dei problemi

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

Sebbene 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 Chat è attivata. Per assistenza su come visualizzare, eseguire il debug e correggere gli errori, consulta la sezione 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.

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per questo tutorial, quando lo elimini, elimini anche qualsiasi altro lavoro che hai svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL su appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più tutorial e guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

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 il progetto che vuoi eliminare e fai clic su Elimina .
3. Nella finestra di dialogo, digita l'ID progetto e fai clic su Chiudi per eliminare il progetto.

Argomenti correlati

• Per aggiungere altre funzionalità all'app Chat, consulta quanto segue:

  • Creare messaggi con schede interattive
  • Rispondere ai comandi slash
  • Aprire e rispondere alle finestre di dialogo

• Scegliere un'architettura per l'app di Chat

• Verificare le richieste da Google Chat