LookerDataSourceSpecBuilder
的建構工具。
本範例說明如何建立新的 Looker 資料來源規格設定建構工具。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
build() | DataSourceSpec | 根據這個建構工具中的設定,建構資料來源規格。 |
copy() | DataSourceSpecBuilder | 根據這個資料來源的設定,建立 DataSourceSpecBuilder 。 |
getExploreName() | String | 取得模型中的 Looker 探索名稱。 |
getInstanceUrl() | String | 取得 Looker 執行個體的網址。 |
getModelName() | String | 取得執行個體中的 Looker 模型名稱。 |
getParameters() | DataSourceParameter[] | 取得資料來源的參數。 |
getType() | DataSourceType | 取得資料來源的類型。 |
removeAllParameters() | LookerDataSourceSpecBuilder | 移除所有參數。 |
removeParameter(parameterName) | LookerDataSourceSpecBuilder | 移除指定的參數。 |
setExploreName(exploreName) | LookerDataSourceSpecBuilder | 在 Looker 模型中設定探索名稱。 |
setInstanceUrl(instanceUrl) | LookerDataSourceSpecBuilder | 設定 Looker 的執行個體網址。 |
setModelName(modelName) | LookerDataSourceSpecBuilder | 在 Looker 例項中設定 Looker 模型名稱。 |
setParameterFromCell(parameterName, sourceCell) | LookerDataSourceSpecBuilder | 新增參數,或如果有同名參數,則更新資料來源規格建構工具 (類型為 DataSourceType.BIGQUERY ) 的來源儲存格。 |
內容詳盡的說明文件
build()
根據這個建構工具中的設定,建立資料來源規格。必須先使用 as...()
指定資料來源類型,才能進行建構。
以下程式碼範例會建構 BigQuery 資料來源規格。
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();
下列程式碼範例會建構 Looker 資料來源規格。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker(); const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name') .setInstanceUrl('my instance url') .setModelName('my model name') .build();
回攻員
DataSourceSpec
:資料來源規格。
copy()
根據這個資料來源的設定,建立 DataSourceSpecBuilder
。
// 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();
回攻員
DataSourceSpecBuilder
:建構工具。
getExploreName()
取得模型中 Looker 探索的名稱。
// 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);
回攻員
String
:Looker 探索的名稱。
getInstanceUrl()
取得 Looker 執行個體的網址。
// 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);
回攻員
String
:Looker 執行個體的網址。
getModelName()
取得執行個體中的 Looker 模型名稱。
// 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);
回攻員
String
:Looker 模型的名稱。
getParameters()
取得資料來源的參數。
// 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();
這個方法僅適用於 BigQuery 資料來源。
回攻員
DataSourceParameter[]
:參數清單。
getType()
取得資料來源的類型。
// 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();
回攻員
DataSourceType
:資料來源類型。
removeAllParameters()
移除所有參數。
const specBuilder = SpreadsheetApp.newDataSourceSpec(); specBuilder.removeAllParameters();
回攻員
LookerDataSourceSpecBuilder
:用於鏈結的建構工具。
removeParameter(parameterName)
移除指定的參數。
const specBuilder = SpreadsheetApp.newDataSourceSpec(); specBuilder.removeParameter('x');
參數
名稱 | 類型 | 說明 |
---|---|---|
parameterName | String | 要移除的參數名稱。 |
回攻員
LookerDataSourceSpecBuilder
:用於鏈結的建構工具。
setExploreName(exploreName)
在 Looker 模型中設定探索名稱。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker(); // TODO(developer): replace explore name with your own lookerDataSourceSpecBuilder.setExploreName('my explore name');
參數
名稱 | 類型 | 說明 |
---|---|---|
exploreName | String | 所選 Looker 模型中的探索名稱。 |
回攻員
LookerDataSourceSpecBuilder
:這個建構工具可用於鏈結。
setInstanceUrl(instanceUrl)
設定 Looker 的執行個體網址。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker(); // TODO(developer): replace instance url with your own lookerDataSourceSpecBuilder.setInstanceUrl('my instance url');
參數
名稱 | 類型 | 說明 |
---|---|---|
instanceUrl | String | Looker 執行個體的網址。 |
回攻員
LookerDataSourceSpecBuilder
:用於鏈結的建構工具。
setModelName(modelName)
在 Looker 例項中設定 Looker 模型名稱。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker(); // TODO(developer): replace model name with your own lookerDataSourceSpecBuilder.setModelName('my model name');
參數
名稱 | 類型 | 說明 |
---|---|---|
modelName | String | Looker 執行個體中的模型名稱。 |
回攻員
LookerDataSourceSpecBuilder
:用於鏈結的建構工具。
setParameterFromCell(parameterName, sourceCell)
新增參數,或如果有同名參數,則更新資料來源規格建構工具 (類型為 DataSourceType.BIGQUERY
) 的來源儲存格。
這個方法僅適用於 BigQuery 資料來源。
const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery(); specBuilder.setParameterFromCell('x', 'A1'); const bigQuerySpec = specBuilder.build();
參數
名稱 | 類型 | 說明 |
---|---|---|
parameterName | String | 參數名稱。 |
sourceCell | String | 來源儲存格,如 A1 符號所示。 |
回攻員
LookerDataSourceSpecBuilder
:用於鏈結的建構工具。