Class LookerDataSourceSpecBuilder

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

LookerDataSourceSpecBuilder のビルダー。

この例では、新しい Looker データソース仕様ビルダーを作成する方法を示します。

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();

メソッド

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

詳細なドキュメント

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


getExploreName()

モデル内の Looker Explore の名前を取得します。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

const lookerDataSourceSpec = ss.getDataSources()[0].getSpec().asLooker();
const exploreName = lookerDataSourceSpec.getExploreName();
Logger.log(exploreName);

戻る

String - Looker Explore の名前。


getInstanceUrl()

Looker インスタンスの URL を取得します。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

const lookerDataSourceSpec = ss.getDataSources()[0].getSpec().asLooker();
const instanceUrl = lookerDataSourceSpec.getInstanceUrl();
Logger.log(instanceUrl);

戻る

String - Looker インスタンスの URL。


getModelName()

インスタンス内の Looker モデルの名前を取得します。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

const lookerDataSourceSpec = ss.getDataSources()[0].getSpec().asLooker();
const modelName = lookerDataSourceSpec.getModelName();
Logger.log(modelName);

戻る

String - Looker モデルの名前。


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

戻る

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


removeParameter(parameterName)

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

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

パラメータ

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

戻る

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


setExploreName(exploreName)

Looker モデルで Explore の名前を設定します。

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace explore name with your own
lookerDataSourceSpecBuilder.setExploreName('my explore name');

パラメータ

名前説明
exploreNameString選択した Looker モデルの Explore 名。

戻る

LookerDataSourceSpecBuilder - チェーン用のこのビルダー。


setInstanceUrl(instanceUrl)

Looker のインスタンス URL を設定します。

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace instance url with your own
lookerDataSourceSpecBuilder.setInstanceUrl('my instance url');

パラメータ

名前説明
instanceUrlStringLooker インスタンスの URL。

戻る

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


setModelName(modelName)

Looker インスタンスで Looker モデル名を設定します。

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
// TODO(developer): replace model name with your own
lookerDataSourceSpecBuilder.setModelName('my model name');

パラメータ

名前説明
modelNameStringLooker インスタンスのモデル名。

戻る

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


setParameterFromCell(parameterName, sourceCell)

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

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

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

パラメータ

名前説明
parameterNameStringパラメータ名。
sourceCellStringA1 表記で指定されたソースセル。

戻る

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