Contains the configuration entries for a connector. These configuration entries define what questions are asked when adding a new connector.
var cc = DataStudioApp.createCommunityConnector(); var config = cc.getConfig(); var info_entry = config.newInfo() .setId("info_id") .setHelpText("This connector can connect to multiple data endpoints.");
Methods
Method | Return type | Brief description |
---|---|---|
Object
|
Validates this object and returns it in the format needed by Data Studio. | |
Checkbox
|
Returns a new checkbox configuration entry. | |
Info
|
Returns a new info configuration entry. | |
OptionBuilder
|
Returns a new options builder. | |
SelectMultiple
|
Returns a new select multiple configuration entry. | |
SelectSingle
|
Returns a new select single configuration entry. | |
TextArea
|
Returns a new text area configuration entry. | |
TextInput
|
Returns a new text input configuration entry. | |
String
|
Prints the JSON representation of this object. | |
Config
|
If true
, a date range is provided for getData() requests. |
|
Config
|
If true
, getConfig()
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 validated Config
object.
newCheckbox()
newInfo()
newOptionBuilder()
newSelectMultiple()
Returns a new select multiple configuration entry.
Return
SelectMultiple
— A new select multiple configuration entry.
newSelectSingle()
Returns a new select single configuration entry.
Return
SelectSingle
— A new select single configuration entry.
newTextArea()
newTextInput()
Returns a new text input configuration entry.
Return
TextInput
— A new text input configuration entry.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setDateRangeRequired(dateRangeRequired)
If true
, a date range is provided for getData() requests.
Parameters
Name | Type | Description |
---|---|---|
dateRangeRequired
|
Boolean
|
Whether or not a date range should be provided to getData()
requests. |
Return
Config
— This builder, for chaining.
setIsSteppedConfig(isSteppedConfig)
If true
, getConfig()
is called again with the current user configuration.
Parameters
Name | Type | Description |
---|---|---|
isSteppedConfig
|
Boolean
|
The stepped config status to set. |
Return
Config
— This builder, for chaining.