Class Config

Configuration

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

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

const 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 d'informations.
newOptionBuilder()OptionBuilderRenvoie un nouvel outil de création d'options.
newSelectMultiple()SelectMultipleRenvoie une nouvelle entrée de configuration de sélection multiple.
newSelectSingle()SelectSingleRenvoie une nouvelle entrée de configuration sélectionnée.
newTextArea()TextAreaRenvoie une nouvelle entrée de configuration de zone de texte.
newTextInput()TextInputRenvoie une nouvelle entrée de configuration d'entrée de texte.
printJson()StringImprime 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 true, getConfig() est appelé à nouveau 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 de case à cocher.


newInfo()

Renvoie une nouvelle entrée de configuration d'informations.

Renvois

Info : nouvelle entrée de configuration d'informations.


newOptionBuilder()

Renvoie un nouvel outil de création d'options.

Renvois

OptionBuilder : nouveau compilateur d'options.


newSelectMultiple()

Renvoie une nouvelle entrée de configuration de sélection multiple.

Renvois

SelectMultiple : nouvelle entrée de sélection multiple de configuration.


newSelectSingle()

Renvoie une nouvelle entrée de configuration sélectionnée.

Renvois

SelectSingle : nouvelle entrée de configuration à sélectionner.


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 d'entrée de texte.

Renvois

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


printJson()

Imprime la représentation JSON de cet objet. Cette option est réservée au 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 aux requêtes getData().

Renvois

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


setIsSteppedConfig(isSteppedConfig)

Si true, getConfig() est appelé à nouveau avec la configuration utilisateur actuelle.

Paramètres

NomTypeDescription
isSteppedConfigBooleanÉtat de la configuration par étapes à définir.

Renvois

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