Diese Seite wurde von der Cloud Translation API übersetzt.

Class Grid

Ein organisiertes Raster zur Anzeige einer Sammlung von Rasterelementen.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`addItem(gridItem)`	`Grid`	Fügt dem Raster ein neues Rasterelement hinzu.
`setAuthorizationAction(action)`	`Grid`	Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde.
`setBorderStyle(borderStyle)`	`Grid`	Legt den Rahmenstil für jedes Rasterelement fest.
`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`	Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
`setOnClickOpenLinkAction(action)`	`Grid`	Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird.
`setOpenLink(openLink)`	`Grid`	Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
`setTitle(title)`	`Grid`	Legt den Titeltext des Rasters fest.

Detaillierte Dokumentation

`addItem(gridItem)`

Fügt dem Raster ein neues Rasterelement hinzu.

Parameter

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

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setAuthorizationAction(action)`

Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. Daraufhin wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und an die 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.

// ...

var 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 dieses Element angeklickt wurde.

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setBorderStyle(borderStyle)`

Legt den Rahmenstil für jedes Rasterelement fest. Der Standardwert ist NO_BORDER.

Parameter

Name	Typ	Beschreibung
`borderStyle`	`BorderStyle`	Der Rahmenstil, der angewendet werden soll.

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setComposeAction(action, composedEmailType)`

Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur haben einen der folgenden Werte: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

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

</ph> Hinweis: Mit dieser Methode wird keine compose-Aktion festgelegt, die zum Erweitern der Benutzeroberfläche zum Schreiben. 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.

// ...

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

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parameter

Name	Typ	Beschreibung
`action`	`Action`	Das Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.
`composedEmailType`	`ComposedEmailType`	Ein Enum-Wert, der angibt, ob der zusammengestellte Entwurf ein als eigenständiger Entwurf oder als Antwortentwurf.

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setNumColumns(numColumns)`

Die Anzahl der Spalten, die im Raster angezeigt werden sollen. In der rechten Seitenleiste können Sie 1–2 Spalten und der Standardwert ist 1. In einem Dialogfeld können 2–3 Spalten und ist der Standardwert 2.

Parameter

Name	Typ	Beschreibung
`numColumns`	`Integer`	Die 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. Ein UI-Objekt kann nur eines der folgenden Elemente haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Parameter Action muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt.

// ...

var 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)`

Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn das Die URL muss erstellt werden oder wenn Sie zusätzlich zum Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Ein UI-Objekt kann nur setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Der Action-Parameter muss eine Callback-Funktion angeben, die ein ActionResponse-Objekt zurückgibt, das mit ActionResponseBuilder.setOpenLink(openLink) konfiguriert wurde.

// ...

var 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 von Links angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde.

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setOpenLink(openLink)`

Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits und muss nur geöffnet werden. Ein UI-Objekt kann nur einen der folgenden Werte haben: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt.

Parameter

Name	Typ	Beschreibung
`openLink`	`OpenLink`	Ein `OpenLink`-Objekt, das die zu öffnende URL beschreibt.

Rückflug

Grid: Dieses Objekt zur Verkettung.

`setTitle(title)`

Legt den Titeltext des Rasters fest. Der Text muss eine einfache Zeichenfolge ohne Formatierung sein.

Parameter

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

Rückflug

Grid: Dieses Objekt zur Verkettung.