Google Kalender-Oberflächen erstellen

Google Workspace-Add-ons können benutzerdefinierte Benutzeroberflächen bereitstellen, wenn Nutzer Kalender und Kalendertermine aufrufen oder bearbeiten. So können Sie Nutzern zusätzliche relevante Informationen zur Verfügung stellen, Aufgaben automatisieren und Systeme von Drittanbietern mit Google Kalender verbinden.

Wenn Sie eine Add-on-Benutzeroberfläche für Google Kalender erstellen, können Sie eine Startseite angeben. Sie können dieselbe Startseite für mehrere Hosts verwenden oder eine spezielle 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.

Auf die Add-on-Benutzeroberfläche zugreifen

Je nachdem, wie es geöffnet wird, kann ein Google Workspace-Add-on eine Startseitenoberfläche, eine Google Kalender-Ereignisoberfläche, eine Oberfläche für die Auswahl von Anhängen oder alle drei 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). Diese Funktion erstellt eine Startseitenkarte und gibt sie zur Anzeige an den Kalender zurück. Wenn keine calendar.homepageTrigger-Funktion definiert ist, wird stattdessen eine generische Startseitenkarte angezeigt.
  • Wenn der Nutzer einen Kalendertermin öffnet und dann auf das Add-on-Symbol klickt oder das Add-on geöffnet ist, wenn der Nutzer einen Termin öffnet, führt das Add-on die entsprechende eventOpenTrigger-Funktion aus (falls vorhanden). Mit dieser Funktion wird die Kalenderterminoberfläche des Add-ons erstellt und zu Google Kalender zurückgegeben, um dort angezeigt zu werden.
  • 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, wird über die Funktion eventAttachmentTrigger die Benutzeroberfläche für die Auswahl von Anhängen des Add-ons erstellt und zur Anzeige an Google Kalender zurückgegeben.

Benutzeroberfläche des Kalender-Add-ons erstellen

So erweitern Sie Google Kalender mit einem Google Workspace-Add-on:

  1. Legen Sie fest, ob Ihr Add-on eine Kalender-spezifische Startseite haben soll. Legen Sie auch fest, ob Sie eine benutzerdefinierte Benutzeroberfläche bereitstellen möchten, während der Nutzer Kalendertermine bearbeitet.
  2. Fügen Sie dem Manifest des Add-on-Scripts die entsprechenden Felder addOns.common und addOns.calendar hinzu, einschließlich aller erforderlichen Bereiche.
  3. Wenn Sie eine Kalender-spezifische Startseite bereitstellen, implementieren Sie die Funktion calendar.homepageTrigger, um diese Benutzeroberfläche zu erstellen. Sie können die Benutzeroberfläche common.homepageTrigger auch für mehrere Google Workspace-Hosts verwenden.
  4. Wenn Sie eine Kalendertermin-Benutzeroberfläche bereitstellen, müssen Sie eine calendar.eventOpenTrigger-Funktion implementieren, um diese Benutzeroberfläche zu erstellen. Weitere Informationen finden Sie unter Die Kalender-Benutzeroberfläche für Ereignisse erweitern.
  5. Implementieren Sie die zugehörigen Callback-Funktionen, die erforderlich sind, um auf die UI-Interaktionen des Nutzers zu reagieren, z. B. auf Klicks auf Schaltflächen.

Kalender-Startseiten

In Google Kalender können Startseiten von Google Workspace-Add-ons angezeigt werden. Damit die Startseite Ihres Add-ons in Google Kalender angezeigt wird, muss im Manifest des Add-ons das Feld addOns.calendar vorhanden sein.

Alternativ können Sie dem Add-on-Manifest ein calendar.homepageTrigger hinzufügen, um eine Kalender-spezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie den Namen einer Startseiten-Triggerfunktion im Scriptprojekt Ihres Add-ons angeben. Diese Funktion wird automatisch aufgerufen, um die Google Kalender-Startseite bei Bedarf 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. Der Triggerfunktion für die Startseite wird als Parameter ein Ereignisobjekt übergeben, das allgemeine Informationen wie die Plattform des Clients enthält. Mit den Daten des Ereignisobjekts können Sie die Erstellung der Startseite anpassen.

Benutzeroberfläche für Kalendertermine erweitern

In Google Kalender wird anhand eines kontextbezogenen Auslösers festgelegt, welche Benutzeroberfläche angezeigt wird, wenn der Nutzer einen Kalendertermin bearbeitet. Wenn der Trigger ausgelöst wird, wird die Kontexttriggerfunktion ausgeführt, die im Feld calendar.eventOpenTrigger im Manifest des Add-ons angegeben ist.

Sie müssen die Funktion implementieren, die im Feld calendar.eventOpenTrigger angegeben ist. Diese Funktion akzeptiert ein Ereignisobjekt als Argument und muss entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben, das in Google Kalender angezeigt werden soll, während der Nutzer den Termin geöffnet hat.

Ereignisobjekte

Wenn ein Nutzer einen Kalendertermin öffnet, wird ein Ereignisobjekt erstellt und an die Kontexttriggerfunktion calendar.eventOpenTrigger übergeben. Die Triggerfunktion kann die Informationen in diesem Ereignisobjekt verwenden, um zu bestimmen, wie Add-on-Karten erstellt oder das Add-on-Verhalten gesteuert werden soll. Ereignisobjekte werden auch erstellt und an homepageTrigger-Funktionen übergeben, wenn ein Add-on zum ersten Mal geöffnet wird und wenn der Nutzer auf interaktive Widgets klickt oder sie auswählt.

Die vollständige Struktur von Ereignisobjekten wird unter Ereignisobjekte beschrieben. Wenn Google Kalender die ausführende Host-App des Add-ons ist, enthalten Kontextauslöser und Ereignisobjekte für die Interaktion mit dem Widget das Feld Kalenderterminobjekt, das kalenderspezifische Kundeninformationen enthält.

Kalendertermine aktualisieren

Zusätzlich zum kontextbezogenen Ereignis calendar.eventOpenTrigger, das ausgelöst wird, wenn ein Nutzer einen Kalendertermin zur Bearbeitung öffnet, können Sie auch ein Ereignis calendar.eventUpdateTrigger definieren, das 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ügen Sie eine oder mehrere Teilnehmer hinzu.
  • Entfernt eine oder mehrere Teilnehmer.
  • Eine andere Konferenzlösung wird hinzugefügt oder verwendet.

Wenn dieser Trigger ausgelöst wird, wird die Triggerfunktion ausgeführt, die im Manifestfeld calendar.eventUpdateTrigger angegeben ist. Die Funktion wird ausgeführt, bevor die Änderungen am Kalendertermin gespeichert werden.

Die Taste calendar.eventUpdateTrigger wird in der Regel für einen oder mehrere der folgenden Zwecke verwendet:

  • Aktualisieren Sie die Kalenderterminoberfläche des Add-ons als Reaktion auf Nutzeränderungen am Kalendertermin.
  • Kalendertermindaten mit einem Drittanbietersystem synchronisieren, z. B. mit einem Konferenzsystem, das mit Google Kalender verbunden ist

Wenn Ihr Add-on Anpassungen an den Daten eines Kalendertermins vornehmen soll (z. B. an der Teilnehmerliste), müssen Sie das Manifest-Feld calendar.currentEventAccess des Add-ons auf WRITE oder READ_WRITE festlegen. Außerdem muss das Add-on den https://www.googleapis.com/auth/calendar.addons.current.event.write-Umfang haben.

Konferenzlösungen hinzufügen

Konferenzlösungen sind Konferenzoptionen von Drittanbietern, die Nutzer an Google Kalender-Termine anhängen können. In der Dokumentation Konferenzlösungen von Drittanbietern finden Sie Details zum Erstellen eines Add-ons, mit dem neue Konferenzlösungen hinzugefügt werden. Für diese Art von Erweiterung ist es nicht erforderlich, eine Benutzeroberfläche zu erstellen. Hinzugefügte Lösungen werden einfach als Optionen im Drop-down-Menü der Google Kalender-Terminoberfläche angezeigt.