Class Config

Config

Enthält die Konfigurationseinträge für einen Connector. Mit diesen Konfigurationseinträgen wird festgelegt, welche Fragen beim Hinzufügen eines neuen Connectors gestellt werden.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info_entry = config.newInfo().setId('info_id').setHelpText(
    'This connector can connect to multiple data endpoints.');

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
newCheckbox()CheckboxGibt einen neuen Konfigurationseintrag für das Kästchen zurück.
newInfo()InfoGibt einen neuen Infokonfigurationseintrag zurück.
newOptionBuilder()OptionBuilderGibt einen neuen Options-Builder zurück.
newSelectMultiple()SelectMultipleGibt einen neuen Konfigurationseintrag für die Mehrfachauswahl zurück.
newSelectSingle()SelectSingleGibt einen neuen ausgewählten einzelnen Konfigurationseintrag zurück.
newTextArea()TextAreaGibt einen neuen Konfigurationseintrag für das Textfeld zurück.
newTextInput()TextInputGibt einen neuen Konfigurationseintrag für die Texteingabe zurück.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setDateRangeRequired(dateRangeRequired)ConfigBei true wird für getData()-Anfragen ein Zeitraum angegeben.
setIsSteppedConfig(isSteppedConfig)ConfigWenn true, wird getConfig() noch einmal mit der aktuellen Nutzerkonfiguration aufgerufen.

Detaillierte Dokumentation

build()

Dieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.

Rückflug

Object: Das validierte Config-Objekt.


newCheckbox()

Gibt einen neuen Konfigurationseintrag für das Kästchen zurück.

Rückflug

Checkbox: Ein neuer Eintrag für die Kästchenkonfiguration.


newInfo()

Gibt einen neuen Infokonfigurationseintrag zurück.

Rückflug

Info – neuer Eintrag in der Infokonfiguration


newOptionBuilder()

Gibt einen neuen Options-Builder zurück.

Rückflug

OptionBuilder – Ein neuer Options-Builder.


newSelectMultiple()

Gibt einen neuen Konfigurationseintrag für die Mehrfachauswahl zurück.

Rückflug

SelectMultiple: Ein neuer Konfigurationseintrag, über den mehrere Elemente ausgewählt werden können.


newSelectSingle()

Gibt einen neuen ausgewählten einzelnen Konfigurationseintrag zurück.

Rückflug

SelectSingle – Ein neuer einzelner Konfigurationseintrag.


newTextArea()

Gibt einen neuen Konfigurationseintrag für das Textfeld zurück.

Rückflug

TextArea – Ein neuer Konfigurationseintrag für Textfelder.


newTextInput()

Gibt einen neuen Konfigurationseintrag für die Texteingabe zurück.

Rückflug

TextInput – Ein neuer Eintrag für die Texteingabekonfiguration.


printJson()

Die JSON-Darstellung dieses Objekts wird ausgegeben. Diese Option ist nur für die Fehlerbehebung gedacht.

Rückflug

String


setDateRangeRequired(dateRangeRequired)

Bei true wird für getData()-Anfragen ein Zeitraum angegeben.

Parameter

NameTypBeschreibung
dateRangeRequiredBooleanOb für getData()-Anfragen ein Zeitraum angegeben werden soll.

Rückflug

Config – Dieser Builder zur Verkettung.


setIsSteppedConfig(isSteppedConfig)

Wenn true, wird getConfig() noch einmal mit der aktuellen Nutzerkonfiguration aufgerufen.

Parameter

NameTypBeschreibung
isSteppedConfigBooleanDer zu setzende Status der abgestuften Konfiguration.

Rückflug

Config – Dieser Builder zur Verkettung.