Class DataSourceSpec

資料來源規格

存取現有資料來源規格的一般設定。如要存取特定類型的資料來源規格，請使用 as...() 方法。如要建立新的資料來源規格，請使用 SpreadsheetApp.newDataSourceSpec()。

請僅將此類別用於與資料庫連結的資料。

本例說明如何從 BigQuery 資料來源規格取得資訊。

const dataSourceTable = SpreadsheetApp.getActive()
                            .getSheetByName('Data Sheet 1')
                            .getDataSourceTables()[0];
const spec = dataSourceTable.getDataSource().getSpec();
if (spec.getType() === SpreadsheetApp.DataSourceType.BIGQUERY) {
  const bqSpec = spec.asBigQuery();
  Logger.log('Project ID: %s\n', bqSpec.getProjectId());
  Logger.log('Raw query string: %s\n', bqSpec.getRawQuery());
}

這個範例說明如何從 Looker 資料來源規格取得資訊。使用 asLooker() 會傳回 LookerDataSourceSpec 物件。

// 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().asLooker();

if (spec.getType() === SpreadsheetApp.DataSourceType.LOOKER) {
  const lookerSpec = spec.asLooker();
  Logger.log('Looker instance URL: %s\n', lookerSpec.getInstanceUrl());
}

方法

方法傳回類型簡短說明
asBigQuery()BigQueryDataSourceSpec取得 BigQuery 資料來源的規格。
asLooker()LookerDataSourceSpec取得 Looker 資料來源的規格。
copy()DataSourceSpecBuilder根據這個資料來源的設定，建立 DataSourceSpecBuilder。
getParameters()DataSourceParameter[]取得資料來源的參數。
getType()DataSourceType取得資料來源的類型。

內容詳盡的說明文件

asBigQuery()

取得 BigQuery 資料來源的規格。

回攻員

BigQueryDataSourceSpec：BigQuery 資料來源規格。

asLooker()

取得 Looker 資料來源的規格。

// 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().asLooker();

回攻員

LookerDataSourceSpec：Looker 資料來源規格。

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

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：資料來源類型。