Data Studio Service

Data Studio

Über diesen Dienst können Skripts auf Data Studio-Community-Connectors zugreifen und diese ändern.

Kurse

NameKurzbeschreibung
AggregationTypeEin Enum-Wert, der die Zusammenfassungstypen definiert, die für eine Field festgelegt werden können.
AuthTypeEin Enum-Wert, der die Authentifizierungstypen definiert, die für einen Connector festgelegt werden können.
BigQueryConfigEin Konfigurationsobjekt für einen nativen BigQuery-Connector.
BigQueryParameterTypeEin Enum-Wert, der die BigQuery-Parametertypen definiert, die Sie festlegen können.
CheckboxEnthält Kästcheninformationen für die Konfiguration.
CommunityConnectorMit CommunityConnector können Skripts auf Builder und Dienstprogramme zugreifen, die bei der Entwicklung von Community-Connectors für Data Studio helfen.
ConfigEnthält die Konfigurationseinträge für einen Connector.
DataStudioAppÜber DataStudioApp können Skripts mit entwicklerorientierten Funktionen für Data Studio interagieren.
DebugErrorEin Fehler, der nur Administratoren des Connectors sichtbar ist.
FieldEnthält feldbezogene Daten.
FieldTypeEin Enum-Wert, der die Typen definiert, die für ein Field festgelegt werden können.
FieldsEnthält eine Reihe von Fields für einen Community-Connector.
GetAuthTypeResponseBuilder zum Erstellen einer getAuthType()-Antwort für Ihr Skriptprojekt
GetDataResponseBuilder zum Erstellen einer getData()-Antwort für Ihr Skriptprojekt
GetSchemaResponseBuilder zum Erstellen einer getSchema()-Antwort für Ihr Skriptprojekt
InfoEnthält Informationen zur Konfiguration.
OptionBuilderEin Builder zum Erstellen von Optionen für SelectSingles und SelectMultiples.
SelectMultipleEnthält ausgewählte Informationen für die Konfiguration.
SelectSingleEnthält ausgewählte Informationen für die Konfiguration.
SetCredentialsResponseBuilder zum Erstellen einer setCredentials()-Antwort für Ihr Skriptprojekt
TextAreaEnthält Informationen zum Textbereich für die Konfiguration.
TextInputEnthält Texteingabeinformationen für die Konfiguration.
UserErrorEin Fehler, der Nutzern des Connectors angezeigt wird.

AggregationType

Attribute

PropertyTypBeschreibung
AVGEnumDurchschnitt.
COUNTEnumCount (Anzahl).
COUNT_DISTINCTEnumEinzeln zählen.
MAXEnumMax.
MINEnumMin.
SUMEnumSumme:
AUTOEnumAutomatisch.

AuthType

Attribute

PropertyTypBeschreibung
NONEEnumKeine Autorisierung erforderlich.
OAUTH2EnumOAuth2-Autorisierung erforderlich.
USER_PASSEnumAnmeldedaten für Nutzername und Passwort erforderlich.
PATH_USER_PASSEnumNutzername, Pfad und Passwort erforderlich.
PATH_KEYEnumPfad und Schlüssel erforderlich.
KEYEnumAPI-Schlüssel oder Token erforderlich.
USER_TOKENEnumNutzername und Token erforderlich.

BigQueryConfig

Methoden

MethodeRückgabetypKurzbeschreibung
addQueryParameter(name, type, value)BigQueryConfigFügt diesem BigQueryConfig einen Abfrageparameter hinzu.
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAccessToken(accessToken)BigQueryConfigLegt das Zugriffstoken von BigQueryConfig fest.
setBillingProjectId(billingProjectId)BigQueryConfigLegt die Abrechnungsprojekt-ID für diesen BigQueryConfig fest.
setQuery(query)BigQueryConfigLegt die SQL-Abfrage dieser BigQueryConfig fest.
setUseStandardSql(useStandardSql)BigQueryConfigBestimmt, ob die Abfrage als Standard- oder Legacy-SQL interpretiert wird.

BigQueryParameterType

Attribute

PropertyTypBeschreibung
STRINGEnumString.
INT64Enum64-Bit-Ganzzahl.
BOOLEnumBoolescher Wert.
FLOAT64Enum64-Bit-Gleitkommazahl.

Checkbox

Methoden

MethodeRückgabetypKurzbeschreibung
setAllowOverride(allowOverride)CheckboxAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)CheckboxLegt den Hilfetext für diesen Konfigurationseintrag fest.
setId(id)CheckboxLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setIsDynamic(isDynamic)CheckboxLegt den dynamischen Status für diesen Konfigurationseintrag fest.
setName(name)CheckboxLegt den Anzeigenamen für diesen Konfigurationseintrag fest.

CommunityConnector

Attribute

PropertyTypBeschreibung
AggregationTypeAggregationTypeDie AggregationType-Aufzählung.
AuthTypeAuthTypeDie AuthType-Aufzählung.
BigQueryParameterTypeBigQueryParameterTypeDie BigQueryParameterType-Aufzählung.
FieldTypeFieldTypeDie FieldType-Aufzählung.

Methoden

MethodeRückgabetypKurzbeschreibung
getConfig()ConfigGibt ein Config-Objekt zurück.
getFields()FieldsGibt ein Fields-Objekt zurück.
newAuthTypeResponse()GetAuthTypeResponseGibt ein neues GetAuthTypeResponse-Objekt zurück.
newBigQueryConfig()BigQueryConfigGibt ein neues BigQueryConfig-Objekt zurück.
newDebugError()DebugErrorGibt ein neues DebugError-Objekt zurück.
newGetDataResponse()GetDataResponseGibt ein neues GetDataResponse-Objekt zurück.
newGetSchemaResponse()GetSchemaResponseGibt ein neues GetSchemaResponse-Objekt zurück.
newSetCredentialsResponse()SetCredentialsResponseGibt ein neues SetCredentialsResponse-Objekt zurück.
newUserError()UserErrorGibt ein neues UserError-Objekt zurück.

Config

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.

DataStudioApp

Methoden

MethodeRückgabetypKurzbeschreibung
createCommunityConnector()CommunityConnectorErstellt einen neuen Community-Connector.

DebugError

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setText(text)DebugErrorLegt den Text des Fehlerbehebungsfehlers fest, der nur Administratoren angezeigt wird.
throwException()voidLöst diese Ausnahme aus, die ausgelöst werden soll.

Field

Methoden

MethodeRückgabetypKurzbeschreibung
getAggregation()AggregationTypeGibt den AggregationType von Field zurück.
getDescription()StringGibt die Beschreibung von Field zurück.
getFormula()StringGibt die Formel von Field zurück.
getGroup()StringGibt die Gruppe von Field zurück.
getId()StringGibt die ID für diesen Field zurück.
getIsReaggregatable()BooleanGibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false.
getName()StringGibt den Namen von Field zurück
getType()FieldTypeGibt den FieldType von Field zurück.
isDefault()BooleanGibt true zurück, wenn Field der Standardmesswert oder die Standarddimension ist.
isDimension()BooleanGibt true zurück, wenn dieses Feld eine Dimension ist.
isHidden()BooleanGibt true zurück, wenn diese Field ausgeblendet ist.
isMetric()BooleanGibt true zurück, wenn dieses Feld ein Messwert ist.
setAggregation(aggregation)FieldLegt den Zusammenfassungstyp für diesen Field fest.
setDescription(description)FieldLegt die Beschreibung dieses Field fest.
setFormula(formula)FieldLegt die Formel für diesen Field fest.
setGroup(group)FieldLegt die Gruppe von Field fest.
setId(id)FieldLegt die ID dieses Field fest.
setIsHidden(isHidden)FieldLegt den ausgeblendeten Status dieses Field fest.
setIsReaggregatable(isReaggregatable)FieldLegt den Status für die erneute Aggregation für einen Field fest.
setName(name)FieldLegt den Namen der Field fest.
setType(type)FieldLegt den FieldType von Field fest.

FieldType

Attribute

PropertyTypBeschreibung
YEAREnumJahr im Format JJJJ, z. B. 2017.
YEAR_QUARTEREnumJahr und Quartal im Format JJJJQ, z. B. 20171.
YEAR_MONTHEnumJahr und Monat im Format JJJJMM, z. B. 201703.
YEAR_WEEKEnumJahr und Woche im Format JJJJww, z. B. 201707.
YEAR_MONTH_DAYEnumJahr, Monat und Tag im Format JJJJMMTT, z. B. 20170317.
YEAR_MONTH_DAY_HOUREnumJahr, Monat, Tag und Stunde im Format JJJJMMTThh, z. B. 2017031703.
YEAR_MONTH_DAY_MINUTEEnumJahr, Monat, Tag, Stunde und Minute im Format JJJJMMTTHHmm, z. B. 201703170230.
YEAR_MONTH_DAY_SECONDEnumJahr, Monat, Tag, Stunde, Minute und Sekunde im Format JJJJMMTTHHmmss, z. B. 20170317023017.
QUARTEREnumQuartal im Format 1, 2, 3 oder 4).
MONTHEnumMonat im Format MM, z. B. 03.
WEEKEnumWoche im Format ww, z. B. 07.
MONTH_DAYEnumMonat und Tag im Format MMTT, z. B. 0317.
DAY_OF_WEEKEnumEine Zahl im Bereich von [0,6], wobei 0 für Sonntag steht.
DAYEnumTag im TT-Format, z. B. 17.
HOUREnumStunden im Format HH, z. B. 13.
MINUTEEnumMinuten im mm-Format, z. B. 12.
DURATIONEnumEine Zeitdauer in Sekunden.
COUNTRYEnumEin Land, z. B. USA.
COUNTRY_CODEEnumEinen Ländercode, z. B. US.
CONTINENTEnumEin Kontinent, z. B. Nord- und Südamerika.
CONTINENT_CODEEnumEinen Kontinentcode wie 019.
SUB_CONTINENTEnumEin Subkontinent, z. B. Nordamerika.
SUB_CONTINENT_CODEEnumEin Subkontinentcode wie 003.
REGIONEnumEine Region wie Kalifornien.
REGION_CODEEnumEinen Regionscode wie „CA“.
CITYEnumEine Stadt wie Mountain View.
CITY_CODEEnumEin Städtecode wie 1014044.
METROEnumEine Metropolregion wie beispielsweise San Francisco-Oakland-San Jose CA
METRO_CODEEnumEin Großraumcode wie 200807.
LATITUDE_LONGITUDEEnumEin Breitengrad/Längengrad-Paar wie 51,5074, -0,1278.
NUMBEREnumEine Dezimalzahl.
PERCENTEnumProzentualer Dezimalwert (kann über 1,0 liegen).
TEXTEnumFreier Text.
BOOLEANEnumEin boolescher Wert für true oder false.
URLEnumEine URL wie z. B. https://google.com.
HYPERLINKEnumEinen Hyperlink.
IMAGEEnumEin Bild.
IMAGE_LINKEnumEinen Bildlink.
CURRENCY_AEDEnumWährung aus AED.
CURRENCY_ALLEnumWährung aus ALL.
CURRENCY_ARSEnumWährung aus AR.
CURRENCY_AUDEnumWährung aus AUD.
CURRENCY_BDTEnumWährung aus BDT.
CURRENCY_BGNEnumWährung aus BGN.
CURRENCY_BOBEnumWährung aus „BOB“.
CURRENCY_BRLEnumWährung aus BRL.
CURRENCY_CADEnumWährung aus CAD.
CURRENCY_CDFEnumWährung der CDF.
CURRENCY_CHFEnumWährung ab CHF.
CURRENCY_CLPEnumWährung aus CLP.
CURRENCY_CNYEnumWährung aus CNY.
CURRENCY_COPEnumWährung aus COP.
CURRENCY_CRCEnumWährung aus CRC.
CURRENCY_CZKEnumWährung aus CZK.
CURRENCY_DKKEnumWährung aus DKK.
CURRENCY_DOPEnumWährung aus DOP.
CURRENCY_EGPEnumWährung aus EGP.
CURRENCY_ETBEnumWährung aus ETB.
CURRENCY_EUREnumWährung von EUR.
CURRENCY_GBPEnumWährung aus GBP.
CURRENCY_HKDEnumWährung aus HKD.
CURRENCY_HRKEnumWährung aus HRK.
CURRENCY_HUFEnumWährung aus HUF.
CURRENCY_IDREnumWährung aus indonesischen Rupiah (IDR).
CURRENCY_ILSEnumWährung aus ILS.
CURRENCY_INREnumWährung aus INR.
CURRENCY_IRREnumWährung aus IRR.
CURRENCY_ISKEnumWährung aus ISK.
CURRENCY_JMDEnumWährung aus JMD.
CURRENCY_JPYEnumWährung aus JPY.
CURRENCY_KRWEnumWährung aus KRW.
CURRENCY_LKREnumWährung aus LKR.
CURRENCY_LTLEnumWährung aus LTL.
CURRENCY_MNTEnumWährung aus MNT.
CURRENCY_MVREnumWährung aus MVR.
CURRENCY_MXNEnumWährung aus MXN.
CURRENCY_MYREnumWährung aus MYR.
CURRENCY_NGNEnumWährung aus NGN.
CURRENCY_NOKEnumWährung aus NOK.
CURRENCY_NZDEnumWährung aus NZD.
CURRENCY_PABEnumWährung aus PAB.
CURRENCY_PENEnumWährung aus PEN.
CURRENCY_PHPEnumWährung aus PHP.
CURRENCY_PKREnumWährung aus PKR.
CURRENCY_PLNEnumWährung aus PLN.
CURRENCY_RONEnumWährung aus RON.
CURRENCY_RSDEnumWährung aus RSD.
CURRENCY_RUBEnumWährung aus RUB.
CURRENCY_SAREnumWährung aus SAR.
CURRENCY_SEKEnumWährung aus SEK.
CURRENCY_SGDEnumWährung aus SGD.
CURRENCY_THBEnumWährung aus THB.
CURRENCY_TRYEnumWährung aus TRY.
CURRENCY_TWDEnumWährung aus TWD.
CURRENCY_TZSEnumWährung aus TZS.
CURRENCY_UAHEnumWährung aus UA.
CURRENCY_USDEnumWährung von USD.
CURRENCY_UYUEnumWährung aus UYU.
CURRENCY_VEFEnumWährung aus VEF.
CURRENCY_VNDEnumWährung aus VND.
CURRENCY_YEREnumWährung aus YER.
CURRENCY_ZAREnumWährung aus ZAR.

Fields

Methoden

MethodeRückgabetypKurzbeschreibung
asArray()Field[]Gibt eine Ansicht dieses Objekts als Array zurück.
build()Object[]Validiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
forIds(ids)FieldsGibt ein neues Fields-Objekt zurück, das nach Fields mit einer ID in ids gefiltert wird.
getDefaultDimension()FieldGibt die Standarddimension zurück, die für den Satz von Feldern verwendet werden soll.
getDefaultMetric()FieldGibt den Standardmesswert zurück, der für die Gruppe von Feldern verwendet werden soll.
getFieldById(fieldId)FieldGibt ein Feld mit einer bestimmten ID oder null zurück, wenn sich in diesem Fields-Objekt kein Feld mit dieser ID befindet.
newDimension()FieldGibt die neue Dimension Field zurück.
newMetric()FieldGibt den neuen Messwert Field zurück.
setDefaultDimension(fieldId)voidLegt die Standarddimension fest, die für die Gruppe von Feldern verwendet werden soll.
setDefaultMetric(fieldId)voidLegt den Standardmesswert fest, der für die Gruppe von Feldern verwendet werden soll.

GetAuthTypeResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAuthType(authType)GetAuthTypeResponseLegt den AuthType des Builders fest.
setHelpUrl(helpUrl)GetAuthTypeResponseLegt die Hilfe-URL des Generators fest.

GetDataResponse

Methoden

MethodeRückgabetypKurzbeschreibung
addAllRows(rows)GetDataResponseFügt dieser GetDataResponse mehrere Datenzeilen hinzu.
addRow(row)GetDataResponseFügt dieser GetDataResponse eine Datenzeile hinzu.
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
setFields(fields)GetDataResponseLegt den Fields des Builders fest.
setFiltersApplied(filtersApplied)GetDataResponseLegt den Status der angewendeten Filter für diesen Builder fest.

GetSchemaResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setFields(fields)GetSchemaResponseLegt den Fields des Builders fest.

Info

Methoden

MethodeRückgabetypKurzbeschreibung
setId(id)InfoLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setText(text)InfoLegt den Text für diesen Konfigurationseintrag fest.

OptionBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
setLabel(label)OptionBuilderLegt das Label dieses Tools zur Erstellung von Optionen fest.
setValue(value)OptionBuilderLegt den Wert dieses Options-Builders fest.

SelectMultiple

Methoden

MethodeRückgabetypKurzbeschreibung
addOption(optionBuilder)SelectMultipleFügt eine neue Auswahloption hinzu.
setAllowOverride(allowOverride)SelectMultipleAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)SelectMultipleLegt den Hilfetext für diesen Konfigurationseintrag fest.
setId(id)SelectMultipleLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setIsDynamic(isDynamic)SelectMultipleLegt den dynamischen Status für diesen Konfigurationseintrag fest.
setName(name)SelectMultipleLegt den Anzeigenamen für diesen Konfigurationseintrag fest.

SelectSingle

Methoden

MethodeRückgabetypKurzbeschreibung
addOption(optionBuilder)SelectSingleFügt eine neue Auswahloption hinzu.
setAllowOverride(allowOverride)SelectSingleAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)SelectSingleLegt den Hilfetext für diesen Konfigurationseintrag fest.
setId(id)SelectSingleLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setIsDynamic(isDynamic)SelectSingleLegt den dynamischen Status für diesen Konfigurationseintrag fest.
setName(name)SelectSingleLegt den Anzeigenamen für diesen Konfigurationseintrag fest.

SetCredentialsResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectValidiert das Objekt und gibt es in dem für Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setIsValid(isValid)SetCredentialsResponseLegt den gültigen Status dieses SetCredentialsResponse fest.

TextArea

Methoden

MethodeRückgabetypKurzbeschreibung
setAllowOverride(allowOverride)TextAreaAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)TextAreaLegt den Hilfetext für diesen Konfigurationseintrag fest.
setId(id)TextAreaLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setIsDynamic(isDynamic)TextAreaLegt den dynamischen Status für diesen Konfigurationseintrag fest.
setName(name)TextAreaLegt den Anzeigenamen für diesen Konfigurationseintrag fest.
setPlaceholder(placeholder)TextAreaLegt den Platzhaltertext für diesen Konfigurationseintrag fest.

TextInput

Methoden

MethodeRückgabetypKurzbeschreibung
setAllowOverride(allowOverride)TextInputAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)TextInputLegt den Hilfetext für diesen Konfigurationseintrag fest.
setId(id)TextInputLegt die eindeutige ID für diesen Konfigurationseintrag fest.
setIsDynamic(isDynamic)TextInputLegt den dynamischen Status für diesen Konfigurationseintrag fest.
setName(name)TextInputLegt den Anzeigenamen für diesen Konfigurationseintrag fest.
setPlaceholder(placeholder)TextInputLegt den Platzhaltertext für diesen Konfigurationseintrag fest.

UserError

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setDebugText(text)UserErrorLegt den Text des Fehlerbehebungsfehlers fest, der nur Administratoren angezeigt wird.
setText(text)UserErrorLegt den Text für den Nutzerfehler fest.
throwException()voidLöst diese Ausnahme aus, die ausgelöst werden soll.