Google Chat-App mit Google Apps Script erstellen

Auf dieser Seite wird beschrieben, wie Sie mit Google Apps Script eine Google Chat-App erstellen. Die Chat-App ermöglicht es Ihnen, direkt Nachrichten zu senden, und antwortet, indem sie Ihre Nachrichten wiederholt.

Das folgende Diagramm zeigt die Architektur und das Messaging-Muster:

Im vorherigen Diagramm hat ein Nutzer, der mit einer Apps Script-Chat-App interagiert, den 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 Logik der Chat-App in Google Workspace-Dienste wie Google Kalender oder Google Sheets oder andere Google-Dienste wie Google Maps oder YouTube eingebunden werden.
4. Die Logik der Chat-App sendet eine Antwort an den Chat-App-Dienst in Google Chat zurück.
5. Die Antwort wird an den Nutzer gesendet.

Ziele

• die Umgebung einrichten
• Das Script einrichten.
• Konfigurieren Sie die Chat-App.
• Testen Sie die Chat-App.

Vorbereitung

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

Umgebung einrichten

Öffnen Sie Ihr Cloud-Projekt in der Google Cloud Console.

Ö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, ist eine Konfiguration des Zustimmungsbildschirms erforderlich. Wenn Sie den OAuth-Zustimmungsbildschirm Ihrer App konfigurieren, legen Sie fest, was Nutzern und App-Prüfern angezeigt wird. Außerdem registrieren Sie Ihre App, damit Sie sie später veröffentlichen können.

1. Öffnen Sie in der Google API Console das Menü  > Google Auth-Plattform > Branding.

   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 Sie die Meldung Google Auth Platform noch nicht konfiguriert sehen, klicken Sie auf Jetzt starten:
1. Geben Sie unter App-Informationen im Feld App-Name einen Namen für die App ein.
2. Wählen Sie unter E-Mail-Adresse für Nutzersupport eine Support-E-Mail-Adresse aus, über die Nutzer Sie mit Fragen zu ihrer Einwilligung kontaktieren können.
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, unter der Sie über Änderungen an Ihrem Projekt benachrichtigt werden können.
7. Klicken Sie auf Weiter.
8. Lesen Sie unter Abschließen die Richtlinie zu Nutzerdaten für Google API-Dienste und wählen Sie Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus, wenn Sie zustimmen.
9. Klicken Sie auf Weiter.
10. Klicken Sie auf Erstellen.
3. Sie können das Hinzufügen von Bereichen vorerst überspringen. Wenn Sie in Zukunft 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 im vollständigen Leitfaden OAuth-Zustimmung konfigurieren.

Script einrichten

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

Apps Script-Projekt erstellen

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

   Chat-App-Vorlage öffnen

2. Geben Sie dem neuen Apps Script-Projekt, das geöffnet wird, einen Namen:

   1. Klicken Sie auf Unbenanntes Projekt.

   2. Geben Sie unter Projekttitel Quickstart app ein.

   3. Klicken Sie auf Umbenennen.

Wenn Sie in Zukunft 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 im Leitfaden zu Google Cloud-Projekten.

Test-Deployment 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 ID der Head-Bereitstellung ab:

1. Klicken Sie im Apps Script-Projekt der Chat-App auf Bereitstellen > Deployments testen.
2. Kopieren Sie die Head-Deployment-ID, um sie in einem späteren Schritt zu verwenden, und klicken Sie auf Fertig.

Chat-App konfigurieren

So konfigurieren Sie die Google Chat App:

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 App-Name Quickstart app ein.
   2. Geben Sie im Feld Avatar-URL https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ein.
   3. Geben Sie im Feld Beschreibung den Text Quickstart app ein.
   4. Wählen Sie unter Funktionsweise 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 Deployment-ID die zuvor kopierte Head-Deployment-ID 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 Trusted Tester hinzugefügt haben.

   Zu Google Chat wechseln

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

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

   Hinweis: Wenn Ihre Chat-App nicht in der Ergebnisliste angezeigt wird, prüfen Sie, ob Sie Ihr Google Workspace-Konto in den Sichtbarkeitseinstellungen auf der Seite Chat API-Konfiguration in der Google API Console angegeben haben.

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.

Weitere 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 Karte einen Fehler zurückgibt, wird in der Chat-Oberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal wird auf der Chat-Benutzeroberfläche keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte liefert ein unerwartetes Ergebnis. Beispielsweise wird eine Kartennachricht möglicherweise nicht angezeigt.

Auch wenn in der Chat-Benutzeroberfläche möglicherweise keine Fehlermeldung angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, mit denen Sie Fehler beheben können, wenn das Fehler-Logging für Chat-Apps aktiviert ist. Informationen zum Ansehen, 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.

Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für diese Anleitung ein bereits bestehendes Projekt verwendet haben, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID verwenden, z. B. eine URL auf appspot.com, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, statt das gesamte Projekt.

Wenn Sie mehrere Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. Wechseln Sie in der Google API Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü > IAM und 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 .
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Beenden, um das Projekt zu löschen.

Nächste Schritte

• Interaktive Karten erstellen: Kartennachrichten unterstützen ein definiertes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Mit Kartennachrichten können Sie detaillierte Informationen präsentieren, Informationen von Nutzern erfassen und Nutzer zu einem nächsten Schritt anleiten.
• Auf Befehle reagieren: Mit Befehlen können Nutzer wichtige Funktionen Ihrer Chat-App finden und verwenden.
• Dialogfelder starten: Dialogfelder sind kartenbasierte Fenster, die Ihre App öffnen kann, um mit einem Nutzer zu interagieren. Mehrere Karten können nacheinander angeordnet werden, um Nutzern bei mehrstufigen Prozessen wie dem Ausfüllen von Formulardaten zu helfen.
• Codelab: Sind Sie bereit, eine komplexere Chat-App zu erstellen? Sehen Sie sich die Feedback-Chat-App aus dem Codelab Apps für Google Chat mit Gemini entwickeln an.

Chat-Apps, die keine Add-ons sind: Google Chat-App mit Google Apps Script erstellen

Wenn Sie eine Chat-App, die kein Google Workspace-Add‑on ist, mit Apps Script erstellen möchten, folgen Sie dieser Anleitung, um das Script aus der Vorlage zu erstellen und die Chat-App, die kein Add‑on ist, zu konfigurieren.

Script aus der Vorlage erstellen

1. Chat-App-Vorlage öffnen

2. Klicken Sie auf Unbenanntes Projekt, geben Sie Quickstart app ein und klicken Sie auf Umbenennen.

   Wenn Sie in Zukunft 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 im Leitfaden zu Google Cloud-Projekten.

3. Klicken Sie im Apps Script-Projekt der Chat-App auf Bereitstellen > Bereitstellungen testen.

4. Kopieren Sie die Head-Deployment-ID, um sie im nächsten Schritt zu verwenden, und klicken Sie auf Fertig.

Chat-App konfigurieren, die kein Add‑on ist

Konfigurieren Sie die Chat-App, die kein Add-on ist, über die API Console:

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, die kein Add-on ist:

   1. Deaktivieren Sie Diese Chat-App als Google Workspace-Add‑on erstellen. Ein Dialogfeld wird geöffnet, in dem Sie zur Bestätigung aufgefordert werden. Klicken Sie im Dialogfeld auf Deaktivieren.
   2. Geben Sie im Feld App-Name Quickstart app ein.
   3. Geben Sie im Feld Avatar-URL https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png ein.
   4. Geben Sie im Feld Beschreibung den Text Quickstart app ein.
   5. Wählen Sie unter Funktionsweise die Option Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
   6. Wählen Sie unter Verbindungseinstellungen die Option Apps Script aus.
   7. Fügen Sie im Feld Deployment-ID die zuvor kopierte Head-Deployment-ID ein.
   8. 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.