Contient des informations spécifiques à la configuration. Ses propriétés déterminent la façon dont la sélection unique s'affiche dans Data Studio.
const cc = DataStudioApp.createCommunityConnector(); const config = cc.getConfig(); const option1 = config.newOptionBuilder().setLabel('option label').setValue('option_value'); const option2 = config.newOptionBuilder() .setLabel('second option label') .setValue('option_value_2'); const info1 = config.newSelectSingle() .setId('api_endpoint') .setName('Data Type') .setHelpText('Select the data type you\'re interested in.') .setAllowOverride(true) .addOption(option1) .addOption(option2);
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
add | Select | Ajoute une nouvelle option de sélection. |
set | Select | Active le forçage pour cette entrée de configuration. |
set | Select | Définit le texte d'aide pour cette entrée de configuration. |
set | Select | Définit l'ID unique de cette entrée de configuration. |
set | Select | Définit l'état dynamique de cette entrée de configuration. |
set | Select | Définit le nom à afficher pour cette entrée de configuration. |
Documentation détaillée
addOption(optionBuilder)
Ajoute une nouvelle option de sélection.
Paramètres
Nom | Type | Description |
---|---|---|
option | Option | Compilateur d'une option. |
Renvois
Select
: ce générateur, pour le chaînage.
setAllowOverride(allowOverride)
Active le forçage pour cette entrée de configuration. Si la valeur est true
, les créateurs de sources de données peuvent l'activer pour les éditeurs de rapports.
Paramètres
Nom | Type | Description |
---|---|---|
allow | Boolean | Indique si cette entrée de configuration peut être ignorée dans les rapports. |
Renvois
Select
: ce générateur, pour le chaînage.
setHelpText(helpText)
Définit le texte d'aide pour cette entrée de configuration.
Paramètres
Nom | Type | Description |
---|---|---|
help | String | Texte d'aide à définir. |
Renvois
Select
: ce générateur, pour le chaînage.
setId(id)
Définit l'ID unique de cette entrée de configuration.
Paramètres
Nom | Type | Description |
---|---|---|
id | String | ID à définir. |
Renvois
Select
: ce générateur, pour le chaînage.
setIsDynamic(isDynamic)
Définit l'état dynamique de cette entrée de configuration.
Si une entrée de configuration dynamique est modifiée, les entrées de configuration suivantes sont effacées.
Paramètres
Nom | Type | Description |
---|---|---|
is | Boolean | État dynamique à définir. |
Renvois
Select
: ce générateur, pour le chaînage.
setName(name)
Définit le nom à afficher pour cette entrée de configuration.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom à définir. |
Renvois
Select
: ce générateur, pour le chaînage.