Ein Chip mit einem Symbol und einem Textlabel. Sie können den Chip bei Bedarf deaktivieren.
Verfügbar für Google Chat-Apps. In der Entwicklervorschau für Google Workspace-Add-ons.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
set | Chip | Legt den alternativen Text des Chips für die Barrierefreiheit fest. |
set | Chip | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. |
set | Chip | Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
set | Chip | Legt fest, ob der Chip deaktiviert ist. |
set | Chip | Hier legen Sie das Symbol fest, das als Chip verwendet werden soll. |
set | Chip | Hiermit wird der Titel des Chips festgelegt. |
set | Chip | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Chip | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Chip | Hier wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
Detaillierte Dokumentation
set Alt Text(altText)
Legt den alternativen Text des Chips für die Barrierefreiheit fest. Wenn nicht festgelegt, wird standardmäßig der Text verwendet, der auf dem Chip angezeigt wird.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
alt | String | Der alternative Text, der diesem Chip zugewiesen werden soll. |
Rückflug
Chip – Dieses Objekt für die 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
Chip – Dieses Objekt für die 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
Chip – dieses Objekt, zur Verkettung
set Disabled(disabled)
Legt fest, ob der Chip deaktiviert ist. Ein deaktivierter Chip ist ausgegraut und kann nicht angeklickt werden.
const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
disabled | Boolean | Der deaktivierte Status. |
Rückflug
Chip – Dieses Objekt für die Verkettung.
set Icon(icon)
Hier legen Sie das Symbol fest, das als Chip verwendet werden soll.
const chip = CardService.newChip().setIcon( CardService.newIconImage().setMaterialIcon( CardService.newMaterialIcon().setName('bug_report'), ), );
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
icon | Icon | Einer der vordefinierten Icon-Werte. |
Rückflug
Chip – Dieses Objekt für die Verkettung.
set Label(label)
Hiermit wird der Titel des Chips festgelegt. Erforderlich.
const chip = CardService.newChip().setLabel('bug Report');
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
label | String | Der anzuzeigende Text. |
Rückflug
Chip – dieses Objekt, zur 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
Chip – Dieses Objekt für die 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
Chip – dieses Objekt, zur Verkettung
set Open Link(openLink)
Hier 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
Chip – dieses Objekt, zur Verkettung