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éthode | Type renvoyé | Brève description |
---|---|---|
build() | Object | Valide cet objet et le renvoie au format requis par Data Studio. |
newCheckbox() | Checkbox | Renvoie une nouvelle entrée de configuration de case à cocher. |
newInfo() | Info | Renvoie une nouvelle entrée de configuration des informations. |
newOptionBuilder() | OptionBuilder | Renvoie un nouveau générateur d'options. |
newSelectMultiple() | SelectMultiple | Renvoie une nouvelle entrée de configuration SELECT multiple. |
newSelectSingle() | SelectSingle | Renvoie une nouvelle entrée de configuration unique SELECT. |
newTextArea() | TextArea | Renvoie une nouvelle entrée de configuration de zone de texte. |
newTextInput() | TextInput | Renvoie une nouvelle entrée de configuration de saisie de texte. |
printJson() | String | Affiche la représentation JSON de cet objet. |
setDateRangeRequired(dateRangeRequired) | Config | Si la valeur est true , une plage de dates est fournie pour les requêtes getData(). |
setIsSteppedConfig(isSteppedConfig) | Config | Si 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()
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
Nom | Type | Description |
---|---|---|
dateRangeRequired | Boolean | Indique 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
Nom | Type | Description |
---|---|---|
isSteppedConfig | Boolean | État de la configuration échelonnée à définir. |
Renvois
Config
: compilateur pour le chaînage.