Class Grid

Siatka

Uporządkowana siatka do wyświetlania kolekcji elementów siatki.

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

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

Metody

MetodaZwracany typKrótki opis
addEventAction(eventAction)WidgetDodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
addItem(gridItem)GridDodaje do siatki nowy element.
setAuthorizationAction(action)GridUstawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu.
setBorderStyle(borderStyle)GridUstawia styl obramowania stosowany do każdego elementu siatki.
setComposeAction(action, composedEmailType)GridUstawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu.
setId(id)WidgetUstawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony.
setNumColumns(numColumns)GridLiczba kolumn do wyświetlenia w siatce.
setOnClickAction(action)GridUstawia 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 ma się otworzyć po kliknięciu obiektu.
setTitle(title)GridUstawia tekst tytułu siatki.
setVisibility(visibility)WidgetUstawia widoczność widżetu.

Szczegółowa dokumentacja

addEventAction(eventAction)

Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.

Parametry

NazwaTypOpis
eventActionEventActionEventAction do dodania.

Powrót

Widget – obiekt do łączenia.


addItem(gridItem)

Dodaje do siatki nowy element.

Parametry

NazwaTypOpis
gridItemGridItemElement siatki do dodania.

Powrót

Grid – ten obiekt do łączenia.


setAuthorizationAction(action)

Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. URL otworzy się w nowym oknie. Gdy użytkownik zakończy proces autoryzacji i wróci do aplikacji, dodatek zostanie ponownie załadowany.

Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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 autoryzacji, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łączenia.


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 łączenia.


setComposeAction(action, composedEmailType)

Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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 tworzenia, które ma zostać wykonane po kliknięciu tego elementu.
composedEmailTypeComposedEmailTypeWartość wyliczeniowa określająca, czy utworzony projekt jest projektem samodzielnym czy projektem odpowiedzi.

Powrót

Grid – ten obiekt do łączenia.


setId(id)

Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. Modyfikacja widżetu jest obsługiwana tylko w dodatkach.

Parametry

NazwaTypOpis
idStringIdentyfikator widżetu, który może mieć maksymalnie 64 znaki i musi być zgodny z formatem `[a-zA-Z0-9-]+`.

Powrót

Widget – ten obiekt do łączenia.


setNumColumns(numColumns)

Liczba kolumn do wyświetlenia w siatce. Jeśli jest wyświetlana w panelu po prawej stronie, możesz wyświetlić 1–2 kolumny. Wartość domyślna to 1. Jeśli jest wyświetlana w oknie, możesz wyświetlić 2–3 kolumny, a wartość domyślna to 2.

Parametry

NazwaTypOpis
numColumnsIntegerLiczba kolumn.

Powrót

Grid – ten obiekt do łączenia.


setOnClickAction(action)

Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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 należy wykonać po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łączenia.


setOnClickOpenLinkAction(action)

Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL musi zostać utworzony lub gdy oprócz utworzenia obiektu OpenLink musisz wykonać inne działania. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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 otwierania linku, które ma zostać wykonane po kliknięciu tego elementu.

Powrót

Grid – ten obiekt do łączenia.


Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. Użyj tej funkcji, gdy adres URL jest już znany i wystarczy go otworzyć. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: 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 łączenia.


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 łączenia.


setVisibility(visibility)

Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.

Parametry

NazwaTypOpis
visibilityVisibilityVisibility widżetu.

Powrót

Widget – obiekt do łączenia.