Google Chat-App mit Google Apps Script erstellen

Entwicklervorschau: Verfügbar als Teil des Google Workspace Developer Preview Program, das frühzeitigen Zugriff auf bestimmte Funktionen gewährt.

Auf dieser Seite wird beschrieben, wie Sie mit Google Apps Script ein Google Workspace-Add-on erstellen, das in Google Chat funktioniert. In Google Chat werden Add-ons für Nutzer als Google Chat-Apps angezeigt. Weitere Informationen finden Sie unter Google Chat erweitern – Übersicht.

Über die Chat-App können Sie direkt Nachrichten senden und erhalten eine Antwort, die Ihre Nachrichten in den Antworten einbezieht.

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

Im vorherigen Diagramm wird der Informationsfluss für einen Nutzer dargestellt, der mit einer Apps Script-Chat-App interagiert:

1. Ein Nutzer sendet eine Nachricht an eine Chat-App, entweder in einer Direktnachricht oder in einem Chat-Bereich.
2. Die Logik der Chat-App, die in Apps Script implementiert ist und 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 Tabellen oder in 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.

Lernziele

• die Umgebung einrichten
• Richten Sie das Script ein.
• Konfigurieren Sie ein Google Workspace-Add-on für die Chat-App.
• Testen Sie die Chat App.

Vorbereitung

• Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
• Ein Google Cloud-Projekt. Weitere 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 noch nicht geschehen:

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. Sie können auch auf Projekt erstellen klicken und der Anleitung auf dem Bildschirm folgen. 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 Einwilligungsbildschirms erforderlich. Wenn Sie den OAuth-Zustimmungsbildschirm Ihrer App konfigurieren, legen Sie fest, was Nutzern und App-Rezensenten angezeigt wird. Außerdem wird Ihre App registriert, damit Sie sie später veröffentlichen können.

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > > Branding.

   Zu „Branding“

2. Wenn Sie die bereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn Sie die Meldung 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 des Nutzersupports 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 Kontaktinformationen eine E-Mail-Adresse ein, unter der Sie über Änderungen an Ihrem Projekt informiert werden können.
7. Klicken Sie auf Weiter.
8. Lesen Sie unter Fertigstellen die Nutzerdatenrichtlinie für Google API-Dienste und wählen Sie dann 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 für Ihre App erforderlich sind. Weitere Informationen finden Sie in der vollständigen Anleitung OAuth-Zustimmung konfigurieren.

Script einrichten

Zum Einrichten des Scripts erstellen Sie eine Kopie des Schnellstartprojekts und richten dann Ihr Cloud-Projekt in Apps Script ein.

Kopie des Einstiegsprojekts erstellen

1. Klicken Sie auf die folgende Schaltfläche, um das Add-on in Google Chat-Apps Script-Projekt zu öffnen.
   Projekt öffnen
2. Klicken Sie auf Übersicht.
3. Klicken Sie auf der Übersichtsseite auf  Kopie erstellen.

4. Geben Sie einen Namen für die Kopie des Apps Script-Projekts an:

   1. Klicken Sie auf Kopie der Add-on-Chat-App.

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

   3. Klicken Sie auf Umbenennen.

Cloud-Projektnummer kopieren

1. Klicken Sie in der Google Cloud Console auf das Dreipunkt-Menü  > IAM und Verwaltung > Einstellungen.

   Weiter zur Seite „IAM & Verwaltung“

2. Kopieren Sie den Wert aus dem Feld Projektnummer.

Cloud-Projekt des Apps Script-Projekts festlegen

1. Klicken Sie im Apps Script-Projekt der Chat App auf Projekteinstellungen .
2. Klicken Sie unter Google Cloud Platform-Projekt (GCP-Projekt) auf Projekt ändern.
3. Fügen Sie unter GCP-Projektnummer die Google Cloud-Projektnummer ein.
4. Klicken Sie auf Projekt festlegen.

Sie haben jetzt funktionierenden App-Code, den Sie wie in den folgenden Schritten beschrieben ausprobieren und dann an Ihre Anforderungen anpassen können.

Achten Sie darauf, dass Sie im richtigen Google-Konto angemeldet sind, wenn Sie das Apps Script-Projekt öffnen. Manchmal wird das aktuelle Konto ohne Ihr Wissen in Ihr Standardkonto umgeschaltet.

Testbereitstellung erstellen

Sie benötigen eine Bereitstellungs-ID für dieses Apps Script-Projekt, damit Sie sie 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 > Bereitstellungen testen.
2. Kopieren Sie die Head-Deployment-ID für einen späteren Schritt und klicken Sie auf Fertig.

Add-on konfigurieren

Führen Sie die folgenden Schritte aus, um mit Ihrer Apps Script-Bereitstellung ein Add-on zu erstellen und die Google Chat App bereitzustellen:

1. Suchen Sie in der Konsole 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 den Namen Add-on Chat app ein.
   2. Geben Sie im Feld Avatar-URL die URL https://developers.google.com/chat/images/quickstart-app-avatar.png ein.
   3. Geben Sie im Feld Beschreibung den Text Add-on Chat app ein.
   4. Wählen Sie unter Funktionsweise die Optionen 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
   5. Wählen Sie unter „Verbindungseinstellungen“ die Option Apps Script-Projekt aus.
   6. Fügen Sie in das Feld Deployment ID (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

Wenn Sie Ihre Chat-App testen möchten, öffnen Sie 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.

   Google Chat öffnen

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 in den Ergebnissen Ihre Chat-App 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 Cloud Console hinzugefügt haben.

5. Geben Sie in der neuen Direktnachricht an die 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 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-Benutzeroberfläche die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann 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

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, empfehlen wir Ihnen, 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 Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Dreistrich-Menü > IAM & Verwaltung > Ressourcen verwalten.

   Ressourcenmanager aufrufen

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.