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
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Widget | Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie. |
add | Grid | Dodaje do siatki nowy element. |
set | Grid | Ustawia działanie autoryzacji, które otwiera adres URL do procedury autoryzacji po kliknięciu obiektu. |
set | Grid | Ustawia styl obramowania stosowany do każdego elementu siatki. |
set | Grid | Ustawia działanie, które tworzy wersję roboczą e-maila po kliknięciu obiektu. |
set | Widget | Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. |
set | Grid | Liczba kolumn do wyświetlenia w siatce. |
set | Grid | Ustawia działanie, które jest wykonywane po kliknięciu obiektu. |
set | Grid | Ustawia działanie, które otwiera URL w karcie po kliknięciu obiektu. |
set | Grid | Ustawia adres URL, który ma się otworzyć po kliknięciu obiektu. |
set | Grid | Ustawia tekst tytułu siatki. |
set | Widget | Ustawia widoczność widżetu. |
Szczegółowa dokumentacja
add Event Action(eventAction)
Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
event | Event | Event do dodania. |
Powrót
Widget – obiekt do łączenia.
add Item(gridItem)
set Authorization Action(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: set, set, set, set lub set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
action | Authorization | Obiekt określający działanie autoryzacji, które ma zostać wykonane po kliknięciu tego elementu. |
Powrót
Grid – ten obiekt do łączenia.
set Border Style(borderStyle)
Ustawia styl obramowania stosowany do każdego elementu siatki. Wartość domyślna to NO_BORDER.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
border | Border | Styl obramowania do zastosowania. |
Powrót
Grid – ten obiekt do łączenia.
set Compose Action(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: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Compose skonfigurowany za pomocą Compose.
// ... 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
| Nazwa | Typ | Opis |
|---|---|---|
action | Action | Obiekt określający działanie tworzenia, które ma zostać wykonane po kliknięciu tego elementu. |
composed | Composed | Wartość wyliczeniowa określająca, czy utworzony projekt jest projektem samodzielnym czy projektem odpowiedzi. |
Powrót
Grid – ten obiekt do łączenia.
set Id(id)
Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. Modyfikacja widżetu jest obsługiwana tylko w dodatkach.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
id | String | Identyfikator 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.
set Num Columns(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
| Nazwa | Typ | Opis |
|---|---|---|
num | Integer | Liczba kolumn. |
Powrót
Grid – ten obiekt do łączenia.
set On Click Action(action)
Ustawia działanie, które jest wykonywane po kliknięciu obiektu. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Action.
// ... 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
| Nazwa | Typ | Opis |
|---|---|---|
action | Action | Działanie, które należy wykonać po kliknięciu tego elementu. |
Powrót
Grid – ten obiekt do łączenia.
set On Click Open Link Action(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 Open musisz wykonać inne działania. Obiekt interfejsu może mieć ustawioną tylko jedną z tych wartości: set, set, set, set lub set.
Parametr Action musi określać funkcję wywołania zwrotnego, która zwraca obiekt Action skonfigurowany za pomocą Action.
// ... 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
| Nazwa | Typ | Opis |
|---|---|---|
action | Action | Obiekt określający działanie otwierania linku, które ma zostać wykonane po kliknięciu tego elementu. |
Powrót
Grid – ten obiekt do łączenia.
set Open Link(openLink)
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: set, set, set, set lub set.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
open | Open | Obiekt Open opisujący adres URL do otwarcia. |
Powrót
Grid – ten obiekt do łączenia.
set Title(title)
Ustawia tekst tytułu siatki. Tekst musi być zwykłym ciągiem znaków bez formatowania.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
title | String | Tekst tytułu. |
Powrót
Grid – ten obiekt do łączenia.
set Visibility(visibility)
Ustawia widoczność widżetu. Wartością domyślną jest „VISIBLE”.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
visibility | Visibility | Visibility widżetu. |
Powrót
Widget – obiekt do łączenia.