Class CardAction

CardAction

Ein anklickbarer Menüpunkt, der dem Menü des Kartenheaders hinzugefügt wird.

const action = CardService.newAction();
// Finish building the action...

const cardAction =
    CardService.newCardAction().setText('Card action').setOnClickAction(action);

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
setAuthorizationAction(action)	CardAction	Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang öffnet.
setComposeAction(action, composedEmailType)	CardAction	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail als Entwurf erstellt wird.
setOnClickAction(action)	CardAction	Legt eine Aktion fest, die beim Klicken auf das Objekt ausgeführt wird.
setOnClickOpenLinkAction(action)	CardAction	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL in einem Tab geöffnet wird.
setOpenLink(openLink)	CardAction	Legt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll.
setText(text)	CardAction	Legt den Menütext für diese Aktion fest.

Detaillierte Dokumentation

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang öffnet. Die URL wird 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 eine der folgenden Methoden festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

// ...

const 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.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.

---

setComposeAction(action, composedEmailType)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail als Entwurf erstellt wird. Für ein UI-Objekt kann nur eine der folgenden Methoden festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Der Action Parameter muss eine Callback-Funktion angeben, die ein ComposeActionResponse Objekt zurückgibt, das mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriert wurde.

Hinweis: Mit dieser Methode wird keine Aktion zum Erstellen festgelegt, mit der die Benutterschnittstelle zum Erstellen von E-Mails erweitert wird. Stattdessen wird dieses UI-Element mit einer Action verknüpft, mit der E-Mail-Entwürfe in Apps Script erstellt werden, die nach Abschluss der Aktion in Gmail geöffnet werden.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

Name	Typ	Beschreibung
action	Action	Das Objekt, das die Aktion zum Erstellen angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailType	ComposedEmailType	Ein Enum-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.

---

setOnClickAction(action)

Legt eine Aktion fest, die beim Klicken auf das Objekt ausgeführt wird. Für ein UI-Objekt kann nur eine der folgenden Methoden festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Der Parameter Action muss eine Callback-Funktion angeben, die ein ActionResponse Objekt zurückgibt.

// ...

const 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	Die Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.

---

setOnClickOpenLinkAction(action)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL in einem Tab geöffnet 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üssen. Für ein UI-Objekt kann nur eine der folgenden Methoden festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Der Action Parameter muss eine Callback-Funktion angeben, die ein ActionResponse Objekt zurückgibt, das mit ActionResponseBuilder.setOpenLink(openLink) konfiguriert wurde.

// ...

const 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.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.

---

setOpenLink(openLink)

Legt eine URL fest, die beim Klicken auf das Objekt geöffnet werden soll. Verwenden Sie diese Funktion, wenn die URL bereits bekannt ist und nur geöffnet werden muss. Für ein UI-Objekt kann nur eine der folgenden Methoden festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Parameter

Name	Typ	Beschreibung
openLink	OpenLink	Ein OpenLink Objekt, das die zu öffnende URL beschreibt.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.

---

setText(text)

Legt den Menütext für diese Aktion fest.

Parameter

Name	Typ	Beschreibung
text	String	Der Text des Menüpunkts.

Rückgabe

CardAction : Dieses Objekt zur Verkettung.