Chat-App mit Google Cloud Functions erstellen

Auf dieser Seite wird erläutert, wie Sie mit Google Cloud Functions eine Chat-App erstellen und damit interagieren.

Zum Erstellen der Anwendung schreiben und stellen Sie eine Cloud Functions-Funktion bereit, mit der die Anwendung eine Antwort auf ein Nachrichtenereignis aus Google Chat verarbeitet. Die Antwort ist eine Karte, die den Namen des Senders und das Avatarbild enthält, wie in der folgenden Abbildung dargestellt:

Chat-App mit einer Karte, die den Anzeigenamen und das Avatarbild des Absenders zeigt

Zielsetzungen

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

Vorbereitung

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 und die Cloud Pub/Sub API.

    APIs aktivieren

Cloud Functions-Funktionen erstellen und bereitstellen

eine Cloud Functions-Funktion erstellen und bereitstellen, die eine Chatkarte 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

    Prüfen Sie, ob das Projekt für die Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

  3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ 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.

      Weitere Informationen zur Authentifizierung in Google Workspace finden Sie unter Chat-Apps und API-Anfragen authentifizieren und autorisieren.

    4. Klicken Sie auf Speichern.

    5. Klicken Sie auf Weiter.

  4. Wählen Sie unter Laufzeit die Option Node.js 10 aus.

  5. Wählen Sie unter Quellcode die Option 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-Bot/Index.js
    /**
     * Google Cloud Function that responds to messages sent from a
     * Hangouts Chat room.
     *
     * @param {Object} req Request sent from Hangouts 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 Hangouts 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 {
        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

    Prüfen Sie, ob das Projekt für die Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

  3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ 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.

      Weitere Informationen zur Authentifizierung in Google Workspace finden Sie unter Chat-Apps und API-Anfragen authentifizieren und autorisieren.

    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 die Option 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-Bot/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 = {
          "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

    Prüfen Sie, ob das Projekt für die Chat-App ausgewählt ist.

  2. Klicken Sie auf Funktion erstellen.

  3. Richten Sie die Funktion auf der Seite „Funktion erstellen“ 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.

      Weitere Informationen zur Authentifizierung in Google Workspace finden Sie unter Chat-Apps und API-Anfragen authentifizieren und autorisieren.

    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 die Option 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-Bot/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.setCardsV2(List.of(cardWithId));
    
        return message;
      }
    }

  9. Ersetzen Sie den Inhalt von pom.xml durch den folgenden Code:

    java/avatar-bot/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 Seite „Cloud Functions“ wird geöffnet und die Funktion wird neben dem Funktionsnamen mit einem Bereitstellungsfortschritt angezeigt. Wenn die Fortschrittsanzeige nicht mehr zu sehen ist, wird ein Häkchen angezeigt.

App in Google Chat veröffentlichen

Nach der Bereitstellung der Cloud Functions-Funktion können Sie sie in eine Google Chat-App umwandeln:

  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“ und klicken Sie auf Google Chat API.

  6. Klicken Sie auf Verwalten.

  7. 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 (Avatar-URL) https://developers.google.com/chat/images/quickstart-app-avatar.png ein.
    3. Geben Sie unter Beschreibung Quickstart app ein.
    4. Wählen Sie unter Funktionsmerkmale die Option 1:1-Nachrichten empfangen, Gruppenbereiche und Gruppenunterhaltungen beitreten und Fehler in Cloud Logging protokollieren 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 Berechtigungen die Option Bestimmte Personen und Gruppen in Ihrer Domain aus und geben Sie Ihre E-Mail-Adresse ein.
  8. Klicken Sie auf Speichern.

Die App kann Nachrichten in Google Chat empfangen und beantworten.

Chat-App testen

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

  1. Öffnen Sie Google Chat.
  2. Wenn Sie eine Direktnachricht an die Anwendung senden möchten, klicken Sie auf „Chat starten“ und dann im eingeblendeten Fenster auf Apps suchen.
  3. Suchen Sie im Dialogfeld Apps suchen nach „Kurzanleitungs-App“.
  4. Wenn Sie eine Direktnachricht mit der Anwendung öffnen möchten, suchen Sie die Kurzanleitungs-App und klicken Sie auf Hinzufügen > Chat.
  5. Geben Sie in der Direktnachricht Hello ein und drücken Sie enter.

Die App gibt dann eine Karte mit deinem Anzeigenamen und Avatarbild zurück.

Nächste Schritte

Informationen zur Fehlerbehebung in der Chat App finden Sie auf den folgenden Seiten:

  • Beim Erstellen der Chat-App müssen Sie möglicherweise Fehler beheben, indem Sie die Fehlerlogs der App lesen. Rufen Sie zum Lesen der Logs in der Google Cloud Console den Log-Explorer auf.
  • Fehlerbehebung

In den folgenden Leitfäden erfahren Sie, wie Sie die Chat-App um zusätzliche Funktionen ergänzen:

  • Interaktive Karten erstellen: Kartennachrichten unterstützen ein bestimmtes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media-Elemente wie Bilder. Verwenden Sie Kartennachrichten, um detaillierte Informationen zu präsentieren, Informationen von Nutzern zu sammeln und Nutzer zum nächsten Schritt zu leiten.
  • Slash-Befehle unterstützen – Mit Slash-Befehlen können Sie bestimmte Befehle registrieren und bewerben, die Nutzer Ihrer App geben können. Dazu geben sie einen Befehl ein, der mit einem Schrägstrich (/) beginnt, z. B. /help.
  • Dialogfelder zum Starten: Dialogfelder sind kartenbasierte Schnittstellen mit Fenstern, die Ihre App öffnen kann, um mit einem Nutzer zu interagieren. Mehrere Karten können nacheinander aufeinanderfolgend sein. Das hilft Nutzern, mehrstufige Prozesse auszuführen, z. B. das Ausfüllen von Formulardaten.

Weitere Informationen zur Google Chat API finden Sie in der Referenzdokumentation.