Trigger für Google Workspace-Add-ons

Apps Script-Trigger sorgen dafür, dass bei jedem Auftreten eines bestimmten Ereignisses eine angegebene Skriptfunktion (die Triggerfunktion) ausgeführt wird. Nur bestimmte Ereignisse können Trigger auslösen. Jede Google Workspace-Anwendung unterstützt unterschiedliche Ereignisse.

Wenn ein Trigger ausgelöst wird, wird ein Ereignisobjekt erstellt. Diese JSON-Struktur enthält Details zum aufgetretenen Ereignis. Die Informationen in der Ereignisobjektstruktur sind je nach Triggertyp unterschiedlich organisiert.

Nachdem das Ereignisobjekt erstellt wurde, übergibt Apps Script es als Parameter an die Triggerfunktion. Die Triggerfunktion ist eine Callback-Funktion, die Sie selbst implementieren müssen, um auf das Ereignis reagieren zu können. In einem Google Workspace-Add-on, das Gmail erweitert, können Sie beispielsweise einen Trigger definieren, der eine neue Kartenoberfläche erstellt, wenn der Nutzer einen Nachrichtenthread öffnet. In diesem Fall implementieren Sie eine kontextbezogene Callback-Funktion, um mithilfe der im Ereignisobjekt übergebenen Daten die Karten zu erstellen, aus denen die neue UI besteht.

Auf dieser Seite finden Sie Richtlinien zur Verwendung von Triggern in Add-on-Projekten für Google Workspace.

Manifesttrigger

Im Gegensatz zu Editor-Add-ons können für Google Workspace-Add-ons derzeit keine einfachen Trigger für Apps Script verwendet werden. Stattdessen werden Trigger verwendet, die speziell für Google Workspace-Add-ons entwickelt wurden: Manifest-Trigger.

Manifesttrigger werden im Manifest des Google Workspace-Add-ons vollständig definiert. Beispiele für Manifest-Trigger:

  • Startseiten-Trigger, mit denen die Startseite des Add-ons erstellt und angezeigt wird
  • Calendar eventOpen-Trigger, mit denen beim Öffnen eines Kalendertermins eine neue Karte angezeigt oder andere Aktionen ausgeführt werden
  • Calendar eventUpdate-Trigger, mit denen eine neue Karte angezeigt oder andere Aktionen ausgeführt werden, wenn ein Nutzer einen Kalendertermin bearbeitet und speichert
  • Drive onItemsSelected Trigger, mit denen eine neue Karte angezeigt oder andere Aktionen ausgeführt werden, wenn ein Nutzer eine oder mehrere Dateien oder Ordner in Drive auswählt.
  • Gmail-Erstellungstrigger, durch die eine Add-on-Karte angezeigt wird, wenn der Nutzer das Add-on im Editorfenster von Gmail öffnet
  • Kontextbezogene Gmail-Trigger, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn der Nutzer eine Gmail-Nachricht öffnet.
  • Editor-onFileScopeGranted-Trigger, durch die eine neue Karte angezeigt wird, wenn Nutzer die Autorisierung für den OAuth-Bereich drive.file im aktuellen Editor-Dokument gewähren.

In der obigen Liste sind nur Startseiten-Trigger nicht kontextbezogen. Die übrigen sind kontextabhängige Trigger. Weitere Informationen zu Manifest-Triggerdefinitionen finden Sie unter Manifest.

Neben Manifest-Triggern können für Google Workspace-Add-ons auch installierbare Trigger von Apps Script verwendet werden.

Einschränkungen

Für Manifesttrigger gelten bestimmte Einschränkungen.

  • Diese Trigger werden nur in Google Workspace-Add-on-Projekten verwendet. In anderen Anwendungen haben sie keinen Zweck.
  • Da sie im Add-on-Manifest und nicht im Code definiert sind, können Sie diese Trigger nicht mit dem Apps Script-Dienst Script erstellen oder ändern.
  • Kontextuelle Gmail-Trigger können derzeit nur ein unconditional-Kriterium haben. Das bedeutet, dass kontextbezogene Trigger für jede E-Mail-Nachricht unabhängig vom Inhalt ausgelöst werden.
  • Jedes Add-on kann nur einen Trigger pro Typ, Nutzer und Dokument haben.