Diese Seite wurde von der Cloud Translation API übersetzt.

Class Grid

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
`addItem(gridItem)`	`Grid`	Dem Raster wird ein neues Rasterelement hinzugefügt.
`setAuthorizationAction(action)`	`Grid`	Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf geöffnet wird.
`setBorderStyle(borderStyle)`	`Grid`	Legt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird.
`setComposeAction(action, composedEmailType)`	`Grid`	Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
`setNumColumns(numColumns)`	`Grid`	Die Anzahl der Spalten, die im Raster angezeigt werden sollen.
`setOnClickAction(action)`	`Grid`	Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`Grid`	Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
`setOpenLink(openLink)`	`Grid`	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
`setTitle(title)`	`Grid`	Hiermit wird der Titeltext des Rasters festgelegt.

Detaillierte Dokumentation

`addItem(gridItem)`

Dem Raster wird ein neues Rasterelement hinzugefügt.

Parameter

Name	Typ	Beschreibung
`gridItem`	`GridItem`	Das hinzuzufügende Rasterelement.

Rückflug

Grid – dieses Objekt, zur Verkettung

`setAuthorizationAction(action)`

Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. Daraufhin 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 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

Name	Typ	Beschreibung
`action`	`AuthorizationAction`	Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Grid – Dieses Objekt für die Verkettung.

`setBorderStyle(borderStyle)`

Legt den Rahmenstil fest, der auf jedes Rasterelement angewendet wird. Der Standardwert ist NO_BORDER.

Parameter

Name	Typ	Beschreibung
`borderStyle`	`BorderStyle`	Der anzuwendende Rahmenstil.

Rückflug

Grid – dieses Objekt, zur Verkettung

`setComposeAction(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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt werden.

Der Parameter Action muss eine Callback-Funktion angeben, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriertes ComposeActionResponse-Objekt zurückgibt.

Hinweis: Mit dieser Methode wird keine Compose-Aktion festgelegt, die zum Erweitern der Compose-Benutzeroberfläche verwendet wird. Stattdessen verbindet diese Methode dieses UI-Element mit einem Action, das in Apps Script Nachrichtenentwürfe verfasst, die nach Abschluss der Aktion in Gmail geöffnet werden.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  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.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Rückflug

Grid – dieses Objekt, zur Verkettung

`setNumColumns(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
`numColumns`	`Integer`	Die Anzahl der Spalten.

Rückflug

Grid – dieses Objekt, zur Verkettung

`setOnClickAction(action)`

Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur 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

Name	Typ	Beschreibung
`action`	`Action`	Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird

Rückflug

Grid – dieses Objekt, zur Verkettung

`setOnClickOpenLinkAction(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 wenn Sie neben dem Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Der Parameter Action muss eine Callback-Funktion angeben, 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

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Aktion zum Öffnen des Links angibt, die beim Klicken auf dieses Element ausgeführt werden soll.

Rückflug

Grid – dieses Objekt, zur Verkettung

`setOpenLink(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: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Parameter

Name	Typ	Beschreibung
`openLink`	`OpenLink`	Ein `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

Name	Typ	Beschreibung
`title`	`String`	Der Titeltext.

Rückflug

Grid – dieses Objekt, zur Verkettung