Page Summary
-
PlatformDataSource is used for populating items in a multiselect menu within a SelectionInput widget.
-
This feature is exclusively available for Google Chat apps and cannot be used with Google Workspace add-ons.
-
You can set the data source using
setCommonDataSourcefor Google Workspace data orsetHostAppDataSourcefor populating spaces in a multiselect menu.
For a Selection
widget that uses a multiselect menu, a data source from Google
Workspace. Used to populate items in a multiselect menu.
const platformDataSource = CardService . newPlatformDataSource (). setCommonDataSource ( CardService . CommonDataSource . USER , ); const multiSelect = CardService . newSelectionInput () . setType ( CardService . SelectionInputType . MULTI_SELECT ) . setFieldName ( 'contacts' ) . setTitle ( 'Selected contacts' ) . setMultiSelectMaxSelectedItems ( 5 ) . setMultiSelectMinQueryLength ( 1 ) . setPlatformDataSource ( platformDataSource );
Only available for Google Chat apps. Not available for Google Workspace add-ons.
Methods
| Method | Return type | Brief description |
|---|---|---|
Platform
|
Sets the data source from Google Workspace. | |
Platform
|
Sets the drive data source spec from Google Workspace. | |
Platform
|
Used to populate spaces in multiselect menu. |
Detailed documentation
set
Sets the data source from Google Workspace.
const platformDataSource = CardService . newPlatformDataSource (). setCommonDataSource ( CardService . CommonDataSource . USER , ); const multiSelect = CardService . newSelectionInput () . setType ( CardService . SelectionInputType . MULTI_SELECT ) . setFieldName ( 'contacts' ) . setTitle ( 'Selected contacts' ) . setMultiSelectMaxSelectedItems ( 5 ) . setMultiSelectMinQueryLength ( 1 ) . setPlatformDataSource ( platformDataSource );
Parameters
| Name | Type | Description |
|---|---|---|
common
|
Common
|
The data source to be set. |
Return
Platform
— This object, for chaining.
set
Sets the drive data source spec from Google Workspace.
const driveDataSourceSpec = CardService . newDriveDataSourceSpec () . addItemType ( CardService . DriveItemType . DOCUMENTS ) . addItemType ( CardService . DriveItemType . FORMS ); const platformDataSource = CardService . newPlatformDataSource (). setCommonDataSource ( CardService . CommonDataSource . DRIVE ). setDriveDataSourceSpec ( driveDataSourceSpec ); const multiSelect = CardService . newSelectionInput () . setType ( CardService . SelectionInputType . MULTI_SELECT ) . setFieldName ( 'files' ) . setTitle ( 'Drive Files' ) . setMultiSelectMaxSelectedItems ( 5 ) . setMultiSelectMinQueryLength ( 1 ) . setPlatformDataSource ( platformDataSource );
https://www.googleapis.com/auth/drive.file
) to manifest. Parameters
| Name | Type | Description |
|---|---|---|
drive
|
Drive
|
The drive data source spec to be set. |
Return
Platform
— This object, for chaining.
set
Used to populate spaces in multiselect menu.
const chatSpaceDataSource = CardService . newChatSpaceDataSource (). setDefaultToCurrentSpace ( true ); const chatClientDataSource = CardService . newChatClientDataSource (). setSpaceDataSource ( chatSpaceDataSource ); const hostAppDataSource = CardService . newHostAppDataSource (). setChatDataSource ( chatClientDataSource ); const platformDataSource = CardService . newPlatformDataSource (). setHostAppDataSource ( hostAppDataSource ); const multiSelect = CardService . newSelectionInput () . setType ( CardService . SelectionInputType . MULTI_SELECT ) . setFieldName ( 'contacts' ) . setTitle ( 'Selected contacts' ) . setMultiSelectMaxSelectedItems ( 5 ) . setMultiSelectMinQueryLength ( 1 ) . setPlatformDataSource ( platformDataSource );
Parameters
| Name | Type | Description |
|---|---|---|
host
|
Host
|
The data source to be set. |
Return
Platform
— This object, for chaining.
