Auslöser für Google Workspace-Add-ons

Apps Script-Trigger führen dazu, dass eine bestimmte Scriptfunktion (die Triggerfunktion) ausgeführt wird, wenn ein bestimmtes Ereignis eintritt. Nur bestimmte Ereignisse können Trigger auslösen und jede Google Workspace-Anwendung unterstützt eine andere Reihe von Ereignissen.

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.

Sobald 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 zu reagieren. 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 Nachrichtenverlauf öffnet. In diesem Fall implementieren Sie eine kontextbezogene Callback-Funktion, um die Karten zu erstellen, aus denen die neue Benutzeroberfläche besteht. Dazu verwenden Sie die Daten, die im Ereignisobjekt übergeben werden.

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

Manifest-Trigger

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

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

  • Startseitentrigger, mit denen die Add-on-Startseite erstellt und angezeigt wird.
  • Open-Trigger für Kalendertermine, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn ein Kalendertermin geöffnet wird.
  • Calendar eventUpdate-Trigger, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn ein Nutzer einen Kalendertermin bearbeitet und speichert.
  • Drive-onItemsSelected-Trigger, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn ein Nutzer eine oder mehrere Dateien oder Ordner in Drive auswählt.
  • Gmail-Auslöser für das Verfassen von Nachrichten, die eine Add-on-Karte anzeigen, wenn der Nutzer das Add-on im Gmail-Fenster zum Verfassen von Nachrichten öffnet.
  • Kontextbezogene Gmail-Trigger, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn der Nutzer eine Gmail-Nachricht öffnet.
  • Editor onFileScopeGranted-Trigger, die eine neue Karte anzeigen, wenn Nutzer die Autorisierung für den drive.file-OAuth-Bereich im aktuellen Editor-Dokument erteilen.

In der obigen Liste sind nur Homepage-Trigger nicht kontextbezogen. Die restlichen sind kontextbezogene Trigger. Weitere Informationen zu Manifest-Triggerdefinitionen finden Sie unter Manifest.

Zusätzlich zu Manifest-Triggern können Google Workspace-Add-ons auch installierbare Apps Script-Trigger verwenden.

Einschränkungen

Für die Verwendung von Manifest-Triggern gelten bestimmte Einschränkungen.

  • Diese Trigger werden nur in Google Workspace-Add‑on-Projekten verwendet. In anderen Anwendungen haben sie keine Funktion.
  • Da sie im Add-on-Manifest und nicht im Code definiert sind, können Sie den Apps Script-Dienst Script nicht verwenden, um diese Trigger zu erstellen oder zu ändern.
  • Kontextbezogene Gmail-Trigger können derzeit nur ein unconditional-Kriterium haben. Das bedeutet, dass kontextbezogene Trigger für jede E-Mail ausgelöst werden, unabhängig vom Inhalt.
  • Jedes Add-on kann nur einen Trigger jedes Typs pro Nutzer und Dokument haben.