Cette page a été traduite par l'API Cloud Translation.

Class DataSourceSpecBuilder

Compilateur pour DataSourceSpec. Pour créer une spécification pour un certain type, utilisez la méthode as...(). Pour créer un compilateur, utilisez SpreadsheetApp.newDataSourceSpec(). Pour utiliser la spécification, consultez DataSourceTable.

N'utilisez cette classe qu'avec des données connectées à une base de données.

Cet exemple montre comment créer une spécification de source de données BigQuery.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();

Cet exemple montre comment créer une spécification de source de données Looker. Elle renvoie un objet LookerDataSourceSpec après avoir utilisé build().

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Méthodes

Méthode	Type renvoyé	Brève description
`asBigQuery()`	`BigQueryDataSourceSpecBuilder`	Récupère le compilateur pour la source de données BigQuery.
`asLooker()`	`LookerDataSourceSpecBuilder`	Récupère le compilateur pour la source de données Looker.
`build()`	`DataSourceSpec`	Crée une spécification de source de données à partir des paramètres de cet outil de création.
`copy()`	`DataSourceSpecBuilder`	Crée un `DataSourceSpecBuilder` en fonction des paramètres de cette source de données.
`getParameters()`	`DataSourceParameter[]`	Récupère les paramètres de la source de données.
`getType()`	`DataSourceType`	Récupère le type de source de données.
`removeAllParameters()`	`DataSourceSpecBuilder`	Supprime tous les paramètres.
`removeParameter(parameterName)`	`DataSourceSpecBuilder`	Supprime le paramètre spécifié.
`setParameterFromCell(parameterName, sourceCell)`	`DataSourceSpecBuilder`	Ajoute un paramètre ou, si le paramètre portant le nom existe, met à jour sa cellule source pour les données compilateurs de spécifications sources de type `DataSourceType.BIGQUERY`.

Documentation détaillée

`asBigQuery()`

Récupère le compilateur pour la source de données BigQuery.

Renvois

BigQueryDataSourceSpecBuilder : générateur de spécifications de sources de données BigQuery.

`asLooker()`

Récupère le compilateur pour la source de données Looker.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Renvois

LookerDataSourceSpecBuilder : compilateur des spécifications de la source de données Looker.

`build()`

Crée une spécification de source de données à partir des paramètres de cet outil de création. Doit utiliser as...() pour spécifier un type de source de données avant de procéder à la compilation.

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

var 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 DataSource Looker.

var lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
var 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');
var spec = ss.getDataSources()[0].getSpec();

var newSpec = spec.copy();

Renvois

DataSourceSpecBuilder : compilateur.

`getParameters()`

Récupère 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');
var spec = ss.getDataSources()[0].getSpec();
var parameters = spec.getParameters();

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

Renvois

DataSourceParameter[] : liste des paramètres.

`getType()`

Récupère le type 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');
var spec = ss.getDataSources()[0].getSpec();
var type = spec.getType();

Renvois

DataSourceType : type de source de données.

`removeAllParameters()`

Supprime tous les paramètres.

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

Renvois

DataSourceSpecBuilder : compilateur pour le chaînage.

`removeParameter(parameterName)`

Supprime le paramètre spécifié.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

Paramètres

Nom	Type	Description
`parameterName`	`String`	Nom du paramètre à supprimer.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.

`setParameterFromCell(parameterName, sourceCell)`

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

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

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

Paramètres

Nom	Type	Description
`parameterName`	`String`	Nom du paramètre.
`sourceCell`	`String`	Cellule source, comme indiqué en notation A1.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.