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