Enthält die Konfigurationseinträge für einen Connector. Diese Konfigurationseinträge definieren, werden beim Hinzufügen eines neuen Connectors Fragen gestellt.
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.");
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
build() | Object | Validiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück. |
newCheckbox() | Checkbox | Gibt einen neuen Eintrag für die Kästchenkonfiguration zurück. |
newInfo() | Info | Gibt einen neuen Eintrag für die Informationskonfiguration zurück. |
newOptionBuilder() | OptionBuilder | Gibt einen neuen Options-Builder zurück |
newSelectMultiple() | SelectMultiple | Gibt einen neuen Eintrag zur Auswahl mehrerer Konfigurationen zurück. |
newSelectSingle() | SelectSingle | Gibt einen neuen Eintrag zur Auswahl einer Konfiguration zurück. |
newTextArea() | TextArea | Gibt einen neuen Konfigurationseintrag für den Textbereich zurück. |
newTextInput() | TextInput | Gibt einen neuen Konfigurationseintrag für die Texteingabe zurück. |
printJson() | String | Gibt die JSON-Darstellung dieses Objekts aus. |
setDateRangeRequired(dateRangeRequired) | Config | Bei true wird ein Zeitraum für getData()-Anfragen angegeben. |
setIsSteppedConfig(isSteppedConfig) | Config | Bei true wird getConfig() noch einmal mit der aktuellen Nutzerkonfiguration aufgerufen. |
Detaillierte Dokumentation
build()
Validiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück.
Rückflug
Object
: Das validierte Config
-Objekt.
newCheckbox()
Gibt einen neuen Eintrag für die Kästchenkonfiguration zurück.
Rückflug
Checkbox
: Ein neuer Eintrag für die Kästchenkonfiguration.
newInfo()
Gibt einen neuen Eintrag für die Informationskonfiguration zurück.
Rückflug
Info
: Ein neuer Eintrag für die Informationskonfiguration.
newOptionBuilder()
newSelectMultiple()
Gibt einen neuen Eintrag zur Auswahl mehrerer Konfigurationen zurück.
Rückflug
SelectMultiple
: Ein neuer Eintrag zur Auswahl mehrerer Konfigurationen.
newSelectSingle()
Gibt einen neuen Eintrag zur Auswahl einer Konfiguration zurück.
Rückflug
SelectSingle
: Ein neuer Eintrag zur Auswahl einer Konfiguration.
newTextArea()
Gibt einen neuen Konfigurationseintrag für den Textbereich zurück.
Rückflug
TextArea
: Ein neuer Konfigurationseintrag für den Textbereich.
newTextInput()
Gibt einen neuen Konfigurationseintrag für die Texteingabe zurück.
Rückflug
TextInput
: Ein neuer Konfigurationseintrag für die Texteingabe.
printJson()
Gibt die JSON-Darstellung dieses Objekts aus. Dies dient nur der Fehlerbehebung.
Rückflug
String
setDateRangeRequired(dateRangeRequired)
Bei true
wird ein Zeitraum für getData()-Anfragen angegeben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
dateRangeRequired | Boolean | Gibt an, ob für getData() ein Zeitraum angegeben werden soll
-Anfragen. |
Rückflug
Config
: Dieser Builder für Verkettungen.
setIsSteppedConfig(isSteppedConfig)
Bei true
wird getConfig()
noch einmal mit der aktuellen Nutzerkonfiguration aufgerufen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
isSteppedConfig | Boolean | Der festzulegende Konfigurationsstatus mit Schritten. |
Rückflug
Config
: Dieser Builder für Verkettungen.