Diese Seite wurde von der Cloud Translation API übersetzt.

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, mit der die Chat-App auf die Nachricht eines Nutzers antwortet.

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

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

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

Ein Nutzer sendet in Google Chat eine Nachricht an eine Chat-App, entweder in einer Direktnachricht oder in einem Chatbereich.
Eine HTTP-Anfrage wird an einen Webserver gesendet, der entweder ein Cloud- oder ein lokales System ist, das die Chat-Anwendungslogik enthält.
Optional kann die Logik der Chat-App in Google Workspace-Dienste wie Google Kalender und Google Tabellen, andere Google-Dienste wie Maps, YouTube und Vertex AI oder andere Webdienste wie ein Projektmanagementsystem oder ein Ticketing-Tool eingebunden werden.
Der Webserver sendet eine HTTP-Antwort an den Chat-App-Dienst in Google Chat zurück.
Die Antwort wird an den Nutzer gesendet.
Optional kann die Chat-App 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 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.
App testen

Voraussetzungen

Ein Google Workspace-Konto mit Zugriff auf Google Chat und Google Cloud Functions.
Ein Google Cloud-Projekt
Aktivieren Sie die Abrechnung für Ihr Cloud-Projekt. Weitere Informationen finden Sie unter Abrechnungsstatus von Projekten prüfen.

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

Eine Cloud Functions-Funktion erstellen und bereitstellen, die eine Chatkarte mit dem Anzeigenamen und dem Avatar 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

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.
Klicken Sie auf Funktion erstellen.
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.
Wählen Sie unter Laufzeit die neueste Version von Node.js aus.
Wählen Sie unter Quellcode die Option Inline-Editor aus.
Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie helloChat ein.

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

node/avatar-app/index.js

Auf GitHub ansehen

/**
 * 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],
      }
    }],
  };
}

Klicken Sie auf Bereitstellen.

Python

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.
Klicken Sie auf Funktion erstellen.
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.
Wählen Sie unter Laufzeit die neueste Version von Python aus.
Wählen Sie unter Quellcode die Option Inline-Editor aus.
Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie hello_chat ein.

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


# 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

Klicken Sie auf Bereitstellen.

Java

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.
Klicken Sie auf Funktion erstellen.
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.
Wählen Sie unter Laufzeit die neueste Version von Java aus.
Wählen Sie unter Quellcode die Option Inline-Editor aus.
Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie HelloChat ein.
Benennen Sie src/main/java/com/example/Example.java in src/main/java/HelloChat.java um.

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

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

Auf GitHub ansehen

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;
  }
}

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

Klicken Sie auf Bereitstellen.

Die Detailseite von Cloud Functions 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 ausgeblendet und durch ein Häkchen ersetzt sind, ist die Funktion bereitgestellt und einsatzbereit.

Google Chat zum Aufrufen der Funktion autorisieren

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

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

Zu Cloud Run
Klicken Sie in der Liste der Cloud Run-Dienste auf das Kästchen neben der empfangenden Funktion. (Klicken Sie nicht auf die Funktion selbst.)
Klicke auf Berechtigungen. Der Bereich Berechtigungen wird geöffnet.
Klicken Sie auf Hauptkonto hinzufügen.
Geben Sie unter Neue Hauptkonten chat@system.gserviceaccount.com ein.
Wählen Sie unter Rolle auswählen die Option Cloud Run > Cloud Run Invoker aus.
Klicke 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 um:

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.
Klicken Sie in der Liste der Funktionen auf QuickStartChatApp.
Klicken Sie auf den Tab Trigger.
Kopieren Sie die URL unter HTTPS.
Suchen Sie nach „Google Chat API“, klicken Sie auf Google Chat API und dann auf Verwalten.

Zur Chat API
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 den Wert 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 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ählen Sie unter Sichtbarkeit die Option Diese Google Chat-Anwendung für bestimmte Personen und Gruppen in Ihrer Domain verfügbar machen aus und geben Sie Ihre E-Mail-Adresse ein.
8. Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.
Klicke auf Speichern.

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

Chat-App testen

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

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

Zu Google Chat
Klicken Sie auf Neuer Chat.
Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihrer Chat-App ein.
Wählen Sie aus den Ergebnissen Ihre Chat-App aus. Eine Direktnachricht wird geöffnet.

Hinweis:Wenn deine Chat-App nicht in der Liste der Ergebnisse angezeigt wird, prüfe in der Google Cloud Console auf der Seite Chat API-Konfiguration, ob dein Google Workspace-Konto in den Einstellungen für die Sichtbarkeit angegeben ist.
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 Avatar des Absenders, wie in der folgenden Abbildung dargestellt:

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

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

Fehlerbehebung

Wenn eine Google Chat-App oder -Karte einen Fehler zurückgibt, wird in der Chat-Oberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal wird in der Chat-UI keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte liefert ein unerwartetes Ergebnis. So kann z. B. keine Kartenmeldung angezeigt werden.

Obwohl eine Fehlermeldung möglicherweise nicht in der Chat-UI angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, um Sie beim Beheben von Fehlern zu unterstützen, wenn das Fehler-Logging für Chat-Apps aktiviert ist. Informationen zum Ansehen, Debuggen 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.

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 vermeiden, indem Sie Projekte wiederverwenden.

Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü > IAM und Verwaltung > Ressourcen verwalten.
Zu Resource Manager
Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen .
Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Beenden, um das Projekt zu löschen.

Weitere Informationen

Informationen zum Hinzufügen weiterer Funktionen zu Ihrer Chat-App finden Sie hier:
Chat-App-Architektur auswählen
Anfragen von Google Chat bestätigen