Google Chat-HTTP-Anwendung mit Cloud Functions 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 können Sie Cloud Functions, Cloud Run und App Engine verwenden. In dieser Kurzanleitung schreiben und stellen Sie eine Cloud Functions-Funktion bereit, die die Chat-Anwendung verwendet, um auf die Nachricht eines Nutzers zu antworten.

Bei dieser Architektur konfigurieren Sie Chat mithilfe von HTTP für die Einbindung in Google Cloud oder einen lokalen Server, wie im folgenden Diagramm dargestellt:

Architektur einer Chat-App mit einem Webdienst auf einem lokalen Server.

Im obigen Diagramm hat ein Nutzer, der mit einer HTTP Chat-Anwendung interagiert, die folgenden Informationen:

  1. Ein Nutzer sendet in Google Chat eine Nachricht an eine Chat-App, entweder in einer Direktnachricht oder in einem Chatbereich.
  2. Eine HTTP-Anfrage wird an einen Webserver gesendet, der entweder ein Cloud- oder lokales System ist, das die Chat-Anwendungslogik enthält.
  3. Optional kann die Chat-Anwendungslogik in Google Workspace-Dienste (z. B. Google Kalender und Google Tabellen), andere Google-Dienste (wie Maps, YouTube und Vertex AI) oder andere Webdienste (z. B. ein Projektmanagementsystem oder ein Ticketing-Tool) eingebunden werden.
  4. Der Webserver sendet eine HTTP-Antwort an den Chat-Anwendungsdienst in Chat.
  5. Die Antwort wird dem Nutzer zugestellt.
  6. Optional kann die Chat-Anwendung die Chat API aufrufen, um asynchron Nachrichten zu senden oder andere Vorgänge auszuführen.

Diese Architektur bietet Ihnen die Flexibilität, vorhandene Bibliotheken und Komponenten zu verwenden, die bereits in Ihrem System vorhanden sind, da diese Chat-Anwendungen mit verschiedenen Programmiersprachen entworfen werden können.

Zielsetzungen

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

Voraussetzungen

  • Ein Google Workspace-Konto mit Zugriff auf Google Chat in einer Google Workspace-Organisation, das nicht authentifizierte Aufrufe von Google Cloud Functions-Funktionen zulässt.

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

    APIs aktivieren

Cloud Functions-Funktionen erstellen und bereitstellen

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

Führen Sie die folgenden Schritte aus, um die Funktion für Ihre Chat-App zu erstellen und bereitzustellen:

Node.js

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

    Zu Cloud Functions

    Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

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

    1. Wählen Sie unter Umgebung die Option 2nd gen aus.
    2. Geben Sie unter Funktionsname QuickStartChatApp ein.
    3. Wählen Sie unter Region eine Region aus.
    4. Wählen Sie unter „Authentifizierung“ die Option Nicht authentifizierte Aufrufe zulassen aus.
    5. Klicken Sie auf Weiter.
  4. Wählen Sie unter Laufzeit die Option Node.js 20 aus.

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

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

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

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

Python

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

    Zu Cloud Functions

    Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

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

    1. Geben Sie unter Funktionsname QuickStartChatApp ein.
    2. Wählen Sie unter Triggertyp die Option HTTP aus.
    3. Wählen Sie unter „Authentifizierung“ die Option Nicht authentifizierte Aufrufe zulassen aus.
    4. Klicken Sie auf Speichern.
    5. Klicken Sie auf Weiter.
  4. Wählen Sie unter Laufzeit die Option Python 3.10 aus.

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

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

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

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

Java

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

    Zu Cloud Functions

    Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

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

    1. Geben Sie unter Funktionsname QuickStartChatApp ein.
    2. Wählen Sie unter Triggertyp die Option HTTP aus.
    3. Wählen Sie unter „Authentifizierung“ die Option Nicht authentifizierte Aufrufe zulassen aus.
    4. Klicken Sie auf Speichern.
    5. Klicken Sie auf Weiter.
  4. Wählen Sie unter Laufzeit die Option Java 11 aus.

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

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

  7. Benennen Sie src/main/java/com/example/Example.java in src/main/java/HelloChat.java um.

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

    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. Ersetzen Sie den Inhalt von pom.xml durch den folgenden Code:

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

Die Cloud Functions-Detailseite wird geöffnet und Ihre Funktion wird mit zwei Fortschrittsanzeigen angezeigt: einer für den Build und einer für den Dienst. Wenn beide Fortschrittsanzeigen verschwinden und durch ein Häkchen ersetzt werden, ist die Funktion bereitgestellt und bereit.

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 um:

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

    Zu Cloud Functions

    Achten Sie darauf, dass das Projekt ausgewählt ist, für das Sie Cloud Functions aktiviert haben.

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

  3. Klicken Sie auf der Seite „Funktionsdetails“ auf Trigger.

  4. Kopieren Sie unter Trigger-URL die URL.

  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 im Feld Avatar-URL den String https://developers.google.com/chat/images/quickstart-app-avatar.png ein.
    3. Geben Sie unter Beschreibung den Text Quickstart app ein.
    4. Wählen Sie unter Funktionen die Option 1:1-Nachrichten erhalten und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
    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 Sichtbarkeit die Option Diese Google Chat-App für bestimmte Personen und Gruppen in Ihrer Domain verfügbar machen aus und geben Sie Ihre E-Mail-Adresse ein.
    7. Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.
  7. Klicken Sie auf Speichern.

Die Chat-App ist bereit, Nachrichten in Google Chat zu empfangen und zu beantworten.

Chat-App testen

Wenn Sie die Chat-App testen möchten, senden Sie eine Direktnachricht an die App:

  1. Öffnen Sie Google Chat.
  2. Klicken Sie zum Senden einer Direktnachricht an die Anwendung auf „Chat starten“ und dann im eingeblendeten Fenster auf Apps suchen.
  3. Suchen Sie im Dialogfeld Apps suchen nach Quickstart App.
  4. Zum Öffnen einer Direktnachricht an die App klicken Sie in der Kurzanleitung auf Hinzufügen > Chat.
  5. Geben Sie in der Direktnachricht Hello ein und drücken Sie enter.

Die Antwort der Chat-Anwendung enthält eine Kartennachricht, die den Namen und das Avatarbild des Absenders enthält, wie in der folgenden Abbildung gezeigt:

Chat-App antwortet mit einer Karte, die den Anzeigenamen und das Avatarbild des Absenders enthält

Unter Interaktive Funktionen für Google Chat-Apps testen erfahren Sie, wie Sie Trusted Tester hinzufügen und mehr über das Testen interaktiver Funktionen erfahren.

Fehler beheben

Weitere Informationen zur Fehlerbehebung finden Sie im Hilfeartikel Fehler in der Google Chat-App beheben.