HTTP-Google Chat-Anwendung erstellen

Auf dieser Seite wird erläutert, wie Sie eine HTTP-Chat-App erstellen. Es gibt verschiedene Möglichkeiten, diese Architektur zu implementieren. In Google Cloud Cloud Functions, Cloud Run und App Engine nutzen können. In dieser Kurzanleitung schreiben und bereitstellen Cloud Functions-Funktion die die Chat-App verwendet, um auf die Nachricht eines Nutzers zu antworten.

Mit dieser Architektur konfigurieren Sie Google Chat für die Integration mit Google Cloud oder einen lokalen Server über HTTP, wie in der folgendes Diagramm:

Im obigen Diagramm interagiert ein Nutzer mit einem Die Chat-App umfasst den folgenden Informationsfluss:

1. Ein Nutzer sendet in Google Chat eine Nachricht an einen Chat-App, entweder in einer Direktnachricht oder in einer Chatbereich.
2. Eine HTTP-Anfrage wird an einen Webserver gesendet, bei dem es sich entweder um eine Cloud- oder Lokales System, das die Chat App enthält Logik.
3. Optional kann die Chat-App-Logik mit Google Workspace-Dienste wie Google Kalender und Google Tabellen), andere Google-Dienste (wie Maps, YouTube und Vertex AI) oder andere Webdienste (z. B. ein Projekt) oder Ticketing-Tool).
4. Der Webserver sendet eine HTTP-Antwort an den Chat-App-Dienst in Google Chat.
5. Die Antwort wird an den Nutzer gesendet.
6. Optional kann die Chat-App die Chat-API, um Nachrichten asynchron zu posten oder andere Geschäftsabläufe.

Diese Architektur bietet Ihnen die Flexibilität, vorhandene Bibliotheken und Komponenten, die bereits in Ihrem System vorhanden sind, Chat-Apps können in verschiedenen Programmiersprachen entwickelt werden.

Zielsetzungen

• die Umgebung einrichten
• Cloud Functions-Funktion erstellen und bereitstellen
• Veröffentlichen Sie die App in Google Chat.
• App testen

Vorbereitung

• Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
• Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. So prüfen Sie, ob die Abrechnung für ein vorhandenes Projekt aktiviert ist: Siehe Überprüfen der Abrechnungsstatus Ihrer Projekte. Informationen zum Erstellen eines Projekts und zum Einrichten der Abrechnung finden Sie unter Erstellen Sie ein Google Cloud-Projekt.

Umgebung einrichten

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.

• Aktivieren Sie in der Google Cloud Console die Google Chat API, die Cloud Build API, die Cloud Functions API Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API und Cloud Run API

  APIs aktivieren

Cloud Functions-Funktionen erstellen und bereitstellen

Cloud Functions-Funktion erstellen und bereitstellen, die eine Chat-Karte generiert durch den Anzeigenamen und das Avatarbild des Absenders. Wenn der Parameter Die Chat-App empfängt eine Nachricht, führt die Funktion aus mit der Karte antwortet.

So erstellen Sie die Funktion für Ihre Chat-App und stellen sie bereit: führen Sie die folgenden Schritte aus:

Node.js

1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Functions:

   Zu Cloud Functions

   Das Projekt für Ihre Chat-App muss ausgewählt.

2. Klicken Sie auf Funktion erstellen.

3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ ein:

   1. Wählen Sie unter Umgebung die Option 2. Generation aus.
   2. Geben Sie unter Funktionsname den Wert QuickStartChatApp ein.
   3. Wählen Sie unter Region eine Region aus.
   4. Wählen Sie unter „Authentifizierung“ die Option Authentifizierung erforderlich aus.
   5. Klicken Sie auf Weiter.

4. Wählen Sie unter Laufzeit die neueste Version von Node.js aus.

5. Wählen Sie unter Quellcode die Option Inline-Editor aus.

6. Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie avatarApp ein.

7. Ersetzen Sie den Inhalt von index.js durch den folgenden Code:

   node/avatar-app/index.js

   Auf GitHub ansehen

   // 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. Klicken Sie auf Bereitstellen.

Python

1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Functions:

   Zu Cloud Functions

   Das Projekt für Ihre Chat-App muss ausgewählt.

2. Klicken Sie auf Funktion erstellen.

3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ ein:

   1. Wählen Sie unter Umgebung die Option 2. Generation aus.
   2. Geben Sie unter Funktionsname den Wert QuickStartChatApp ein.
   3. Wählen Sie unter Region eine Region aus.
   4. Wählen Sie unter „Authentifizierung“ die Option Authentifizierung erforderlich aus.
   5. Klicken Sie auf Weiter.

4. Wählen Sie unter Laufzeit die neueste Version von Python aus.

5. Wählen Sie unter Quellcode die Option Inline-Editor aus.

6. Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie avatar_app ein.

7. Ersetzen Sie den Inhalt von main.py durch den folgenden Code:

   python/avatar-app/main.py

   Auf GitHub ansehen

   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. Klicken Sie auf Bereitstellen.

Java

1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Functions:

   Zu Cloud Functions

   Das Projekt für Ihre Chat-App muss ausgewählt.

2. Klicken Sie auf Funktion erstellen.

3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ ein:

   1. Wählen Sie unter Umgebung die Option 2. Generation aus.
   2. Geben Sie unter Funktionsname den Wert QuickStartChatApp ein.
   3. Wählen Sie unter Region eine Region aus.
   4. Wählen Sie unter „Authentifizierung“ die Option Authentifizierung erforderlich aus.
   5. Klicken Sie auf Weiter.

4. Wählen Sie unter Laufzeit die neueste Version von Java aus.

5. Wählen Sie unter Quellcode die Option Inline-Editor aus.

6. Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie App ein.

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

8. Ersetzen Sie den Inhalt von App.java durch den folgenden Code:

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

   Auf GitHub ansehen

   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.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:
           JsonObject aboutMessage = new JsonObject();
           aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
           aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
             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) {
       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. Ersetzen Sie den Inhalt von pom.xml durch den folgenden Code:

   java/avatar-app/pom.xml

   Auf GitHub ansehen

   <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-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. Klicken Sie auf Bereitstellen.

Die Detailseite von Cloud Functions wird geöffnet und Ihre Funktion wird mit zwei eine für den Build und eine für den Dienst. Wenn beide ausgeblendet und durch ein Häkchen ersetzt, wird Ihre Funktion bereitgestellt und bereit ist.

Google Chat zum Aufrufen der Funktion autorisieren

Fügen Sie den Google Chat hinzu, um Google Chat zum Aufrufen der Funktion zu autorisieren Dienstkonto mit der Rolle Cloud Run Invoker

1. Rufen Sie in der Google Cloud Console die Seite „Cloud Run“ auf:

   Zu Cloud Run

2. Klicken Sie in der Liste der Cloud Run-Dienste auf das Kästchen neben dem . (Klicken Sie nicht auf die Funktion selbst.)

3. Klicke auf Berechtigungen. Der Bereich Berechtigungen wird geöffnet.

4. Klicken Sie auf Hauptkonto hinzufügen.

5. Geben Sie unter Neue Hauptkonten [e-mail] ein.

6. Wählen Sie unter Rolle auswählen die Option Cloud Run aus. Cloud Run Invoker:

7. Klicken Sie auf Speichern.

App in Google Chat veröffentlichen

Nachdem die Cloud Functions-Funktion bereitgestellt wurde, wandeln Sie sie mit den folgenden Schritten in eine Google Chat App:

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > Cloud Functions.

   Zu Cloud Functions

   Prüfen Sie, ob das Projekt, für das Sie Cloud Functions aktiviert haben, ausgewählt.

2. Klicken Sie in der Liste der Funktionen auf QuickStartChatApp.

3. Klicken Sie auf den Tab Trigger.

4. Kopieren Sie die URL unter HTTPS.

5. Suchen Sie nach „Google Chat API“. Klicken Sie auf Google Chat API und dann auf Verwalten.

   Zur Chat API

6. Klicken Sie auf Konfiguration und richten Sie die Google Chat App ein:

   1. Geben Sie unter App-Name Quickstart App ein.
   2. Geben Sie unter Avatar URL (Avatar-URL) Folgendes ein: https://developers.google.com/chat/images/quickstart-app-avatar.png
   3. Geben Sie unter Beschreibung den Wert Quickstart app ein.
   4. Wählen Sie unter Funktionen die Option 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten
   5. Wählen Sie unter Verbindungseinstellungen die Option App-URL aus und fügen Sie die URL für den Cloud Functions-Trigger in das Feld ein.
   6. Wählen Sie unter Authentication Audience (Authentifizierungsziel) die Option App URL (App-URL) aus.
   7. Wähle unter Sichtbarkeit die Option Diese Google Chat App bestimmten Personen und in Ihrer Domain und geben Sie Ihre E-Mail-Adresse ein.
   8. Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.

7. Klicken Sie auf Speichern.

Die Chat-App kann jetzt Nachrichten empfangen und beantworten. Nachrichten in Google Chat.

Chat-App testen

Öffnen Sie zum Testen der Chat App einen Direktnachrichtenbereich mit Chat-App und senden Sie eine Nachricht:

1. Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie wenn Sie sich als Trusted Tester hinzugefügt haben.

   Zu Google Chat

2. Klicken Sie auf Neuer Chat.
3. Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihres Chat-App.

4. Wählen Sie aus den Ergebnissen Ihre Chat-App aus. Eine direkte wird die Nachricht geöffnet.

   Hinweis:Falls Ihre Chat App nicht in der Liste der achten Sie darauf, dass Ihr Google Workspace-Konto Einstellungen für die Sichtbarkeit der Chat API-Konfiguration Seite in der Google Cloud Console.
5. Geben Sie in der neuen Direktnachricht an die App Hello ein und drücken Sie enter.

Die Antwort der Chat-App enthält ein Kartennachricht mit den Name und Avatar-Bild des Absenders, wie in der folgenden Abbildung gezeigt:

Informationen zum Hinzufügen von Trusted Testern und zum Testen interaktiver Funktionen findest du unter Interaktive Funktionen für Google Chat-Apps

Fehlerbehebung

Wenn eine Google Chat App oder card gibt einen Fehler zurück. Der Parameter In der Chatoberfläche wird die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal kann die Chat-UI Es wird zwar keine Fehlermeldung angezeigt, aber die Chat-App oder die Karte zu einem unerwarteten Ergebnis führt. z. B. wird eine Kartennachricht angezeigt werden.

Auch wenn in der Chat-Benutzeroberfläche möglicherweise keine Fehlermeldung angezeigt wird, beschreibende Fehlermeldungen und Protokolldaten stehen zur Fehlerbehebung zur Verfügung. wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Hilfe bei der Anzeige: Debugging und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben

Bereinigen

Um zu vermeiden, dass Ihrem Google Cloud-Konto Gebühren für Ressourcen, die in dieser Anleitung verwendet werden, empfehlen wir, dass Sie den Cloud-Projekt

Achtung:Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für diese Anleitung ein bereits bestehendes Projekt verwendet haben, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID verwenden, z. B. eine URL auf appspot.com, erhalten bleiben, sollten Sie die ausgewählten Ressourcen innerhalb des Projekts löschen, anstatt das gesamte Projekt zu löschen.

Wenn Sie mehrere Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf Menü > IAM und Verwaltung > Ressourcen verwalten.

   <ph type="x-smartling-placeholder"></ph> Zu Resource Manager

2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie auf löschen.
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie zum Löschen auf Beenden. für das Projekt.

Weitere Informationen

• Informationen zum Hinzufügen weiterer Funktionen zu Ihrer Chat App finden Sie in der Folgendes:

  • Interaktive Kartennachrichten erstellen
  • Auf Slash-Befehle reagieren
  • Dialogfelder öffnen und beantworten

• Chat-App-Architektur auswählen

• Anfragen von Google Chat bestätigen