Creare un'app Google Chat HTTP con Cloud Functions

In questa pagina viene spiegato come creare un'app di chat HTTP. Esistono diversi modi per implementare questa architettura. Su Google Cloud, possono usare Cloud Functions, Cloud Run e App Engine. In questa guida rapida, scrivere ed eseguire il deployment funzione Cloud Functions Functions usate dall'app Chat 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 mediante HTTP, come illustrato nelle diagramma seguente:

Nel diagramma precedente, un utente interagisce con un indirizzo HTTP L'app Chat prevede il seguente flusso di informazioni:

1. Un utente invia un messaggio in Chat a un App di Chat, in un messaggio diretto o in Spazio di Chat.
2. Una richiesta HTTP viene inviata a un server web che è cloud o sistema on-premise che contiene l'app di Chat logica.
3. Facoltativamente, la logica dell'app di Chat può integrarsi con ai servizi Google Workspace (come Calendar e Fogli), altri servizi Google (come Maps, YouTube e Vertex AI) o altri servizi web (come un progetto di gestione dei ticket o di gestione dei ticket).
4. Il server web invia una risposta HTTP al Servizio app di Chat in Chat.
5. La risposta viene consegnata all'utente.
6. Facoltativamente, l'app Chat può chiamare API Chat per pubblicare messaggi in modo asincrono o eseguire operations.

Questa architettura offre la flessibilità di utilizzare le librerie esistenti componenti già esistenti nel sistema, in quanto Le 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

• R Google Workspace account con accesso a Google Chat e Google Cloud Functions.
• Un progetto Google Cloud.
• Assicurati di attivare la fatturazione per il tuo progetto Cloud. Impara come Verificare lo stato di fatturazione dei progetti.

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, API Cloud Pub/Sub, API Cloud Logging, API Artifact Registry e API Cloud Run.

  Abilita le API

Crea ed esegui il deployment di una funzione Cloud

Crea ed esegui il deployment di una funzione Cloud Functions che genera una scheda Chat con il nome visualizzato e l'immagine 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

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

   Vai a Cloud Functions

   Assicurati che il progetto per la tua app di Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona 2a generazione.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi 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 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 la tua app di Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona 2a generazione.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi 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 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 la tua app di Chat sia selezionato.

2. Fai clic su Crea funzione.

3. Nella pagina Crea funzione, imposta la funzione:

   1. In Ambiente, seleziona 2a generazione.
   2. In Nome funzione, inserisci QuickStartChatApp.
   3. In Regione, seleziona una regione.
   4. In Autenticazione, seleziona Richiedi 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 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 da un segno di spunta, la funzione e il deployment è pronto.

Autorizza Google Chat a richiamare la tua funzione

Per autorizzare Google Chat a richiamare la tua funzione, aggiungi il modulo account di servizio 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 personalizzata. Non fare clic sulla funzione in sé.

3. Fai clic su Autorizzazioni. Si apre il riquadro Autorizzazioni.

4. Fai clic su Aggiungi entità.

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

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

7. Fai clic su Salva.

Pubblicare l'app in Google Chat

Una volta 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 il progetto per il quale hai abilitato Cloud Functions sia selezionato.

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

3. Fai clic sulla scheda Trigger.

4. Copia l'URL in HTTPS.

5. Cerca "API Google Chat" e fai clic su API Google Chat, quindi 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 Partecipare a spazi e conversazioni di gruppo.
   5. In Impostazioni di connessione, seleziona URL app e incolla l'URL per il trigger della funzione Cloud Functions.
   6. In Authentication Audience (Pubblico di autenticazione), seleziona App URL (URL dell'app).
   7. In Visibilità, seleziona Rendi disponibile questa app di Google Chat a persone specifiche e gruppi nel tuo dominio e inserisci il tuo indirizzo email.
   8. In Log, seleziona Log errori in Logging.

7. Fai clic su Salva.

L'app Chat è pronta per ricevere e rispondere 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 usando l'account Google Workspace che hai indicato quando ti sei aggiunto come trusted tester.

   Vai a Google Chat

2. Fai clic su Nuova chat.
3. Nel campo Aggiungi una o più persone, digita il nome del tuo App Chat.

4. Seleziona la tua app Chat dai risultati. Un annuncio diretto si apre il messaggio.

   Nota:se non vedi l'app Chat nell'elenco di risultati, assicurati di aver incluso il tuo account Google Workspace nell' Impostazioni di visibilità della configurazione dell'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 della 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 Testa le funzionalità interattive per App Google Chat.

Risoluzione dei problemi

Quando un'app Google Chat o card restituisce un errore, L'interfaccia di Chat mostra il messaggio "Si è verificato un problema". o "Impossibile elaborare la richiesta". A volte, l'UI di Chat non mostra alcun messaggio di errore, ma l'app Chat o la scheda restituisce un risultato inaspettato; Ad esempio, il messaggio di una scheda potrebbe non vengono visualizzate.

Anche se un messaggio di errore potrebbe non essere visualizzato nella UI di Chat, messaggi di errore descrittivi e dati di log che ti aiuteranno a correggere gli errori quando il logging degli errori per le app di chat è attivo. Per assistenza con la visualizzazione, il debug e la correzione degli errori, consulta Risolvere i problemi e correggere gli errori di Google Chat.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi per utilizzate in questo tutorial, ti consigliamo di eliminare 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 il 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 prevedi di esplorare più tutorial e guide rapide, il riutilizzo dei progetti può aiutarti a evitare di superare i limiti di quota.

1. Nella console Google Cloud, vai alla pagina Gestisci risorse. Clic Menu > IAM e Amministratore > 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 eliminarlo. del progetto.

Argomenti correlati

• Per aggiungere altre funzionalità all'app Chat, vedi le seguenti:

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

• Scegliere un'architettura dell'app di Chat

• Verificare le richieste di Google Chat