Data Studio Service

Data Studio

Mit diesem Dienst können Skripts auf Community-Connectors in Data Studio zugreifen und diese ändern.

Klassen

NameKurzbeschreibung
AggregationTypeEin Enum, das die Zusammenfassungstypen definiert, die für ein Field festgelegt werden können.
AuthTypeEine Enumeration, die die Authentifizierungstypen definiert, die für einen Connector festgelegt werden können.
BigQueryConfigEin Konfigurationsobjekt für einen nativen BigQuery-Connector.
BigQueryParameterTypeEine Enumeration, die die BigQuery-Parametertypen definiert, die Sie festlegen können.
CheckboxEnthält Informationen zu Kontrollkästchen 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 hilfreich sind.
ConfigEnthält die Konfigurationseinträge für einen Connector.
DataStudioAppMit DataStudioApp können Skripts mit entwicklerorientierten Funktionen für Data Studio interagieren.
DebugErrorEin Fehler, der nur für Administratoren des Connectors sichtbar ist.
FieldEnthält feldbezogene Daten.
FieldTypeEin Enum, das die Typen definiert, die für ein Field festgelegt werden können.
FieldsEnthält eine Reihe von Field für einen Community-Connector.
GetAuthTypeResponseBuilder zum Erstellen einer getAuthType()-Antwort für Ihr Script-Projekt.
GetDataResponseBuilder zum Erstellen einer getData()-Antwort für Ihr Script-Projekt.
GetSchemaResponseBuilder zum Erstellen einer getSchema()-Antwort für Ihr Script-Projekt.
InfoEnthält Infodaten für die Konfiguration.
OptionBuilderEin Builder zum Erstellen von Optionen für SelectSingles und SelectMultiples.
SelectMultipleEnthält mehrere Informationen für die Konfiguration.
SelectSingleEnthält ausgewählte Einzelinformationen für die Konfiguration.
SetCredentialsResponseBuilder zum Erstellen einer setCredentials()-Antwort für Ihr Script-Projekt.
TextAreaEnthält Informationen zum Textbereich für die Konfiguration.
TextInputEnthält Informationen zur Texteingabe für die Konfiguration.
UserErrorEin Fehler, der Nutzern des Connectors angezeigt wird.

AggregationType

Properties

AttributTypBeschreibung
AVGEnumDurchschnitt
COUNTEnumAnzahl.
COUNT_DISTINCTEnumEinzeln zählen
MAXEnumMax.
MINEnumMin.
SUMEnumSumme:
AUTOEnumAutomatisch.

AuthType

Properties

AttributTypBeschreibung
NONEEnumKeine Autorisierung erforderlich.
OAUTH2EnumOAuth2-Autorisierung erforderlich.
USER_PASSEnumNutzername und Passwort sind erforderlich.
PATH_USER_PASSEnumNutzername, Pfad und Passwort sind erforderlich.
PATH_KEYEnumPfad und Schlüssel erforderlich.
KEYEnumAPI-Schlüssel oder ‑Token erforderlich.
USER_TOKENEnumNutzername und Token sind erforderlich.

BigQueryConfig

Methoden

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

BigQueryParameterType

Properties

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

Checkbox

Methoden

MethodeRückgabetypKurzbeschreibung
setAllowOverride(allowOverride)CheckboxErmöglicht 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

Properties

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

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 dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
newCheckbox()CheckboxGibt einen neuen Konfigurationseintrag für das Kontrollkästchen zurück.
newInfo()InfoGibt einen neuen Eintrag für die Informationskonfiguration 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 Konfigurationseintrag für die Auswahl einer einzelnen Option zurück.
newTextArea()TextAreaGibt einen neuen Konfigurationseintrag für den 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)ConfigWenn true, wird getConfig() noch einmal mit der aktuellen Nutzerkonfiguration 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 Debug-Fehlers fest, der nur Administratoren angezeigt wird.
throwException()voidLöst das Auslösen dieser Ausnahme aus.

Field

Methoden

MethodeRückgabetypKurzbeschreibung
getAggregation()AggregationTypeGibt die AggregationType dieses Field zurück.
getDescription()StringGibt die Beschreibung dieses Field zurück.
getFormula()StringGibt die Formel dieses Field zurück.
getGroup()StringGibt die Gruppe dieses Field zurück.
getId()StringGibt die ID dieses Field zurück.
getIsReaggregatable()BooleanGibt true zurück, wenn dieses Feld neu aggregiert werden kann, andernfalls false.
getName()StringGibt den Namen dieses Field zurück.
getType()FieldTypeGibt die FieldType dieses Field zurück.
isDefault()BooleanGibt true zurück, wenn dieser 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 Aggregationstyp dieses Field fest.
setDescription(description)FieldLegt die Beschreibung dieses Field fest.
setFormula(formula)FieldLegt die Formel für diese Field fest.
setGroup(group)FieldLegt die Gruppe für dieses Field fest.
setId(id)FieldLegt die ID für dieses Field fest.
setIsHidden(isHidden)FieldLegt den verborgenen Status von Field fest.
setIsReaggregatable(isReaggregatable)FieldLegt den Status „Reaggregation zulässig“ für eine Field fest.
setName(name)FieldLegt den Namen dieser Field fest.
setType(type)FieldLegt FieldType für Field fest.

FieldType

Properties

AttributTypBeschreibung
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 [0,6], wobei 0 für Sonntag steht.
DAYEnumTag im Format TT, z. B. 17.
HOUREnumStunde im Format HH, z. B. 13.
MINUTEEnumMinute im Format „mm“, z. B. „12“.
DURATIONEnumEine Zeitdauer in Sekunden.
COUNTRYEnumEin Land wie die USA.
COUNTRY_CODEEnumEin Ländercode wie US.
CONTINENTEnumEin Kontinent wie Amerika.
CONTINENT_CODEEnumEin Kontinentcode, z. B. 019.
SUB_CONTINENTEnumEin Subkontinent wie Nordamerika.
SUB_CONTINENT_CODEEnumEin Unterkontinentcode, z. B. 003.
REGIONEnumEine Region wie Kalifornien.
REGION_CODEEnumEin Regionscode wie CA.
CITYEnumEine Stadt wie Mountain View.
CITY_CODEEnumEin Stadtcode, z. B. 1014044.
METROEnumEin Ballungsraum wie San Francisco-Oakland-San Jose CA.
METRO_CODEEnumEin Großraumcode, z. B. 200807.
LATITUDE_LONGITUDEEnumEin Paar aus Breiten- und Längengrad, z. B. 51.5074, -0.1278.
NUMBEREnumEine Dezimalzahl.
PERCENTEnumDezimalprozentsatz (kann über 1,0 liegen).
TEXTEnumFreitext.
BOOLEANEnumEin boolescher Wert (true oder false).
URLEnumEine URL als Text, z. B. https://google.com.
HYPERLINKEnumEin Hyperlink.
IMAGEEnumEin Bild.
IMAGE_LINKEnumEin Bildlink.
CURRENCY_AEDEnumWährung aus AED.
CURRENCY_ALLEnumWährung aus ALL.
CURRENCY_ARSEnumWährung ab ARS.
CURRENCY_AUDEnumWährung aus AUD.
CURRENCY_BDTEnumWährung aus BDT.
CURRENCY_BGNEnumWährung aus BGN.
CURRENCY_BOBEnumWährung von BOB.
CURRENCY_BRLEnumWährung aus BRL.
CURRENCY_CADEnumWährung aus CAD.
CURRENCY_CDFEnumWährung aus CDF.
CURRENCY_CHFEnumWährung: CHF
CURRENCY_CLPEnumWährung aus CLP.
CURRENCY_CNYEnumWährung aus CNY.
CURRENCY_COPEnumWährung aus COP.
CURRENCY_CRCEnumWährung aus CRC.
CURRENCY_CZKEnumWährung: CZK
CURRENCY_DKKEnumWährung ab DKK.
CURRENCY_DOPEnumWährung aus dem DOP.
CURRENCY_EGPEnumWährung: EGP
CURRENCY_ETBEnumWährung aus ETB.
CURRENCY_EUREnumWährung aus EUR.
CURRENCY_GBPEnumWährung aus GBP.
CURRENCY_HKDEnumWährung aus HKD.
CURRENCY_HRKEnumWährung aus HRK.
CURRENCY_HUFEnumWährung: HUF
CURRENCY_IDREnumWährung aus IDR.
CURRENCY_ILSEnumWährung aus ILS.
CURRENCY_INREnumWährung ab INR.
CURRENCY_IRREnumWährung aus dem internen Zinsfuß.
CURRENCY_ISKEnumWährung aus ISK.
CURRENCY_JMDEnumWährung aus JMD.
CURRENCY_JPYEnumWährung ab JPY.
CURRENCY_KRWEnumWährung: KRW
CURRENCY_LKREnumWährung: LKR
CURRENCY_LTLEnumWährung aus LTL.
CURRENCY_MNTEnumWährung von MNT.
CURRENCY_MVREnumWährung aus MVR.
CURRENCY_MXNEnumWährung: MXN
CURRENCY_MYREnumWährung: MYR
CURRENCY_NGNEnumWährung aus NGN.
CURRENCY_NOKEnumWährung aus NOK.
CURRENCY_NZDEnumWährung: NZD
CURRENCY_PABEnumWährung aus dem PAB.
CURRENCY_PENEnumWährung aus PEN.
CURRENCY_PHPEnumWährung aus PHP.
CURRENCY_PKREnumWährung aus PKR.
CURRENCY_PLNEnumWährung: 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 ab THB.
CURRENCY_TRYEnumWährung aus TRY.
CURRENCY_TWDEnumWährung aus TWD.
CURRENCY_TZSEnumWährung aus TZS.
CURRENCY_UAHEnumWährung aus UAH.
CURRENCY_USDEnumWährung aus 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 dieses Objekt und gibt es im von 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 wurde.
getDefaultDimension()FieldGibt die Standarddimension zurück, die für die Gruppe 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 zurück oder null, wenn in diesem Fields-Objekt kein Feld mit dieser ID vorhanden ist.
newDimension()FieldGibt eine neue Dimension Field zurück.
newMetric()FieldGibt einen 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 dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAuthType(authType)GetAuthTypeResponseLegt die AuthType des Builders fest.
setHelpUrl(helpUrl)GetAuthTypeResponseLegt die Hilfe-URL des Builders fest.

GetDataResponse

Methoden

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

GetSchemaResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectValidiert dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setFields(fields)GetSchemaResponseLegt die 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 Options-Builders fest.
setValue(value)OptionBuilderLegt den Wert dieses Options-Builders fest.

SelectMultiple

Methoden

MethodeRückgabetypKurzbeschreibung
addOption(optionBuilder)SelectMultipleFügt eine neue Auswahloption hinzu.
setAllowOverride(allowOverride)SelectMultipleErmöglicht 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)SelectSingleErmöglicht 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 dieses Objekt und gibt es im von Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setIsValid(isValid)SetCredentialsResponseLegt den gültigen Status von SetCredentialsResponse fest.

TextArea

Methoden

MethodeRückgabetypKurzbeschreibung
setAllowOverride(allowOverride)TextAreaErmöglicht 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)TextInputErmöglicht 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 Debug-Fehlers fest, der nur Administratoren angezeigt wird.
setText(text)UserErrorLegt den Text des Nutzerfehlers fest.
throwException()voidLöst das Auslösen dieser Ausnahme aus.