Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

Построитель для LookerDataSourceSpecBuilder .

В этом примере показано, как создать новый построитель спецификаций источников данных Looker.

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

Методы

Метод Тип возврата Краткое описание
build() DataSourceSpec Создает спецификацию источника данных на основе настроек этого построителя.
copy() DataSourceSpecBuilder Создает DataSourceSpecBuilder на основе настроек этого источника данных.
getExploreName() String Получает имя исследования Looker в модели.
getInstanceUrl() String Получает URL-адрес экземпляра Looker.
getModelName() String Получает имя модели Looker в экземпляре.
getParameters() DataSourceParameter[] Получает параметры источника данных.
getType() DataSourceType Получает тип источника данных.
removeAllParameters() LookerDataSourceSpecBuilder Удаляет все параметры.
removeParameter(parameterName) LookerDataSourceSpecBuilder Удаляет указанный параметр.
setExploreName(exploreName) LookerDataSourceSpecBuilder Устанавливает имя исследования в модели Looker.
setInstanceUrl(instanceUrl) LookerDataSourceSpecBuilder Устанавливает URL-адрес экземпляра для Looker.
setModelName(modelName) LookerDataSourceSpecBuilder Устанавливает имя модели Looker в экземпляре 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.

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

Получает URL-адрес экземпляра 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 — URL-адрес экземпляра 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');

Параметры

Имя Тип Описание
parameterName String Имя параметра, который нужно удалить.

Возвращаться

LookerDataSourceSpecBuilder — Построитель для цепочки.


setExploreName(exploreName)

Устанавливает имя исследования в модели Looker.

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

Параметры

Имя Тип Описание
exploreName String Имя исследования в выбранной модели Looker.

Возвращаться

LookerDataSourceSpecBuilder — этот построитель для создания цепочек.


setInstanceUrl(instanceUrl)

Устанавливает URL-адрес экземпляра для Looker.

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

Параметры

Имя Тип Описание
instanceUrl String URL-адрес экземпляра Looker.

Возвращаться

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 — Построитель для цепочки.