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

Apps Script-Trigger sorgen dafür, dass eine bestimmte Scriptfunktion (die Triggerfunktion) ausgeführt wird, wenn ein bestimmtes Ereignis eintritt. Nur bestimmte Ereignisse können Auslöser aktivieren. Jede Google Workspace-Anwendung unterstützt eine andere Gruppe 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.

Nachdem das Ereignisobjekt erstellt wurde, gibt Apps Script es als Parameter an die Triggerfunktion weiter. Die Triggerfunktion ist eine Callback-Funktion, die Sie selbst implementieren müssen, um die erforderlichen Aktionen auszuführen, 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 Nachrichten-Thread öffnet. In diesem Fall implementieren Sie eine kontextbezogene Rückruffunktion, um die Karten zu erstellen, aus denen die neue Benutzeroberfläche besteht, und verwenden dabei 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 in Google Workspace-Add-ons derzeit keine einfachen Trigger von Apps Script verwendet werden. Stattdessen werden Trigger verwendet, die speziell für Google Workspace-Add-ons entwickelt wurden: Manifest-Trigger.

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

• Startseitentrigger, mit denen die Startseite des Add-ons erstellt und angezeigt wird.
• Trigger vom Typ „Kalendertermin geöffnet“, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn ein Kalendertermin geöffnet wird.
• Trigger vom Typ „Kalender – Ereignis aktualisieren“, 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-Trigger für das Verfassen von E-Mails, die eine Add-on-Karte anzeigen, wenn der Nutzer das Add-on im Gmail-Fenster zum Verfassen von E-Mails öffnet.
• Kontextauslöser für Gmail, die eine neue Karte anzeigen oder andere Aktionen ausführen, wenn der Nutzer eine Gmail-Nachricht öffnet.
• Editor-Trigger vom Typ „onFileScopeGranted“, die eine neue Karte anzeigen, wenn Nutzer im aktuellen Editordokument die Autorisierung für den OAuth-Berechtigungsbereich drive.file gewähren.

In der Liste oben sind nur Startseitentrigger nicht kontextbezogen, der Rest sind kontextbezogene Trigger. Weitere Informationen zu Manifest-Triggerdefinitionen finden Sie unter Manifest.

Neben Manifesttriggern können Google Workspace-Add-ons auch installierbare Trigger von Apps Script verwenden.

Einschränkungen

Die Verwendung von Manifest-Triggern unterliegt bestimmten Einschränkungen.

• Diese Trigger werden nur in Google Workspace-Add-on-Projekten verwendet und haben in anderen Anwendungen 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.
• Gmail-Kontexttrigger können derzeit nur unconditional-Kriterien haben. Das bedeutet, dass Kontexttrigger für jede E-Mail-Nachricht ausgelöst werden, unabhängig vom Inhalt.
• Jedes Add-on kann pro Nutzer und Dokument nur einen Trigger jedes Typs haben.