Auf dieser Seite wird beschrieben, wie Sie eine Chat-App mit Pub/Sub erstellen. Diese Art von Architektur für eine Chat-App ist nützlich, wenn Ihre Organisation eine Firewall hat, die verhindert, dass Chat Nachrichten an Ihre Chat-App sendet, oder wenn die Chat-App die Google Workspace Events APIverwendet. Diese Architektur hat jedoch die folgenden Einschränkungen, da diese Chat-Apps nur asynchrone Nachrichtensenden und empfangen können:
- Dialogfelder können nicht in Nachrichten verwendet werden. Verwenden Sie stattdessen eine Kartennachricht.
- Einzelne Karten können nicht mit einer synchronen Antwort aktualisiert werden. Aktualisieren Sie stattdessen
die gesamte Nachricht, indem Sie die
patchMethode aufrufen.
Das folgende Diagramm zeigt die Architektur einer mit Pub/Sub erstellten Chat-App:
Im vorherigen Diagramm hat ein Nutzer, der mit einer Pub/Sub-Chat-App interagiert, den folgenden Informationsfluss:
Ein Nutzer sendet in Chat eine Nachricht an eine Chat-App, entweder in einer Direktnachricht oder in einem Chatbereich, oder es tritt ein Ereignis in einem Chatbereich auf, für das die Chat-App ein aktives Abo hat.
Chat sendet die Nachricht an ein Pub/Sub-Thema.
Ein Anwendungsserver, entweder ein Cloud- oder ein lokales System, das die Chat-App-Logik enthält, abonniert das Pub/Sub-Thema, um die Nachricht über die Firewall zu empfangen.
Optional kann die Chat-App die Chat API aufrufen, um asynchron Nachrichten zu posten oder andere Vorgänge auszuführen.
Vorbereitung
Wenn Sie Ihre Chat-App erstellen, müssen Sie auf der Seite zur Chat API-Konfiguration in der Google Cloud Console die Option Diese Chat-App als Google Workspace-Add‑on erstellen deaktivieren. Weitere Informationen finden Sie unter App in Google Chat veröffentlichen.
Node.js
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. Informationen zum Prüfen, ob die Abrechnung für ein vorhandenes 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.
- Node.js 14 oder höher
- Das npm Paketverwaltungstool
-
Ein initialisiertes Node.js-Projekt. Wenn Sie ein neues Projekt initialisieren möchten, erstellen Sie einen neuen Ordner, wechseln Sie zu diesem und führen Sie dann den folgenden Befehl in der Befehlszeilenschnittstelle aus:
npm init
Python
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. Informationen zum Prüfen, ob die Abrechnung für ein vorhandenes 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.
- Python 3.6 oder höher
- Das Paketverwaltungstool pip
Java
- Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. Informationen zum Prüfen, ob die Abrechnung für ein vorhandenes 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.
- Java 11 oder höher
- Das Paketverwaltungstool Maven
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 und die Pub/Sub API.
Pub/Sub einrichten
Erstellen Sie ein Pub/Sub-Thema an das die Chat API Nachrichten senden kann. Wir empfehlen, ein einzelnes Thema pro Chat-App zu verwenden.
Gewähren Sie Chat die Berechtigung, zu veröffentlichen im Thema, indem Sie dem folgenden Dienstkonto die Rolle Pub/Sub-Publisher zuweisen:
chat-api-push@system.gserviceaccount.comErstellen Sie ein Dienstkonto für die Chat-App, um sich bei Pub/Sub und Chat zu authentifizieren, und speichern Sie die Datei mit dem privaten Schlüssel in Ihrem Arbeitsverzeichnis.
Erstellen Sie ein Pull-Abo für das Thema.
Weisen Sie dem zuvor erstellten Dienstkonto die Rolle Pub/Sub-Abonnent für das Abo zu.
Skript schreiben
Node.js
Geben Sie in einer Befehlszeilenschnittstelle die Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATHGeben Sie in einer Befehlszeilenschnittstelle die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_IDGeben Sie in einer Befehlszeilenschnittstelle die Abo-ID für das zuvor erstellte Pub/Sub-Abo an:
export SUBSCRIPTION_ID=SUBSCRIPTION_IDErstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
package.json.Fügen Sie in die Datei
package.jsonden folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
index.js.Fügen Sie in
index.jsden folgenden Code ein:
Python
Geben Sie in einer Befehlszeilenschnittstelle die Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATHGeben Sie in einer Befehlszeilenschnittstelle die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_IDGeben Sie in einer Befehlszeilenschnittstelle die Abo-ID für das zuvor erstellte Pub/Sub-Abo an:
export SUBSCRIPTION_ID=SUBSCRIPTION_IDErstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
requirements.txt.Fügen Sie in die Datei
requirements.txtden folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
app.py.Fügen Sie in
app.pyden folgenden Code ein:
Java
Geben Sie in einer Befehlszeilenschnittstelle die Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATHGeben Sie in einer Befehlszeilenschnittstelle die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_IDGeben Sie in einer Befehlszeilenschnittstelle die Abo-ID für das zuvor erstellte Pub/Sub-Abo an:
export SUBSCRIPTION_ID=SUBSCRIPTION_IDErstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
pom.xml.Fügen Sie in die Datei
pom.xmlden folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis die Verzeichnisstruktur
src/main/java.Erstellen Sie im Verzeichnis
src/main/javaeine Datei mit dem NamenMain.java.Fügen Sie in
Main.javaden folgenden Code ein:
App in Chat veröffentlichen
Gehen Sie in der Google Cloud Console zu Menü > APIs und Dienste > Aktivierte APIs und Dienste > Google Chat API > Konfiguration.
Konfigurieren Sie die Chat-App für Pub/Sub:
- Deaktivieren Sie Diese Chat-App als Google Workspace-Add‑on erstellen. Ein Dialogfeld wird geöffnet, in dem Sie die Aktion bestätigen müssen. Klicken Sie im Dialogfeld auf Deaktivieren.
- Geben Sie unter App-Name
Quickstart Appein. - Geben Sie unter Avatar-URL
https://developers.google.com/chat/images/quickstart-app-avatar.pngein. - Geben Sie unter Beschreibung
Quickstart appein. - Wählen Sie unter Funktionen die Option Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
- Wählen Sie unter Verbindungseinstellungen die Option Cloud Pub/Sub aus und fügen Sie den Namen des zuvor erstellten Pub/Sub-Themas ein.
- Wählen Sie unter Sichtbarkeit die Option Diese Google Chat-App bestimmten Personen und Gruppen in meiner Domain zur Verfügung stellen aus und geben Sie Ihre E-Mail-Adresse ein.
- Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.
Klicken Sie auf Speichern.
Die App ist jetzt bereit, Nachrichten in Chat zu empfangen und darauf zu antworten.
Skript ausführen
Wechseln Sie in einer Befehlszeilenschnittstelle zu Ihrem Arbeitsverzeichnis und führen Sie das Skript aus:
Node.js
npm install
npm start
Python
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
Java
mvn compile exec:java -Dexec.mainClass=Main
Wenn Sie den Code ausführen, beginnt die Anwendung, auf Nachrichten zu warten, die im Pub/Sub-Thema veröffentlicht werden.
Chat-App testen
Wenn Sie Ihre Chat-App testen möchten, ö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.
- Klicken Sie auf Neuer Chat.
- Geben Sie im Feld 1 oder mehrere Personen hinzufügen den Namen Ihrer Chat-App ein.
Wählen Sie Ihre Chat-App in den Ergebnissen aus. Eine Direktnachricht wird geöffnet.
- Geben Sie in der neuen Direktnachricht an die App
Helloein und drücken Sieenter.
Informationen zum Hinzufügen vertrauenswürdiger Tester 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-Oberfläche die Meldung „Ein Fehler ist aufgetreten.“ 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 wird beispielsweise möglicherweise keine Kartennachricht angezeigt.
Auch wenn in der Chat-UI keine Fehlermeldung angezeigt wird, aussagekräftige Fehlermeldungen und Logdaten sind verfügbar, mit denen Sie Fehler beheben können, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Ansehen, Debuggen und Beheben von Fehlern finden Sie unter Fehler in Google Chat 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.
- Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf Menü > IAM und Verwaltung > Ressourcen verwalten.
- 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 Herunterfahren, um das Projekt zu löschen.
Weitere Informationen
Informationen zum Hinzufügen weiterer Funktionen zu Ihrer Chat-App finden Sie unter: