Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder のビルダー。

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

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

メソッド

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

詳細なドキュメント

build()

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

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

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 データソース仕様を作成します。

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

パラメータ

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

戻る

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

---

setExploreName(exploreName)

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

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

パラメータ

名前	タイプ	説明
exploreName	String	選択した 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');

パラメータ

名前	タイプ	説明
instanceUrl	String	Looker インスタンスの URL。

戻る

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

---

setModelName(modelName)

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

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

パラメータ

名前	タイプ	説明
modelName	String	Looker インスタンスのモデル名。

戻る

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

---

setParameterFromCell(parameterName, sourceCell)

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

このメソッドは、BigQuery データソースでのみ使用できます。

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

パラメータ

名前	タイプ	説明
parameterName	String	パラメータ名。
sourceCell	String	A1 形式で指定されたソースセル。

戻る

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