Google Kalender-Oberflächen erstellen

Add-ons für Google Workspace bieten benutzerdefinierte Oberflächen, wenn Nutzer Kalender und Kalendertermine ansehen oder bearbeiten. So können Sie dem Nutzer zusätzliche relevante Informationen zur Verfügung stellen, 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 spezielle Startseite für Google Kalender erstellen.

Ihr Add-on kann auch eine Oberfläche definieren, die angezeigt wird, wenn der Nutzer einen Kalendertermin geöffnet hat.

Auf die Add-on-UI zugreifen

Je nachdem, wie es geöffnet wird, kann ein Google Workspace-Add-on eine Startseite, eine Oberfläche für Google Kalender-Termine, eine Oberfläche zur Auswahl von Anhängen 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). Diese Funktion erstellt eine Startseitenkarte und gibt sie zur Anzeige an Google 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). Diese Funktion erstellt die Oberfläche für Kalenderereignisse des Add-ons und kehrt zur Anzeige an Google Kalender zurück.
  • Wenn im Add-on eine eventAttachmentTrigger-Funktion definiert ist, wird das Add-on als Anhangsanbieter angezeigt, wenn der Nutzer beim Bearbeiten eines Kalendertermins auf Anhang hinzufügen klickt. Wenn das Add-on ausgewählt ist, erstellt die Funktion eventAttachmentTrigger die Oberfläche zum Auswählen von Anhängen des Add-ons und gibt sie zur Anzeige an Google Kalender zurück.

Add-on-Oberfläche für Google Kalender erstellen

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

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

Kalender-Startseiten

Google Kalender unterstützt das Anzeigen von Google Workspace-Add-on-Startseiten. Damit die allgemeine Startseite des 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 einen calendar.homepageTrigger hinzufügen, um eine kalenderspezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie im Skriptprojekt des Add-ons den Namen einer Homepage-Triggerfunktion angeben. Diese Funktion wird bei Bedarf automatisch aufgerufen, um die Startseite von Google Kalender 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 für die Startseite wird ein Ereignisobjekt als Parameter übergeben, der einige allgemeine Informationen enthält, z. B. die Plattform des Clients. Mit den Ereignisobjektdaten können Sie den Aufbau der Startseite anpassen.

Erweitern der Oberfläche für Google Kalender-Termine

Google Kalender stützt sich auf einen kontextbezogenen 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 kontextabhängige Triggerfunktion aus, die im Feld calendar.eventOpenTrigger im Add-on-Manifest angegeben ist.

Sie müssen die im Feld calendar.eventOpenTrigger benannte 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 den Termin geöffnet hat.

Ereignisobjekte

Ein Ereignisobjekt wird erstellt und an die kontextuelle Triggerfunktion calendar.eventOpenTrigger übergeben, wenn ein Nutzer einen Kalendertermin öffnet. Die Triggerfunktion kann anhand der Informationen in diesem Ereignisobjekt bestimmen, wie Add-on-Karten erstellt oder das Add-on-Verhalten gesteuert werden soll. Außerdem werden Ereignisobjekte erstellt und an homepageTrigger-Funktionen übergeben, wenn ein Add-on zum ersten Mal geöffnet wird oder der Nutzer auf interaktive Widgets klickt oder diese auswählt.

Die vollständige Struktur von Ereignisobjekten wird unter Ereignisobjekte beschrieben. Wenn Google Kalender die aktive Host-App des Add-ons ist, enthalten kontextabhängige Trigger- und Widget-Interaktionsereignisobjekte das Feld Calendar event object (Kalenderereignisobjekt), das kalenderspezifische Clientinformationen enthält.

Kalendertermine aktualisieren

Zusätzlich zum kontextbezogenen calendar.eventOpenTrigger, das ausgelöst wird, wenn ein Nutzer einen Kalendertermin zur Bearbeitung öffnet, können Sie auch ein 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ügt einen oder mehrere Teilnehmer hinzu.
  • Entfernt einen oder mehrere Teilnehmer.
  • Eine andere Videokonferenzlösung hinzufügen oder zu einer anderen Lösung wechseln.

Wenn dieser Trigger ausgelöst wird, führt er die im Manifestfeld calendar.eventUpdateTrigger angegebene Triggerfunktion aus. Die Funktion wird ausgeführt, bevor die Bearbeitung des Kalendertermins gespeichert wird.

Der calendar.eventUpdateTrigger wird in der Regel für einen oder mehrere der folgenden Aufgaben verwendet:

  • Aktualisieren Sie die Oberflä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 Änderungen an den Daten eines Kalendertermins (z. B. der Teilnehmerliste) vornehmen soll, müssen Sie das Manifestfeld calendar.currentEventAccess des Add-ons auf WRITE oder READ_WRITE festlegen. Dazu muss das Add-on außerdem den Bereich 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. In der Dokumentation Übersicht über Videokonferenzen von Drittanbietern erfahren Sie, wie Sie ein Add-on erstellen, mit dem neue Videokonferenzlösungen hinzugefügt werden. Für diese Art von Erweiterung muss keine UI erstellt werden. Hinzugefügte Lösungen werden einfach als Optionen im Drop-down-Menü der Termin-UI von Google Kalender angezeigt.