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 Google Chat Nachrichten an Ihre Chat-App sendet, oder wenn die Chat-App die Google Workspace Events API verwendet. Diese Architektur hat jedoch die folgenden Einschränkungen, da diese Chat-Apps nur asynchrone Nachrichten senden und empfangen können:
- Dialogfelder können nicht in Nachrichten verwendet werden. Verwenden Sie stattdessen eine Kartenmitteilung.
- Einzelne Karten können nicht mit einer synchronen Antwort aktualisiert werden. Aktualisieren Sie stattdessen die gesamte Nachricht, indem Sie die Methode
patch
aufrufen.
Das folgende Diagramm zeigt die Architektur einer Chat-App, die mit Pub/Sub erstellt wurde:
Im vorherigen Diagramm wird der Informationsfluss eines Nutzers, der mit einer Pub/Sub-Chat-App interagiert, so dargestellt:
Ein Nutzer sendet eine Nachricht in Google Chat an eine Chat-App, entweder in einer Direktnachricht oder in einem Chatbereich, oder es findet ein Ereignis in einem Chatbereich statt, für das die Chat-App ein aktives Abo hat.
Chat sendet die Nachricht an ein Pub/Sub-Thema.
Ein Anwendungsserver, also ein Cloud- oder On-Premise-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
Java
- 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.
- Java 11 oder höher
- Das Paketverwaltungstool Maven
Python
- 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.
- Python 3.6 oder höher
- Das Paketverwaltungstool pip
Node.js
- 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.
- Node.js 14 oder höher
- Das Paketverwaltungstool npm
-
Ein initialisiertes Node.js-Projekt. Um ein neues Projekt zu initialisieren, erstellen Sie einen neuen Ordner, wechseln Sie in diesen und führen Sie dann den folgenden Befehl in der Befehlszeilenschnittstelle aus:
npm init
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, pro Chat-App nur ein Thema zu verwenden.
Gewähren Sie Chat die Berechtigung zum Veröffentlichen im Thema, indem Sie dem folgenden Dienstkonto die Rolle Pub/Sub-Publisher zuweisen:
chat-api-push@system.gserviceaccount.com
Erstellen 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.
Script schreiben
Java
Anmeldedaten für das Dienstkonto in einer CLI bereitstellen:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer CLI die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer CLI die Abo-ID für das Pub/Sub-Abo an, das Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
pom.xml
.Fügen Sie in die Datei
pom.xml
den folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis die Verzeichnisstruktur
src/main/java
.Erstellen Sie im Verzeichnis
src/main/java
eine Datei mit dem NamenMain.java
.Fügen Sie in
Main.java
den folgenden Code ein:
Python
Anmeldedaten für das Dienstkonto in einer CLI bereitstellen:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer CLI die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer CLI die Abo-ID für das Pub/Sub-Abo an, das Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
requirements.txt
.Fügen Sie in die Datei
requirements.txt
den folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
app.py
.Fügen Sie in
app.py
den folgenden Code ein:
Node.js
Anmeldedaten für das Dienstkonto in einer CLI bereitstellen:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer CLI die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer CLI die Abo-ID für das Pub/Sub-Abo an, das Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
package.json
.Fügen Sie in die Datei
package.json
den folgenden Code ein:Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
index.js
.Fügen Sie in
index.js
den folgenden Code ein:
App in Google Chat veröffentlichen
Rufen Sie in der Google Cloud Console das Menü> APIs und Dienste > Aktivierte APIs und Dienste > Google Chat API > Konfiguration auf.
Chat-App für Pub/Sub konfigurieren:
- Geben Sie unter App-Name
Quickstart App
ein. - Geben Sie unter Avatar URL (Avatar-URL)
https://developers.google.com/chat/images/quickstart-app-avatar.png
ein. - Geben Sie unter Beschreibung
Quickstart app
ein. - Wählen Sie unter Funktionsweise 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 Pub/Sub-Themas ein, das Sie zuvor erstellt haben.
- 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.
- Wählen Sie unter Logs die Option Fehler in Logging protokollieren aus.
- Geben Sie unter App-Name
Klicken Sie auf Speichern.
Die App ist bereit, Nachrichten in Google Chat zu empfangen und darauf zu antworten.
Skript ausführen
Wechseln Sie in einer CLI in Ihr Arbeitsverzeichnis und führen Sie das Skript aus:
Java
mvn compile exec:java -Dexec.mainClass=Main
Python
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
Node.js
npm install
npm start
Wenn Sie den Code ausführen, beginnt die Anwendung, auf Nachrichten zu warten, die im Pub/Sub-Thema veröffentlicht werden.
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.
- 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.
- Geben Sie in der neuen Direktnachricht mit der App
Hello
ein und drücken Sie dieenter
-Taste.
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.
- Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü > IAM & 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 Beenden, um das Projekt zu löschen.
Weitere Informationen
Wenn Sie Ihrer Chat-App weitere Funktionen hinzufügen möchten, lesen Sie die folgenden Informationen: