Diese Seite wurde von der Cloud Translation API übersetzt.

HTTP-Google Chat-Anwendung erstellen

Auf dieser Seite wird beschrieben, wie Sie ein Google Workspace-Add‑on erstellen, das in Google Chat mit einem HTTP-Dienst funktioniert.

In dieser Kurzanleitung erfahren Sie, wie Sie einen HTTP-Dienst mit Google Cloud-Diensten erstellen. Um die Chat-App zu erstellen, schreiben und stellen Sie eine Cloud Run-Funktion bereit, die die Chat-App verwendet, um auf die Nachricht eines Nutzers zu antworten.

Bei einer HTTP-Architektur konfigurieren Sie Chat so, dass es über HTTP in Google Cloud oder auf einem lokalen Server integriert wird, wie im folgenden Diagramm dargestellt:

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

Im vorherigen Diagramm sieht der Informationsfluss bei der Interaktion eines Nutzers mit einer HTTP-Chat-App so aus:

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-App-Logik enthält.
Optional kann die Chat-App-Logik in Google Workspace-Dienste (z. B. Kalender und Tabellen), andere Google-Dienste (z. B. Maps, YouTube und Vertex AI) oder andere Webdienste (z. B. ein Projektmanagementsystem oder ein Ticketing-Tool) eingebunden werden.
Der Webserver sendet eine HTTP-Antwort zurück an den Chat App-Dienst in Chat.
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 in verschiedenen Programmiersprachen entwickelt werden können.

Lernziele

die Umgebung einrichten
Cloud Run-Funktion erstellen und bereitstellen
Konfigurieren Sie ein Google Workspace-Add‑on für die Chat-App.
App testen

Vorbereitung

Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. Informationen dazu, wie Sie prüfen können, ob die Abrechnung für ein bestehendes Projekt aktiviert ist, finden Sie unter Abrechnungsstatus Ihrer Projekte prüfen. Informationen zum Erstellen eines Projekts und Einrichten der Abrechnung finden Sie unter Google Cloud-Projekt erstellen.

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 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 Run-Funktion erstellen und bereitstellen

Erstellen und stellen Sie eine Cloud Run-Funktion bereit, die eine Chatkarte mit dem Anzeigenamen und dem Avaturbild des Absenders generiert. Wenn die Chat-App eine Nachricht empfängt, wird die Funktion ausgeführt und mit der Karte geantwortet.

So erstellen und stellen Sie die Funktion für Ihre Chat-App bereit:

Node.js

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

Zu Cloud Run

Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.
Klicken Sie auf Funktion schreiben.
Richten Sie auf der Seite Dienst erstellen Ihre Funktion ein:
1. Geben Sie im Feld Name des Dienstkontos addonchatapp ein.
2. Wählen Sie in der Liste Region eine Region aus.
3. Wählen Sie in der Liste Laufzeit die aktuelle Version von Node.js aus.
4. Wählen Sie im Bereich Authentifizierung die Option Authentifizierung erforderlich aus.
5. Klicken Sie auf Erstellen und warten Sie, bis der Dienst in Cloud Run erstellt wurde. Sie werden in der Console zum Tab Quelle weitergeleitet.

Auf dem Tab Quelle:

Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie avatarApp ein.
Ersetzen Sie den Inhalt von index.js durch den folgenden Code:

/**
 * Google Cloud Run 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
 */
import { http } from '@google-cloud/functions-framework';

http('avatarApp', (req, res) => {
    if (req.method === 'GET' || !req.body.chat) {
        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 chatMessage = req.body.chat.messagePayload.message;

    // Replies with the sender's avatar in a card.
    const displayName = chatMessage.sender.displayName;
    const avatarUrl = chatMessage.sender.avatarUrl;
    res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        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 }
                    }]
                }]
            }
        }]
    }}}}});
});

Ersetzen Sie den Inhalt von package.json durch den folgenden Code:

{
  "name": "avatar-app",
  "version": "1.0.0",
  "description": "Google Chat Avatar App",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0"
  }
}

Klicken Sie auf Speichern und wieder bereitstellen.

Python

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

Zu Cloud Run

Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.
Klicken Sie auf Funktion schreiben.
Richten Sie auf der Seite Dienst erstellen Ihre Funktion ein:
1. Geben Sie im Feld Name des Dienstkontos addonchatapp ein.
2. Wählen Sie in der Liste Region eine Region aus.
3. Wählen Sie in der Liste Laufzeit die neueste Version von Python aus.
4. Wählen Sie im Bereich Authentifizierung die Option Authentifizierung erforderlich aus.
5. Klicken Sie auf Erstellen und warten Sie, bis der Dienst in Cloud Run erstellt wurde. Sie werden in der Console zum Tab Quelle weitergeleitet.

Auf dem Tab Quelle:

Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie avatar_app ein.
Ersetzen Sie den Inhalt von main.py durch den folgenden Code:

from typing import Any, Mapping

import flask
import functions_framework

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
    """Google Cloud Run 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)

    # Stores the Google Chat event as a variable.
    chat_message = request_json["chat"]["messagePayload"]["message"]

    # Replies with the sender's avatar in a card.
    display_name = chat_message["sender"]["displayName"]
    avatar_url = chat_message["sender"]["avatarUrl"]
    return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": { "message": {
        "text": "Here's your avatar",
        "cardsV2": [{
            "cardId": "avatarCard",
            "card": {
                "name": "Avatar Card",
                "header": { "title": f"Hello {display_name}!" },
                "sections": [{
                    "widgets": [{
                        "textParagraph": { "text": "Your avatar picture:" }
                    }, {
                        "image": { "imageUrl": avatar_url }
                    }]
                }]
            }
        }]
    }}}}}

Klicken Sie auf Speichern und wieder bereitstellen.

Java

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

Zu Cloud Run

Achten Sie darauf, dass das Projekt für Ihre Chat-App ausgewählt ist.
Klicken Sie auf Funktion schreiben.
Richten Sie auf der Seite Dienst erstellen Ihre Funktion ein:
1. Geben Sie im Feld Name des Dienstkontos addonchatapp ein.
2. Wählen Sie in der Liste Region eine Region aus.
3. Wählen Sie in der Liste Laufzeit die aktuelle Version von Java aus.
4. Wählen Sie im Bereich Authentifizierung die Option Authentifizierung erforderlich aus.
5. Klicken Sie auf Erstellen und warten Sie, bis der Dienst in Cloud Run erstellt wurde. Sie werden in der Console zum Tab Quelle weitergeleitet.

Auf dem Tab Quelle:

Löschen Sie unter Einstiegspunkt den Standardtext und geben Sie AvatarApp ein.
Benennen Sie die Standard-Java-Datei in src/main/java/gcfv2/AvatarApp.java um.
Ersetzen Sie den Inhalt von AvatarApp.java durch den folgenden Code:

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 AvatarApp 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("chat")) {
            response.getWriter().write("Hello! This function is meant to be used " +
                "in a Google Chat Space..");
            return;
        }

        // Stores the Google Chat event as a variable.
        JsonObject chatMessage = body.getAsJsonObject("chat")
            .getAsJsonObject("messagePayload").getAsJsonObject("message");

        // Replies with the sender's avatar in a card.
        String displayName = chatMessage.getAsJsonObject("sender").get("displayName").getAsString();
        String avatarUrl = chatMessage.getAsJsonObject("sender").get("avatarUrl").getAsString();
        Message message = createMessage(displayName, avatarUrl);

        JsonObject createMessageAction = new JsonObject();
        createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));

        JsonObject chatDataAction = new JsonObject();
        chatDataAction.add("createMessageAction", createMessageAction);

        JsonObject hostAppDataAction = new JsonObject();
        hostAppDataAction.add("chatDataAction", chatDataAction);

        JsonObject dataActions = new JsonObject();
        dataActions.add("hostAppDataAction", hostAppDataAction);
        response.getWriter().write(gson.toJson(dataActions));
    }

    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("avatarCard");
        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:

<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.4</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 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 Speichern und wieder bereitstellen.

Die Detailseite des Cloud Run-Dienstes wird geöffnet. Warten Sie, bis die Funktion bereitgestellt wurde.

Add‑on konfigurieren

Nachdem die Cloud Run-Funktion bereitgestellt wurde, gehen Sie so vor, um ein Add-on zu erstellen und die Google Chat-App bereitzustellen:

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

Zu Cloud Run

Achten Sie darauf, dass das Projekt ausgewählt ist, für das Sie Cloud Run aktiviert haben.
Klicken Sie in der Liste der Funktionen auf addonchatapp.
Kopieren Sie auf der Seite Dienstdetails die URL für die Funktion. Die URL endet mit run.app.
Suchen Sie im Google Cloud-Suchfeld nach „Google Chat API“, klicken Sie dann auf Google Chat API und auf Verwalten.

Zur Chat API
Klicken Sie auf Konfiguration und richten Sie die Google Chat App ein:
1. Geben Sie unter App-Name Add-on Chat app ein.
2. Geben Sie unter Avatar URL (Avatar-URL) https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png ein.
3. Geben Sie unter Beschreibung Add-on Chat app ein.
4. Wählen Sie unter Funktionsweise die Option Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
5. Wählen Sie unter Verbindungseinstellungen die Option HTTP-Endpunkt-URL aus.
6. Kopieren Sie die E-Mail-Adresse des Dienstkontos. Sie benötigen diese E-Mail-Adresse, wenn Sie Ihr Add‑on autorisieren, Ihre Funktion aufzurufen.
7. Wählen Sie unter Trigger die Option Gemeinsame HTTP-Endpunkt-URL für alle Trigger verwenden aus und fügen Sie die URL für den Cloud Run-Funktionstrigger in das Feld ein.
8. 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.
9. Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.
Klicken Sie auf Speichern.

Als Nächstes autorisieren Sie die Chat-App, die Cloud Run-Funktion aufzurufen.

Google Chat zum Aufrufen Ihrer Funktion autorisieren

Damit das Google Workspace-Add-on Ihre Funktion aufrufen kann, fügen Sie das Dienstkonto des Google Workspace-Add-ons mit der Rolle Cloud Run Service Invoker (Cloud Run-Dienstaufrufer) hinzu.

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

Zu Cloud Run
Aktivieren Sie in der Liste der Cloud Run-Dienste 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 die E-Mail-Adresse des Google Workspace-Add-on-Dienstkontos ein, das Ihrer Chat-App zugeordnet ist.

Die E-Mail-Adresse des Dienstkontos finden Sie auf der Seite „Chat API-Konfiguration“ unter Verbindungseinstellungen > HTTP-Endpunkt-URL > E-Mail-Adresse des Dienstkontos:

Zur Chat API-Konfiguration
Wählen Sie unter Rolle auswählen die Option Cloud Run > Cloud Run Service Invoker aus.
Klicken Sie auf Speichern.

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

Chat-App testen

So testen Sie Ihre Chat-App: Öffnen Sie einen Direktnachrichtenbereich 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 vertrauenswürdiger Tester hinzugefügt haben.

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

Hinweis:Wenn Ihre Chat-App nicht in der Ergebnisliste angezeigt wird, prüfen Sie, ob Sie Ihr Google Workspace-Konto in den Sichtbarkeitseinstellungen der Seite Chat API-Konfiguration in der Google Cloud Console angegeben haben.
Geben Sie in der neuen Direktnachricht mit der App Hello ein und drücken Sie die enter-Taste.

Die Nachricht der Chat-App enthält eine Karte mit dem Namen und dem Avaturbild des Absenders, wie im folgenden Bild dargestellt:

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

Weitere Informationen zum Hinzufügen von vertrauenswürdigen 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 kann nicht bearbeitet werden.“ Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder ‑Karte liefert ein unerwartetes Ergebnis, z. B. wird eine Kartennachricht nicht angezeigt.

Auch wenn in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt wird, sind aussagekräftige Fehlermeldungen und Protokolldaten verfügbar, die Ihnen helfen, Fehler zu beheben, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Aufrufen, 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, empfehlen wir, das Cloud-Projekt zu löschen.

Achtung:Das Löschen eines Projekts 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 ausgewählte Ressourcen innerhalb des Projekts löschen, statt das gesamte Projekt.

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

Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü > IAM & Verwaltung > Ressourcen verwalten.
Zum Ressourcenmanager
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.

HTTP-Google Chat-Anwendung erstellen Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Lernziele

Vorbereitung

Umgebung einrichten

Cloud Run-Funktion erstellen und bereitstellen

Node.js

Python

Java

Add‑on konfigurieren

Google Chat zum Aufrufen Ihrer Funktion autorisieren

Chat-App testen

Fehlerbehebung

Bereinigen

HTTP-Google Chat-Anwendung erstellen