Class Grid

Raster

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

MethodeRückgabetypKurzbeschreibung
addEventAction(eventAction)WidgetFügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
addItem(gridItem)GridFügt dem Raster ein neues Rasterelement hinzu.
setAuthorizationAction(action)GridLegt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf öffnet.
setBorderStyle(borderStyle)GridLegt den Rahmenstil fest, der auf die einzelnen Rasterelemente angewendet wird.
setComposeAction(action, composedEmailType)GridLegt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail-Nachricht erstellt wird.
setId(id)WidgetLegt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird.
setNumColumns(numColumns)GridDie Anzahl der Spalten, die im Raster angezeigt werden sollen.
setOnClickAction(action)GridLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)GridLegt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird.
setOpenLink(openLink)GridLegt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setTitle(title)GridHiermit wird der Titeltext des Rasters festgelegt.
setVisibility(visibility)WidgetLegt die Sichtbarkeit des Widgets fest.

Detaillierte Dokumentation

addEventAction(eventAction)

Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.

Parameter

NameTypBeschreibung
eventActionEventActionDie hinzuzufügende EventAction.

Rückflug

Widget – Das Objekt für die Verkettung.


addItem(gridItem)

Fügt dem Raster ein neues Rasterelement hinzu.

Parameter

NameTypBeschreibung
gridItemGridItemDas hinzuzufügende Grid-Element.

Rückflug

Grid: Dieses Objekt zur Verkettung.


setAuthorizationAction(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 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

NameTypBeschreibung
actionAuthorizationActionDas Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Grid: Dieses Objekt zur Verkettung.


setBorderStyle(borderStyle)

Legt den Rahmenstil fest, der auf die einzelnen Rasterelemente angewendet wird. Der Standardwert ist NO_BORDER.

Parameter

NameTypBeschreibung
borderStyleBorderStyleDer anzuwendende Rahmenstil.

Rückflug

Grid: 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.

// ...

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

NameTypBeschreibung
actionActionDas Objekt, das die Compose-Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin Enumerationswert, der angibt, ob der erstellte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Rückflug

Grid: Dieses Objekt zur Verkettung.


setId(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

NameTypBeschreibung
idStringDie ID des Widgets mit einem Limit von 64 Zeichen und im Format `[a-zA-Z0-9-]+`.

Rückflug

Widget: Dieses Objekt zur Verkettung.


setNumColumns(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

NameTypBeschreibung
numColumnsIntegerDie Anzahl der Spalten.

Rückflug

Grid: 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 eines der Attribute 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

NameTypBeschreibung
actionActionDie Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Grid: 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

NameTypBeschreibung
actionActionDas 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.


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

NameTypBeschreibung
openLinkOpenLinkEin OpenLink-Objekt, das die zu öffnende URL beschreibt.

Rückflug

Grid: Dieses Objekt zur Verkettung.


setTitle(title)

Hiermit wird der Titeltext des Rasters festgelegt. Der Text muss ein einfacher String ohne Formatierung sein.

Parameter

NameTypBeschreibung
titleStringDer Titeltext.

Rückflug

Grid: Dieses Objekt zur Verkettung.


setVisibility(visibility)

Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist „VISIBLE“.

Parameter

NameTypBeschreibung
visibilityVisibilityDie Visibility des Widgets.

Rückflug

Widget – Das Objekt für die Verkettung.