Data Studio Service

Studio danych

Ta usługa umożliwia skryptom dostęp do złączy społeczności Studia danych i ich modyfikowanie.

Zajęcia

NazwaKrótki opis
AggregationTypeWyliczenie, które definiuje typy agregacji, jakie można ustawić dla elementu Field.
AuthTypeWyliczenie, które definiuje typy uwierzytelniania, jakie można ustawić dla oprogramowania sprzęgającego.
BigQueryConfigObiekt konfiguracji natywnego oprogramowania sprzęgającego BigQuery.
BigQueryParameterTypeWyliczenie, które definiuje typy parametrów BigQuery, które możesz ustawić.
CheckboxZawiera informacje o polach wyboru w konfiguracji.
CommunityConnectorInterfejs CommunityConnector umożliwia skryptom dostęp do narzędzi i funkcji pomocniczych, które ułatwiają tworzenie społecznościowych oprogramowań sprzęgających do Studia danych.
ConfigZawiera wpisy konfiguracyjne oprogramowania sprzęgającego.
DataStudioAppDataStudioApp umożliwia skryptom interakcję z funkcjami Studia danych przeznaczonymi dla deweloperów.
DebugErrorBłąd widoczny tylko dla administratorów łącznika.
FieldZawiera dane związane z polem.
FieldTypeWyliczenie, które definiuje typy, jakie można ustawić dla parametru Field.
FieldsZawiera zestaw Field dla społecznościowego oprogramowania sprzęgającego.
GetAuthTypeResponseKreator do tworzenia odpowiedzi getAuthType() w projekcie skryptu.
GetDataResponseKreator do tworzenia odpowiedzi getData() w projekcie skryptu.
GetSchemaResponseKreator do tworzenia odpowiedzi getSchema() w projekcie skryptu.
InfoZawiera dane informacyjne dotyczące konfiguracji.
OptionBuilderKreator do tworzenia opcji dla SelectSingleSelectMultiple.
SelectMultipleZawiera informacje o wielokrotnym wyborze w konfiguracji.
SelectSingleZawiera wybrane pojedyncze informacje o konfiguracji.
SetCredentialsResponseKreator do tworzenia odpowiedzi setCredentials() w projekcie skryptu.
TextAreaZawiera informacje o obszarze tekstowym konfiguracji.
TextInputZawiera informacje o polu tekstowym w konfiguracji.
UserErrorBłąd wyświetlany użytkownikom oprogramowania sprzęgającego.

AggregationType

Właściwości

WłaściwośćTypOpis
AVGEnumŚrednia.
COUNTEnumLiczba.
COUNT_DISTINCTEnumLiczba unikalnych wartości.
MAXEnumMaks.
MINEnumMin.
SUMEnumSuma.
AUTOEnumAutomatyczny

AuthType

Właściwości

WłaściwośćTypOpis
NONEEnumNie jest wymagana autoryzacja.
OAUTH2EnumWymagana autoryzacja OAuth2.
USER_PASSEnumWymagane są dane logowania (nazwa użytkownika i hasło).
PATH_USER_PASSEnumWymagane są nazwa użytkownika, ścieżka i hasło.
PATH_KEYEnumWymagane są ścieżka i klucz.
KEYEnumWymagany jest klucz interfejsu API lub token.
USER_TOKENEnumWymagane są nazwa użytkownika i token.

BigQueryConfig

Metody

MetodaZwracany typKrótki opis
addQueryParameter(name, type, value)BigQueryConfigDodaje do tego BigQueryConfig parametr zapytania.
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWyświetla reprezentację JSON tego obiektu.
setAccessToken(accessToken)BigQueryConfigUstawia token dostępu tego BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigUstawia identyfikator projektu rozliczeniowego tego BigQueryConfig.
setQuery(query)BigQueryConfigUstawia zapytanie SQL tego BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigOkreśla, czy zapytanie jest interpretowane jako standardowa czy starsza wersja SQL.

BigQueryParameterType

Właściwości

WłaściwośćTypOpis
STRINGEnumCiąg tekstowy.
INT64Enum64-bitowa liczba całkowita.
BOOLEnumWartość logiczna.
FLOAT64Enum64-bitowa liczba zmiennoprzecinkowa.

Checkbox

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)CheckboxWłącza zastępowanie w przypadku tego wpisu konfiguracji.
setHelpText(helpText)CheckboxUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)CheckboxUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)CheckboxUstawia stan dynamiczny dla tego wpisu konfiguracji.
setName(name)CheckboxUstawia wyświetlaną nazwę tego wpisu konfiguracji.

CommunityConnector

Właściwości

WłaściwośćTypOpis
AggregationTypeAggregationTypeWyliczenie AggregationType.
AuthTypeAuthTypeWyliczenie AuthType.
BigQueryParameterTypeBigQueryParameterTypeWyliczenie BigQueryParameterType.
FieldTypeFieldTypeWyliczenie FieldType.

Metody

MetodaZwracany typKrótki opis
getConfig()ConfigZwraca obiekt Config.
getFields()FieldsZwraca obiekt Fields.
newAuthTypeResponse()GetAuthTypeResponseZwraca nowy obiekt GetAuthTypeResponse.
newBigQueryConfig()BigQueryConfigZwraca nowy obiekt BigQueryConfig.
newDebugError()DebugErrorZwraca nowy obiekt DebugError.
newGetDataResponse()GetDataResponseZwraca nowy obiekt GetDataResponse.
newGetSchemaResponse()GetSchemaResponseZwraca nowy obiekt GetSchemaResponse.
newSetCredentialsResponse()SetCredentialsResponseZwraca nowy obiekt SetCredentialsResponse.
newUserError()UserErrorZwraca nowy obiekt UserError.

Config

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
newCheckbox()CheckboxZwraca nowy wpis konfiguracji pola wyboru.
newInfo()InfoZwraca nowy wpis konfiguracji informacji.
newOptionBuilder()OptionBuilderZwraca nowy kreator opcji.
newSelectMultiple()SelectMultipleZwraca nowy wpis konfiguracji wyboru wielokrotnego.
newSelectSingle()SelectSingleZwraca nowy wpis konfiguracji pojedynczego wyboru.
newTextArea()TextAreaZwraca nowy wpis konfiguracji obszaru tekstowego.
newTextInput()TextInputZwraca nowy wpis konfiguracji wprowadzania tekstu.
printJson()StringWyświetla reprezentację JSON tego obiektu.
setDateRangeRequired(dateRangeRequired)ConfigJeśli true, w przypadku żądań getData() podawany jest zakres dat.
setIsSteppedConfig(isSteppedConfig)ConfigJeśli true, funkcja getConfig() jest wywoływana ponownie z bieżącą konfiguracją użytkownika.

DataStudioApp

Metody

MetodaZwracany typKrótki opis
createCommunityConnector()CommunityConnectorTworzy nowe społecznościowe oprogramowanie sprzęgające.

DebugError

Metody

MetodaZwracany typKrótki opis
printJson()StringWyświetla reprezentację JSON tego obiektu.
setText(text)DebugErrorUstawia tekst błędu debugowania, który jest widoczny tylko dla administratorów.
throwException()voidPowoduje zgłoszenie tego wyjątku.

Field

Metody

MetodaZwracany typKrótki opis
getAggregation()AggregationTypeZwraca AggregationType tego Field.
getDescription()StringZwraca opis tego elementu Field.
getFormula()StringZwraca formułę tego Field.
getGroup()StringZwraca grupę tego elementu Field.
getId()StringZwraca identyfikator tego Field.
getIsReaggregatable()BooleanZwraca wartość true, jeśli to pole można ponownie zagregować, a w przeciwnym razie false.
getName()StringZwraca nazwę tego Field.
getType()FieldTypeZwraca FieldType tego Field.
isDefault()BooleanZwraca wartość true, jeśli ten element Field jest domyślnymi danymi lub wymiarem.
isDimension()BooleanZwraca true, jeśli to pole jest wymiarem.
isHidden()BooleanZwraca wartość true, jeśli ten element Field jest ukryty.
isMetric()BooleanZwraca wartość true, jeśli to pole jest danymi.
setAggregation(aggregation)FieldUstawia typ agregacji tego Field.
setDescription(description)FieldUstawia opis tego elementu Field.
setFormula(formula)FieldUstawia formułę tego Field.
setGroup(group)FieldUstawia grupę tego elementu Field.
setId(id)FieldUstawia identyfikator tego Field.
setIsHidden(isHidden)FieldUstawia stan ukrycia tego Field.
setIsReaggregatable(isReaggregatable)FieldUstawia stan zezwolenia na ponowne agregowanie dla Field.
setName(name)FieldUstawia nazwę tego Field.
setType(type)FieldUstawia FieldType tego Field.

FieldType

Właściwości

WłaściwośćTypOpis
YEAREnumRok w formacie RRRR, np. 2017.
YEAR_QUARTEREnumRok i kwartał w formacie RRRRK, np. 20171.
YEAR_MONTHEnumRok i miesiąc w formacie RRRRMM, np. 201703.
YEAR_WEEKEnumRok i tydzień w formacie RRRRww, np. 201707.
YEAR_MONTH_DAYEnumRok, miesiąc i dzień w formacie RRRRMMDD, np. 20170317.
YEAR_MONTH_DAY_HOUREnumRok, miesiąc, dzień i godzina w formacie RRRRMMDDGG, np. 2017031703.
YEAR_MONTH_DAY_MINUTEEnumRok, miesiąc, dzień, godzina i minuta w formacie RRRRMMDDGGmm, np. 201703170230.
YEAR_MONTH_DAY_SECONDEnumRok, miesiąc, dzień, godzina, minuta i sekunda w formacie RRRRMMDDHHmmss, np. 20170317023017.
QUARTEREnumKwartał w formacie 1, 2, 3 lub 4.
MONTHEnumMiesiąc w formacie MM, np. 03.
WEEKEnumTydzień w formacie ww, np. 07.
MONTH_DAYEnumMiesiąc i dzień w formacie MMDD, np. 0317.
DAY_OF_WEEKEnumLiczba z zakresu [0, 6], gdzie 0 oznacza niedzielę.
DAYEnumDzień w formacie DD, np. 17.
HOUREnumGodzina w formacie GG, np. 13.
MINUTEEnumMinuta w formacie mm, np. 12.
DURATIONEnumCzas trwania w sekundach.
COUNTRYEnumKraj, np. Stany Zjednoczone.
COUNTRY_CODEEnumKod kraju, np. US.
CONTINENTEnumKontynent, np. Ameryki.
CONTINENT_CODEEnumKod kontynentu, np. 019.
SUB_CONTINENTEnumSubkontynent, np. Ameryka Północna.
SUB_CONTINENT_CODEEnumKod subkontynentu, np. 003.
REGIONEnumRegion, np. Kalifornia.
REGION_CODEEnumKod regionu, np. CA.
CITYEnumMiasto, np. Mountain View.
CITY_CODEEnumKod miasta, np. 1014044.
METROEnumObszar metropolitalny, np. San Francisco-Oakland-San Jose CA.
METRO_CODEEnumKod obszaru miejskiego, np. 200807.
LATITUDE_LONGITUDEEnumPara szerokości i długości geograficznej, np. 51.5074, -0.1278.
NUMBEREnumLiczba dziesiętna.
PERCENTEnumWartość procentowa w formie dziesiętnej (może być większa niż 1,0).
TEXTEnumDowolny tekst.
BOOLEANEnumWartość logiczna true lub false.
URLEnumAdres URL w formie tekstu, np. https://google.com.
HYPERLINKEnumhiperlink,
IMAGEEnumobrazu,
IMAGE_LINKEnumLink do zdjęcia.
CURRENCY_AEDEnumwalutę z AED;
CURRENCY_ALLEnumWaluta: ALL.
CURRENCY_ARSEnumWaluta z ARS.
CURRENCY_AUDEnumWaluta: AUD.
CURRENCY_BDTEnumWaluta: BDT.
CURRENCY_BGNEnumwaluty z lewów bułgarskich;
CURRENCY_BOBEnumWaluta: BOB.
CURRENCY_BRLEnumWaluta: BRL.
CURRENCY_CADEnumWaluta z CAD.
CURRENCY_CDFEnumWaluta z CDF.
CURRENCY_CHFEnumWaluta: CHF.
CURRENCY_CLPEnumWaluta z CLP.
CURRENCY_CNYEnumWaluta: CNY.
CURRENCY_COPEnumWaluta: COP.
CURRENCY_CRCEnumWaluta z CRC.
CURRENCY_CZKEnumwalutę z CZK;
CURRENCY_DKKEnumWaluta: DKK.
CURRENCY_DOPEnumWaluta z DOP.
CURRENCY_EGPEnumWaluta: EGP.
CURRENCY_ETBEnumWaluta: ETB.
CURRENCY_EUREnumwalutę inną niż EUR;
CURRENCY_GBPEnumWaluta z GBP.
CURRENCY_HKDEnumWaluta z HKD.
CURRENCY_HRKEnumwalutę HRK;
CURRENCY_HUFEnumWaluta: HUF.
CURRENCY_IDREnumWaluta z IDR.
CURRENCY_ILSEnumWaluta z ILS.
CURRENCY_INREnumwalutę z INR;
CURRENCY_IRREnumWaluta z IRR.
CURRENCY_ISKEnumWaluta z ISK.
CURRENCY_JMDEnumWaluta z JMD.
CURRENCY_JPYEnumWaluta z JPY.
CURRENCY_KRWEnumWaluta: KRW.
CURRENCY_LKREnumWaluta: LKR.
CURRENCY_LTLEnumWaluta z LTL.
CURRENCY_MNTEnumWaluta z MNT.
CURRENCY_MVREnumWaluta: MVR.
CURRENCY_MXNEnumwalutę z MXN;
CURRENCY_MYREnumwalutę z MYR;
CURRENCY_NGNEnumWaluta: NGN.
CURRENCY_NOKEnumWaluta: NOK.
CURRENCY_NZDEnumWaluta: NZD.
CURRENCY_PABEnumWaluta z PAB.
CURRENCY_PENEnumWaluta z PEN.
CURRENCY_PHPEnumWaluta: PHP.
CURRENCY_PKREnumWaluta: PKR.
CURRENCY_PLNEnumwalutę z PLN;
CURRENCY_RONEnumWaluta: RON.
CURRENCY_RSDEnumWaluta: RSD.
CURRENCY_RUBEnumWaluta: RUB.
CURRENCY_SAREnumWaluta z SAR.
CURRENCY_SEKEnumWaluta: SEK.
CURRENCY_SGDEnumWaluta: SGD.
CURRENCY_THBEnumWaluta: THB.
CURRENCY_TRYEnumWaluta: TRY.
CURRENCY_TWDEnumWaluta: TWD.
CURRENCY_TZSEnumWaluta: TZS.
CURRENCY_UAHEnumWaluta z UAH.
CURRENCY_USDEnumWaluta z USD.
CURRENCY_UYUEnumWaluta z UYU.
CURRENCY_VEFEnumWaluta z VEF.
CURRENCY_VNDEnumwalutę z dongów wietnamskich;
CURRENCY_YEREnumWaluta z YER.
CURRENCY_ZAREnumWaluta z ZAR.

Fields

Metody

MetodaZwracany typKrótki opis
asArray()Field[]Zwraca widok tego obiektu jako tablicę.
build()Object[]Sprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
forIds(ids)FieldsZwraca nowy obiekt Fields, który jest filtrowany pod kątem Field z identyfikatorem w ids.
getDefaultDimension()FieldZwraca domyślny wymiar, który ma być używany w przypadku zestawu pól.
getDefaultMetric()FieldZwraca domyślny wskaźnik, który ma być używany w przypadku zestawu pól.
getFieldById(fieldId)FieldZwraca pole o podanym identyfikatorze lub null, jeśli w tym obiekcie Fields nie ma pola o tym identyfikatorze.
newDimension()FieldZwraca nowy wymiar Field.
newMetric()FieldZwraca nowe dane Field.
setDefaultDimension(fieldId)voidUstawia domyślny wymiar, który ma być używany w przypadku zbioru pól.
setDefaultMetric(fieldId)voidUstawia domyślny rodzaj danych, który ma być używany w przypadku zbioru pól.

GetAuthTypeResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWyświetla reprezentację JSON tego obiektu.
setAuthType(authType)GetAuthTypeResponseUstawia AuthType kreatora.
setHelpUrl(helpUrl)GetAuthTypeResponseUstawia adres URL pomocy dotyczący kreatora.

GetDataResponse

Metody

MetodaZwracany typKrótki opis
addAllRows(rows)GetDataResponseDodaje do tego elementu GetDataResponse kilka wierszy danych.
addRow(row)GetDataResponseDodaje wiersz danych do tego raportu GetDataResponse.
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
setFields(fields)GetDataResponseUstawia Fields kreatora.
setFiltersApplied(filtersApplied)GetDataResponseUstawia stan zastosowania filtrów w przypadku tego narzędzia do tworzenia.

GetSchemaResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWyświetla reprezentację JSON tego obiektu.
setFields(fields)GetSchemaResponseUstawia Fields kreatora.

Info

Metody

MetodaZwracany typKrótki opis
setId(id)InfoUstawia unikalny identyfikator tego wpisu konfiguracji.
setText(text)InfoUstawia tekst dla tego wpisu konfiguracji.

OptionBuilder

Metody

MetodaZwracany typKrótki opis
setLabel(label)OptionBuilderUstawia etykietę tego narzędzia do tworzenia opcji.
setValue(value)OptionBuilderUstawia wartość tego narzędzia do tworzenia opcji.

SelectMultiple

Metody

MetodaZwracany typKrótki opis
addOption(optionBuilder)SelectMultipleDodaje nową opcję wyboru.
setAllowOverride(allowOverride)SelectMultipleWłącza zastępowanie w przypadku tego wpisu konfiguracji.
setHelpText(helpText)SelectMultipleUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)SelectMultipleUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)SelectMultipleUstawia stan dynamiczny dla tego wpisu konfiguracji.
setName(name)SelectMultipleUstawia wyświetlaną nazwę tego wpisu konfiguracji.

SelectSingle

Metody

MetodaZwracany typKrótki opis
addOption(optionBuilder)SelectSingleDodaje nową opcję wyboru.
setAllowOverride(allowOverride)SelectSingleWłącza zastępowanie w przypadku tego wpisu konfiguracji.
setHelpText(helpText)SelectSingleUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)SelectSingleUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)SelectSingleUstawia stan dynamiczny dla tego wpisu konfiguracji.
setName(name)SelectSingleUstawia wyświetlaną nazwę tego wpisu konfiguracji.

SetCredentialsResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza poprawność tego obiektu i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWyświetla reprezentację JSON tego obiektu.
setIsValid(isValid)SetCredentialsResponseUstawia prawidłowy stan tego SetCredentialsResponse.

TextArea

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)TextAreaWłącza zastępowanie w przypadku tego wpisu konfiguracji.
setHelpText(helpText)TextAreaUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)TextAreaUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)TextAreaUstawia stan dynamiczny dla tego wpisu konfiguracji.
setName(name)TextAreaUstawia wyświetlaną nazwę tego wpisu konfiguracji.
setPlaceholder(placeholder)TextAreaUstawia tekst zastępczy dla tego wpisu konfiguracji.

TextInput

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)TextInputWłącza zastępowanie w przypadku tego wpisu konfiguracji.
setHelpText(helpText)TextInputUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)TextInputUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)TextInputUstawia stan dynamiczny dla tego wpisu konfiguracji.
setName(name)TextInputUstawia wyświetlaną nazwę tego wpisu konfiguracji.
setPlaceholder(placeholder)TextInputUstawia tekst zastępczy dla tego wpisu konfiguracji.

UserError

Metody

MetodaZwracany typKrótki opis
printJson()StringWyświetla reprezentację JSON tego obiektu.
setDebugText(text)UserErrorUstawia tekst błędu debugowania, który jest widoczny tylko dla administratorów.
setText(text)UserErrorUstawia tekst błędu użytkownika.
throwException()voidPowoduje zgłoszenie tego wyjątku.