Class TextButton

TextButton

Ein TextButton mit einem Textlabel. Sie können die Hintergrundfarbe festlegen und die Schaltfläche bei Bedarf deaktivieren.

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

const textButton = CardService.newTextButton()
                       .setText('Open Link')
                       .setOpenLink(CardService.newOpenLink().setUrl(
                           'https://www.google.com'));

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
setAltText(altText)	TextButton	Legt den Alternativtext des Buttons für die Barrierefreiheit fest.
setAuthorizationAction(action)	TextButton	Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL für den Autorisierungsablauf öffnet.
setBackgroundColor(backgroundColor)	TextButton	Legt die Hintergrundfarbe für die Schaltfläche TextButtonStyle.FILLED fest.
setComposeAction(action, composedEmailType)	TextButton	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E‑Mail-Nachricht erstellt wird.
setDisabled(disabled)	TextButton	Legt fest, ob der Button deaktiviert ist.
setIcon(icon)	TextButton	Legt ein vordefiniertes Icon fest, das auf der Schaltfläche angezeigt werden soll.
setIconUrl(url)	TextButton	Legt die URL eines Bildes fest, das als Symbol für diese Schaltfläche verwendet werden soll.
setMaterialIcon(icon)	TextButton	Legt das Material Design-Symbol fest.
setOnClickAction(action)	TextButton	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)	TextButton	Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird.
setOpenLink(openLink)	TextButton	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setOverflowMenu(menu)	TextButton	Legt fest, dass beim Klicken auf das Objekt ein Pop‑up-Menü geöffnet wird.
setText(text)	TextButton	Legt den Text fest, der auf der Schaltfläche angezeigt wird.
setTextButtonStyle(textButtonStyle)	TextButton	Legt den Stil der Schaltfläche fest.

Detaillierte Dokumentation

setAltText(altText)

Legt den Alternativtext des Buttons für die Barrierefreiheit fest. Wenn nicht festgelegt, wird standardmäßig der Text verwendet, der auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
altText	String	Der alternative Text, der dieser Schaltfläche zugewiesen werden soll.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL für den Autorisierungsablauf öffnet. 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 eines der Attribute setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

// ...

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

TextButton – Dieses Objekt zur Verkettung.

---

setBackgroundColor(backgroundColor)

Legt die Hintergrundfarbe für die Schaltfläche TextButtonStyle.FILLED fest. Wenn sie für eine TextButtonStyle.FILLED-Schaltfläche nicht festgelegt ist, wird die im Manifest des Add-ons definierte sekundäre Farbe verwendet. Diese Methode ist für TextButtonStyle.OUTLINED-Schaltflächen ein No-Op.

Parameter

Name	Typ	Beschreibung
backgroundColor	String	Die Farbe im Format #rgb.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setComposeAction(action, composedEmailType)

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

Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriertes ComposeActionResponse-Objekt zurückgibt.

Hinweis: Mit dieser Methode wird keine Compose-Aktion festgelegt, die zum Erweitern der Compose-Benutzeroberfläche verwendet wird. Stattdessen wird dieses UI-Element mit einem Action verbunden, das Entwurfsnachrichten in Apps Script verfasst, 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 Compose-Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailType	ComposedEmailType	Ein Enum-Wert, der angibt, ob der zusammengesetzte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setDisabled(disabled)

Legt fest, ob der Button deaktiviert ist. Eine deaktivierte Schaltfläche ist ausgegraut und kann nicht angeklickt werden.

Parameter

Name	Typ	Beschreibung
disabled	Boolean	Der deaktivierte Status.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setIcon(icon)

Legt ein vordefiniertes Icon fest, das auf der Schaltfläche angezeigt werden soll. Entweder muss dies oder setIconUrl(url) verwendet werden, um das Schaltflächenbild zu definieren.

Parameter

Name	Typ	Beschreibung
icon	Icon	Einer der vordefinierten Icon-Werte.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setIconUrl(url)

Legt die URL eines Bildes fest, das als Symbol für diese Schaltfläche verwendet werden soll. Entweder diese oder setIcon(icon) muss verwendet werden, um das Schaltflächenbild zu definieren.

Parameter

Name	Typ	Beschreibung
url	String	Die URL-Adresse eines gehosteten Bildes, das als Symbol für diese Schaltfläche verwendet werden soll.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setMaterialIcon(icon)

Legt das Material Design-Symbol fest.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parameter

Name	Typ	Beschreibung
icon	MaterialIcon	Das Material Design-Symbol.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setOnClickAction(action)

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der Werte setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

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

TextButton – Dieses Objekt zur Verkettung.

---

setOnClickOpenLinkAction(action)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder wenn Sie zusätzlich zum Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur eines der Attribute setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, die ein mit ActionResponseBuilder.setOpenLink(openLink) konfiguriertes ActionResponse-Objekt zurückgibt.

// ...

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 des Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

TextButton – Dieses Objekt zur 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 eines der folgenden Attribute 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ückflug

TextButton – Dieses Objekt zur Verkettung.

---

setOverflowMenu(menu)

Legt fest, dass beim Klicken auf das Objekt ein Pop‑up-Menü geöffnet 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. Aktionen für Menüpunkte dürfen kein Dreipunkt-Menü angeben.

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

Entwicklervorschau:Im Rahmen des Google Workspace Developer Preview Program verfügbar, das Vorabzugriff 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ückflug

TextButton – Dieses Objekt zur Verkettung.

---

setText(text)

Legt den Text fest, der auf der Schaltfläche angezeigt wird.

Parameter

Name	Typ	Beschreibung
text	String	Der Text, der auf der Schaltfläche angezeigt wird.

Rückflug

TextButton – Dieses Objekt zur Verkettung.

---

setTextButtonStyle(textButtonStyle)

Legt den Stil der Schaltfläche fest. Wenn nicht festgelegt, wird standardmäßig die Schaltfläche TextButtonStyle.OUTLINED verwendet.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

Parameter

Name	Typ	Beschreibung
textButtonStyle	TextButtonStyle	Der Stil des Buttons.

Rückflug

TextButton – Dieses Objekt zur Verkettung.