Class DataSourceSpecBuilder

DataSourceSpecBuilder

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

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

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

var 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 オブジェクトを返します。

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

メソッド

メソッド戻り値の型概要
asBigQuery()BigQueryDataSourceSpecBuilderBigQuery データソースのビルダーを取得します。
asLooker()LookerDataSourceSpecBuilderLooker データソースのビルダーを取得します。
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 データソースのビルダーを取得します。 

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

戻る

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

build()

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

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

var 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 仕様をビルドします。

var lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
var 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');
var spec = ss.getDataSources()[0].getSpec();

var 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');
var spec = ss.getDataSources()[0].getSpec();
var 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');
var spec = ss.getDataSources()[0].getSpec();
var type = spec.getType();

戻る

DataSourceType - データソースのタイプ。

removeAllParameters()

すべてのパラメータを削除します。 

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

戻る

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

removeParameter(parameterName)

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

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

パラメータ

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

戻る

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

setParameterFromCell(parameterName, sourceCell)

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

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

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

パラメータ

名前型説明
parameterNameStringパラメータ名。
sourceCellStringソースセル（A1 表記で指定）。

戻る

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