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 können Sie Cloud Functions, Cloud Run und App Engine verwenden. In dieser Kurzanleitung schreiben und stellen Sie eine Cloud Function bereit, mit der die Chat-App auf die Nachricht eines Nutzers antwortet.

Bei dieser Architektur konfigurieren Sie Google Chat so, dass es über HTTP mit Google Cloud oder einem lokalen Server verbunden wird, wie im folgenden Diagramm dargestellt:

Architektur einer Chat-App, die einen Webdienst auf einem lokalen Server verwendet.

Im obigen Diagramm verläuft ein Nutzer, der mit einer HTTP Chat-App interagiert, den folgenden Informationsfluss:

  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 ein On-Premises-System ist, das die Logik der Chat-App enthält.
  3. Optional kann die Logik der Chat-App in Google Workspace-Dienste (z. B. Google Kalender und Google Tabellen), andere Google-Dienste (z. B. Google Maps, YouTube und Vertex AI) oder andere Webdienste (z. B. ein Projektverwaltungssystem oder ein Ticketsystem) eingebunden werden.
  4. Der Webserver sendet eine HTTP-Antwort an den Chat App-Dienst in Google Chat zurück.
  5. Die Antwort wird an den Nutzer gesendet.
  6. Die Chat-App kann optional die Chat API aufrufen, um asynchron Nachrichten zu posten 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-Apps in verschiedenen Programmiersprachen entwickelt werden können.

Zielsetzungen

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

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, 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

Erstellen und implementieren Sie eine Cloud Function, 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. Wechseln Sie in der Google Cloud Console zur Seite Cloud Functions:

    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 Cloud Run-Funktion 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 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 folgenden Code:

    node/avatar-app/index.js
    // 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

    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 Cloud Run-Funktion 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 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 folgenden Code:

    python/avatar-app/main.py
    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

    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 Cloud Run-Funktion 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 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. Benennen Sie src/main/java/com/example/Example.java in src/main/java/App.java um.

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

    java/avatar-app/src/main/java/App.java
    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. Ersetzen Sie den Inhalt von pom.xml durch 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>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. Klicken Sie auf Bereitstellen.

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

Google Chat zum Aufrufen Ihrer Funktion autorisieren

Wenn Sie Google Chat autorisieren möchten, Ihre Funktion aufzurufen, fügen Sie dem Google Chat-Dienstkonto die Rolle Cloud Run Invoker hinzu.

  1. Wechseln Sie in der Google Cloud Console zur Seite Cloud Run.

    Zu Cloud Run

  2. Klicken Sie in der Liste der Cloud Run-Dienste auf das Kästchen neben der empfangenden Funktion. (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 chat@system.gserviceaccount.com ein.

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

  7. Klicken Sie auf Speichern.

App in Google Chat veröffentlichen

Nachdem die Cloud-Funktion bereitgestellt wurde, können Sie sie so in eine Google Chat-App umwandeln:

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü &gt; 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 den Tab Trigger.

  4. Kopieren Sie unter HTTPS 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 unter 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 Funktionen die Option 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
    5. Wählen Sie unter Verbindungseinstellungen die Option HTTP-Endpunkt-URL aus und fügen Sie die URL für den Cloud Functions-Trigger in das Feld ein.
    6. Wählen Sie unter Authentifizierungsziel die Option HTTP-Endpunkt-URL aus.
    7. Wählen Sie unter Sichtbarkeit die Option Diese Google Chat-App bestimmten Personen und Gruppen in Ihrer Domain zur Verfügung stellen aus und geben Sie Ihre E-Mail-Adresse ein.
    8. Wählen Sie unter Protokolle die Option Fehler in Logging protokollieren aus.

  7. Klicken Sie auf Speichern.

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

Chat-App testen

Öffnen Sie zum Testen der Chat-App einen Bereich für Direktnachrichten mit der Chat-App und senden Sie eine Nachricht:

  1. Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie angegeben haben, als Sie sich als vertrauenswürdiger 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 Ihrer Chat-App ein.

  4. Wählen Sie in den Ergebnissen die Chat-App aus. Eine Direktnachricht wird geöffnet.

  5. Geben Sie in der neuen Direktnachricht an die App Hello ein und drücken Sie enter.

Die Antwort der Chat-App enthält eine Kartennachricht mit dem Namen und dem Avatarbild des Absenders, wie im folgenden Bild dargestellt:

Chat-App antwortet mit einer Karte mit dem Anzeigenamen und dem Avatarbild des Absenders

Informationen zum Hinzufügen von Trusted Testern und zum Testen interaktiver Funktionen finden Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Fehlerbehebung

Wenn eine Google Chat-App oder Karte einen Fehler zurückgibt, wird in der Chat-Benutzeroberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage konnte nicht verarbeitet werden“ Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte führt zu einem unerwarteten Ergebnis. Beispielsweise wird eine Kartennachricht möglicherweise nicht angezeigt.

Auch wenn in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, die Ihnen bei der Fehlerbehebung helfen, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Ansehen, Entfernen und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben.

Bereinigen

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, sollten Sie das Cloud-Projekt löschen.

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

    Zu Resource Manager

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