Class Config
Page Summary
Config contains the configuration entries for a connector, defining the questions asked when adding a new connector.
The
build()method validates the Config object and returns it in the format needed by Data Studio.Config offers methods to create various configuration entry types like checkbox, info, select multiple, select single, text area, and text input.
Methods like
setDateRangeRequired()andsetIsSteppedConfig()allow for setting specific behaviors for the connector configuration.
Contains the configuration entries for a connector. These configuration entries define whatquestions are asked when adding a new connector.
constcc=DataStudioApp.createCommunityConnector();constconfig=cc.getConfig();constinfo_entry=config.newInfo().setId('info_id').setHelpText('This connector can connect to multiple data endpoints.');
Methods
| Method | Return type | Brief description |
|---|---|---|
build() | Object | Validates this object and returns it in the format needed by Data Studio. |
new | Checkbox | Returns a new checkbox configuration entry. |
new | Info | Returns a new info configuration entry. |
new | Option | Returns a new options builder. |
new | Select | Returns a new select multiple configuration entry. |
new | Select | Returns a new select single configuration entry. |
new | Text | Returns a new text area configuration entry. |
new | Text | Returns a new text input configuration entry. |
print | String | Prints the JSON representation of this object. |
set | Config | Iftrue, a date range is provided for getData() requests. |
set | Config | Iftrue,get is called again with the current user configuration. |
Detailed documentation
build()
Validates this object and returns it in the format needed by Data Studio.
Return
Object — The validatedConfig object.
newCheckbox()
newInfo()
newOptionBuilder()
newSelectMultiple()
Returns a new select multiple configuration entry.
Return
Select — A new select multiple configuration entry.
newSelectSingle()
Returns a new select single configuration entry.
Return
Select — A new select single configuration entry.
newTextArea()
newTextInput()
Returns a new text input configuration entry.
Return
Text — A new text input configuration entry.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setDateRangeRequired(dateRangeRequired)
Iftrue, a date range is provided for getData() requests.
Parameters
| Name | Type | Description |
|---|---|---|
date | Boolean | Whether or not a date range should be provided toget requests. |
Return
Config — This builder, for chaining.
setIsSteppedConfig(isSteppedConfig)
Iftrue,get is called again with the current user configuration.
Parameters
| Name | Type | Description |
|---|---|---|
is | Boolean | The stepped config status to set. |
Return
Config — This builder, 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-11 UTC.