Auf dieser Seite wird erläutert, wie Sie eine Chat-App mit Pub/Sub erstellen. 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. Diese Architektur hat jedoch die folgenden Einschränkungen, da diese Chat-Apps nur asynchrone Nachrichten senden und empfangen können:
- Dialogfelder können nicht verwendet werden in Nachrichten. 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 Methode
patch
aufrufen.
Das folgende Diagramm zeigt die Architektur einer Chat-App, die mit Pub/Sub erstellt wurde:
Im vorherigen Diagramm wird der Informationsfluss für einen Nutzer dargestellt, der mit einer Pub/Sub-Chat-App interagiert:
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 ein Cloud- oder On-Premises-System, das die Logik der Chat-App enthält, abonniert das Pub/Sub-Thema, um die Nachricht über 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. Wie Sie prüfen, ob für ein bestehendes Projekt die Abrechnung aktiviert ist, erfahren Sie unter Abrechnungsstatus Ihrer Projekte prüfen. 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 Paketverwaltungstool Maven
Python
- Ein Google Workspace-Konto für Unternehmen oder Organisationen 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
- Das Paketverwaltungstool pip
Node.js
- Ein Google Workspace-Konto für Unternehmen oder Organisationen 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
- Das Paketverwaltungstool npm
-
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 Befehlszeile 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, pro Chat-App ein einzelnes Thema zu verwenden.
Weisen Sie dem Thema die Berechtigung zum Veröffentlichen von Chats zu, indem Sie dem folgenden Dienstkonto die Rolle Pub/Sub-Publisher zuweisen:
chat-api-push@system.gserviceaccount.com
Erstellen Sie ein Dienstkonto, das die Chat-App für die Autorisierung bei Pub/Sub und Chat verwenden kann, 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.
Script schreiben
Java
Geben Sie in einer Befehlszeile die 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 zuvor erstellte Pub/Sub-Abo an:
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 die 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 zuvor erstellte Pub/Sub-Abo an:
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
requirements.txt
.Fügen Sie in der 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
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 zuvor erstellte Pub/Sub-Abo an:
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 Anwendungsname
Quickstart App
ein. - Geben Sie unter Avatar URL
https://developers.google.com/chat/images/quickstart-app-avatar.png
ein. - Geben Sie unter Beschreibung
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 bestimmten Personen und Gruppen in zur Verfügung stellen aus und geben Sie Ihre E-Mail-Adresse ein.
- Wählen Sie unter Protokolle die Option Fehler in Logging protokollieren aus.
- Geben Sie unter Anwendungsname
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 Script 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 hören, die im Pub/Sub-Thema veröffentlicht werden.
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 in den Ergebnissen die 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 finden Sie unter Interaktive Funktionen für Google Chat-Apps testen.
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 konnte nicht verarbeitet werden“ Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte führt zu einem unerwarteten Ergebnis. Beispielsweise wird möglicherweise keine Kartennachricht angezeigt.
Auch wenn in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, die Ihnen bei der Fehlerbehebung helfen, wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Informationen zum Ansehen, Entfernen 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.
- 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
So fügen Sie Ihrer Chat-App weitere Funktionen hinzu: