Ein organisiertes Raster zur Darstellung einer Sammlung von Rasterelementen.
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 | Widget | Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann. |
add | Grid | Fügt dem Raster ein neues Rasterelement hinzu. |
set | Grid | Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf öffnet. |
set | Grid | Legt den Rahmenstil fest, der auf die einzelnen Rasterelemente angewendet wird. |
set | Grid | Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail-Nachricht erstellt wird. |
set | Widget | Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. |
set | Grid | Die Anzahl der Spalten, die im Raster angezeigt werden sollen. |
set | Grid | Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Grid | Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird. |
set | Grid | Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
set | Grid | Hiermit wird der Titeltext des Rasters festgelegt. |
set | Widget | Legt die Sichtbarkeit des Widgets fest. |
Detaillierte Dokumentation
add Event Action(eventAction)
Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
event | Event | Die hinzuzufügende Event. |
Rückflug
Widget – Das Objekt für die Verkettung.
add Item(gridItem)
set Authorization Action(action)
Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum 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 set, set, set, set oder set festgelegt werden.
// ... 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 die einzelnen Rasterelemente 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)
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 set, set, set, set oder set festgelegt werden.
Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, 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 Compose-Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composed | Composed | Ein Enumerationswert, der angibt, ob der erstellte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Rückflug
Grid: Dieses Objekt zur Verkettung.
set Id(id)
Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. Die Mutation von Widgets wird nur in Add-ons unterstützt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
id | String | Die ID des Widgets mit einem Limit von 64 Zeichen und im Format `[a-zA-Z0-9-]+`. |
Rückflug
Widget: Dieses Objekt zur Verkettung.
set Num Columns(numColumns)
Die Anzahl der Spalten, die im Raster angezeigt werden sollen. Wenn die Seitenleiste rechts angezeigt wird, können Sie 1–2 Spalten einblenden. Der Standardwert ist 1. Wenn sie in einem Dialogfeld angezeigt werden, können Sie 2–3 Spalten einblenden. 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)
Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur eines der Attribute set, set, set, set oder set festgelegt werden.
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)
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 Open-Objekts weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur eines der Attribute set, set, set, set oder set festgelegt werden.
Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, 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 des Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Grid: Dieses Objekt zur Verkettung.
set Open Link(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: 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.
set Visibility(visibility)
Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist „VISIBLE“.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
visibility | Visibility | Die Visibility des Widgets. |
Rückflug
Widget – Das Objekt für die Verkettung.