Class SelectionInput
Page Summary
SelectionInput is an input field for choosing from predefined options.
It supports form submission validation for DROP_DOWN and MULTI_SELECT menu types.
It is available for Google Workspace add-ons and Google Chat apps.
Methods like
addItem,addMultiSelectItem,setTitle, andsetTypeare available to customize the SelectionInput.
An input field that allows choosing between a set of predefined options.
Supports form submission validation forSelection andSelection menus only. WhenAction.setAllWidgetsAreRequired(allWidgetsAreRequired) is settotrue or this widget is specified throughAction.addRequiredWidget(requiredWidget), thesubmission action is blocked unless a value is selected.
Available for Google Workspace add-ons and Google Chat apps.
constcheckboxGroup=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'),);constradioGroup=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);constmultiSelect=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);
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Selection | Sets the data source configs for the selection control. |
add | Widget | Adds the event action that can be performed on the widget. |
add | Selection | Adds a new item that can be selected. |
add | Selection | Adds a new item that can be selected, for multi-select menus. |
set | Selection | Sets external data source, such as a relational data base. |
set | Selection | Sets the key that identifies this selection input in the event object that is generated whenthere is a UI interaction. |
set | Widget | Sets the unique ID assigned that's used to identify the widget to be mutated. |
set | Selection | Sets the maximum number of items that a user can select. |
set | Selection | Sets the number of text characters that a user inputs before the app queries autocomplete anddisplays suggested items on the card. |
set | Selection | Sets anAction to be performed whenever the selection input changes. |
set | Selection | Sets a data source from Google Workspace. |
set | Selection | Sets the title to be shown ahead of the input field. |
set | Selection | Sets the type of this input. |
set | Widget | Sets the visibility of the widget. |
Detailed documentation
addDataSourceConfig(dataSourceConfig)
Sets the data source configs for the selection control. This field provides more fine-grainedcontrol over the data source. This is an optional field.
constmultiSelect=CardService.newSelectionInput().setType(CardService.SelectionInputType.MULTI_SELECT).setFieldName('contacts').setTitle('Selected contacts').setDataSourceConfig(CardService.newDataSourceConfig().setPlatformDataSource(CardService.newPlatformDataSource().setCommonDataSource(CardService.CommonDataSource.USER,)));
Parameters
| Name | Type | Description |
|---|---|---|
data | Data | The data source configuration to be applied to the selection input. |
Return
Selection — This object, for chaining.
addEventAction(eventAction)
Adds the event action that can be performed on the widget.
Parameters
| Name | Type | Description |
|---|---|---|
event | Event | TheEvent to be added. |
Return
Widget — The Object, for chaining.
addItem(text, value, selected)
Adds a new item that can be selected.
Parameters
| Name | Type | Description |
|---|---|---|
text | Object | The text to be shown for this item. Non-string primitive arguments are converted to strings automatically. |
value | Object | The form input value that is sent via the callback. Non-string primitive arguments are converted to strings automatically. |
selected | Boolean | Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. |
Return
Selection — This object, for chaining.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)
Adds a new item that can be selected, for multi-select menus.
constmultiSelect=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',);
Parameters
| Name | Type | Description |
|---|---|---|
text | Object | The text to be shown for this item. Non-string primitive arguments are converted to strings automatically. |
value | Object | The form input value that is sent via the callback. Non-string primitive arguments are converted to strings automatically. |
selected | Boolean | Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. |
start | Object | For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. |
bottom | Object | For multiselect menus, a text description or label that's displayed below the item's text field. |
Return
Selection — This object, for chaining.
setExternalDataSource(action)
Sets external data source, such as a relational data base.
constmultiSelect=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'),);
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The external data source. |
Return
Selection — This object, for chaining.
setFieldName(fieldName)
Sets the key that identifies this selection input in the event object that is generated whenthere is a UI interaction. Not visible to the user. Required, must be unique.
Parameters
| Name | Type | Description |
|---|---|---|
field | String | The name to assign to this input. |
Return
Selection — This object, for chaining.
setId(id)
Sets the unique ID assigned that's used to identify the widget to be mutated. Widget mutationis only supported in Add-Ons.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | The id of the widget, with a limit of 64 characters and in format of `[a-zA-Z0-9-]+`. |
Return
Widget — This object, for chaining.
setMultiSelectMaxSelectedItems(maxSelectedItems)
Sets the maximum number of items that a user can select.
constmultiSelect=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',);
Parameters
| Name | Type | Description |
|---|---|---|
max | Integer | The maximum number of items. |
Return
Selection — This object, for chaining.
setMultiSelectMinQueryLength(queryLength)
Sets the number of text characters that a user inputs before the app queries autocomplete anddisplays suggested items on the card.
constmultiSelect=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',);
Parameters
| Name | Type | Description |
|---|---|---|
query | Integer | The number of text characters. |
Return
Selection — This object, for chaining.
setOnChangeAction(action)
Sets anAction to be performed whenever the selection input changes.
Parameters
| Name | Type | Description |
|---|---|---|
action | Action | The action to take. |
Return
Selection — This object, for chaining.
setPlatformDataSource(platformDataSource)
Sets a data source from Google Workspace. Used to populate items in a multiselect menu.
constmultiSelect=CardService.newSelectionInput().setType(CardService.SelectionInputType.MULTI_SELECT).setFieldName('contacts').setTitle('Selected contacts').setPlatformDataSource(CardService.newPlatformDataSource().setCommonDataSource(CardService.CommonDataSource.USER,),);
Parameters
| Name | Type | Description |
|---|---|---|
platform | Platform | The data source. |
Return
Selection — This object, for chaining.
setTitle(title)
Sets the title to be shown ahead of the input field.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | The input field title. |
Return
Selection — This object, for chaining.
setType(type)
Sets the type of this input. Defaults toCHECKBOX.
Parameters
| Name | Type | Description |
|---|---|---|
type | Selection | The selection type. |
Return
Selection — This object, for chaining.
setVisibility(visibility)
Sets the visibility of the widget. The default value is `VISIBLE`.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Visibility | TheVisibility of the widget. |
Return
Widget — The Object, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.