Eine Text
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 |
---|---|---|
set | Text | Hiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt. |
set | Text | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf geöffnet wird. |
set | Text | Hier legen Sie die Hintergrundfarbe der Schaltfläche Text fest. |
set | Text | Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
set | Text | Hier legen Sie fest, ob die Schaltfläche deaktiviert ist. |
set | Text | Hiermit wird eine vordefinierte Icon festgelegt, die auf der Schaltfläche angezeigt wird. |
set | Text | Hier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll. |
set | Text | Hiermit wird das Material Design-Symbol festgelegt. |
set | Text | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Text | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Text | Hiermit wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
set | Text | Hiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Text | Hier legen Sie den Text fest, der auf der Schaltfläche angezeigt wird. |
set | Text | Hier legen Sie den Schaltflächenstil fest. |
Detaillierte Dokumentation
set Alt Text(altText)
Hiermit wird der alternative Text der Schaltfläche für die Barrierefreiheit festgelegt. Wenn nicht festgelegt, wird standardmäßig der Text verwendet, der auf der Schaltfläche angezeigt wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
alt | String | Der alternative Text, der dieser Schaltfläche zugewiesen werden soll. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Authorization Action(action)
Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt 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 einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Authorization | Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Background Color(backgroundColor)
Hier legen Sie die Hintergrundfarbe der Schaltfläche Text
fest. Wenn für eine Text
-Schaltfläche keine Farbe festgelegt ist, wird die im Manifest des Add-ons definierte sekundäre Farbe verwendet.
Diese Methode ist für Text
-Schaltflächen nicht relevant.
Parameter
Name | Typ | Beschreibung |
---|---|---|
background | String | Die Farbe im #rgb-Format. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Compose Action(action, composedEmailType)
Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Compose
konfiguriertes Compose
-Objekt zurückgibt.
// ... 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 angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composed | Composed | Ein enum-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Disabled(disabled)
Legt fest, ob die Schaltfläche deaktiviert ist. Eine deaktivierte Schaltfläche ist ausgegraut und kann nicht angeklickt werden.
Parameter
Name | Typ | Beschreibung |
---|---|---|
disabled | Boolean | Der deaktivierte Status. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Icon(icon)
Hiermit wird eine vordefinierte Icon
festgelegt, die auf der Schaltfläche angezeigt wird. Entweder dieses oder set
muss verwendet werden, um das Schaltflächenbild zu definieren.
Parameter
Name | Typ | Beschreibung |
---|---|---|
icon | Icon | Einer der vordefinierten Icon -Werte. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Icon Url(url)
Hier wird die URL eines Bildes festgelegt, das als Symbol für diese Schaltfläche verwendet werden soll. Entweder dieses oder set
muss verwendet werden, um das Schaltflächenbild zu definieren.
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | Die URL eines gehosteten Bildes, das als Symbol für diese Schaltfläche verwendet werden soll. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Material Icon(icon)
Hiermit wird das Material Design-Symbol festgelegt.
const textButton = CardService.newTextButton().setMaterialIcon( CardService.newMaterialIcon().setName('search'), );
Parameter
Name | Typ | Beschreibung |
---|---|---|
icon | Material | Das Symbol für Material Design. |
Rückflug
Text
– Dieses Objekt für die Verkettung.
set On Click Action(action)
Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein Action
-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
Text
– dieses Objekt, zur Verkettung
set On Click Open Link Action(action)
Hiermit wird eine Aktion festgelegt, durch die 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 Sie zusätzlich zum Erstellen des Open
-Objekts noch andere Aktionen ausführen müssen. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Action
konfiguriertes Action
-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 eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Open Link(openLink)
Hiermit wird eine URL festgelegt, 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 einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
open | Open | Ein Open -Objekt, das die zu öffnende URL beschreibt. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Overflow Menu(menu)
Hiermit wird ein Pop-up-Menü festgelegt, das geöffnet wird, wenn auf das Objekt geklickt wird. Für jeden Menüpunkt kann eine Aktion festgelegt werden, die ausgelöst wird, wenn darauf geklickt wird. Verschachtelte Menüs werden nicht unterstützt. Aktionen für Menüpunkte dürfen kein Dreipunkt-Menü angeben.
Verfügbar für Google Chat-Apps. In der Entwicklervorschau für Google Workspace-Add-ons
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 | Overflow | Das Objekt, das das Dreipunkt-Menü angibt, das angezeigt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Text
– dieses Objekt, zur Verkettung
set Text(text)
Hier legen Sie 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
Text
– dieses Objekt, zur Verkettung
set Text Button Style(textButtonStyle)
Hier legen Sie den Schaltflächenstil fest. Wenn nicht festgelegt, wird standardmäßig die Taste Text
verwendet.
const button = CardService.newTextButton() .setText('Filled') .setTextButtonStyle(CardService.TextButtonStyle.FILLED) .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | Text | Der Schaltflächenstil. |
Rückflug
Text
– dieses Objekt, zur Verkettung