Class DataSourceSpecBuilder

データソース仕様ビルダー

DataSourceSpec のビルダー。特定のタイプの仕様を作成するには、as...() メソッドを使用します。新しいビルダーを作成するには、SpreadsheetApp.newDataSourceSpec() を使用します。仕様を使用するには、DataSourceTable をご覧ください。

このクラスは、データベースに接続されているデータでのみ使用してください。

この例では、BigQuery データソース仕様を作成する方法を示します。

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asBigQuery()
                 .setProjectId('big_query_project')
                 .setRawQuery('select @FIELD from table limit @LIMIT')
                 .setParameterFromCell('FIELD', 'Sheet1!A1')
                 .setParameterFromCell('LIMIT', 'namedRangeCell')
                 .build();

この例は、Looker データソース仕様を作成する方法を示しています。build() を使用した後、LookerDataSourceSpec オブジェクトを返します。

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

メソッド

メソッド	戻り値の型	概要
asBigQuery()	BigQueryDataSourceSpecBuilder	BigQuery データソースのビルダーを取得します。
asLooker()	LookerDataSourceSpecBuilder	Looker データソースのビルダーを取得します。
build()	DataSourceSpec	このビルダーの設定からデータソース仕様を作成します。
copy()	DataSourceSpecBuilder	このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。
getParameters()	DataSourceParameter[]	データソースのパラメータを取得します。
getType()	DataSourceType	データソースのタイプを取得します。
removeAllParameters()	DataSourceSpecBuilder	すべてのパラメータを削除します。
removeParameter(parameterName)	DataSourceSpecBuilder	指定されたパラメータを削除します。
setParameterFromCell(parameterName, sourceCell)	DataSourceSpecBuilder	パラメータを追加します。名前が同じパラメータが存在する場合は、DataSourceType.BIGQUERY タイプのデータソース仕様ビルダーのソースセルを更新します。

詳細なドキュメント

asBigQuery()

BigQuery データソースのビルダーを取得します。

戻る

BigQueryDataSourceSpecBuilder - BigQuery データソース仕様ビルダー。

---

asLooker()

Looker データソースのビルダーを取得します。

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

戻る

LookerDataSourceSpecBuilder - Looker データソース仕様ビルダー。

---

build()

このビルダーの設定からデータソース仕様を作成します。ビルド前に as...() を使用してデータソースのタイプを指定する必要があります。

次のコードサンプルは、BigQuery DataSource 仕様をビルドします。

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 DataSource Spec をビルドします。

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 - ビルダー。

---

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

戻る

DataSourceSpecBuilder - チェーン用のビルダー。

---

removeParameter(parameterName)

指定されたパラメータを削除します。

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

パラメータ

名前	型	説明
parameterName	String	削除するパラメータの名前。

戻る

DataSourceSpecBuilder - チェーン用のビルダー。

---

setParameterFromCell(parameterName, sourceCell)

パラメータを追加します。名前が同じパラメータが存在する場合は、DataSourceType.BIGQUERY タイプのデータソース仕様ビルダーのソースセルを更新します。

この方法は、BigQuery データソースでのみ使用できます。

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

パラメータ

名前	型	説明
parameterName	String	パラメータ名。
sourceCell	String	A1 表記で指定されたソースセル。

戻る

DataSourceSpecBuilder - チェーン用のビルダー。