Class Grid

Siatka

uporządkowana siatka do wyświetlania kolekcji elementów siatki;

Dostępne w przypadku dodatków do Google Workspace i aplikacji Google Chat.

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

Metody

MetodaZwracany typKrótki opis
addItem(gridItem)GridDodaje nowy element siatki do siatki.
setAuthorizationAction(action)GridUstawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu.
setBorderStyle(borderStyle)GridUstawia styl obramowania stosowany do każdego elementu siatki.
setComposeAction(action, composedEmailType)GridPo kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila.
setNumColumns(numColumns)GridLiczba kolumn wyświetlanych w siatce.
setOnClickAction(action)GridOkreśla działanie, które jest wykonywane po kliknięciu obiektu.
setOnClickOpenLinkAction(action)GridUstawia działanie, które otwiera URL w karcie po kliknięciu obiektu.
setOpenLink(openLink)GridUstawia adres URL, który zostanie otwarty po kliknięciu obiektu.
setTitle(title)GridUstawia tekst tytułu siatki.

Szczegółowa dokumentacja

addItem(gridItem)

Dodaje nowy element siatki do siatki.

Parametry

NazwaTypOpis
gridItemGridItemElement siatki do dodania.

Powrót

Grid – ten obiekt do łańcucha.


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera URL do procesu autoryzacji po kliknięciu obiektu. Spowoduje to otwarcie adresu URL w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, wtyczka zostanie ponownie załadowana.

Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametry

NazwaTypOpis
actionAuthorizationActionObiekt określający działanie autoryzacyjne, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łańcucha.


setBorderStyle(borderStyle)

Ustawia styl obramowania stosowany do każdego elementu siatki. Wartość domyślna to NO_BORDER.

Parametry

NazwaTypOpis
borderStyleBorderStyleStyl obramowania do zastosowania.

Powrót

Grid – ten obiekt do łańcucha.


setComposeAction(action, composedEmailType)

Po kliknięciu obiektu ustawia działanie, które tworzy wersję roboczą e-maila. Obiekt interfejsu może mieć tylko jedną z tych przeglądarek: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ComposeActionResponse skonfigurowany za pomocą ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

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();
}

Parametry

NazwaTypOpis
actionActionObiekt określający działanie, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość typu enumeracji określająca, czy skomponowany projekt jest samodzielny czy jest odpowiedzią na inny projekt.

Powrót

Grid – ten obiekt do łańcucha.


setNumColumns(numColumns)

Liczba kolumn wyświetlanych w siatce. Jeśli panel boczny jest widoczny po prawej stronie, możesz wyświetlić 1–2 kolumny. Wartość domyślna to 1. Jeśli w oknie dialogowym, możesz wyświetlić 2–3 kolumny, a wartością domyślną jest 2.

Parametry

NazwaTypOpis
numColumnsIntegerLiczba kolumn.

Powrót

Grid – ten obiekt do łańcucha.


setOnClickAction(action)

Określa działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse.

// ...

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();
}

Parametry

NazwaTypOpis
actionActionDziałanie, które ma być wykonywane po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łańcucha.


setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. Użyj tej funkcji, gdy musisz utworzyć adres URL lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne czynności. Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt ActionResponse skonfigurowany za pomocą ActionResponseBuilder.setOpenLink(openLink).

// ...

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();
}

Parametry

NazwaTypOpis
actionActionObiekt określający działanie polegające na otwarciu linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łańcucha.


Ustawia adres URL, który zostanie otwarty po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i trzeba go tylko otworzyć. Obiekt interfejsu może mieć tylko jeden z tych parametrów: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) lub setComposeAction(action, composedEmailType).

Parametry

NazwaTypOpis
openLinkOpenLinkObiekt OpenLink opisujący adres URL do otwarcia.

Powrót

Grid – ten obiekt do łańcucha.


setTitle(title)

Ustawia tekst tytułu siatki. Tekst musi być zwykłym ciągiem znaków bez formatowania.

Parametry

NazwaTypOpis
titleStringTekst tytułu.

Powrót

Grid – ten obiekt do łańcucha.