Google Chat-App mit Google Apps Script erstellen

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

Mit der Chat-App können Sie direkt Nachrichten senden und erhalten Antworten, die Ihre Nachrichten einbeziehen.

Im folgenden Diagramm werden die Architektur und das Messaging-Muster dargestellt:

Im vorherigen Diagramm hat ein Nutzer, der mit einer Apps Script-Chat-App interagiert, folgenden Informationsfluss:

1. Ein Nutzer sendet eine Nachricht an eine Chat-App, entweder in einer Direktnachricht oder in einem Chatbereich.
2. Die in Apps Script implementierte Chat-App-Logik, die sich in Google Cloud befindet, empfängt und verarbeitet die Nachricht.
3. Optional kann die Chat-App-Logik in Google Workspace-Dienste wie Google Kalender oder Google Sheets oder andere Google-Dienste wie Google Maps oder YouTube eingebunden werden.
4. Die Chat-App-Logik sendet eine Antwort an den Chat-App-Dienst in Chat zurück.
5. Die Antwort wird an den Nutzer gesendet.

Ziele

• die Umgebung einrichten
• Das Script einrichten.
• Die Chat-App konfigurieren.
• Die Chat-App testen.

Vorbereitung

• Ein Google Workspace-Konto für Unternehmen oder Enterprise mit Zugriff auf Google Chat.
• Ein Google Cloud-Projekt. Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.

Umgebung einrichten

Cloud-Projekt in der Google Cloud Console öffnen

Öffnen Sie das Cloud-Projekt, das Sie für dieses Beispiel verwenden möchten, falls es noch nicht geöffnet ist:

1. Rufen Sie in der Google Cloud Console die Seite Projekt auswählen auf.

   Cloud-Projekt auswählen

2. Wählen Sie das Google Cloud-Projekt aus, das Sie verwenden möchten. Oder klicken Sie auf Projekt erstellen und folgen Sie der Anleitung auf dem Bildschirm. Wenn Sie ein Google Cloud-Projekt erstellen, müssen Sie möglicherweise die Abrechnung für das Projekt aktivieren.

Chat API aktivieren

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.

API aktivieren

OAuth-Zustimmungsbildschirm konfigurieren

Für alle Apps, die OAuth 2.0 verwenden, muss ein Zustimmungsbildschirm konfiguriert werden. Wenn Sie den OAuth-Zustimmungsbildschirm Ihrer App konfigurieren, legen Sie fest, was Nutzern und App-Prüfern angezeigt wird, und registrieren Ihre App, damit Sie sie später veröffentlichen können.

1. Rufen Sie in der Google API Console das Menü menu > Google Auth Platform > Branding auf.

   Zum Branding

2. Wenn Sie die Google Auth Platform bereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn die Meldung Google Auth Platform noch nicht konfiguriert angezeigt wird, klicken Sie auf Jetzt starten:
1. Geben Sie unter Anwendungsinformationen im Feld Anwendungsname einen Namen für die App ein.
2. Wählen Sie unter E‑Mail-Adresse für Nutzersupport eine E‑Mail-Adresse für den Support aus, über die Nutzer Sie kontaktieren können, wenn sie Fragen zu ihrer Einwilligung haben.
3. Klicken Sie auf Weiter.
4. Wählen Sie unter Zielgruppe die Option Intern aus.
5. Klicken Sie auf Weiter.
6. Geben Sie unter Kontaktdaten eine E‑Mail-Adresse ein, über die Sie über Änderungen an Ihrem Projekt benachrichtigt werden können.
7. Klicken Sie auf Weiter.
8. Lesen Sie unter Abschließen die Nutzerdatenrichtlinie für Google API-Dienste. Wenn Sie damit einverstanden sind, wählen Sie Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus.
9. Klicken Sie auf Weiter.
10. Klicken Sie auf Erstellen.
3. Sie können das Hinzufügen von Bereichen vorerst überspringen. Wenn Sie später eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie den Nutzertyp in Extern ändern. Fügen Sie dann die Autorisierungsbereiche hinzu, die Ihre App benötigt. Weitere Informationen finden Sie in der vollständigen Anleitung zum Konfigurieren des OAuth-Zustimmungsbildschirms.

Das Script einrichten.

Zum Einrichten des Scripts verwenden Sie die Vorlage für Chat-Apps auf der Seite Erste Schritte von Apps Script.

Apps Script-Projekt erstellen

1. Rufen Sie auf der Seite Erste Schritte von Apps Script den Bereich Google Workspace-Add‑on-Starter auf und klicken Sie auf die Vorlage Chat-App:

   Vorlage für Chat-App öffnen

2. Geben Sie im neuen Apps Script-Projekt einen Namen für das Projekt ein:

   1. Klicken Sie auf Unbenanntes Projekt.

   2. Geben Sie unter Projekttitel Add-on Chat app ein.

   3. Klicken Sie auf Umbenennen.

Wenn Sie bestimmte Google APIs verwenden oder Ihre App veröffentlichen möchten, müssen Sie Ihr Cloud-Projekt mit Ihrem Apps Script-Projekt verknüpfen. Für diese Anleitung ist das nicht erforderlich. Weitere Informationen finden Sie in der Anleitung zu Google Cloud-Projekten.

Testbereitstellung erstellen

Sie benötigen eine Bereitstellungs-ID für dieses Apps Script-Projekt, damit Sie es im nächsten Schritt verwenden können.

So rufen Sie die Bereitstellungs-ID für die Head-Bereitstellung ab:

1. Klicken Sie im Apps Script-Projekt für die Chat-App auf Bereitstellen > Bereitstellungen testen.
2. Kopieren Sie die Bereitstellungs-ID für die Head-Bereitstellung für einen späteren Schritt und klicken Sie auf Fertig.

Chat-App konfigurieren

Führen Sie die folgenden Schritte aus, um die Google Chat-App zu konfigurieren:

1. Suchen Sie in der API Console nach Google Chat API, und klicken Sie auf Google Chat API.
2. Klicken Sie auf Verwalten.

3. Klicken Sie auf Konfiguration und richten Sie die Chat-App ein:

   1. Geben Sie im Feld Anwendungsname Add-on Chat app ein.
   2. Geben Sie im Feld Avatar-URL https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png ein.
   3. Geben Sie im Beschreibung Feld Add-on Chat app ein.
   4. Wählen Sie unter Funktionen die Option Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
   5. Wählen Sie unter „Verbindungseinstellungen“ die Option Apps Script-Projekt aus.
   6. Fügen Sie im Feld Bereitstellungs-ID die zuvor kopierte Bereitstellungs-ID für die Head-Bereitstellung ein.
   7. Wählen Sie unter „Sichtbarkeit“ die Option Bestimmte Personen und Gruppen in Ihrer Domain aus und geben Sie Ihre E‑Mail-Adresse ein.

4. Klicken Sie auf Speichern.

Die Chat-App ist bereit, auf Nachrichten zu antworten.

Chat-App testen

Öffnen Sie zum Testen Ihrer Chat-App einen Direktnachrichtenbereich mit der Chat-App und senden Sie eine Nachricht:

1. Ö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

2. Klicken Sie auf add Neuer Chat.
3. Geben Sie im Feld 1 oder mehrere Personen hinzufügen den Namen Ihrer Chat-App ein.

4. Wählen Sie Ihre Chat-App in den Ergebnissen aus. Eine Direktnachricht wird geöffnet.

5. Geben Sie in der neuen Direktnachricht mit der App Hello ein und drücken Sie enter.

   Die Chat-App bedankt sich für das Hinzufügen und wiederholt Ihre Nachricht.

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.“ angezeigt. Manchmal wird in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder Karte liefert ein unerwartetes Ergebnis. Beispielsweise wird möglicherweise keine Kartenmeldung angezeigt.

Auch wenn in der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt wird, beschreibende 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.

1. Rufen Sie in der Google API Console die Seite Ressourcen verwalten auf. Klicken Sie auf das Menü menu > IAM & Verwaltung > Ressourcen verwalten.

   Zum Ressourcenmanager

2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen delete.
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Beenden, um das Projekt zu löschen.