The builder for Looker
.
This example shows how to create a new Looker Data Source Spec builder.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker ();
Methods
| Method | Return type | Brief description |
|---|---|---|
Data
|
Builds a data source specification from the settings in this builder. | |
Data
|
Creates a Data
based on this data source's settings. |
|
String
|
Gets the name of the Looker explore in the model. | |
String
|
Gets the URL of the Looker instance. | |
String
|
Gets the name of the Looker model in the instance. | |
Data
|
Gets the parameters of the data source. | |
Data
|
Gets the type of the data source. | |
Looker
|
Removes all the parameters. | |
Looker
|
Removes the specified parameter. | |
Looker
|
Sets the explore name in the Looker model. | |
Looker
|
Sets the instance URL for Looker. | |
Looker
|
Sets the Looker model name in the Looker instance. | |
Looker
|
Adds a parameter, or if the parameter with the name exists, updates its source cell for data
source spec builders of type Data
. |
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.
const bigQueryDataSourceSpec = 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.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker (); const lookerSpec = lookerDataSourceSpecBuilder . setExploreName ( 'my explore name' ) . setInstanceUrl ( 'my instance url' ) . setModelName ( 'my model name' ) . build ();
Return
Data
— The data source specification.
copy()
Creates a Data
based on this data source's settings.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const newSpec = spec . copy ();
Return
Data
— The builder.
get
Gets the name of the Looker explore in the model.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const lookerDataSourceSpec = ss . getDataSources ()[ 0 ]. getSpec (). asLooker (); const exploreName = lookerDataSourceSpec . getExploreName (); Logger . log ( exploreName );
Return
String
— The name of the Looker explore.
get
Gets the URL of the Looker instance.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const lookerDataSourceSpec = ss . getDataSources ()[ 0 ]. getSpec (). asLooker (); const instanceUrl = lookerDataSourceSpec . getInstanceUrl (); Logger . log ( instanceUrl );
Return
String
— The URL of the Looker instance.
get
Gets the name of the Looker model in the instance.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const lookerDataSourceSpec = ss . getDataSources ()[ 0 ]. getSpec (). asLooker (); const modelName = lookerDataSourceSpec . getModelName (); Logger . log ( modelName );
Return
String
— The name of the Looker model.
get
Gets the parameters of the data source.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const parameters = spec . getParameters ();
This method is only available for BigQuery data sources.
Return
Data
— The parameter list.
get
Gets the type of the data source.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const type = spec . getType ();
Return
Data
— The data source type.
remove
Removes all the parameters.
const specBuilder = SpreadsheetApp . newDataSourceSpec (); specBuilder . removeAllParameters ();
Return
Looker
— The builder, for chaining.
remove
Removes the specified parameter.
const specBuilder = SpreadsheetApp . newDataSourceSpec (); specBuilder . removeParameter ( 'x' );
Parameters
| Name | Type | Description |
|---|---|---|
parameter
|
String
|
The name of the parameter to remove. |
Return
Looker
— The builder, for chaining.
set
Sets the explore name in the Looker model.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker (); // TODO(developer): replace explore name with your own lookerDataSourceSpecBuilder . setExploreName ( 'my explore name' );
Parameters
| Name | Type | Description |
|---|---|---|
explore
|
String
|
The explore name in the selected Looker model. |
Return
Looker
— This builder, for chaining.
set
Sets the instance URL for Looker.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker (); // TODO(developer): replace instance url with your own lookerDataSourceSpecBuilder . setInstanceUrl ( 'my instance url' );
Parameters
| Name | Type | Description |
|---|---|---|
instance
|
String
|
The URL of the Looker instance. |
Return
Looker
— The builder, for chaining.
set
Sets the Looker model name in the Looker instance.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker (); // TODO(developer): replace model name with your own lookerDataSourceSpecBuilder . setModelName ( 'my model name' );
Parameters
| Name | Type | Description |
|---|---|---|
model
|
String
|
The model name in the Looker instance. |
Return
Looker
— The builder, for chaining.
set
Adds a parameter, or if the parameter with the name exists, updates its source cell for data
source spec builders of type Data
.
This method is only available for BigQuery data sources.
const specBuilder = SpreadsheetApp . newDataSourceSpec (). asBigQuery (); specBuilder . setParameterFromCell ( 'x' , 'A1' ); const bigQuerySpec = specBuilder . build ();
Parameters
| Name | Type | Description |
|---|---|---|
parameter
|
String
|
The parameter name. |
source
|
String
|
The source cell, as specified in A1 notation. |
Return
Looker
— The builder, for chaining.
