Ein organisiertes Raster, in dem eine Sammlung von Rasterelementen angezeigt wird.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
add | Grid | Dem Raster wird ein neues Rasterelement hinzugefügt. |
set | Grid | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf geöffnet wird. |
set | Grid | Legt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird. |
set | Grid | Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
set | Grid | Die Anzahl der Spalten, die im Raster angezeigt werden sollen. |
set | Grid | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Grid | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Grid | Hier wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
set | Grid | Hiermit wird der Titeltext des Rasters festgelegt. |
Detaillierte Dokumentation
add Item(gridItem)
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
Grid
– dieses Objekt, zur Verkettung
set Border Style(borderStyle)
Legt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird. Der Standardwert ist „NO_BORDER“.
Parameter
Name | Typ | Beschreibung |
---|---|---|
border | Border | Der anzuwendende Rahmenstil. |
Rückflug
Grid
– 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
Grid
– dieses Objekt, zur Verkettung
set Num Columns(numColumns)
Die Anzahl der Spalten, die im Raster angezeigt werden sollen. Wenn die Option in der rechten Seitenleiste angezeigt wird, können Sie 1–2 Spalten anzeigen. Der Standardwert ist 1. Wenn die Daten in einem Dialogfeld angezeigt werden, können Sie zwei bis drei Spalten anzeigen. Der Standardwert ist 2.
Parameter
Name | Typ | Beschreibung |
---|---|---|
num | Integer | Die Anzahl der Spalten. |
Rückflug
Grid
– 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
Grid
– 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
Grid
– 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
Grid
– dieses Objekt, zur Verkettung
set Title(title)
Hiermit wird der Titeltext des Rasters festgelegt. Der Text muss ein einfacher String ohne Formatierung sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titeltext. |
Rückflug
Grid
– dieses Objekt, zur Verkettung