Class LookerDataSourceSpecBuilder

  • LookerDataSourceSpecBuilder is used to create a new Looker Data Source Spec builder in Apps Script.

  • You can build a data source specification from the builder's settings using the build() method.

  • The builder provides methods to get and set the Looker explore name, instance URL, and model name.

  • You can manage parameters using methods like getParameters(), removeAllParameters(), and removeParameter().
LookerDataSourceSpecBuilder

The builder for LookerDataSourceSpecBuilder .

This example shows how to create a new Looker Data Source Spec builder. 

constlookerDataSourceSpecBuilder=
SpreadsheetApp.newDataSourceSpec().asLooker();

Methods

MethodReturn typeBrief description
build() DataSourceSpec Builds a data source specification from the settings in this builder.
copy() DataSourceSpecBuilder Creates a DataSourceSpecBuilder based on this data source's settings.
getExploreName() StringGets the name of the Looker explore in the model.
getInstanceUrl() StringGets the URL of the Looker instance.
getModelName() StringGets the name of the Looker model in the instance.
getParameters() DataSourceParameter[] Gets the parameters of the data source.
getType() DataSourceType Gets the type of the data source.
removeAllParameters() LookerDataSourceSpecBuilder Removes all the parameters.
removeParameter(parameterName) LookerDataSourceSpecBuilder Removes the specified parameter.
setExploreName(exploreName) LookerDataSourceSpecBuilder Sets the explore name in the Looker model.
setInstanceUrl(instanceUrl) LookerDataSourceSpecBuilder Sets the instance URL for Looker.
setModelName(modelName) LookerDataSourceSpecBuilder Sets the Looker model name in the Looker instance.
setParameterFromCell(parameterName, sourceCell) LookerDataSourceSpecBuilder Adds a parameter, or if the parameter with the name exists, updates its source cell for data source spec builders of type DataSourceType.BIGQUERY .

Detailed documentation

build()

Builds a data source specification from the settings in this builder. Must use as...() to specify a data source type before building.

The following code sample builds a BigQuery DataSource Spec. 

constbigQueryDataSourceSpec=SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');
bigQueryDataSourceSpec.build();

The following code sample builds a Looker DataSource Spec. 

constlookerDataSourceSpecBuilder=
SpreadsheetApp.newDataSourceSpec().asLooker();
constlookerSpec=lookerDataSourceSpecBuilder.setExploreName('my explore name')
.setInstanceUrl('my instance url')
.setModelName('my model name')
.build();

Return

DataSourceSpec — The data source specification.

copy()

Creates a DataSourceSpecBuilder based on this data source's settings. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constspec=ss.getDataSources()[0].getSpec();
constnewSpec=spec.copy();

Return

DataSourceSpecBuilder — The builder.

getExploreName()

Gets the name of the Looker explore in the model. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constlookerDataSourceSpec=ss.getDataSources()[0].getSpec().asLooker();
constexploreName=lookerDataSourceSpec.getExploreName();
Logger.log(exploreName);

Return

String — The name of the Looker explore.

getInstanceUrl()

Gets the URL of the Looker instance. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constlookerDataSourceSpec=ss.getDataSources()[0].getSpec().asLooker();
constinstanceUrl=lookerDataSourceSpec.getInstanceUrl();
Logger.log(instanceUrl);

Return

String — The URL of the Looker instance.

getModelName()

Gets the name of the Looker model in the instance. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constlookerDataSourceSpec=ss.getDataSources()[0].getSpec().asLooker();
constmodelName=lookerDataSourceSpec.getModelName();
Logger.log(modelName);

Return

String — The name of the Looker model.

getParameters()

Gets the parameters of the data source. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constspec=ss.getDataSources()[0].getSpec();
constparameters=spec.getParameters();

This method is only available for BigQuery data sources.

Return

DataSourceParameter[] — The parameter list.

getType()

Gets the type of the data source. 

// TODO(developer): Replace the URL with your own.
constss=SpreadsheetApp.openByUrl(
'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
constspec=ss.getDataSources()[0].getSpec();
consttype=spec.getType();

Return

DataSourceType — The data source type.

removeAllParameters()

Removes all the parameters. 

constspecBuilder=SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Return

LookerDataSourceSpecBuilder — The builder, for chaining.

removeParameter(parameterName)

Removes the specified parameter. 

constspecBuilder=SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Parameters

NameTypeDescription
parameterNameStringThe name of the parameter to remove.

Return

LookerDataSourceSpecBuilder — The builder, for chaining.

setExploreName(exploreName)

Sets the explore name in the Looker model. 

constlookerDataSourceSpecBuilder=
SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace explore name with your own
lookerDataSourceSpecBuilder.setExploreName('my explore name');

Parameters

NameTypeDescription
exploreNameStringThe explore name in the selected Looker model.

Return

LookerDataSourceSpecBuilder — This builder, for chaining.

setInstanceUrl(instanceUrl)

Sets the instance URL for Looker. 

constlookerDataSourceSpecBuilder=
SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace instance url with your own
lookerDataSourceSpecBuilder.setInstanceUrl('my instance url');

Parameters

NameTypeDescription
instanceUrlStringThe URL of the Looker instance.

Return

LookerDataSourceSpecBuilder — The builder, for chaining.

setModelName(modelName)

Sets the Looker model name in the Looker instance. 

constlookerDataSourceSpecBuilder=
SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace model name with your own
lookerDataSourceSpecBuilder.setModelName('my model name');

Parameters

NameTypeDescription
modelNameStringThe model name in the Looker instance.

Return

LookerDataSourceSpecBuilder — The builder, for chaining.

setParameterFromCell(parameterName, sourceCell)

Adds a parameter, or if the parameter with the name exists, updates its source cell for data source spec builders of type DataSourceType.BIGQUERY .

This method is only available for BigQuery data sources. 

constspecBuilder=SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x','A1');
constbigQuerySpec=specBuilder.build();

Parameters

NameTypeDescription
parameterNameStringThe parameter name.
sourceCellStringThe source cell, as specified in A1 notation.

Return

LookerDataSourceSpecBuilder — The builder, for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024年12月03日 UTC.