Data Studio Service

Data Studio

This service allows scripts to access and modify Data Studio Community Connectors.

Classes

NameBrief description
AggregationTypeAn enum that defines the aggregation types that can be set for a Field.
CheckboxContains checkbox information for the config.
CommunityConnectorCommunityConnector enables scripts to access builders and utilities to help with development of Community Connectors for Data Studio.
ConfigContains the configuration entries for a connector.
DataStudioAppDataStudioApp allows scripts to interact with developer-oriented features for Data Studio.
FieldContains field-related data.
FieldTypeAn enum that defines the types that can be set for a Field.
FieldsContains a set of Fields for a community connector.
InfoContains info data for the config.
OptionBuilderA builder for creating options for SelectSingles and SelectMultiples.
SelectMultipleContains select multiple information for the config.
SelectSingleContains select single information for the config.
TextAreaContains text area information for the config.
TextInputContains text input information for the config.

AggregationType

Properties

PropertyTypeDescription
NO_AGGREGATIONEnumNo aggregation.
AVGEnumAverage.
COUNTEnumCount.
COUNT_DISTINCTEnumCount Distinct.
MAXEnumMax.
MINEnumMin.
SUMEnumSum.

Checkbox

Methods

MethodReturn typeBrief description
setAllowOverride(allowOverride)CheckboxEnables overriding for this config entry.
setHelpText(helpText)CheckboxSets the help text for this configuration entry.
setId(id)CheckboxSets the unique ID for this configuration entry.
setName(name)CheckboxSets the display name for this configuration entry.

CommunityConnector

Properties

PropertyTypeDescription
AggregationTypeAggregationTypeThe AggregationType enumeration.
FieldTypeFieldTypeThe FieldType enumeration.

Methods

MethodReturn typeBrief description
getConfig()ConfigReturns a Config object.
getFields()FieldsReturns a Fields object.

Config

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.

DataStudioApp

Methods

MethodReturn typeBrief description
createCommunityConnector()CommunityConnectorCreates a new Community Connector.

Field

Methods

MethodReturn typeBrief description
getAggregation()AggregationTypeReturns the AggregationType of this Field.
getDescription()StringReturns the description of this Field.
getFormula()StringReturns the formula of this Field.
getGroup()StringReturns the group of this Field.
getId()StringReturns the ID of this Field.
getName()StringReturns the name of this Field.
getType()FieldTypeReturns the FieldType of this Field.
isDefault()BooleanReturns true if this Field is the default metric or dimension.
isDimension()BooleanReturns true if this field is a dimension.
isHidden()BooleanReturns true if this Field is hidden.
isMetric()BooleanReturns true if this field is a metric.
setAggregation(aggregation)FieldSets the aggregation type of this Field.
setDescription(description)FieldSets the description of this Field.
setFormula(formula)FieldSets the formula of this Field.
setGroup(group)FieldSets the group of this Field.
setId(id)FieldSets the ID of this Field.
setIsHidden(isHidden)FieldSets the hidden status of this Field.
setName(name)FieldSets the name of this Field.
setType(type)FieldSets the FieldType of this Field.

FieldType

Properties

PropertyTypeDescription
YEAREnumYear in the format of YYYY such as 2017.
YEAR_QUARTEREnumYear and quarter in the format of YYYYQ such as 20171.
YEAR_MONTHEnumYear and month in the format of YYYYMM such as 201703.
YEAR_WEEKEnumYear and week in the format of YYYYww such as 201707.
YEAR_MONTH_DAYEnumYear, month, and day in the format of YYYYMMDD such as 20170317.
YEAR_MONTH_DAY_HOUREnumYear, month, day, and hour in the format of YYYYMMDDHH such as 2017031703.
QUARTEREnumQuarter in the format of 1, 2, 3, or 4).
MONTHEnumMonth in the format of MM such as 03.
WEEKEnumWeek in the format of ww such as 07.
MONTH_DAYEnumMonth and day in the format of MMDD such as 0317.
DAY_OF_WEEKEnumA number in the range of [0,6] with 0 representing Sunday.
DAYEnumDay in the format of DD such as 17.
HOUREnumHour in the format of HH such as 13.
MINUTEEnumMinute in the format of mm such as 12.
DURATIONEnumA duration of time in seconds.
COUNTRYEnumA country such as United States.
COUNTRY_CODEEnumA country code such as US.
CONTINENTEnumA continent such as Americas.
CONTINENT_CODEEnumA continent code such as 019.
SUB_CONTINENTEnumA sub-continent such as North America.
SUB_CONTINENT_CODEEnumA sub-continent code such as 003.
REGIONEnumA region such as California.
REGION_CODEEnumA region code such as CA.
CITYEnumA city such as Mountain View.
CITY_CODEEnumA city code such as 1014044.
METROEnumA metro such as San Francisco-Oakland-San Jose CA.
METRO_CODEEnumA metro code such as 200807.
LATITUDE_LONGITUDEEnumA latitude longitude pair such as 51.5074, -0.1278.
NUMBEREnumA decimal number.
PERCENTEnumDecimal percentage (can be over 1.0).
TEXTEnumFree-form text.
BOOLEANEnumA true or false boolean value.
URLEnumA URL as text such as https://google.com.
CURRENCY_AEDEnumCurrency from AED.
CURRENCY_ALLEnumCurrency from ALL.
CURRENCY_ARSEnumCurrency from ARS.
CURRENCY_AUDEnumCurrency from AUD.
CURRENCY_BDTEnumCurrency from BDT.
CURRENCY_BGNEnumCurrency from BGN.
CURRENCY_BOBEnumCurrency from BOB.
CURRENCY_BRLEnumCurrency from BRL.
CURRENCY_CADEnumCurrency from CAD.
CURRENCY_CDFEnumCurrency from CDF.
CURRENCY_CHFEnumCurrency from CHF.
CURRENCY_CLPEnumCurrency from CLP.
CURRENCY_CNYEnumCurrency from CNY.
CURRENCY_COPEnumCurrency from COP.
CURRENCY_CRCEnumCurrency from CRC.
CURRENCY_CZKEnumCurrency from CZK.
CURRENCY_DKKEnumCurrency from DKK.
CURRENCY_DOPEnumCurrency from DOP.
CURRENCY_EGPEnumCurrency from EGP.
CURRENCY_ETBEnumCurrency from ETB.
CURRENCY_EUREnumCurrency from EUR.
CURRENCY_GBPEnumCurrency from GBP.
CURRENCY_HKDEnumCurrency from HKD.
CURRENCY_HRKEnumCurrency from HRK.
CURRENCY_HUFEnumCurrency from HUF.
CURRENCY_IDREnumCurrency from IDR.
CURRENCY_ILSEnumCurrency from ILS.
CURRENCY_INREnumCurrency from INR.
CURRENCY_IRREnumCurrency from IRR.
CURRENCY_ISKEnumCurrency from ISK.
CURRENCY_JMDEnumCurrency from JMD.
CURRENCY_JPYEnumCurrency from JPY.
CURRENCY_KRWEnumCurrency from KRW.
CURRENCY_LKREnumCurrency from LKR.
CURRENCY_LTLEnumCurrency from LTL.
CURRENCY_MNTEnumCurrency from MNT.
CURRENCY_MVREnumCurrency from MVR.
CURRENCY_MXNEnumCurrency from MXN.
CURRENCY_MYREnumCurrency from MYR.
CURRENCY_NOKEnumCurrency from NOK.
CURRENCY_NZDEnumCurrency from NZD.
CURRENCY_PABEnumCurrency from PAB.
CURRENCY_PENEnumCurrency from PEN.
CURRENCY_PHPEnumCurrency from PHP.
CURRENCY_PKREnumCurrency from PKR.
CURRENCY_PLNEnumCurrency from PLN.
CURRENCY_RONEnumCurrency from RON.
CURRENCY_RSDEnumCurrency from RSD.
CURRENCY_RUBEnumCurrency from RUB.
CURRENCY_SAREnumCurrency from SAR.
CURRENCY_SEKEnumCurrency from SEK.
CURRENCY_SGDEnumCurrency from SGD.
CURRENCY_THBEnumCurrency from THB.
CURRENCY_TRYEnumCurrency from TRY.
CURRENCY_TWDEnumCurrency from TWD.
CURRENCY_TZSEnumCurrency from TZS.
CURRENCY_UAHEnumCurrency from UAH.
CURRENCY_USDEnumCurrency from USD.
CURRENCY_UYUEnumCurrency from UYU.
CURRENCY_VEFEnumCurrency from VEF.
CURRENCY_VNDEnumCurrency from VND.
CURRENCY_YEREnumCurrency from YER.
CURRENCY_ZAREnumCurrency from ZAR.

Fields

Methods

MethodReturn typeBrief description
asArray()Field[]Returns a view of this object as an array.
build()Object[]Validates this object and returns it in the format needed by Data Studio.
forIds(ids)FieldsReturns a new Fields object filtered to Fields with an ID in ids.
getDefaultDimension()FieldReturns the default dimension to be used for the set of fields.
getDefaultMetric()FieldReturns the default metric to be used for the set of fields.
getFieldById(fieldId)FieldReturns a field with a given ID, or null if no field with that ID is in this Fields object.
newDimension()FieldReturns a new dimension Field.
newMetric()FieldReturns a new metric Field.
setDefaultDimension(fieldId)voidSets the default dimension to be used for the set of fields.
setDefaultMetric(fieldId)voidSets the default metric to be used for the set of fields.

Info

Methods

MethodReturn typeBrief description
setId(id)InfoSets the unique ID for this configuration entry.
setText(text)InfoSets the text for this configuration entry.

OptionBuilder

Methods

MethodReturn typeBrief description
setLabel(label)OptionBuilderSets the label of this option builder.
setValue(value)OptionBuilderSets the value of this option builder.

SelectMultiple

Methods

MethodReturn typeBrief description
addOption(optionBuilder)SelectMultipleAdds a new select option.
setAllowOverride(allowOverride)SelectMultipleEnables overriding for this config entry.
setHelpText(helpText)SelectMultipleSets the help text for this configuration entry.
setId(id)SelectMultipleSets the unique ID for this configuration entry.
setName(name)SelectMultipleSets the display name for this configuration entry.

SelectSingle

Methods

MethodReturn typeBrief description
addOption(optionBuilder)SelectSingleAdds a new select option.
setAllowOverride(allowOverride)SelectSingleEnables overriding for this config entry.
setHelpText(helpText)SelectSingleSets the help text for this configuration entry.
setId(id)SelectSingleSets the unique ID for this configuration entry.
setName(name)SelectSingleSets the display name for this configuration entry.

TextArea

Methods

MethodReturn typeBrief description
setAllowOverride(allowOverride)TextAreaEnables overriding for this config entry.
setHelpText(helpText)TextAreaSets the help text for this configuration entry.
setId(id)TextAreaSets the unique ID for this configuration entry.
setName(name)TextAreaSets the display name for this configuration entry.
setPlaceholder(placeholder)TextAreaSets the placeholder text for this configuration entry.

TextInput

Methods

MethodReturn typeBrief description
setAllowOverride(allowOverride)TextInputEnables overriding for this config entry.
setHelpText(helpText)TextInputSets the help text for this configuration entry.
setId(id)TextInputSets the unique ID for this configuration entry.
setName(name)TextInputSets the display name for this configuration entry.
setPlaceholder(placeholder)TextInputSets the placeholder text for this configuration entry.

Send feedback about...

Apps Script
Apps Script
Need help? Visit our support page.