Kurzanleitung für Google Apps Script Chat App

Erstellen Sie eine Google Chat-App, der Sie direkt Nachrichten senden können und die mit einem Echo Ihrer Nachrichten antwortet.

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

Im obigen Diagramm verläuft 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 Chat-App-Logik, die in Apps Script implementiert ist und 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 Tabellen 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.

Zielsetzungen

• die Umgebung einrichten
• Richten Sie das Skript ein.
• Veröffentlichen Sie die Chat App.
• Chat-App testen

Voraussetzungen

• Ein Google Workspace-Konto mit Zugriff auf Google Chat.
• Ein Google Cloud-Projekt

Umgebung einrichten

Cloud-Projekt in der Google Cloud Console öffnen

Falls noch nicht geschehen, öffnen Sie das Cloud-Projekt, das Sie für dieses Beispiel verwenden möchten:

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 der Zustimmungsbildschirm konfiguriert werden. Durch das Konfigurieren des OAuth-Zustimmungsbildschirms Ihrer App wird festgelegt, was Nutzern und App-Prüfern angezeigt wird, und Ihre App wird registriert, damit Sie sie später veröffentlichen können.

1. Öffnen Sie in der Google Cloud Console das Dreistrich-Menü menu > APIs und Dienste > OAuth-Zustimmungsbildschirm.

   Zum OAuth-Zustimmungsbildschirm

2. Wählen Sie für Nutzertyp die Option Intern aus und klicken Sie dann auf Erstellen.
3. Füllen Sie das App-Registrierungsformular aus und klicken Sie dann auf Speichern und fortfahren.

4. Vorerst können Sie das Hinzufügen von Bereichen überspringen und auf Speichern und fortfahren klicken. Wenn Sie in Zukunft eine Anwendung zur Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie den Nutzertyp in Extern ändern und dann die Autorisierungsbereiche hinzufügen, die Ihre Anwendung benötigt.

5. Überprüfen Sie die Registrierungsübersicht der App. Klicken Sie auf Bearbeiten, um Änderungen vorzunehmen. Wenn die Anwendungsregistrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.

Skript einrichten

Zum Einrichten des Skripts verwenden Sie eine Vorlage und legen dann Ihr Cloud-Projekt in Apps Script fest.

Skript aus der Vorlage erstellen

1. Rufen Sie die Apps Script-Seite Erste Schritte auf.
2. Klicken Sie auf die Vorlage Chat-App. Möglicherweise müssen Sie nach unten scrollen, um diese Vorlage zu sehen.
3. Klicken Sie auf Unbenanntes Projekt, geben Sie Quickstart app ein und klicken Sie auf Umbenennen.

Cloud-Projektnummer kopieren

1. Öffnen Sie in der Google Cloud Console das Dreistrich-Menü menu > IAM und Verwaltung > Einstellungen.

   IAM- und Verwaltungseinstellungen aufrufen

2. Kopieren Sie den Wert im 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 in GCP-Projektnummer die Google Cloud-Projektnummer ein.
4. Klicken Sie auf Projekt festlegen.

Sie haben jetzt funktionierenden Anwendungscode, den Sie wie in den folgenden Schritten beschrieben testen und dann an Ihre Anforderungen anpassen können.

Achten Sie beim Öffnen der Apps Script-Vorlage darauf, dass Sie im richtigen Google-Konto angemeldet sind. Das aktuelle Konto kann manchmal zu Ihrem Standardkonto wechseln, ohne dass Sie es merken.

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 Head-Bereitstellungs-ID ab:

1. Klicken Sie im Apps Script-Projekt der Chat-App auf Bereitstellen > Bereitstellungen testen.
2. Kopieren Sie die Head-Deployment-ID, damit Sie sie in einem späteren Schritt verwenden können. Klicken Sie dann auf Done (Fertig).

Chat App veröffentlichen

Veröffentlichen Sie die Chat-App über die Google Cloud Console.

1. Suchen Sie in der Google Cloud 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 den Wert Quickstart app ein.
   2. Geben Sie im Feld Avatar URL (Avatar-URL) https://developers.google.com/chat/images/quickstart-app-avatar.png ein.
   3. Geben Sie im Feld Beschreibung den Text Quickstart app ein.
   4. Wählen Sie unter „Funktionalität“ die Option 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 im Feld Deployment ID (Bereitstellungs-ID) die zuvor kopierte Head-Bereitstellungs-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. Klicke auf Speichern.

Die Chat App ist bereit, auf Nachrichten zu antworten.

Chat App testen

Öffnen Sie zum Testen der Chat-App einen Bereich für Direktnachrichten 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

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

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

5. Geben Sie in der neuen Direktnachricht an die Anwendung Hello ein und drücken Sie enter.

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

Informationen zum Hinzufügen von Trusted Testern und zum Testen interaktiver Funktionen finden Sie unter Interaktive Features 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 in der Chat-UI keine Fehlermeldung angezeigt, aber die Chat-App oder -Karte liefert ein unerwartetes Ergebnis. So kann z. B. keine Kartenmeldung angezeigt werden.

Obwohl eine Fehlermeldung möglicherweise nicht in der Chat-UI angezeigt wird, sind beschreibende Fehlermeldungen und Protokolldaten verfügbar, um Sie beim Beheben von Fehlern zu unterstützen, 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, sollten Sie das Cloud-Projekt löschen.

1. Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Menü menu > IAM und Verwaltung > Ressourcen verwalten.

   Zu Resource Manager

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.

Nächste Schritte

• Interaktive Karten erstellen: Kartennachrichten unterstützen ein festgelegtes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Verwenden Sie Kartennachrichten, um detaillierte Informationen zu präsentieren, Informationen von Nutzern zu erfassen und sie zum nächsten Schritt zu führen.
• Unterstützung von Slash-Befehlen: Mit Slash-Befehlen können Sie bestimmte Befehle registrieren und anbieten, die Nutzer Ihrer Anwendung durch die Eingabe eines Befehls eingeben können, der mit einem Schrägstrich (/) beginnt, z. B. /help.
• Startdialogfelder: Dialoge sind kartenbasierte Oberflächen in Fenstermodus, die von Ihrer App geöffnet werden können, um mit einem Nutzer zu interagieren. Es können mehrere Karten nacheinander aneinandergereiht werden, was Nutzern hilft, mehrstufige Prozesse wie das Ausfüllen von Formulardaten auszuführen.
• code Codelab: Bereit für die Entwicklung einer erweiterten Chat-App? Sehen Sie sich dazu die Feedback-App aus dem Codelab Mit Gemini Apps für Google Chat erstellen an.