Kurzanleitung für Google Apps Script Chat App

Erstelle eine Google Chat-App, der du direkt Nachrichten senden kannst und die antwortet mit einem Echo.

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

Architektur einer mit Apps Script implementierten Chat-App

Im obigen Diagramm interagiert ein Nutzer mit einem Apps Script Die Chat-App umfasst den folgenden Informationsfluss:

  1. Ein Nutzer sendet eine Nachricht an eine Chat-App, entweder in einem oder in einem Chatbereich.
  2. Die Chat-App-Logik, die in Apps Script, das sich in Google Cloud befindet, und verarbeitet die Nachricht.
  3. Optional kann die Chat-App-Logik mit Google Workspace-Dienste wie Google Kalender oder Google Tabellen oder andere Google-Dienste wie Google Maps oder YouTube.
  4. Die Chat-App-Logik sendet eine Antwort an den Chat-App-Dienst in Google Chat.
  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

Vorbereitung

Umgebung einrichten

Cloud-Projekt in der Google Cloud Console öffnen

Falls noch nicht geschehen, öffnen Sie das gewünschte Cloud-Projekt. für dieses Beispiel:

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

  1. Öffnen Sie in der Google Cloud Console das Menü . > 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 App erstellen, die außerhalb Ihres Google Workspace-Organisation verwenden, müssen Sie den Nutzertyp in Extern ändern. fügen Sie die Autorisierungsbereiche hinzu, die Ihre Anwendung benötigt.

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

Skript einrichten

Um das Skript einzurichten, verwenden Sie eine Vorlage und legen dann Ihr Cloud-Projekt in Apps Script.

Skript aus der Vorlage erstellen

  1. Gehen Sie zur Apps Script-Seite Erste Schritte.
  2. Klicken Sie auf die Vorlage Chat-App. Möglicherweise musst du nach unten scrollen, um diese Vorlage anzuzeigen.
  3. Klicken Sie auf Unbenanntes Projekt und geben Sie Quickstart app ein. Klicken Sie auf Umbenennen.

Cloud-Projektnummer kopieren

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

    Zu IAM und Administratoreinstellungen

  2. Kopieren Sie den Wert im Feld Projektnummer.

Cloud-Projekt des Apps Script-Projekts festlegen

  1. Im Apps Script-Projekt der Chat-App Klicken Sie auf Projekteinstellungen Das Symbol für die 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 verfügen nun über funktionierenden App-Code, den Sie ausprobieren können (siehe den folgenden Schritten) und passen Sie sie dann an Ihre Anforderungen an.

Achten Sie beim Öffnen der App darauf, dass Sie im richtigen Google-Konto angemeldet sind. Apps Script-Vorlage. Das aktuelle Konto wird manchmal ohne dass Sie es merken.

Testbereitstellung erstellen

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

So rufen Sie die Head-Bereitstellungs-ID ab:

  1. Im Apps Script-Projekt der Chat-App Klicken Sie 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. Im Google Cloud Console suchen Sie 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) Folgendes ein: https://developers.google.com/chat/images/quickstart-app-avatar.png
    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
    5. Wählen Sie unter „Verbindungseinstellungen“ die Option Apps Script-Projekt aus.
    6. Fügen Sie in das Feld Deployment ID (Bereitstellungs-ID) die ID der Head-Bereitstellung ein, die Sie zuvor zuvor kopiert.
    7. Wählen Sie unter Sichtbarkeit die Option Bestimmte Personen und Gruppen in Ihrem Domain 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 der Chat App einen Direktnachrichtenbereich mit Chat-App und senden Sie eine Nachricht:

  1. Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie wenn Sie sich als Trusted Tester hinzugefügt haben.

    Zu Google Chat

  2. Klicken Sie auf Neuer Chat.
  3. Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihres Chat-App.
  4. Wählen Sie aus den Ergebnissen Ihre Chat-App aus. Eine direkte wird die Nachricht geöffnet.

  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 findest du unter Interaktive Funktionen für Google Chat-Apps

Fehlerbehebung

Wenn eine Google Chat App oder card gibt einen Fehler zurück. Der Parameter In der Chatoberfläche wird die Meldung „Ein Fehler ist aufgetreten“ angezeigt. oder „Ihre Anfrage kann nicht verarbeitet werden.“ Manchmal kann die Chat-UI Es wird zwar keine Fehlermeldung angezeigt, aber die Chat-App oder die Karte zu einem unerwarteten Ergebnis führt. z. B. wird eine Kartennachricht erscheinen.

Auch wenn in der Chat-Benutzeroberfläche möglicherweise keine Fehlermeldung angezeigt wird, beschreibende Fehlermeldungen und Protokolldaten stehen zur Fehlerbehebung zur Verfügung. wenn die Fehlerprotokollierung für Chat-Apps aktiviert ist. Hilfe bei der Anzeige: Debugging und Beheben von Fehlern finden Sie unter Google Chat-Fehler beheben

Bereinigen

Um zu vermeiden, dass Ihrem Google Cloud-Konto Gebühren für Ressourcen, die in dieser Anleitung verwendet werden, empfehlen wir, dass Sie den Cloud-Projekt

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

    <ph type="x-smartling-placeholder"></ph> Zu Resource Manager

  2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie auf löschen.
  3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie zum Löschen auf Beenden. für das Projekt.

Nächste Schritte

  • Interaktive Karten erstellen: Karte unterstützen Mitteilungen ein definiertes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Verwenden Sie Kartennachrichten, um detaillierte Informationen, Informationen von Nutzenden sammeln und sie anleiten, den nächsten Schritt zu tun.
  • Unterstützung von Slash-Befehlen: Sie registrieren und bewerben bestimmte Befehle, mit denen Nutzer Ihrer App indem Sie einen Befehl eingeben, der mit einem Schrägstrich (/) beginnt, z. B. /help.
  • Startdialogfelder: Dialogfelder sind kartenbasiert und werden im Fenstermodus angezeigt. Schnittstellen, die deine App öffnen kann, um mit Nutzern zu interagieren. Mehrere Karten können sequenziell aneinandergereiht werden, wodurch Nutzende mehrstufige wie das Ausfüllen von Formulardaten.
  • Codelab:Bereit zum Erstellen einer erweiterten Version Chat-App? Feedback ansehen Chat-App aus dem Codelab Apps für Google Chat mit Gemini erstellen