Class LookerDataSourceSpecBuilder

LookerDataSourceSpecBuilder

Compilateur pour LookerDataSourceSpecBuilder.

Cet exemple montre comment créer un générateur Looker Data Source Spec. 

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

Méthodes

MéthodeType renvoyéBrève description
build()DataSourceSpecCrée une spécification de source de données à partir des paramètres de ce générateur.
copy()DataSourceSpecBuilderCrée un DataSourceSpecBuilder en fonction des paramètres de cette source de données.
getExploreName()StringRécupère le nom de l'exploration Looker dans le modèle.
getInstanceUrl()StringRécupère l'URL de l'instance Looker.
getModelName()StringRécupère le nom du modèle Looker dans l'instance.
getParameters()DataSourceParameter[]Obtient les paramètres de la source de données.
getType()DataSourceTypeObtient le type de source de données.
removeAllParameters()LookerDataSourceSpecBuilderSupprime tous les paramètres.
removeParameter(parameterName)LookerDataSourceSpecBuilderSupprime le paramètre spécifié.
setExploreName(exploreName)LookerDataSourceSpecBuilderDéfinit le nom de l'exploration dans le modèle Looker.
setInstanceUrl(instanceUrl)LookerDataSourceSpecBuilderDéfinit l'URL de l'instance pour Looker.
setModelName(modelName)LookerDataSourceSpecBuilderDéfinit le nom du modèle Looker dans l'instance Looker.
setParameterFromCell(parameterName, sourceCell)LookerDataSourceSpecBuilderAjoute un paramètre ou, si le paramètre portant ce nom existe, met à jour sa cellule source pour les générateurs de spécifications de source de données de type DataSourceType.BIGQUERY.

Documentation détaillée

build()

Crée une spécification de source de données à partir des paramètres de ce générateur. Vous devez utiliser as...() pour spécifier un type de source de données avant de créer le modèle.

L'exemple de code suivant crée une spécification DataSource 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();

L'exemple de code suivant crée une spécification Looker DataSource. 

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

Renvois

DataSourceSpec : spécification de la source de données.

copy()

Crée un DataSourceSpecBuilder en fonction des paramètres de cette source de données. 

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

Renvois

DataSourceSpecBuilder : le compilateur.

getExploreName()

Récupère le nom de l'exploration Looker dans le modèle. 

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

Renvois

String : nom de l'exploration Looker.

getInstanceUrl()

Récupère l'URL de l'instance 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);

Renvois

String : URL de l'instance Looker.

getModelName()

Récupère le nom du modèle Looker dans l'instance. 

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

Renvois

String : nom du modèle Looker.

getParameters()

Obtient les paramètres de la source de données. 

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

Cette méthode n'est disponible que pour les sources de données BigQuery.

Renvois

DataSourceParameter[] : liste des paramètres.

getType()

Obtient le type de source de données. 

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

Renvois

DataSourceType : type de source de données.

removeAllParameters()

Supprime tous les paramètres. 

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

Renvois

LookerDataSourceSpecBuilder : compilateur, pour le chaînage.

removeParameter(parameterName)

Supprime le paramètre spécifié. 

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

Paramètres

NomTypeDescription
parameterNameStringNom du paramètre à supprimer.

Renvois

LookerDataSourceSpecBuilder : compilateur, pour le chaînage.

setExploreName(exploreName)

Définit le nom de l'exploration dans le modèle Looker. 

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

Paramètres

NomTypeDescription
exploreNameStringNom de l'exploration dans le modèle Looker sélectionné.

Renvois

LookerDataSourceSpecBuilder : ce générateur, pour le chaînage.

setInstanceUrl(instanceUrl)

Définit l'URL de l'instance pour Looker. 

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

Paramètres

NomTypeDescription
instanceUrlStringURL de l'instance Looker.

Renvois

LookerDataSourceSpecBuilder : compilateur, pour le chaînage.

setModelName(modelName)

Définit le nom du modèle Looker dans l'instance Looker. 

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

Paramètres

NomTypeDescription
modelNameStringNom du modèle dans l'instance Looker.

Renvois

LookerDataSourceSpecBuilder : compilateur, pour le chaînage.

setParameterFromCell(parameterName, sourceCell)

Ajoute un paramètre ou, si le paramètre portant ce nom existe, met à jour sa cellule source pour les générateurs de spécifications de source de données de type DataSourceType.BIGQUERY.

Cette méthode n'est disponible que pour les sources de données BigQuery. 

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

Paramètres

NomTypeDescription
parameterNameStringNom du paramètre.
sourceCellStringCellule source, telle qu'elle est spécifiée dans la notation A1.

Renvois

LookerDataSourceSpecBuilder : compilateur, pour le chaînage.