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 antwortet.

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

Architektur einer mit Apps Script implementierten Chat-App

Im obigen Diagramm hat ein Nutzer, der mit einer Apps Script Chat-Anwendung interagiert, den folgenden Informationsfluss:

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

Zielsetzungen

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

Voraussetzungen

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

Für alle Apps, die OAuth 2.0 verwenden, ist ein Zustimmungsbildschirm konfiguriert. Wenn Sie den OAuth-Zustimmungsbildschirm Ihrer Anwendung konfigurieren, wird festgelegt, was Nutzern und Prüfern angezeigt wird. Außerdem wird die Anwendung registriert, damit Sie sie später veröffentlichen können.

  1. Rufen Sie in der Google Cloud Console das Menü auf > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Wählen Sie den Nutzertyp für Ihre App aus und klicken Sie 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 für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie die für die Anwendung erforderlichen Autorisierungsbereiche hinzufügen und überprüfen.

  5. Wenn Sie als Nutzertyp Extern ausgewählt haben, fügen Sie Testnutzer hinzu:
    1. Klicken Sie unter Testnutzer auf Nutzer hinzufügen.
    2. Geben Sie Ihre E-Mail-Adresse und alle weiteren autorisierten Testnutzer ein und klicken Sie dann auf Speichern und fortfahren.
  6. Prüfen Sie die Zusammenfassung der App-Registrierung. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die Anwendungsregistrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.

Skript einrichten

Verwenden Sie zum Einrichten des Skripts eine Vorlage und richten Sie dann Ihr Cloud-Projekt in Apps Script ein.

Script aus der Vorlage erstellen

  1. Rufen Sie die Seite Erste Schritte mit Apps Script auf.
  2. Klicken Sie auf die Vorlage Chat-App. Eventuell 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ü > IAM und Verwaltung > Einstellungen.

    Zur Seite „IAM und Verwaltung“

  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 Das Symbol für die Projekteinstellungen.
  2. Klicken Sie unter Google Cloud Platform-Projekt (GCP) 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 Anwendungscode, den Sie wie in den folgenden Schritten beschrieben ausprobieren 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 zum Standardkonto wechseln, ohne dass Sie es merken.

Testbereitstellung erstellen

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

So rufen Sie die Head-Deployment-ID ab:

  1. Klicken Sie im Apps Script-Projekt der Chat-App auf Bereitstellen > Bereitstellungen testen.
  2. Kopieren Sie die Head-Deployment-ID zur Verwendung in einem späteren Schritt und klicken Sie 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. Klicke 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 den Wert 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“ 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten aus.
    5. Wählen Sie unter „Verbindungseinstellungen“ die Option Apps Script-Projekt aus und fügen Sie die Bereitstellungs-ID in das Feld ein.
    6. 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 und aktualisieren Sie die Seite.

  5. Legen Sie auf der Konfigurationsseite unter Anwendungsstatus den Status auf Live – für Nutzer verfügbar fest.

  6. Klicken Sie auf Speichern.

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

Chat App testen

  1. Öffnen Sie Google Chat.
  2. Senden Sie eine neue Direktnachricht an die App. Klicken Sie dazu auf Chat starten > Apps suchen.
  3. Suchen Sie auf der Seite „Apps suchen“ nach Quickstart App.
  4. Klicken Sie neben Schnellstart-App auf Chat.
  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 gibt Ihre Nachricht wieder.

Unter Interaktive Funktionen für Google Chat-Apps testen erfahren Sie, wie Sie Trusted Tester hinzufügen und mehr über das Testen interaktiver Funktionen erfahren.

Nächste Schritte

  • Interaktive Karten erstellen: Kartennachrichten unterstützen ein definiertes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Verwende Kartennachrichten, um detaillierte Informationen zu präsentieren, Informationen von Nutzern zu sammeln und Nutzer zum nächsten Schritt zu führen.
  • Slash-Befehle unterstützen: Mit Slash-Befehlen können Sie bestimmte Befehle registrieren und bewerben, die Nutzer Ihrer Anwendung geben können. Geben Sie dazu einen Befehl ein, der mit einem Schrägstrich (/) beginnt, z. B. /help.
  • Dialogfelder starten: Dialogfelder sind kartenbasierte Oberflächen im Fenster, die Ihre App für die Interaktion mit einem Nutzer öffnen kann. Mehrere Karten können aufeinanderfolgend aneinandergereiht werden, was Nutzern dabei hilft, mehrstufige Prozesse wie das Ausfüllen von Formulardaten auszuführen.