Diese Seite wurde von der Cloud Translation API übersetzt.

Add-on-Aktionen

Add-on-Aktionen ermöglichen interaktives Verhalten für Widgets. Wenn Sie eine Aktion erstellen, legen Sie fest, was passiert, wenn der Nutzer ein Widget auswählt oder aktualisiert.

In den meisten Fällen können Sie Add-on-Aktionen mit Action-Objekten definieren, die vom Apps Script-Kartenservice bereitgestellt werden. Jeder Action ist beim Erstellen eine Callback-Funktion zugeordnet. Sie implementieren die Callback-Funktion, um ausgewählte Schritte auszuführen, wenn der Nutzer mit dem Widget interagiert. Sie müssen auch Action mit dem Widget verknüpfen. Verwenden Sie dazu eine geeignete Widget-Handler-Funktion, die definiert, welche Art von Interaktion den Action-Callback auslöst.

So konfigurieren Sie ein Widget mit einem Action:

Erstellen Sie das Action-Objekt und geben Sie die Callback-Funktion an, die es zusammen mit allen erforderlichen Parametern ausführen soll.
Rufen Sie die entsprechende Widget-Handler-Funktion für das Widget mit dem Action-Objekt auf.
Implementieren Sie die Callback-Funktion, um das erforderliche Verhalten zu aktivieren.

Wenn Sie ein Widget mit einem bestimmten Action oder einem anderen Verhalten verknüpfen möchten, verwenden Sie eine Widget-Handler-Funktion. Die Handler-Funktion bestimmt, welche Art von Interaktion (z. B. Klicken auf das Widget oder Bearbeiten eines Textfelds) das Aktionsverhalten auslöst. Die Handler-Funktion definiert auch, welche Schritte die Benutzeroberfläche nach Abschluss der Aktion ausführt.

In der folgenden Tabelle sind die verschiedenen Handlertypen für Widgets und die Widgets aufgeführt, mit denen sie verwendet werden:

Handler-Funktion	Aktion auslösen	Anwendbare Widgets	Beschreibung
`setOnChangeAction()`	Der Widget-Wert ändert sich	`DatePicker` `DateTimePicker` `SelectionInput` `Switch` `TextInput` `TimePicker`	Legt einen `Action` fest, der eine Apps Script-Funktion ausführt, wenn das Widget den Fokus verliert, z. B. wenn der Nutzer Text in ein Eingabefeld eingibt und die Eingabetaste drückt. Der Handler übergibt automatisch ein Ereignisobjekt an die Funktion, die er aufruft. Sie können zusätzliche Parameterinformationen in dieses Ereignisobjekt einfügen, sofern es ausgewählt ist.
`setOnClickAction()`	Der Nutzer klickt auf das Widget.	`CardAction` `Image` `ImageButton` `DecoratedText` `TextButton`	Legt ein `Action` fest, das eine Apps Script-Funktion ausführt, wenn der Nutzer auf das Widget klickt. Der Handler übergibt automatisch ein Ereignisobjekt an die Funktion, die er aufruft. Sie können optionale Parameterinformationen in dieses Ereignisobjekt einfügen.
`setComposeAction()`	Der Nutzer klickt auf das Widget.	`CardAction` `Image` `ImageButton` `DecoratedText` `TextButton`	Gmail-spezifisch: Legt eine `Action` fest, die einen E‑Mail-Entwurf erstellt und diesen Entwurf dann dem Nutzer in einem Gmail-Fenster zum Verfassen von Nachrichten präsentiert. Sie können den Entwurf als neue Nachricht oder als Antwort auf die geöffnete Nachricht in Gmail erstellen. Wenn der Handler die Callback-Funktion zum Erstellen von Entwürfen aufruft, übergibt er ein Ereignisobjekt an die Callback-Funktion. Weitere Informationen finden Sie unter Nachrichtentwürfe erstellen.
`setOnClickOpenLinkAction()`	Der Nutzer klickt auf das Widget.	`CardAction` `Image` `ImageButton` `DecoratedText` `TextButton`	Legt eine `Action` fest, um eine URL zu öffnen, wenn der Nutzer auf das Widget klickt. Verwenden Sie diesen Handler, wenn Sie die URL erstellen müssen oder andere Aktionen ausgeführt werden müssen, bevor der Link geöffnet wird. Andernfalls ist es in der Regel einfacher, `setOpenLink()` zu verwenden. Sie können die URL nur in einem neuen Fenster öffnen. Wenn das Add‑on geschlossen ist, können Sie die Benutzeroberfläche dazu veranlassen, es neu zu laden.
`setOpenLink()`	Der Nutzer klickt auf das Widget.	`CardAction` `Image` `ImageButton` `DecoratedText` `TextButton`	Öffnet direkt eine URL, wenn der Nutzer auf das Widget klickt. Verwenden Sie diesen Handler, wenn Sie die URL kennen und sie nur öffnen müssen. Andernfalls verwenden Sie `setOnClickOpenLinkAction()`. Sie können die URL in einem neuen Fenster oder in einem Overlay öffnen. Wenn das Add‑on geschlossen ist, können Sie die Benutzeroberfläche dazu veranlassen, es neu zu laden.
`setSuggestionsAction()`	Der Nutzer gibt Text in ein Eingabefeld ein.	`TextInput`	Legt einen `Action` fest, der eine Apps Script-Funktion ausführt, wenn der Nutzer Text in ein Text-Eingabe-Widget eingibt. Der Handler übergibt automatisch ein Ereignisobjekt an die Funktion, die er aufruft. Weitere Informationen finden Sie unter Vorschläge zur automatischen Vervollständigung für Texteingaben.

Callback-Funktionen

Callback-Funktionen werden ausgeführt, wenn ein Action ausgelöst wird. Da Callback-Funktionen Apps Script-Funktionen sind, können Sie sie fast alles tun lassen, was andere Skriptfunktionen tun können.

empfangen wird.

Eine Callback-Funktion gibt manchmal ein bestimmtes Antwortobjekt zurück. Diese Arten von Antworten weisen auf zusätzliche Vorgänge hin, die nach Abschluss des Callbacks ausgeführt werden müssen, z. B. das Anzeigen einer neuen Karte oder das Präsentieren von Vorschlägen für die automatische Vervollständigung. Wenn Ihre Callback-Funktion ein bestimmtes Antwortobjekt zurückgeben muss, verwenden Sie eine Builder-Klasse im Card-Dienst, um dieses Objekt zu erstellen.

In der folgenden Tabelle sehen Sie, wann Ihre Callback-Funktionen für bestimmte Aktionen ein bestimmtes Antwortobjekt zurückgeben müssen. Diese Aktionen sind alle unabhängig von der jeweiligen Hostanwendung, die durch das Add-on erweitert wird:

Versuchte Aktion	Die Callback-Funktion sollte zurückgeben
Zwischen Karten wechseln	`ActionResponse`
`Notification` anzeigen	`ActionResponse`
Link mit `setOnClickOpenLinkAction()` öffnen	`ActionResponse`
Vorschläge zur automatischen Vervollständigung anzeigen	`SuggestionResponse`
Universelle Aktion verwenden	`UniversalActionResponse`
Weitere Aktionen	Nichts

Aktionen für Google Workspace-Hostanwendungen

Zusätzlich zu diesen Aktionen hat jede Hostanwendung eigene Aktionen, die nur in diesem Host ausgeführt werden können. Weitere Informationen finden Sie in den folgenden Anleitungen:

Aktionsereignisobjekte

Wenn Ihr Add-on ein Action auslöst, erstellt die Benutzeroberfläche automatisch ein JSON-Ereignisobjekt und übergibt es als Argument an die Action-Callback-Funktion. Dieses Ereignisobjekt enthält Informationen zum aktuellen clientseitigen Kontext des Nutzers, z. B. die aktuellen Werte aller interaktiven Widgets auf der angezeigten Karte.

Aktionsereignisobjekte haben eine bestimmte JSON-Struktur, in der die enthaltenen Informationen organisiert sind. Dieselbe Struktur wird verwendet, wenn ein Homepage-Trigger ausgelöst wird, um eine Homepage zu erstellen, oder wenn ein kontextbezogener Trigger ausgelöst wird, um die Add-on-Anzeige zu aktualisieren.

Eine vollständige Beschreibung der Struktur von Ereignisobjekten finden Sie unter Ereignisobjekte.