Google Kalender-Oberflächen erstellen

Mit Google Workspace-Add-ons können Sie wenn Nutzer Kalender und Kalendertermine ansehen oder bearbeiten. So können Sie dem Nutzer zusätzliche relevante Informationen bereitstellen, und Drittanbietersysteme mit Google Kalender verbinden.

Wenn Sie ein Add-on für Google Kalender erstellen, können Sie eine Startseite. Sie können die gleichen für mehrere Veranstalter erstellen oder eine eigene Startseite für Google Kalender entwerfen.

Ihr Add-on kann auch eine Schnittstelle definieren, die angezeigt wird, wenn der Nutzer ein Kalendertermin geöffnet ist.

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, wird das Add-on ausgeführt. das entsprechende calendar.homepageTrigger (falls vorhanden). Diese Funktion erstellt eine Startseitenkarte und gibt sie zurück zur Anzeige in Google Kalender. Falls nein calendar.homepageTrigger definiert ist, wird stattdessen eine generische Karte für die Startseite angezeigt.
  • Wenn der Nutzer einen Kalendertermin öffnet und dann auf das Add-on-Symbol oder das Add-on geöffnet ist, wenn der Nutzer ein Ereignis öffnet, die entsprechende eventOpenTrigger (falls vorhanden). Diese Funktion erstellt den Kalendertermin des Add-ons und kehrt zur Anzeige zu Google Kalender zurück.
  • Wenn das Add-on eine eventAttachmentTrigger-Funktion definiert, Das Add-on wird als Anbieter für Anhänge angezeigt, wenn der Nutzer beim Bearbeiten eines Kalendertermins auf Anhang hinzufügen klickt. Wenn das Add-on ausgewählt ist, Mit der Funktion eventAttachmentTrigger wird der Anhang des Add-ons erstellt. und sendet sie zur Ansicht an Google Kalender zurück.

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

Sie können Google Kalender um eine Google Workspace-Add-on. Gehen Sie dazu so vor:

  1. Entscheiden Sie, ob das Add-on eine Kalender-spezifische Startseite. Entscheiden Sie außerdem, ob Sie eine benutzerdefinierte Oberfläche anbieten möchten, zum Bearbeiten von Kalenderterminen.
  2. Fügen Sie die entsprechenden addOns.common und addOns.calendar dem Manifest des Projekts für das Add-on-Skript, einschließlich aller erforderlichen Bereiche.
  3. Wenn Sie eine Kalender-spezifische Startseite, Implementieren der calendar.homepageTrigger um diese Schnittstelle zu erstellen. Sie können auch die common.homepageTrigger für mehrere Google Workspace-Hosts.
  4. Wenn Sie eine Oberfläche für Google Kalender-Termine bereitstellen, müssen Sie eine calendar.eventOpenTrigger um diese Schnittstelle zu erstellen. Weitere Informationen finden Sie unter Die Oberfläche für Google Kalender-Termine erweitern .
  5. Implementieren Sie die zugehörigen Callback-Funktionen, die zum Antworten auf die Callback-Funktion des Nutzers erforderlich sind. Interaktionen auf der Benutzeroberfläche, z. B. Klicks auf Schaltflächen

Kalender-Startseiten

Google Kalender unterstützt die Anzeige von Startseiten des Google Workspace-Add-ons. Damit die Startseite Ihres Add-ons in Google Kalender angezeigt wird, ist ein addOns.calendar im Manifest des Add-ons.

Alternativ können Sie calendar.homepageTrigger dem Add-on-Manifest hinzu, um eine für Google Kalender spezifische Startseite bereitzustellen.

In beiden Fällen müssen Sie den Namen einer Startseiten-Triggerfunktion in Ihrem das Skriptprojekt des Add-ons. Diese Funktion wird automatisch aufgerufen, um den Google Kalender-Startseite. Sie müssen diese Funktion implementieren, um und eine einzelne Card oder ein Array von Card Objekte, aus denen die Startseite besteht. An die Triggerfunktion für die Startseite wird ein Ereignisobjekt als Parameter, der einige allgemeine Informationen enthält, wie z. B. die Plattform. Sie können die Ereignisobjektdaten verwenden, um die Konstruktion des Ereignisses Startseite.

Erweiterung der Oberfläche für Kalendertermine

Google Kalender verwendet einen kontextbezogenen Trigger, um zu bestimmen, welche Oberfläche (falls vorhanden), die angezeigt werden, wenn der Nutzer einen Kalendertermin bearbeitet. Wenn der Trigger ausgelöst wird, führt sie die kontextabhängige Triggerfunktion aus, die vom calendar.eventOpenTrigger im Manifest des Add-ons.

Sie müssen die Funktion implementieren, die in den calendar.eventOpenTrigger ein. Diese Funktion akzeptiert ein Ereignisobjekt als Argument und muss entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten für Google Kalender angezeigt wird, während der Nutzer das Ereignis geöffnet hat.

Ereignisobjekte

Ein Ereignisobjekt wird erstellt und an die calendar.eventOpenTrigger kontextbezogene Triggerfunktion beim Öffnen durch einen Nutzer Kalendertermin Die Triggerfunktion kann die Informationen in diesem Ereignis verwenden -Objekt, um zu bestimmen, wie Add-on-Karten erstellt oder das Add-on gesteuert wird. verhalten. Ereignisobjekte werden ebenfalls erstellt und an homepageTrigger wenn ein Add-on zum ersten Mal geöffnet wird und wenn die Nutzenden auf ein Add-on klicken oder interaktive Widgets.

Die vollständige Struktur der Ereignisobjekte wird unter Ereignisobjekte: Wenn Google Kalender die agierende Host-App des Add-ons ist, werden der kontextabhängige Trigger und die Widget-Interaktionsereignisobjekte beinhalten die Kalenderterminobjekt -Feld, das kalenderspezifische Kundeninformationen enthält.

Kalendertermine aktualisieren

Neben den kontextbezogenen calendar.eventOpenTrigger wird ausgelöst, wenn ein Nutzer einen Kalendertermin zur Bearbeitung haben, können Sie auch einen calendar.eventUpdateTrigger Sie wird ausgelöst, wenn der Nutzer einen Kalendertermin aktualisiert und speichert. Nur diesen Trigger wird 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 den Triggerfunktion, die durch die calendar.eventUpdateTrigger Manifest-Feld. Die Funktion wird ausgeführt, bevor die Bearbeitung des Kalendertermins erfolgt. gespeichert.

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

  • Add-on-Oberfläche für Kalenderereignisse als Reaktion auf Nutzeränderungen aktualisieren in den Kalendertermin ein.
  • Kalendertermindaten mit einem Drittanbietersystem synchronisieren, z. B. einer Konferenz das mit Google Kalender verbunden ist.

Wenn Sie mit dem Add-on Anpassungen an Kalendertermindaten vornehmen möchten (z. B. als Teilnehmerliste angezeigt wird, müssen Sie das Add-on calendar.currentEventAccess Manifest-Feld auf WRITE oder READ_WRITE setzen. Dies gilt auch für muss das Add-on die https://www.googleapis.com/auth/calendar.addons.current.event.write Scope (Bereich).

Konferenzlösungen hinzufügen

Konferenzlösungen stellen Konferenzoptionen eines Drittanbieters dar, an die Nutzer angehängt werden können. Google Kalender-Termine Die Übersicht zu Videokonferenzen mit Drittanbietern die Dokumentation enthält Details zur Erstellung eines Add-ons, das neue Konferenzlösungen. Es ist nicht notwendig, eine UI für diese Art von Erweiterung; hinzugefügte Lösungen werden einfach als Optionen im Drop-down-Menü der Benutzeroberfläche von Google Kalender-Terminen.