Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder 的构建器。

此示例展示了如何创建新的 Looker 数据源规范构建器。 

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

方法

方法返回值类型简介
build()DataSourceSpec根据此构建器中的设置构建数据源规范。
copy()DataSourceSpecBuilder根据此数据源的设置创建 DataSourceSpecBuilder。
getExploreName()String获取模型中 Looker 探索的名称。
getInstanceUrl()String获取 Looker 实例的网址。
getModelName()String获取实例中 Looker 模型的名称。
getParameters()DataSourceParameter[]获取数据源的参数。
getType()DataSourceType获取数据源的类型。
removeAllParameters()LookerDataSourceSpecBuilder移除所有参数。
removeParameter(parameterName)LookerDataSourceSpecBuilder移除指定的参数。
setExploreName(exploreName)LookerDataSourceSpecBuilder设置 Looker 模型中的探索名称。
setInstanceUrl(instanceUrl)LookerDataSourceSpecBuilder为 Looker 设置实例网址。
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 探索的名称。 

// 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 探索的名称。

getInstanceUrl()

获取 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 instanceUrl = lookerDataSourceSpec.getInstanceUrl();
Logger.log(instanceUrl);

返回

String - Looker 实例的网址。

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 模型中的探索名称。 

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

参数

名称类型说明
exploreNameString所选 Looker 模型中的探索名称。

返回

LookerDataSourceSpecBuilder - 此构建器，用于链式调用。

setInstanceUrl(instanceUrl)

为 Looker 设置实例网址。 

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

参数

名称类型说明
instanceUrlStringLooker 实例的网址。

返回

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参数名称。
sourceCellString源单元格，以 A1 表示法指定。

返回

LookerDataSourceSpecBuilder - 构建器，用于链式调用。