本頁面由 Cloud Translation API 翻譯而成。

Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder 的建構工具。

方法

方法	傳回類型	簡短說明
`build()`	`DataSourceSpec`	根據這個建構工具中的設定，建構資料來源規格。
`copy()`	`DataSourceSpecBuilder`	根據這個資料來源的設定，建立 `DataSourceSpecBuilder`。
`getDatasetId()`	`String`	取得 BigQuery 資料集 ID。
`getParameters()`	`DataSourceParameter[]`	取得資料來源的參數。
`getProjectId()`	`String`	取得帳單專案 ID。
`getRawQuery()`	`String`	取得原始查詢字串。
`getTableId()`	`String`	取得 BigQuery 資料表 ID。
`getTableProjectId()`	`String`	取得資料表的 BigQuery 專案 ID。
`getType()`	`DataSourceType`	取得資料來源的類型。
`removeAllParameters()`	`BigQueryDataSourceSpecBuilder`	移除所有參數。
`removeParameter(parameterName)`	`BigQueryDataSourceSpecBuilder`	移除指定的參數。
`setDatasetId(datasetId)`	`BigQueryDataSourceSpecBuilder`	設定 BigQuery 資料集 ID。
`setParameterFromCell(parameterName, sourceCell)`	`BigQueryDataSourceSpecBuilder`	新增參數，或如果有同名參數，則更新資料來源規格建構工具 (類型為 `DataSourceType.BIGQUERY`) 的來源儲存格。
`setProjectId(projectId)`	`BigQueryDataSourceSpecBuilder`	設定 BigQuery 帳單專案 ID。
`setRawQuery(rawQuery)`	`BigQueryDataSourceSpecBuilder`	設定原始查詢字串。
`setTableId(tableId)`	`BigQueryDataSourceSpecBuilder`	設定 BigQuery 資料表 ID。
`setTableProjectId(projectId)`	`BigQueryDataSourceSpecBuilder`	設定資料表的 BigQuery 專案 ID。

內容詳盡的說明文件

`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：建構工具。

`getDatasetId()`

取得 BigQuery 資料集 ID。

回攻員

String：資料集 ID，如果資料來源規格是由原始查詢定義，則為空字串。

`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[]：參數清單。

`getProjectId()`

取得帳單專案 ID。

回攻員

String：專案 ID。

`getRawQuery()`

取得原始查詢字串。

回攻員

String：原始查詢字串。

`getTableId()`

取得 BigQuery 資料表 ID。

回攻員

String：資料表 ID，如果資料來源規格是由原始查詢定義，則為空字串。

`getTableProjectId()`

取得資料表的 BigQuery 專案 ID。

回攻員

String：資料表專案 ID，如果資料來源規格是由原始查詢定義，則為空字串。

`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();

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。

`removeParameter(parameterName)`

移除指定的參數。

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

參數

名稱	類型	說明
`parameterName`	`String`	要移除的參數名稱。

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。

`setDatasetId(datasetId)`

設定 BigQuery 資料集 ID。

參數

名稱	類型	說明
`datasetId`	`String`	資料集 ID。

回攻員

BigQueryDataSourceSpecBuilder：這個建構工具可用於鏈結。

`setParameterFromCell(parameterName, sourceCell)`

新增參數，或如果有同名參數，則更新資料來源規格建構工具 (類型為 DataSourceType.BIGQUERY) 的來源儲存格。

這個方法僅適用於 BigQuery 資料來源。

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

參數

名稱	類型	說明
`parameterName`	`String`	參數名稱。
`sourceCell`	`String`	來源儲存格，如 A1 符號所示。

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。

`setProjectId(projectId)`

設定 BigQuery 帳單專案 ID。

參數

名稱	類型	說明
`projectId`	`String`	報帳專案的 ID。

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。

`setRawQuery(rawQuery)`

設定原始查詢字串。

參數

名稱	類型	說明
`rawQuery`	`String`	原始查詢字串。

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。

`setTableId(tableId)`

設定 BigQuery 資料表 ID。

參數

名稱	類型	說明
`tableId`	`String`	資料表的 ID。

回攻員

BigQueryDataSourceSpecBuilder：這個建構工具可用於鏈結。

`setTableProjectId(projectId)`

設定資料表的 BigQuery 專案 ID。

參數

名稱	類型	說明
`projectId`	`String`	BigQuery 資料表的專案 ID。

回攻員

BigQueryDataSourceSpecBuilder：用於鏈結的建構工具。