In diesem Tutorial erfahren Sie, wie Sie eine Google Chat-App erstellen, mit der Google Chat-Nutzer ihre privaten und geschäftlichen Kontakte verwalten können. Um Informationen zu erfassen, werden Nutzer in der Chat App aufgefordert, in Kartennachrichten und Dialogfeldern ein Kontaktformular auszufüllen.
Sehen Sie sich die Google Chat App in Aktion an:
-
Abbildung 2: Die Die Chat-App öffnet ein Dialogfeld, in dem Nutzer Informationen zu einem Kontakt eingeben. -
Abbildung 3: Die zeigt die Chat-App ein Bestätigungsdialogfeld an, damit Nutzende die Informationen überprüfen und bestätigen können, senden. -
Abbildung 4: Nachdem der Nutzer das Formular gesendet hat sendet die Chat-App eine private um die Einreichung zu bestätigen. -
Abbildung 5 In der Chat App werden Nutzer auch aufgefordert, einen Kontakt aus einer Karte in einer Nachricht hinzuzufügen.
Vorbereitung
- Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:
Zielsetzungen
- Benutzeroberflächen (UIs) entwerfen und erstellen
card
-Objekten und zeigen die Benutzeroberflächen in Meldungen und Dialogfeldern an. - Informationen empfangen und verarbeiten, die Nutzer mithilfe von Widgets für die Formulareingabe.
- Auf Slash-Befehle reagieren, indem Sie Nachrichten, die Text, Karten und Zubehör-Widgets enthalten.
Architektur
Die Chat-App ist in Google Apps Script implementiert und verwendet Interaktionsereignisse, um Chat-Nutzer zu verarbeiten und zu beantworten.
Im Folgenden sehen Sie, wie Nutzende normalerweise mit dem Chat-App:
Ein Nutzer öffnet eine Direktnachricht mit der Chat App oder fügt die Chat App einem vorhandenen Gruppenbereich hinzu.
Die Chat-App fordert den Nutzer auf, einen Kontakt hinzuzufügen, indem er ein Kontaktformular als
card
-Objekt erstellt und anzeigt. Wenn die Chat-App das Kontaktformular anzeigt, reagiert sie auf Nutzer auf folgende Weise:- auf @Erwähnungen und Direktnachrichten mit einer Kartennachricht antwortet, enthält das Kontaktformular.
- Reagiert auf den Slash-Befehl
/addContact
, indem ein Dialogfeld mit das Kontaktformular aus. - Er antwortet auf den Slash-Befehl
/about
mit einer Textnachricht mit dem Schaltfläche Kontakt hinzufügen, auf die Nutzer klicken können, um ein Dialogfeld mit dem Kontaktformular.
Wenn der Nutzer im Kontaktformular erscheint, gibt er seine Kontaktdaten ein. in die folgenden Felder und Widgets ein:
- Vor- und Nachname: a
textInput
das Zeichenfolgen akzeptiert. - Geburtsdatum: Ein
dateTimePicker
-Widget, das nur Datumsangaben akzeptiert. - Kontakttyp: Ein
selectionInput
-Widget mit Optionsfeldern, über das Nutzer einen einzelnen Stringwert (Personal
oderWork
) auswählen und senden können. - Schaltfläche Überprüfen und senden: a
buttonList
Array mit dem Widgetbutton
, auf das der Nutzer klickt, um die Werte zu senden, die die sie eingeben.
- Vor- und Nachname: a
Die Google Chat App verarbeitet ein
CARD_CLICKED
-Interaktionsereignis, um die von Nutzern eingegebenen Werte zu verarbeiten, und zeigt die Werte auf einer Bestätigungskarte an.Der Nutzer sieht sich die Bestätigungskarte an und klickt auf die Schaltfläche Senden, um die Kontaktdaten abzuschließen.
Die Google Chat App sendet eine private SMS, bestätigt die Einreichung.
Umgebung vorbereiten
In diesem Abschnitt wird beschrieben, wie Sie ein Google Cloud-Projekt für die Chat-App erstellen und konfigurieren.
Google Cloud-Projekt erstellen
Google Cloud Console
- Öffnen Sie in der Google Cloud Console das Menü > IAM und Verwaltung > Projekt erstellen. .
-
Geben Sie im Feld Projektname einen aussagekräftigen Namen für Ihr Projekt ein.
Optional: Klicken Sie auf Bearbeiten, um die Projekt-ID zu bearbeiten. Die Projekt-ID kann nach dem Erstellen des Projekts nicht mehr geändert werden. Wählen Sie also eine ID aus, die während der gesamten Dauer des Projekts den Anforderungen entspricht.
- Klicken Sie im Feld Standort auf Durchsuchen, um die potenziellen Standorte für Ihr Projekt arbeiten. Klicken Sie danach auf Auswählen.
- Klicken Sie auf Erstellen. In der Google Cloud Console wird die Dashboard-Seite aufgerufen und Ihr Projekt wurde erstellt. innerhalb weniger Minuten.
gcloud-CLI
Greifen Sie in einer der folgenden Entwicklungsumgebungen auf die Google Cloud
Befehlszeile (gcloud
):
-
Cloud Shell: Onlineterminal mit der gcloud CLI verwenden
aktivieren Sie Cloud Shell.
Cloud Shell aktivieren -
Lokale Shell: Zur Verwendung einer lokalen Entwicklungsumgebung müssen Sie die gcloud CLI installieren und initialisieren.
Verwenden Sie den Befehlgcloud projects create
, um ein Cloud-Projekt zu erstellen: Ersetzen Sie PROJECT_ID durch die ID des Projekts, das Sie erstellen möchten.gcloud projects create PROJECT_ID
Authentifizierung und Autorisierung einrichten
Für Google Chat-Apps müssen Sie ein OAuth-Zustimmungsbildschirm eingeben, damit Nutzer können Ihre App in Google Workspace-Anwendungen autorisieren, darunter: Google Chat
In dieser Anleitung stellen Sie eine Chat-App bereit, die nur für und zur internen Verwendung. Daher ist es in Ordnung, Platzhalterinformationen für die Zustimmungsbildschirm. Ersetzen Sie vor dem Veröffentlichen der Chat App Platzhalterinformationen mit echten Informationen.
Gehen Sie in der Google Cloud Console zu Menü > APIs und Dienste > OAuth-Zustimmungsbildschirm.
Wählen Sie unter Nutzertyp die Option Intern aus und klicken Sie auf Erstellen.
Geben Sie unter App-Name
Contact Manager
ein.Wählen Sie unter Nutzer-Support-E-Mail Ihre E-Mail-Adresse oder eine geeignete Google-Gruppe.
Geben Sie unter Kontaktdaten des Entwicklers Ihre E-Mail-Adresse ein.
Klicken Sie auf Speichern und fortfahren.
Klicken Sie auf der Seite Bereiche auf Speichern und fortfahren. Für die Chat-App sind keine OAuth-Bereiche erforderlich.
Überprüfen Sie die Zusammenfassung und klicken Sie dann auf Zurück zum Dashboard.
Chat-App erstellen und bereitstellen
Im folgenden Abschnitt kopieren und aktualisieren Sie Apps Script-Projekt, das alle erforderlichen Anwendungen enthält Code für Ihre Chat-App ändern. Sie müssen den Code also nicht fügen Sie jede Datei ein.
Optional können Sie das gesamte Projekt auf GitHub ansehen.
Hier eine Übersicht über die einzelnen Dateien:
main.gs
Hier werden alle App-Logiken verarbeitet, einschließlich Interaktionsereignisse, wenn Nutzer Nachrichten an die Chat-App senden, in einer Chat-App-Nachricht auf Schaltflächen klicken oder Dialogfelder öffnen und schließen.
main.gs
-Code ansehencontactForm.gs
Enthält die Widgets, die Formulardaten von Nutzern empfangen. Diese Formulareingaben Widgets werden auf Karten in Nachrichten und Dialogfeldern angezeigt.
contactForm.gs
-Code ansehenappsscript.json
Die Apps Script-Manifest zum Definieren und Konfigurieren des Apps Script-Projekts für die Chat-App.
appsscript.json
-Code ansehen
Nummer und ID Ihres Cloud-Projekts ermitteln
Rufen Sie in der Google Cloud Console Ihr Cloud-Projekt auf.
Klicken Sie auf „Einstellungen und Dienstprogramme“ > Projekteinstellungen.
Notieren Sie sich die Werte in den Feldern Projektnummer und Projekt-ID. Sie verwenden sie in den folgenden Abschnitten.
Apps Script-Projekt erstellen
Um ein Apps Script-Projekt zu erstellen und mit Ihrem Cloud-Projekt:
- Klicken Sie auf die folgende Schaltfläche, um das Apps Script-Projekt Kontakte in Google Chat verwalten zu öffnen.
Projekt öffnen - Klicken Sie auf Übersicht.
- Klicken Sie auf der Übersichtsseite auf Kopie erstellen.
Benennen Sie Ihre Kopie des Apps Script-Projekts:
Klicken Sie auf Kopie von „Kontakte in Google Chat verwalten“.
Geben Sie unter Projekttitel
Contact Manager - Google Chat app
ein.Klicken Sie auf Umbenennen.
Cloud-Projekt des Apps Script-Projekts festlegen
- In Ihrem Apps Script-Projekt Klicken Sie auf Projekteinstellungen.
- Klicken Sie unter Google Cloud Platform-Projekt (GCP-Projekt) auf Projekt ändern.
- Fügen Sie unter GCP-Projektnummer die Projektnummer Ihres Cloud-Projekts ein.
- Klicken Sie auf Projekt festlegen. Cloud-Projekt und Apps Script sind jetzt verbunden.
Apps Script-Bereitstellung erstellen
Jetzt, wo der gesamte Code vorhanden ist, können Sie das Apps Script bereitstellen. Projekt arbeiten. Mit der Bereitstellungs-ID konfigurieren Sie die Chat-App in Google Cloud
Öffnen Sie in Apps Script die Projekt arbeiten.
Klicken Sie auf Bereitstellen > Neue Bereitstellung.
Wenn Add-on noch nicht ausgewählt ist, klicken Sie neben Typ auswählen auf die Bereitstellungstypen und wählen Sie Add-on aus.
Geben Sie unter Beschreibung eine Beschreibung für die Version ein, z. B.
Test of Contact Manager
Klicken Sie auf Bereitstellen. Apps Script-Berichte erfolgreich Bereitstellung und stellt eine Bereitstellungs-ID bereit.
Klicken Sie zum Kopieren auf
Kopieren. die Bereitstellungs-ID und klicken Sie dann auf Fertig.
Chat-App in der Google Cloud Console konfigurieren
In diesem Abschnitt wird beschrieben, wie Sie die Google Chat API in der Google Cloud Console mit Informationen zu Ihrer Chat-App konfigurieren, einschließlich der ID der Bereitstellung, die Sie gerade über Ihr Apps Script-Projekt erstellt haben.
Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü. > Weitere Produkte > Google Workspace > Produktbibliothek > Google Chat API > Verwalten > Konfiguration.
Geben Sie unter App-Name
Contact Manager
ein.Geben Sie unter Avatar-URL
https://developers.google.com/chat/images/contact-icon.png
ein.Geben Sie unter Beschreibung den Wert
Manage your personal and business contacts
ein.Stellen Sie die Ein/Aus-Schaltfläche Interaktive Funktionen aktivieren auf „Ein“.
Aktivieren Sie unter Funktionsweise die Kästchen 1:1-Nachrichten empfangen und Gruppenbereichen und Gruppenunterhaltungen beitreten.
Wählen Sie unter Verbindungseinstellungen die Option Apps Script aus.
Fügen Sie unter Deployment ID (Bereitstellungs-ID) die Deployment-ID für Apps Script ein. die Sie im vorherigen Abschnitt kopiert haben, als Sie den Apps Script-Bereitstellung
Richten Sie unter Slash-Befehle die Slash-Befehle
/about
und/addContact
:- Klicken Sie auf Slash-Befehl hinzufügen, um den ersten Slash-Befehl einzurichten.
- Geben Sie unter Name den Wert
/about
ein. - Geben Sie unter Befehls-ID
1
ein. - Geben Sie unter Beschreibung den Wert
Learn how to use this Chat app to manage your contacts
ein. - Wählen Sie Öffnet ein Dialogfeld aus.
- Klicken Sie auf Fertig.
- Klicken Sie auf Slash-Befehl hinzufügen, um einen weiteren Slash-Befehl einzurichten.
- Geben Sie unter Name
/addContact
ein. - Geben Sie unter Befehls-ID
2
ein. - Geben Sie unter Beschreibung
Submit information about a contact
- Wählen Sie Öffnet ein Dialogfeld aus.
- Klicken Sie auf Fertig.
Wähle unter Sichtbarkeit die Option Diese Chat-App bestimmten Personen und Gruppen in YOUR DOMAIN zur Verfügung stellen und geben Sie Ihre E-Mail-Adresse ein.
Wählen Sie unter Protokolle die Option Fehler in Logging protokollieren aus.
Klicken Sie auf Speichern. Eine Meldung, dass die Konfiguration gespeichert wurde, wird angezeigt.
Die Chat App kann jetzt in Google Chat installiert und getestet werden.
Chat App testen
Wenn Sie die Chat App testen möchten, öffnen Sie einen Direktnachrichtenbereich mit der Chat App und senden Sie eine Nachricht:
Öffnen Sie Google Chat mit dem Google Workspace-Konto, das Sie angegeben haben, als Sie sich als vertrauenswürdiger Tester hinzugefügt haben.
- Klicken Sie auf Neuer Chat.
- Geben Sie im Feld Eine oder mehrere Personen hinzufügen den Namen Ihres Chat-App.
Wählen Sie in den Ergebnissen die Chat-App aus. Eine Direktnachricht wird geöffnet.
Geben Sie in der neuen Direktnachricht in der Chat App
/addContact
ein und drücken Sie die Eingabetaste.Geben Sie im daraufhin angezeigten Dialogfeld die Kontaktdaten ein:
- Geben Sie im Textfeld Vor- und Nachname einen Namen ein.
- Wählen Sie in der Datumsauswahl unter Geburtsdatum ein Datum aus.
- Wählen Sie unter Kontakttyp das Optionsfeld Geschäftlich oder Privat aus.
Klicken Sie auf Überprüfen und senden.
Prüfen Sie im Bestätigungsdialogfeld die von Ihnen eingereichten Informationen und Klicken Sie auf Senden. Die Chat-App antwortet mit der Textnachricht
✅ CONTACT NAME has been added to your contacts.
.Optional können Sie das Kontaktformular auch auf der folgenden Seite testen und an uns senden: Möglichkeiten:
- Verwenden Sie den Slash-Befehl
/about
. Die Chat-App antwortet mit einer Textnachricht und einer Schaltfläche für das Zubehör-Widget mit der AufschriftAdd a contact
. Wenn Sie auf die Schaltfläche klicken, wird ein Dialogfeld mit der Kontaktformular. - Senden Sie der Chat App eine Direktnachricht ohne
Slash-Befehl wie
Hello
. Chat App mit einem Text und einer Karte, die das Kontaktformular enthalten.
- Verwenden Sie den Slash-Befehl
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
- Wechseln Sie in der Google Cloud Console zur Seite Ressourcen verwalten. Klicken Sie auf das Dreistrich-Menü > IAM & Verwaltung > Ressourcen verwalten.
- Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen .
- Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie zum Löschen auf Beenden. für das Projekt.
Weitere Informationen
- Auf Slash-Befehle reagieren
- Informationen von Google Chat-Nutzern erheben und verarbeiten
- Interaktive Dialogfelder öffnen
- Weitere Beispiele für die Google Chat App