Class GetDataResponse

GetDataResponse

Builder to create a getData() response for your script project. 

functiongetFields(){//...}functiongetData(){constcc=DataStudioApp.createCommunityConnector();returncc.newGetDataResponse().setFields(getFields()).addRow(['3','Foobar.com']).addRow(['4','Foobaz.com']).addRows([['5','Fizzbuz.com'],['6','Fizzbaz.com'],]).build();}

Methods

MethodReturn typeBrief description
addAllRows(rows)GetDataResponseAdds multiple rows of data to this GetDataResponse.
addRow(row)GetDataResponseAdds a row of data to this GetDataResponse.
build()ObjectValidates this object and returns it in the format needed by Data Studio.
setFields(fields)GetDataResponseSets the Fields of the builder.
setFiltersApplied(filtersApplied)GetDataResponseSets the filters applied status for this builder.

Detailed documentation

addAllRows(rows)

Adds multiple rows of data to this GetDataResponse.

Parameters

NameTypeDescription
rowsString[][]The rows of data to set.

Return

GetDataResponse — This builder, for chaining.

addRow(row)

Adds a row of data to this GetDataResponse.

Parameters

NameTypeDescription
rowString[]The row of data to set.

Return

GetDataResponse — This builder, for chaining.

build()

Validates this object and returns it in the format needed by Data Studio.

Return

Object — The validated GetDataResponse object.

setFields(fields)

Sets the Fields of the builder.

Parameters

NameTypeDescription
fieldsFieldsThe fields to set.

Return

GetDataResponse — This builder, for chaining.

setFiltersApplied(filtersApplied)

Sets the filters applied status for this builder. Set to true if all filters were successfully applied, false otherwise.

Parameters

NameTypeDescription
filtersAppliedBoolean- The filters applied status to set.

Return

GetDataResponse — This builder, for chaining.