Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

O builder de LookerDataSourceSpecBuilder.

Este exemplo mostra como criar um novo criador de especificações de fonte de dados do Looker. 

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

Métodos

MétodoTipo de retornoBreve descrição
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste criador.
copy()DataSourceSpecBuilderCria uma DataSourceSpecBuilder com base nas configurações da fonte de dados.
getExploreName()StringRecebe o nome da análise do Looker no modelo.
getInstanceUrl()StringRecebe o URL da instância do Looker.
getModelName()StringMostra o nome do modelo do Looker na instância.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeRecebe o tipo da fonte de dados.
removeAllParameters()LookerDataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)LookerDataSourceSpecBuilderRemove o parâmetro especificado.
setExploreName(exploreName)LookerDataSourceSpecBuilderDefine o nome da análise no modelo do Looker.
setInstanceUrl(instanceUrl)LookerDataSourceSpecBuilderDefine o URL da instância do Looker.
setModelName(modelName)LookerDataSourceSpecBuilderDefine o nome do modelo do Looker na instância do Looker.
setParameterFromCell(parameterName, sourceCell)LookerDataSourceSpecBuilderAdiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem para construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

Documentação detalhada

build()

Cria uma especificação de fonte de dados com base nas configurações deste criador. É necessário usar as...() para especificar um tipo de fonte de dados antes da criação.

O exemplo de código a seguir cria uma especificação de fonte de dados do 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();

O exemplo de código a seguir cria uma especificação de fonte de dados do Looker. 

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

Retornar

DataSourceSpec: a especificação da fonte de dados.

copy()

Cria uma DataSourceSpecBuilder com base nas configurações da fonte de dados. 

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

Retornar

DataSourceSpecBuilder: o builder.

getExploreName()

Recebe o nome da análise do Looker no modelo. 

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

Retornar

String: o nome da Análise do Looker.

getInstanceUrl()

Recebe o URL da instância do 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);

Retornar

String: o URL da instância do Looker.

getModelName()

Mostra o nome do modelo do Looker na instância. 

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

Retornar

String: o nome do modelo do Looker.

getParameters()

Recebe os parâmetros da fonte de dados. 

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

Esse método está disponível apenas para fontes de dados do BigQuery.

Retornar

DataSourceParameter[]: a lista de parâmetros.

getType()

Recebe o tipo da fonte de dados. 

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

Retornar

DataSourceType: o tipo de origem de dados.

removeAllParameters()

Remove todos os parâmetros. 

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Retornar

LookerDataSourceSpecBuilder: o builder para encadeamento.

removeParameter(parameterName)

Remove o parâmetro especificado. 

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

Parâmetros

NomeTipoDescrição
parameterNameStringO nome do parâmetro a ser removido.

Retornar

LookerDataSourceSpecBuilder: o builder para encadeamento.

setExploreName(exploreName)

Define o nome da análise no modelo do Looker. 

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

Parâmetros

NomeTipoDescrição
exploreNameStringO nome da análise no modelo do Looker selecionado.

Retornar

LookerDataSourceSpecBuilder: este builder, para encadeamento.

setInstanceUrl(instanceUrl)

Define o URL da instância do Looker. 

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

Parâmetros

NomeTipoDescrição
instanceUrlStringO URL da instância do Looker.

Retornar

LookerDataSourceSpecBuilder: o builder para encadeamento.

setModelName(modelName)

Define o nome do modelo do Looker na instância do Looker. 

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

Parâmetros

NomeTipoDescrição
modelNameStringO nome do modelo na instância do Looker.

Retornar

LookerDataSourceSpecBuilder: o builder para encadeamento.

setParameterFromCell(parameterName, sourceCell)

Adiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem para construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

Esse método está disponível apenas para fontes de dados do BigQuery. 

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

Parâmetros

NomeTipoDescrição
parameterNameStringO nome do parâmetro.
sourceCellStringA célula de origem, conforme especificada na notação A1.

Retornar

LookerDataSourceSpecBuilder: o builder para encadeamento.