Class BigQueryDataSourceSpec

BigQueryDataSourceSpec

Access the existing BigQuery data source specification. To create a new data source specification, use SpreadsheetApp.newDataSourceSpec() .

Methods

Method	Return type	Brief description
`copy()`	`DataSourceSpecBuilder`	Creates a `DataSourceSpecBuilder` based on this data source's settings.
`getDatasetId()`	`String`	Gets the BigQuery dataset ID.
`getParameters()`	`DataSourceParameter[]`	Gets the parameters of the data source.
`getProjectId()`	`String`	Gets the billing project ID.
`getRawQuery()`	`String`	Gets the raw query string.
`getTableId()`	`String`	Gets the BigQuery table ID.
`getTableProjectId()`	`String`	Gets the BigQuery project ID for the table.
`getType()`	`DataSourceType`	Gets the type of the data source.

Detailed documentation

`copy()`

Creates a DataSourceSpecBuilder 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' 
 ); 
 var 
  
 spec 
  
 = 
  
 ss 
 . 
 getDataSources 
 ()[ 
 0 
 ] 
 . 
 getSpec 
 (); 
 var 
  
 newSpec 
  
 = 
  
 spec 
 . 
 copy 
 ();

Return

DataSourceSpecBuilder — The builder.

`getDatasetId()`

Gets the BigQuery dataset ID.

Return

String — The dataset ID, or an empty string if the data source spec is defined by a raw query.

`getParameters()`

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' 
 ); 
 var 
  
 spec 
  
 = 
  
 ss 
 . 
 getDataSources 
 ()[ 
 0 
 ] 
 . 
 getSpec 
 (); 
 var 
  
 parameters 
  
 = 
  
 spec 
 . 
 getParameters 
 ();

This method is only available for BigQuery data sources.

Return

DataSourceParameter[] — The parameter list.

`getProjectId()`

Gets the billing project ID.

Return

String — The project ID.

`getRawQuery()`

Gets the raw query string.

Return

String — The raw query string.

`getTableId()`

Gets the BigQuery table ID.

Return

String — The table ID, or an empty string if the data source spec is defined by a raw query.

`getTableProjectId()`

Gets the BigQuery project ID for the table.

Return

String — The table project ID, or an empty string if the data source spec is defined by a raw query.

`getType()`

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' 
 ); 
 var 
  
 spec 
  
 = 
  
 ss 
 . 
 getDataSources 
 ()[ 
 0 
 ] 
 . 
 getSpec 
 (); 
 var 
  
 type 
  
 = 
  
 spec 
 . 
 getType 
 ();

Return

DataSourceType — The data source type.