Ein anklickbares Menüelement, das dem Menü der Kopfzeile der Karte hinzugefügt wird.
var action = CardService.newAction(); // Finish building the action... var cardAction = CardService.newCardAction() .setText("Card action") .setOnClickAction(action);
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setAuthorizationAction(action) | CardAction | Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf geöffnet wird. |
setComposeAction(action, composedEmailType) | CardAction | Legt eine Aktion fest, bei der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
setOnClickAction(action) | CardAction | Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
setOnClickOpenLinkAction(action) | CardAction | Legt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
setOpenLink(openLink) | CardAction | Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
setText(text) | CardAction | Legt den Menütext für diese Aktion fest. |
Detaillierte Dokumentation
setAuthorizationAction(action)
Legt eine Autorisierungsaktion fest, durch die beim Anklicken des Objekts eine URL zum Autorisierungsablauf geöffnet wird. Dadurch wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und zur Anwendung zurückkehrt, wird das Add-on neu geladen.
Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | AuthorizationAction | Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Return
CardAction
: Dieses Objekt für Verkettungen.
setComposeAction(action, composedEmailType)
Legt eine Aktion fest, bei der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft)
konfiguriertes ComposeActionResponse
-Objekt zurückgibt.
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die zusammensetzende Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composedEmailType | ComposedEmailType | Ein ENUM-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Return
CardAction
: Dieses Objekt für Verkettungen.
setOnClickAction(action)
Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein ActionResponse
-Objekt zurückgibt.
// ... var action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton().setText('Create notification').setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification(CardService.newNotification() .setText("Some info to display to user")) .build(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Return
CardAction
: Dieses Objekt für Verkettungen.
setOnClickOpenLinkAction(action)
Legt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder wenn Sie neben dem Erstellen des OpenLink
-Objekts weitere Aktionen ausführen möchten. Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit ActionResponseBuilder.setOpenLink(openLink)
konfiguriertes ActionResponse
-Objekt zurückgibt.
// ... var action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink() .setUrl('https://www.google.com')) .build(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion zum Öffnen eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Return
CardAction
: Dieses Objekt für Verkettungen.
setOpenLink(openLink)
Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits bekannt ist und nur geöffnet werden muss. Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
openLink | OpenLink | Ein OpenLink -Objekt, das die zu öffnende URL beschreibt. |
Return
CardAction
: Dieses Objekt für Verkettungen.
setText(text)
Legt den Menütext für diese Aktion fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Text des Menüpunkts. |
Return
CardAction
: Dieses Objekt für Verkettungen.