Data Studio Service

Data Studio

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

Classes

NameKurzbeschreibung
AggregationTypeEin Enum, das die Aggregationstypen definiert, die für eine Field festgelegt werden können.
AuthTypeEin Enum, das die Authentifizierungstypen definiert, die für einen Connector festgelegt werden können.
BigQueryConfigEin Konfigurationsobjekt für einen nativen BigQuery-Connector.
BigQueryParameterTypeEin Enum, das die BigQuery-Parametertypen definiert, die Sie festlegen können.
CheckboxEnthält Informationen zu Kästchen für die Konfiguration.
CommunityConnectorMit dem CommunityConnector können Scripts 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.
DataStudioAppMit der DataStudio App können Scripts mit entwicklungsorientierten 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 eine 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 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 Informationsdaten für die Konfiguration.
OptionBuilderEin Builder zum Erstellen von Optionen für SelectSingles und SelectMultiples.
SelectMultipleEnthält mehrere ausgewählte Informationen für die Konfiguration.
SelectSingleEnthält ausgewählte einzelne Informationen für die Konfiguration.
SetCredentialsResponseBuilder zum Erstellen einer setCredentials()-Antwort für Ihr Script-Projekt.
TextAreaEnthält Informationen zum Textfeld für die Konfiguration.
TextInputEnthält Informationen zur Texteingabe für die Konfiguration.
UserErrorEin Fehler, der Nutzern des Connectors angezeigt wird.

AggregationType

Attribute

AttributTypBeschreibung
AVGEnumDurchschnittlich.
COUNTEnumZählen.
COUNT_DISTINCTEnum„Einzeln zählen“
MAXEnumMax.
MINEnumMin.
SUMEnumSumme:
AUTOEnumAutomatisch.

AuthType

Attribute

AttributTypBeschreibung
NONEEnumKeine Autorisierung erforderlich.
OAUTH2EnumOAuth2-Autorisierung erforderlich.
USER_PASSEnumNutzername 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()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setAccessToken(accessToken)BigQueryConfigLegen Sie das Zugriffstoken für diese BigQueryConfig fest.
setBillingProjectId(billingProjectId)BigQueryConfigLegt die ID des Abrechnungsprojekts für diese BigQueryConfig fest.
setQuery(query)BigQueryConfigHiermit wird die SQL-Abfrage dieser BigQueryConfig festgelegt.
setUseStandardSql(useStandardSql)BigQueryConfigBestimmt, ob die Abfrage als Standard-SQL oder Legacy-SQL interpretiert wird.

BigQueryParameterType

Attribute

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

Checkbox

Methoden

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

CommunityConnector

Attribute

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()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.

DataStudioApp

Methoden

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

DebugError

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setText(text)DebugErrorHiermit wird der Text des Debugfehlers festgelegt, der nur für Administratoren angezeigt wird.
throwException()voidAuslöser für diese Ausnahme.

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 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)FieldHiermit wird der Aggregationstyp dieser Field festgelegt.
setDescription(description)FieldHiermit wird die Beschreibung dieser Field festgelegt.
setFormula(formula)FieldLegt die Formel für diese Field fest.
setGroup(group)FieldLegt die Gruppe dieses 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 zulässige Zusammenführung für eine Field fest.
setName(name)FieldLegt den Namen dieser Field fest.
setType(type)FieldLegt die FieldType dieses Field fest.

FieldType

Attribute

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_CODEEnumEinen Ländercode wie „US“.
CONTINENTEnumEin Kontinent wie Amerika.
CONTINENT_CODEEnumEinen Kontinentcode wie 019.
SUB_CONTINENTEnumEin Teilkontinent wie Nordamerika.
SUB_CONTINENT_CODEEnumEinen Subkontinentcode wie 003.
REGIONEnumEine Region wie Kalifornien.
REGION_CODEEnumEinen Regionscode wie „CA“.
CITYEnumEine Stadt wie Mountain View.
CITY_CODEEnumEine Ortsvorwahl, z. B. 1014044.
METROEnumEine U-Bahn wie San Francisco-Oakland-San Jose CA.
METRO_CODEEnumGroßraumcode, z. B. 200807
LATITUDE_LONGITUDEEnumEin Breiten- und Längengrad-Paar wie 51.5074, -0.1278.
NUMBEREnumEine Dezimalzahl.
PERCENTEnumDezimalprozentsatz (kann über 1,0 liegen).
TEXTEnumFreier Text
BOOLEANEnumEin boolescher Wert (true oder false).
URLEnumEine URL als Text, z. B. https://google.com.
HYPERLINKEnumEinen Hyperlink.
IMAGEEnumEin Bild.
IMAGE_LINKEnumEin Bildlink.
CURRENCY_AEDEnumWährung von AED.
CURRENCY_ALLEnumWährung von ALLE.
CURRENCY_ARSEnumWährung von ARS.
CURRENCY_AUDEnumWährung von AUD.
CURRENCY_BDTEnumWährung von BDT.
CURRENCY_BGNEnumWährung von BGN.
CURRENCY_BOBEnumWährung von BOB
CURRENCY_BRLEnumWährung von BRL.
CURRENCY_CADEnumWährung von CAD
CURRENCY_CDFEnumWährung von CDF
CURRENCY_CHFEnumWährung von CHF.
CURRENCY_CLPEnumWährung von CLP
CURRENCY_CNYEnumWährung von CNY.
CURRENCY_COPEnumWährung von COP
CURRENCY_CRCEnumWährung von CRC
CURRENCY_CZKEnumWährung von CZK.
CURRENCY_DKKEnumWährung von DKK.
CURRENCY_DOPEnumWährung aus DOP.
CURRENCY_EGPEnumWährung von EGP.
CURRENCY_ETBEnumWährung von ETB
CURRENCY_EUREnumWährung von EUR.
CURRENCY_GBPEnumWährung von GBP.
CURRENCY_HKDEnumWährung von HKD.
CURRENCY_HRKEnumWährung von HRK.
CURRENCY_HUFEnumWährung von HUF.
CURRENCY_IDREnumWährung von IDR.
CURRENCY_ILSEnumWährung von ILS
CURRENCY_INREnumWährung von INR
CURRENCY_IRREnumWährung aus IRR.
CURRENCY_ISKEnumWährung von ISK.
CURRENCY_JMDEnumWährung von JMD.
CURRENCY_JPYEnumWährung von JPY
CURRENCY_KRWEnumWährung von KRW.
CURRENCY_LKREnumWährung von LKR.
CURRENCY_LTLEnumWährung von LTL
CURRENCY_MNTEnumWährung von MNT
CURRENCY_MVREnumWährung von MVR
CURRENCY_MXNEnumWährung von MXN.
CURRENCY_MYREnumWährung von MYR.
CURRENCY_NGNEnumWährung von NGN
CURRENCY_NOKEnumWährung von NOK
CURRENCY_NZDEnumWährung von NZD
CURRENCY_PABEnumWährung von PAB
CURRENCY_PENEnumWährung von PEN
CURRENCY_PHPEnumWährung aus PHP
CURRENCY_PKREnumWährung von PKR.
CURRENCY_PLNEnumWährung von PLN.
CURRENCY_RONEnumWährung von RON.
CURRENCY_RSDEnumWährung von RSD.
CURRENCY_RUBEnumWährung von RUB.
CURRENCY_SAREnumWährung von SAR
CURRENCY_SEKEnumWährung von SEK
CURRENCY_SGDEnumWährung von SGD.
CURRENCY_THBEnumWährung von THB
CURRENCY_TRYEnumWährung von TRY.
CURRENCY_TWDEnumWährung von TWD.
CURRENCY_TZSEnumWährung von TZS.
CURRENCY_UAHEnumWährung von UAH.
CURRENCY_USDEnumWährung von USD
CURRENCY_UYUEnumWährung von UYU.
CURRENCY_VEFEnumWährung von VEF
CURRENCY_VNDEnumWährung von VND.
CURRENCY_YEREnumWährung von YER
CURRENCY_ZAREnumWährung von ZAR.

Fields

Methoden

MethodeRückgabetypKurzbeschreibung
asArray()Field[]Gibt eine Ansicht dieses Objekts als Array zurück.
build()Object[]Dieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
forIds(ids)FieldsGibt ein neues Fields-Objekt zurück, das nach Fields mit einer ID in ids gefiltert ist.
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 dieses Fields-Objekt kein Feld mit dieser ID enthält.
newDimension()FieldGibt eine neue Dimension Field zurück.
newMetric()FieldGibt den neuen Messwert Field zurück.
setDefaultDimension(fieldId)voidLegt die Standarddimension für den Feldsatz fest.
setDefaultMetric(fieldId)voidLegt den Standardmesswert für die Gruppe von Feldern fest.

GetAuthTypeResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setAuthType(authType)GetAuthTypeResponseLegt die AuthType des Builders fest.
setHelpUrl(helpUrl)GetAuthTypeResponseLegt die Hilfe-URL des Builders fest.

GetDataResponse

Methoden

MethodeRückgabetypKurzbeschreibung
addAllRows(rows)GetDataResponseHiermit werden dieser GetDataResponse mehrere Datenzeilen hinzugefügt.
addRow(row)GetDataResponseHiermit wird dieser GetDataResponse eine Datenzeile hinzugefügt.
build()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
setFields(fields)GetDataResponseLegt die Fields des Builders fest.
setFiltersApplied(filtersApplied)GetDataResponseLegen Sie den Status der angewendeten Filter für diesen Builder fest.

GetSchemaResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setFields(fields)GetSchemaResponseLegt die Fields des Builders fest.

Info

Methoden

MethodeRückgabetypKurzbeschreibung
setId(id)InfoHier wird die eindeutige ID für diesen Konfigurationseintrag festgelegt.
setText(text)InfoHiermit wird der Text für diesen Konfigurationseintrag festgelegt.

OptionBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
setLabel(label)OptionBuilderHiermit wird das Label dieses Optionsbuilders festgelegt.
setValue(value)OptionBuilderHier wird der Wert dieses Optionsbuilders festgelegt.

SelectMultiple

Methoden

MethodeRückgabetypKurzbeschreibung
addOption(optionBuilder)SelectMultipleEs wird eine neue Auswahloption hinzugefügt.
setAllowOverride(allowOverride)SelectMultipleAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)SelectMultipleHiermit wird der Hilfetext für diesen Konfigurationseintrag festgelegt.
setId(id)SelectMultipleHier wird die eindeutige ID für diesen Konfigurationseintrag festgelegt.
setIsDynamic(isDynamic)SelectMultipleHier wird der dynamische Status für diesen Konfigurationseintrag festgelegt.
setName(name)SelectMultipleLegt den Anzeigenamen für diesen Konfigurationseintrag fest.

SelectSingle

Methoden

MethodeRückgabetypKurzbeschreibung
addOption(optionBuilder)SelectSingleEs wird eine neue Auswahloption hinzugefügt.
setAllowOverride(allowOverride)SelectSingleAktiviert das Überschreiben für diesen Konfigurationseintrag.
setHelpText(helpText)SelectSingleHiermit wird der Hilfetext für diesen Konfigurationseintrag festgelegt.
setId(id)SelectSingleHier wird die eindeutige ID für diesen Konfigurationseintrag festgelegt.
setIsDynamic(isDynamic)SelectSingleHier wird der dynamische Status für diesen Konfigurationseintrag festgelegt.
setName(name)SelectSingleLegt den Anzeigenamen für diesen Konfigurationseintrag fest.

SetCredentialsResponse

Methoden

MethodeRückgabetypKurzbeschreibung
build()ObjectDieses Objekt wird validiert und im für Data Studio erforderlichen Format zurückgegeben.
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setIsValid(isValid)SetCredentialsResponseLegt den gültigen Status dieser SetCredentialsResponse fest.

TextArea

Methoden

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

TextInput

Methoden

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

UserError

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setDebugText(text)UserErrorHiermit wird der Text des Debugfehlers festgelegt, der nur für Administratoren angezeigt wird.
setText(text)UserErrorLegt den Text des Nutzerfehlers fest.
throwException()voidAuslöser für diese Ausnahme.