Google is committed to advancing racial equity for Black communities. See how.

Class Config

Config

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

MethodReturn typeBrief description
build()ObjectValidates this object and returns it in the format needed by Data Studio.
newCheckbox()CheckboxReturns a new checkbox configuration entry.
newInfo()InfoReturns a new info configuration entry.
newOptionBuilder()OptionBuilderReturns a new options builder.
newSelectMultiple()SelectMultipleReturns a new select multiple configuration entry.
newSelectSingle()SelectSingleReturns a new select single configuration entry.
newTextArea()TextAreaReturns a new text area configuration entry.
newTextInput()TextInputReturns a new text input configuration entry.
printJson()StringPrints the JSON representation of this object.
setDateRangeRequired(dateRangeRequired)ConfigIf true, a date range is provided for getData() requests.
setIsSteppedConfig(isSteppedConfig)ConfigIf 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()

Returns a new checkbox configuration entry.

Return

Checkbox — A new checkbox configuration entry.


newInfo()

Returns a new info configuration entry.

Return

Info — A new info configuration entry.


newOptionBuilder()

Returns a new options builder.

Return

OptionBuilder — A new options builder.


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()

Returns a new text area configuration entry.

Return

TextArea — A new text area configuration entry.


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

NameTypeDescription
dateRangeRequiredBooleanWhether 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

NameTypeDescription
isSteppedConfigBooleanThe stepped config status to set.

Return

Config — This builder, for chaining.