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.

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

Methode	Rückgabetyp	Kurzbeschreibung
build()	Object	Validiert dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
newCheckbox()	Checkbox	Gibt einen neuen Konfigurationseintrag für das Kontrollkästchen 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 Konfigurationseintrag für die Mehrfachauswahl zurück.
newSelectSingle()	SelectSingle	Gibt einen neuen Konfigurationseintrag für die Auswahl einer einzelnen Option 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	Wenn true, wird getConfig() noch einmal mit der aktuellen Nutzerkonfiguration aufgerufen.

Detaillierte Dokumentation

build()

Validiert dieses Objekt und gibt es im von Data Studio benötigten Format zurück.

Rückflug

Object: Das validierte Config-Objekt.

---

newCheckbox()

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

Rückflug

Checkbox: Ein neuer Konfigurationseintrag für das Kästchen.

---

newInfo()

Gibt einen neuen Eintrag für die Informationskonfiguration zurück.

Rückflug

Info: Ein neuer Eintrag in der Informationskonfiguration.

---

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 für die Mehrfachauswahl.

---

newSelectSingle()

Gibt einen neuen Konfigurationseintrag für die Auswahl einer einzelnen Option zurück.

Rückflug

SelectSingle: Ein neuer Eintrag zum Auswählen einer einzelnen 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 Eintrag für die Konfiguration der Texteingabe.

---

printJson()

Gibt die JSON-Darstellung dieses Objekts aus. Dies dient nur zur 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()-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

Name	Typ	Beschreibung
isSteppedConfig	Boolean	Der festzulegende Status der stufenweisen Konfiguration.

Rückflug

Config – Dieser Builder zur Verkettung.