Pole do wprowadzania danych, które umożliwia wybór spośród określonych opcji.
Obsługuje sprawdzanie poprawności przesłania formularza tylko w przypadku menu Selection i Selection. Gdy parametr Action.setAllWidgetsAreRequired(allWidgetsAreRequired) ma wartość true lub ten widżet jest określony za pomocą parametru Action.addRequiredWidget(requiredWidget), działanie przesyłania jest blokowane, chyba że zostanie wybrana wartość.
Dostępne w przypadku dodatków do Google Workspace i aplikacji do Google Chat.
const checkboxGroup = CardService.newSelectionInput() .setType(CardService.SelectionInputType.CHECK_BOX) .setTitle('A group of checkboxes. Multiple selections are allowed.') .setFieldName('checkbox_field') .addItem('checkbox one title', 'checkbox_one_value', false) .addItem('checkbox two title', 'checkbox_two_value', true) .addItem('checkbox three title', 'checkbox_three_value', true) .setOnChangeAction( CardService.newAction().setFunctionName('handleCheckboxChange'), ); const radioGroup = CardService.newSelectionInput() .setType(CardService.SelectionInputType.RADIO_BUTTON) .setTitle( 'A group of radio buttons. Only a single selection is allowed.') .setFieldName('checkbox_field') .addItem('radio button one title', 'radio_one_value', true) .addItem('radio button two title', 'radio_two_value', false) .addItem('radio button three title', 'radio_three_value', false); const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('multiselect') .setTitle('A multi select input example.') .addMultiSelectItem( 'Contact 1', 'contact-1', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact one description', ) .addMultiSelectItem( 'Contact 2', 'contact-2', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact two description', ) .addMultiSelectItem( 'Contact 3', 'contact-3', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact three description', ) .addMultiSelectItem( 'Contact 4', 'contact-4', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact four description', ) .addMultiSelectItem( 'Contact 5', 'contact-5', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact five description', ) .setMultiSelectMaxSelectedItems(3) .setMultiSelectMinQueryLength(1);
Metody
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Selection | Ustawia konfiguracje źródła danych dla kontrolki wyboru. |
add | Widget | Dodaje działanie związane z wydarzeniem, które można wykonać w widżecie. |
add | Selection | Dodaje nowy element, który można wybrać. |
add | Selection | Dodaje nowy element, który można wybrać w menu wielokrotnego wyboru. |
set | Selection | Ustawia zewnętrzne źródło danych, np. relacyjną bazę danych. |
set | Selection | Ustawia klucz, który identyfikuje to pole wyboru w obiekcie zdarzenia generowanym podczas interakcji z interfejsem. |
set | Widget | Ustawia unikalny identyfikator przypisany do widżetu, który ma zostać zmieniony. |
set | Selection | Określa maksymalną liczbę elementów, które użytkownik może wybrać. |
set | Selection | Określa liczbę znaków tekstowych, które użytkownik musi wpisać, zanim aplikacja wyśle zapytanie do autouzupełniania i wyświetli sugerowane elementy na karcie. |
set | Selection | Ustawia Action, które ma być wykonywane za każdym razem, gdy zmieni się dane wejściowe wyboru. |
set | Selection | Ustawia źródło danych z Google Workspace. |
set | Selection | Ustawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych. |
set | Selection | Ustawia typ tego wejścia. |
set | Widget | Ustawia widoczność widżetu. |
Szczegółowa dokumentacja
add Data Source Config(dataSourceConfig)
Ustawia konfiguracje źródła danych dla kontrolki wyboru. To pole zapewnia bardziej szczegółową kontrolę nad źródłem danych. To pole jest opcjonalne.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('contacts') .setTitle('Selected contacts') .setDataSourceConfig( CardService.newDataSourceConfig().setPlatformDataSource( CardService.newPlatformDataSource().setCommonDataSource( CardService.CommonDataSource.USER, ) ) );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
data | Data | Konfiguracja źródła danych, która ma zostać zastosowana do danych wejściowych wyboru. |
Powrót
Selection – ten obiekt do łączenia.
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(text, value, selected)
Dodaje nowy element, który można wybrać.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | Object | Tekst, który ma być wyświetlany w przypadku tego elementu. Argumenty pierwotne, które nie są ciągami znaków, są automatycznie konwertowane na ciągi znaków. |
value | Object | Wartość wprowadzona w formularzu, która jest wysyłana za pomocą wywołania zwrotnego. Argumenty pierwotne inne niż ciągi znaków są automatycznie konwertowane na ciągi znaków. |
selected | Boolean | Czy element jest domyślnie wybrany. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu. |
Powrót
Selection – ten obiekt do łączenia.
add Multi Select Item(text, value, selected, startIconUri, bottomText)
Dodaje nowy element, który można wybrać w menu wielokrotnego wyboru.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('multiselect') .setTitle('A multi select input example.') .addMultiSelectItem( 'Contact 1', 'contact-1', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact one description', ) .addMultiSelectItem( 'Contact 2', 'contact-2', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact two description', ) .addMultiSelectItem( 'Contact 3', 'contact-3', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact three description', ) .addMultiSelectItem( 'Contact 4', 'contact-4', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact four description', ) .addMultiSelectItem( 'Contact 5', 'contact-5', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact five description', );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | Object | Tekst, który ma być wyświetlany w przypadku tego elementu. Argumenty pierwotne, które nie są ciągami znaków, są automatycznie konwertowane na ciągi znaków. |
value | Object | Wartość wprowadzona w formularzu, która jest wysyłana za pomocą wywołania zwrotnego. Argumenty pierwotne inne niż ciągi znaków są automatycznie konwertowane na ciągi znaków. |
selected | Boolean | Czy element jest domyślnie wybrany. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu. |
start | Object | W przypadku menu wielokrotnego wyboru adres URL ikony wyświetlanej obok pola tekstowego elementu. Obsługuje pliki PNG i JPEG. |
bottom | Object | W przypadku menu wielokrotnego wyboru jest to opis tekstowy lub etykieta wyświetlana pod polem tekstowym elementu. |
Powrót
Selection – ten obiekt do łączenia.
set External Data Source(action)
Ustawia zewnętrzne źródło danych, np. relacyjną bazę danych.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('contacts') .setTitle('Selected contacts') .addMultiSelectItem( 'Contact 3', 'contact-3', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact three description', ) .setMultiSelectMaxSelectedItems(5) .setMultiSelectMinQueryLength(2) .setExternalDataSource( CardService.newAction().setFunctionName('getContacts'), );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
action | Action | Zewnętrzne źródło danych. |
Powrót
Selection – ten obiekt do łączenia.
set Field Name(fieldName)
Ustawia klucz, który identyfikuje to pole wyboru w obiekcie zdarzenia generowanym podczas interakcji z interfejsem. Niewidoczny dla użytkownika. Wymagany, musi być unikalny.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
field | String | Nazwa, którą chcesz przypisać do tego wejścia. |
Powrót
Selection – 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 Multi Select Max Selected Items(maxSelectedItems)
Określa maksymalną liczbę elementów, które użytkownik może wybrać.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('multiselect') .setTitle('A multi select input example.') .setMultiSelectMaxSelectedItems(3) .addMultiSelectItem( 'Contact 1', 'contact-1', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact one description', ) .addMultiSelectItem( 'Contact 2', 'contact-2', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact two description', ) .addMultiSelectItem( 'Contact 3', 'contact-3', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact three description', ) .addMultiSelectItem( 'Contact 4', 'contact-4', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact four description', ) .addMultiSelectItem( 'Contact 5', 'contact-5', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact five description', );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
max | Integer | Maksymalna liczba elementów. |
Powrót
Selection – ten obiekt do łączenia.
set Multi Select Min Query Length(queryLength)
Określa liczbę znaków tekstowych, które użytkownik musi wpisać, zanim aplikacja wyśle zapytanie do autouzupełniania i wyświetli sugerowane elementy na karcie.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('multiselect') .setTitle('A multi select input example.') .setMultiSelectMinQueryLength(1) .addMultiSelectItem( 'Contact 1', 'contact-1', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact one description', ) .addMultiSelectItem( 'Contact 2', 'contact-2', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact two description', ) .addMultiSelectItem( 'Contact 3', 'contact-3', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact three description', ) .addMultiSelectItem( 'Contact 4', 'contact-4', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact four description', ) .addMultiSelectItem( 'Contact 5', 'contact-5', false, 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png', 'Contact five description', );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
query | Integer | Liczba znaków tekstowych. |
Powrót
Selection – ten obiekt do łączenia.
set On Change Action(action)
Ustawia Action, które ma być wykonywane za każdym razem, gdy zmieni się dane wejściowe wyboru.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
action | Action | Działanie do wykonania. |
Powrót
Selection – ten obiekt do łączenia.
set Platform Data Source(platformDataSource)
Ustawia źródło danych z Google Workspace. Służy do wypełniania pozycji w menu wielokrotnego wyboru.
const multiSelect = CardService.newSelectionInput() .setType(CardService.SelectionInputType.MULTI_SELECT) .setFieldName('contacts') .setTitle('Selected contacts') .setPlatformDataSource( CardService.newPlatformDataSource().setCommonDataSource( CardService.CommonDataSource.USER, ), );
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
platform | Platform | Źródło danych. |
Powrót
Selection – ten obiekt do łączenia.
set Title(title)
Ustawia tytuł, który ma być wyświetlany przed polem do wprowadzania danych.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
title | String | Tytuł pola do wprowadzania danych. |
Powrót
Selection – ten obiekt do łączenia.
set Type(type)
Ustawia typ tego wejścia. Domyślna wartość to CHECKBOX.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
type | Selection | Typ wyboru. |
Powrót
Selection – 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.