Google Kalender-Oberflächen erstellen

Google Workspace-Add-ons können benutzerdefinierte Oberflächen bereitstellen, wenn Nutzer Kalender und Kalendertermine ansehen oder bearbeiten. Auf diese Weise 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 eigene Startseite für Google Kalender erstellen.

Mit dem Add-on kann auch eine Oberfläche definiert werden, die angezeigt wird, wenn der Nutzer einen Kalendertermin geöffnet hat.

Auf die Add-on-UI zugreifen

Je nachdem, wie ein Add-on geöffnet wird, können Sie eine Oberfläche für die Startseite, eine Oberfläche für Termine in Google Kalender, eine Oberfläche zur 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 (falls vorhanden) aus. Diese Funktion erstellt eine Startseitenkarte und gibt sie 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 (falls vorhanden) aus. Diese Funktion erstellt die Oberfläche für Kalenderereignisse des Add-ons und kehrt zur Anzeige an Google Kalender zurück.
  • Wenn das Add-on eine eventAttachmentTrigger-Funktion definiert, 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 zur Auswahl von Anhängen und gibt sie zur Ansicht an Google Kalender zurück.

Benutzeroberfläche des Add-ons für Google Kalender erstellen

Sie können Google Kalender mit einem Google Workspace-Add-on erweitern. Gehen Sie dazu so vor:

  1. Entscheiden Sie, ob das Add-on eine Kalender-spezifische 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 Projekts des Add-on-Skripts die entsprechenden Felder addOns.common und addOns.calendar hinzu, einschließlich aller erforderlichen Bereiche.
  3. Wenn Sie eine Kalender-spezifische Startseite bereitstellen, müssen Sie die Funktion calendar.homepageTrigger implementieren, um diese Schnittstelle zu erstellen. Sie können die Schnittstelle common.homepageTrigger auch für mehrere Google Workspace-Hosts verwenden.
  4. Wenn Sie eine Oberfläche für Google Kalender-Termine bereitstellen, müssen Sie die Funktion calendar.eventOpenTrigger implementieren. Weitere Informationen finden Sie unter Kalendertermine erweitern.
  5. Implementiere die zugehörigen Callback-Funktionen, die erforderlich sind, um auf UI-Interaktionen des Nutzers zu reagieren, z. B. Klicks auf Schaltflächen.

Kalender-Startseiten

Google Kalender unterstützt die Anzeige von Startseiten des Google Workspace-Add-ons. 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 ein calendar.homepageTrigger hinzufügen, um eine für Google Kalender spezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie den Namen einer Startseiten-Triggerfunktion im Skriptprojekt des Add-ons angeben. Diese Funktion wird bei Bedarf automatisch zum Erstellen der Google Kalender-Startseite aufgerufen. Sie müssen diese Funktion implementieren, um ein einzelnes Card-Objekt oder ein Array von Card-Objekten, aus denen die Startseite besteht, zu erstellen und zurückzugeben. An die Triggerfunktion der Startseite wird ein Ereignisobjekt als Parameter übergeben, der einige allgemeine Informationen enthält, z. B. die Plattform des Clients. Mithilfe der Ereignisobjektdaten können Sie die Konstruktion der Startseite anpassen.

Erweiterung der Oberfläche für Kalendertermine

Google Kalender verwendet einen kontextbezogenen Trigger, um zu bestimmen, welche Oberfläche (falls vorhanden) angezeigt wird, wenn ein Nutzer einen Kalendertermin bearbeitet. Wenn der Trigger ausgelöst wird, wird die kontextbezogene Triggerfunktion ausgeführt, die im Feld calendar.eventOpenTrigger im Add-on-Manifest 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 kontextbezogene Triggerfunktion calendar.eventOpenTrigger übergeben, wenn ein Nutzer einen Kalendertermin öffnet. Die Triggerfunktion kann die Informationen in diesem Ereignisobjekt verwenden, um zu bestimmen, wie Add-on-Karten erstellt werden oder wie das Add-on-Verhalten gesteuert wird. Ereignisobjekte werden auch erstellt und an homepageTrigger-Funktionen übergeben, wenn ein Add-on zum ersten Mal geöffnet wird oder wenn der Nutzer interaktive Widgets klickt oder auswählt.

Die vollständige Struktur der Ereignisobjekte wird unter Ereignisobjekte beschrieben. Wenn Google Kalender die agierende Host-App des Add-ons ist, enthalten kontextbasierte Trigger und Widget-Interaktionsereignisobjekte das Feld Kalenderereignisobjekt, das kalenderspezifische Clientinformationen enthält.

Kalendertermine aktualisieren

Zusätzlich zum kontextbezogenen calendar.eventOpenTrigger, der ausgelöst wird, wenn ein Nutzer ein Kalenderereignis zur Bearbeitung öffnet, können Sie auch einen calendar.eventUpdateTrigger definieren, der ausgelöst wird, wenn der Nutzer ein Kalenderereignis 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 ausgeführt, bevor die Bearbeitung des Kalendertermins gespeichert wird.

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

  • Die Oberfläche des Add-ons für Kalenderereignisse wird aktualisiert, wenn Nutzer Änderungen am Kalendertermin vornehmen.
  • Synchronisieren Sie Kalendertermindaten mit einem Drittanbietersystem, z. B. einem Konferenzsystem, das mit Google Kalender verbunden ist.

Wenn Sie mit dem Add-on Anpassungen an Daten eines Kalendertermins (z. B. der Teilnehmerliste) vornehmen möchten, müssen Sie das Manifestfeld calendar.currentEventAccess des Add-ons auf WRITE oder READ_WRITE setzen. Außerdem muss das Add-on 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 Übersicht zu Videokonferenzen von Drittanbietern wird im Detail beschrieben, wie Sie ein Add-on erstellen, mit dem neue Konferenzlösungen hinzugefügt werden. Für diese Art von Erweiterung muss keine Benutzeroberfläche erstellt werden. Hinzugefügte Lösungen werden einfach als Optionen im Drop-down-Menü der Google Kalender-Termin-UI angezeigt.