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()BigQueryDataSourceSpecBigQuery データソースの仕様を取得します。
asLooker()LookerDataSourceSpecLooker データソースの仕様を取得します。
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 - データソースのタイプ。