Google Workspace-Add-ons können benutzerdefinierte Schnittstellen bereitstellen, wenn Nutzer Kalender und Kalendertermine aufrufen oder bearbeiten. So können Sie dem Nutzer zusätzliche relevante Informationen bereitstellen, Aufgaben automatisieren und Drittanbietersysteme mit Google Kalender verbinden.
Wenn Sie eine Add-on-Oberfläche für Google Kalender erstellen, können Sie eine Startseite angeben. Sie können dieselbe Startseite für mehrere Hosts verwenden oder eine spezifische Startseite für Google Kalender entwerfen.
Ihr Add-on kann auch eine Benutzeroberfläche definieren, die angezeigt wird, wenn der Nutzer einen Kalendertermin geöffnet hat.
Add-on-UI aufrufen
Je nachdem, wie das Add-on geöffnet wird, können Sie eine Startseite, eine Google Kalender-Oberfläche, eine Auswahl für Anhänge oder alle drei Optionen definieren:
- Wenn ein Nutzer in einer Kalenderansicht auf das Add-on-Symbol klickt, führt das Add-on die entsprechende
calendar.homepageTrigger
-Funktion aus (falls vorhanden). Mit dieser Funktion wird eine Startseitenkarte erstellt und an Google Kalender zur Anzeige zurückgegeben. Wenn keine Funktioncalendar.homepageTrigger
definiert ist, wird stattdessen eine allgemeine Startseitenkarte angezeigt. - Wenn der Nutzer einen Kalendertermin öffnet und dann auf das Add-on-Symbol klickt oder das Add-on beim Öffnen eines Termins geöffnet wird, führt das Add-on die entsprechende
eventOpenTrigger
-Funktion aus (falls vorhanden). Diese Funktion erstellt die Benutzeroberfläche des Kalendertermins des Add-ons und kehrt zur Anzeige in Google Kalender zurück. - Wenn das Add-on eine
eventAttachmentTrigger
-Funktion definiert, wird es als Anhangsanbieter angezeigt, wenn der Nutzer beim Bearbeiten eines Kalendertermins auf Anhang hinzufügen klickt. Wenn das Add-on ausgewählt ist, erstellt die FunktioneventAttachmentTrigger
die Oberfläche zur Anhangsauswahl des Add-ons und gibt es zur Anzeige an Google Kalender zurück.
Add-on-Kalender-Oberfläche erstellen
So erweitern Sie Google Kalender mit einem Google Workspace-Add-on:
- Entscheiden Sie, ob das Add-on eine kalenderspezifische Startseite haben soll. Entscheiden Sie auch, ob Sie eine benutzerdefinierte Oberfläche bereitstellen möchten, während der Nutzer Kalendertermine bearbeitet.
- Fügen Sie dem Add-on-Skript-Projekt-Manifest die entsprechenden
addOns.common
- undaddOns.calendar
-Felder hinzu, einschließlich aller erforderlichen Bereiche. - Wenn Sie eine kalenderspezifische Startseite angeben möchten, implementieren Sie die Funktion
calendar.homepageTrigger
, um diese Schnittstelle zu erstellen. Sie können die Oberflächecommon.homepageTrigger
auch für mehrere Google Workspace-Hosts verwenden. - Wenn Sie eine Kalender-Terminschnittstelle bereitstellen, müssen Sie eine
calendar.eventOpenTrigger
-Funktion zum Erstellen dieser Schnittstelle implementieren. Weitere Informationen finden Sie unter Benutzeroberfläche für Kalendertermine. - Implementiere die zugehörigen Callback-Funktionen, die erforderlich sind, um auf UI-Interaktionen des Nutzers zu reagieren, z. B. auf Klicks auf Schaltflächen.
Kalender-Startseiten
In Google Kalender können Google Home-Add-ons als Startseiten angezeigt werden.
Wenn Sie die allgemeine Startseite des Add-ons in Google Kalender anzeigen möchten, muss das Manifest des Add-ons das Feld addOns.calendar
enthalten.
Alternativ können Sie dem Add-on-Manifest ein calendar.homepageTrigger
hinzufügen, um eine Kalender-spezifische Startseite anzugeben.
In beiden Fällen müssen Sie den Namen einer Homepage-Trigger-Funktion im Skriptprojekt des Add-ons angeben. Diese Funktion wird bei Bedarf automatisch aufgerufen, um die Google Kalender-Startseite zu erstellen. Sie müssen diese Funktion implementieren, um ein einzelnes Card
-Objekt oder ein Array von Card
-Objekten zu erstellen und zurückzugeben, die die Startseite bilden. An die Triggerfunktion der Startseite wird ein Ereignisobjekt als Parameter übergeben, der einige allgemeine Informationen wie die Clientplattform enthält. Mithilfe der Ereignisobjektdaten können Sie die Erstellung der Startseite anpassen.
Benutzeroberfläche für Kalendertermine erweitern
Google Kalender verwendet einen kontextabhängigen Trigger, um zu bestimmen, welche Oberfläche (falls vorhanden) angezeigt wird, wenn der Nutzer einen Kalendertermin bearbeitet. Wenn der Trigger ausgelöst wird, führt er die Kontext-Trigger-Funktion aus, die im Feld calendar.eventOpenTrigger
im Add-on des Add-ons angegeben ist.
Sie müssen die im Feld calendar.eventOpenTrigger
angegebene Funktion implementieren. Diese Funktion akzeptiert ein Ereignisobjekt als Argument und muss entweder ein einzelnes Card
-Objekt oder ein Array von Card
-Objekten zurückgeben, damit Google Kalender angezeigt wird, während der Nutzer das Ereignis geöffnet hat.
Ereignisobjekte
Ein Ereignisobjekt wird erstellt und an die Kontexttriggerfunktion calendar.eventOpenTrigger
übergeben, wenn ein Nutzer einen Kalendertermin öffnet. Die Triggerfunktion kann anhand der Informationen in diesem Ereignisobjekt bestimmen, wie Add-on-Karten erstellt werden bzw. das Add-on-Verhalten steuern. Ereignisobjekte werden auch erstellt und an homepageTrigger
-Funktionen übergeben, wenn ein Add-on zum ersten Mal geöffnet wird und der Nutzer auf interaktive Widgets klickt oder diese auswählt.
Die vollständige Struktur von Ereignisobjekten wird unter Ereignisobjekte beschrieben. Wenn Google Kalender die Host-App des Add-ons ist, enthalten kontextbezogene Trigger- und Widget-Interaktionsereignisobjekte das Feld Kalenderereignisobjekt, das kalenderspezifische Clientinformationen enthält.
Kalendertermine aktualisieren
Zusätzlich zum kontextabhängigen calendar.eventOpenTrigger
, der ausgelöst wird, wenn ein Nutzer ein Kalenderereignis zum Bearbeiten öffnet, können Sie auch einen calendar.eventUpdateTrigger
definieren, der ausgelöst wird, wenn der Nutzer einen Kalendertermin aktualisiert und speichert. Dieser Trigger wird nur ausgelöst, wenn der Nutzer eine oder mehrere der folgenden Änderungen vornimmt:
- Fügt einen oder mehrere Teilnehmer hinzu.
- Entfernt einen oder mehrere Teilnehmer.
- Fügt eine andere Konferenzlösung hinzu oder wechselt zu ihr.
Wenn dieser Trigger ausgelöst wird, führt er die im Manifestfeld calendar.eventUpdateTrigger
angegebene Triggerfunktion aus. Die Funktion wird vor dem Speichern des Kalendertermins ausgeführt.
calendar.eventUpdateTrigger
wird normalerweise verwendet, um eine oder mehrere der folgenden Aufgaben auszuführen:
- Aktualisieren Sie die Benutzeroberfläche des Kalendertermins des Add-ons als Reaktion auf Nutzeränderungen am Kalendertermin.
- Synchronisieren von Kalendertermindaten mit einem Drittanbietersystem, z. B. einem Konferenzsystem, das mit Google Kalender verbunden ist
Wenn Sie das Add-on verwenden möchten, um Anpassungen an den Daten eines Kalendertermins vorzunehmen (z. B. die Teilnehmerliste), müssen Sie das Feld für das Manifest des Add-ons calendar.currentEventAccess
auf WRITE
oder READ_WRITE
festlegen. Außerdem muss das Add-on den Umfang https://www.googleapis.com/auth/calendar.addons.current.event.write
haben.
Konferenzlösungen hinzufügen
Konferenzlösungen stellen Konferenzoptionen von Drittanbietern dar, die Nutzer an Google Kalender-Termine anhängen können. Die Dokumentation zu Drittanbieter-Konferenzen enthält Details zum Erstellen eines Add-ons, das neue Konferenzlösungen hinzufügt. Für diese Art von Erweiterung muss keine UI erstellt werden. Hinzugefügte Lösungen werden einfach als Optionen im Drop-down-Menü der Benutzeroberfläche für Google Kalender-Termine angezeigt.