Auf dieser Seite wird erläutert, wie Sie mit Pub/Sub: Diese Art von Architektur einer Chat-App nützlich ist, wenn in Ihrer Organisation eine Firewall eingerichtet ist, die verhindern kann, dass Google Chat Nachrichten an Ihre Chat-App senden Die Chat-App verwendet die Google Workspace Events API. Dieses Architektur die folgenden Einschränkungen, da diese Chat-Apps können nur Nachrichten senden und empfangen asynchrone Nachrichten:
- Dialogfelder können nicht verwendet werden in Nachrichten. Verwenden Sie stattdessen eine Kartennachricht.
- Bei einer synchronen Antwort können einzelne Karten nicht aktualisiert werden. Aktualisieren Sie stattdessen
gesamte Nachricht durch Aufrufen der Methode
patch
.
Das folgende Diagramm zeigt die Architektur eines Mit Pub/Sub erstellte Chat-App:
Im obigen Diagramm interagiert ein Nutzer mit einem Pub/Sub Die Chat-App umfasst den folgenden Informationsfluss:
Ein Nutzer sendet in Google Chat eine Nachricht an einen Chat-App, entweder in einer Direktnachricht oder in einer Chatbereich oder ein Termin in einem Chatbereich für die die Chat-App eine aktive Abo aus.
Chat sendet die Nachricht an ein Pub/Sub-Thema.
Ein Anwendungsserver, also entweder ein Cloud- oder ein lokales System, enthält die Chat-App-Logik, abonniert den Pub/Sub-Thema, um die Nachricht durch die Firewall zu empfangen.
Optional kann die Chat-App die Chat-API, um Nachrichten asynchron zu posten oder andere Geschäftsabläufe.
Vorbereitung
Java
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. So prüfen Sie, ob die Abrechnung für ein vorhandenes Projekt aktiviert ist: Siehe Überprüfen der Abrechnungsstatus Ihrer Projekte. Informationen zum Erstellen eines Projekts und zum Einrichten der Abrechnung finden Sie unter Erstellen Sie ein Google Cloud-Projekt.
- Java 11 oder höher
- Das Maven-Paketverwaltungstool
Python
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. So prüfen Sie, ob die Abrechnung für ein vorhandenes Projekt aktiviert ist: Siehe Überprüfen der Abrechnungsstatus Ihrer Projekte. Informationen zum Erstellen eines Projekts und zum Einrichten der Abrechnung finden Sie unter Erstellen Sie ein Google Cloud-Projekt.
- Python 3.6 oder höher
- Paketverwaltungstool pip
Node.js
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
- Google Cloud-Projekt mit aktivierter Abrechnungsfunktion. So prüfen Sie, ob die Abrechnung für ein vorhandenes Projekt aktiviert ist: Siehe Überprüfen der Abrechnungsstatus Ihrer Projekte. Informationen zum Erstellen eines Projekts und zum Einrichten der Abrechnung finden Sie unter Erstellen Sie ein Google Cloud-Projekt.
- Node.js 14 oder höher
- Der Parameter npm Paketverwaltungstool
-
Ein initialisiertes Node.js-Projekt. Um ein neues Projekt zu initialisieren, erstellen Sie
wechseln Sie in einen neuen Ordner und führen Sie dann in der Befehlszeile den folgenden Befehl 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
Pub/Sub-Thema erstellen an die die Chat API Nachrichten senden kann. Wir empfehlen die Verwendung von ein Thema pro Chat-App.
Google Chat die Berechtigung zum Veröffentlichen erteilen Thema hinzufügen, indem Sie die Rolle Pub/Sub-Publisher Dienstkonto:
chat-api-push@system.gserviceaccount.com
Dienstkonto erstellen damit die Chat-App mit Pub/Sub autorisiert wird. Chatten Sie und speichern Sie die Datei mit dem privaten Schlüssel in Ihrem Arbeitsverzeichnis.
Pull-Abo erstellen zum Thema.
Weisen Sie dem Abo die Pub/Sub-Abonnentenrolle zu für das Dienstkonto, das Sie zuvor erstellt haben.
Skript schreiben
Java
Geben Sie in einer Befehlszeile Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer Befehlszeile die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer Befehlszeile die Abo-ID für das Pub/Sub-Abo an, das die Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
pom.xml
.Fügen Sie den folgenden Code in die Datei
pom.xml
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
Geben Sie in einer Befehlszeile Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer Befehlszeile die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer Befehlszeile die Abo-ID für das Pub/Sub-Abo an, das die Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
requirements.txt
.Fügen Sie den folgenden Code in die Datei
requirements.txt
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
Geben Sie in einer Befehlszeile Anmeldedaten für das Dienstkonto an:
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
Geben Sie in einer Befehlszeile die Google Cloud-Projekt-ID an:
export PROJECT_ID=PROJECT_ID
Geben Sie in einer Befehlszeile die Abo-ID für das Pub/Sub-Abo an, das die Sie zuvor erstellt haben:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
package.json
.Fügen Sie den folgenden Code in die Datei
package.json
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 Dreistrich-Menü > APIs und Dienste > Aktivierte APIs und Dienste > Google Chat API > Konfiguration.
Konfigurieren Sie die Chat-App für Pub/Sub:
- Geben Sie unter App-Name
Quickstart App
ein. - Geben Sie unter Avatar URL
https://developers.google.com/chat/images/quickstart-app-avatar.png
ein. - Geben Sie unter Beschreibung den Wert
Quickstart app
ein. - Wählen Sie unter Funktionen die Option 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
- Wählen Sie unter Verbindungseinstellungen Cloud Pub/Sub aus und fügen Sie Name des zuvor erstellten Pub/Sub-Themas.
- Wählen Sie unter Sichtbarkeit die Option Diese Google Chat App für bestimmte Personen und Gruppen in Ihrer Domain verfügbar machen 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 kann jetzt Nachrichten in Google Chat empfangen und beantworten.
Skript ausführen
Wechseln Sie in einer Befehlszeile zu Ihrem 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 mit dem Warten auf veröffentlichte Nachrichten zum Pub/Sub-Thema.
Chat-App testen
Öffnen Sie zum Testen der Chat App einen Direktnachrichtenbereich mit Chat-App und senden Sie eine Nachricht:
Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie wenn Sie sich als Trusted Tester hinzugefügt haben.
- Klicken Sie auf Neuer Chat.
- Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihres Chat-App.
Wählen Sie aus den Ergebnissen Ihre Chat-App aus. Eine direkte wird die Nachricht geöffnet.
- Geben Sie in der neuen Direktnachricht an die App
Hello
ein und drücken Sieenter
.
Informationen zum Hinzufügen von Trusted Testern und zum Testen interaktiver Funktionen findest du unter Interaktive Funktionen für Google Chat-Apps
Fehlerbehebung
Wenn eine Google Chat-App oder card gibt einen Fehler zurück. Der Parameter In der Chatoberfläche wird die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal kann die Chat-UI Es wird zwar keine Fehlermeldung angezeigt, aber die Chat-App oder die Karte zu einem unerwarteten Ergebnis führt. z. B. wird eine Kartennachricht erscheinen.
Auch wenn in der Chat-Benutzeroberfläche möglicherweise keine Fehlermeldung angezeigt wird, beschreibende Fehlermeldungen und Protokolldaten stehen zur Fehlerbehebung zur Verfügung. wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Hilfe bei der Anzeige: Debugging und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben
Bereinigen
Um zu vermeiden, dass Ihrem Google Cloud-Konto Gebühren für Ressourcen, die in dieser Anleitung verwendet werden, empfehlen wir, dass Sie den Cloud-Projekt
-
Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf
Menü > IAM und Verwaltung
> Ressourcen verwalten.
<ph type="x-smartling-placeholder"></ph> Zu Resource Manager
- Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie auf löschen.
- Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie zum Löschen auf Beenden. für das Projekt.
Weitere Informationen
Informationen zum Hinzufügen weiterer Funktionen zu Ihrer Chat App finden Sie in der Folgendes: