Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

Конструктор для LookerDataSourceSpecBuilder .

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

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

Методы

Метод Тип возвращаемого значения Краткое описание
build() Data Source Spec Создает спецификацию источника данных на основе настроек этого конструктора.
copy() Data Source Spec Builder Создает Data Source Spec Builder на основе настроек этого источника данных.
get Explore Name() String Получает имя объекта Looker explore в модели.
get Instance Url() String Получает URL-адрес экземпляра Looker.
get Model Name() String Получает имя модели Looker в экземпляре.
get Parameters() Data Source Parameter[] Получает параметры источника данных.
get Type() Data Source Type Получает тип источника данных.
remove All Parameters() Looker Data Source Spec Builder Удаляет все параметры.
remove Parameter(parameterName) Looker Data Source Spec Builder Удаляет указанный параметр.
set Explore Name(exploreName) Looker Data Source Spec Builder Задает имя для исследования в модели Looker.
set Instance Url(instanceUrl) Looker Data Source Spec Builder Задает URL-адрес экземпляра для Looker.
set Model Name(modelName) Looker Data Source Spec Builder Задает имя модели Looker в экземпляре Looker.
set Parameter From Cell(parameterName, sourceCell) Looker Data Source Spec Builder Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для конструкторов спецификаций источников данных типа Data Source Type.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()

Получает 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');

Параметры

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

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

LookerDataSourceSpecBuilder — конструктор для создания цепочек вызовов.

setExploreName(exploreName)

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

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

Параметры

Имя Тип Описание
explore Name 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');

Параметры

Имя Тип Описание
instance Url 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');

Параметры

Имя Тип Описание
model Name String Название модели в экземпляре Looker.

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

LookerDataSourceSpecBuilder — конструктор для создания цепочек вызовов.

setParameterFromCell(parameterName, sourceCell)

Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для построителей спецификаций источников данных типа DataSourceType.BIGQUERY .

Этот метод доступен только для источников данных BigQuery. 

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

Параметры

Имя Тип Описание
parameter Name String Название параметра.
source Cell String Исходная ячейка, как указано в обозначении A1.

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

LookerDataSourceSpecBuilder — конструктор для создания цепочек вызовов.