Class Button

Button

Eine Basisklasse für alle Schaltflächen.

Verfügbar für Google Workspace-Add‑ons und Google Chat-Apps.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
setAuthorizationAction(action)	Button	Legt eine Autorisierungsaktion fest, mit der beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird.
setComposeAction(action, composedEmailType)	Button	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E‑Mail als Entwurf erstellt wird.
setOnClickAction(action)	Button	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)	Button	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL in einem Tab geöffnet wird.
setOpenLink(openLink)	Button	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setOverflowMenu(menu)	Button	Legt ein Pop‑up-Menü fest, das geöffnet werden soll, wenn auf das Objekt geklickt wird.

Detaillierte Dokumentation

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, mit der beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. 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

Button – Dieses Objekt für die 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 Benutzeroberfläche zum Erstellen erweitert wird. Stattdessen wird dieses UI-Element mit einem Action verknüpft, das E‑Mail-Entwürfe in Apps Script erstellt, 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

Button – Dieses Objekt für die Verkettung.

---

setOnClickAction(action)

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt 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

Button – Dieses Objekt für die 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

Button – Dieses Objekt für die Verkettung.

---

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

Button – Dieses Objekt für die Verkettung.

---

setOverflowMenu(menu)

Legt ein Pop‑up-Menü fest, das geöffnet werden soll, wenn auf das Objekt geklickt wird. Für jedes Element im Menü kann eine Aktion angegeben werden, die beim Klicken ausgelöst werden soll. Verschachtelte Menüs werden nicht unterstützt. Für Menüelemente dürfen keine Überlaufmenüs angegeben werden.

Verfügbar für Google Chat-Apps. In der Entwicklervorschau für Google Workspace-Add‑ons.

Entwicklervorschau: Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das frühen Zugriff auf bestimmte Funktionen bietet.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parameter

Name	Typ	Beschreibung
menu	OverflowMenu	Das Objekt, das das Überlaufmenü angibt, das angezeigt werden soll, wenn auf dieses Element geklickt wird.

Rückgabe

Button – Dieses Objekt für die Verkettung.