Class Config

Configuration

Contient les entrées de configuration d'un connecteur. Ces entrées de configuration définissent questions sont posées lors de l'ajout d'un connecteur.

var cc = DataStudioApp.createCommunityConnector();
var config = cc.getConfig();

var info_entry = config.newInfo()
  .setId("info_id")
  .setHelpText("This connector can connect to multiple data endpoints.");

Méthodes

MéthodeType renvoyéBrève description
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
newCheckbox()CheckboxRenvoie une nouvelle entrée de configuration de case à cocher.
newInfo()InfoRenvoie une nouvelle entrée de configuration des informations.
newOptionBuilder()OptionBuilderRenvoie un nouveau générateur d'options.
newSelectMultiple()SelectMultipleRenvoie une nouvelle entrée de configuration SELECT multiple.
newSelectSingle()SelectSingleRenvoie une nouvelle entrée de configuration unique SELECT.
newTextArea()TextAreaRenvoie une nouvelle entrée de configuration de zone de texte.
newTextInput()TextInputRenvoie une nouvelle entrée de configuration de saisie de texte.
printJson()StringAffiche la représentation JSON de cet objet.
setDateRangeRequired(dateRangeRequired)ConfigSi la valeur est true, une plage de dates est fournie pour les requêtes getData().
setIsSteppedConfig(isSteppedConfig)ConfigSi la valeur est true, getConfig() est rappelé avec la configuration utilisateur actuelle.

Documentation détaillée

build()

Valide cet objet et le renvoie au format requis par Data Studio.

Renvois

Object : objet Config validé.


newCheckbox()

Renvoie une nouvelle entrée de configuration de case à cocher.

Renvois

Checkbox : nouvelle entrée de configuration d'une case à cocher.


newInfo()

Renvoie une nouvelle entrée de configuration des informations.

Renvois

Info : nouvelle entrée de configuration des informations.


newOptionBuilder()

Renvoie un nouveau générateur d'options.

Renvois

OptionBuilder : nouveau générateur d'options.


newSelectMultiple()

Renvoie une nouvelle entrée de configuration SELECT multiple.

Renvois

SelectMultiple : nouvelle entrée de configuration multiple.


newSelectSingle()

Renvoie une nouvelle entrée de configuration unique SELECT.

Renvois

SelectSingle : nouvelle entrée de configuration unique sélectionnée.


newTextArea()

Renvoie une nouvelle entrée de configuration de zone de texte.

Renvois

TextArea : nouvelle entrée de configuration de zone de texte.


newTextInput()

Renvoie une nouvelle entrée de configuration de saisie de texte.

Renvois

TextInput : nouvelle entrée de configuration de saisie de texte.


printJson()

Affiche la représentation JSON de cet objet. Il n'est utilisé qu'à des fins de débogage.

Renvois

String


setDateRangeRequired(dateRangeRequired)

Si la valeur est true, une plage de dates est fournie pour les requêtes getData().

Paramètres

NomTypeDescription
dateRangeRequiredBooleanIndique si une plage de dates doit être fournie ou non à getData() requêtes.

Renvois

Config : compilateur pour le chaînage.


setIsSteppedConfig(isSteppedConfig)

Si la valeur est true, getConfig() est rappelé avec la configuration utilisateur actuelle.

Paramètres

NomTypeDescription
isSteppedConfigBooleanÉtat de la configuration échelonnée à définir.

Renvois

Config : compilateur pour le chaînage.