Class Config

Konfiguration

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

MethodeRückgabetypKurzbeschreibung
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
newCheckbox()CheckboxGibt einen neuen Konfigurationseintrag für ein Kästchen zurück.
newInfo()InfoGibt einen neuen Konfigurationseintrag für Informationen zurück.
newOptionBuilder()OptionBuilderGibt einen neuen Options-Builder zurück
newSelectMultiple()SelectMultipleGibt einen neuen Eintrag für die Auswahl mehrerer Konfigurationen zurück.
newSelectSingle()SelectSingleGibt einen neuen Eintrag für die Auswahl einer einzelnen Konfiguration zurück.
newTextArea()TextAreaGibt einen neuen Konfigurationseintrag für einen Textbereich zurück.
newTextInput()TextInputGibt einen neuen Konfigurationseintrag für die Texteingabe zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setDateRangeRequired(dateRangeRequired)ConfigBei true wird ein Zeitraum für getData()-Anfragen angegeben.
setIsSteppedConfig(isSteppedConfig)ConfigBei 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()

Gibt einen neuen Options-Builder zurück

Return

OptionBuilder: Ein neuer Options-Builder.


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

NameTypBeschreibung
dateRangeRequiredBooleanGibt 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

NameTypBeschreibung
isSteppedConfigBooleanDer festzulegende Status der abgestuften Konfiguration.

Return

Config: Dieser Builder für Verkettungen.