Data Studio Service

Studio danych

Ta usługa umożliwia skryptom dostęp do społecznościowego oprogramowania sprzęgającego w Studiu danych oraz ich modyfikowanie.

Zajęcia

NazwaKrótki opis
AggregationTypeWyliczenie definiujące typy agregacji, które można ustawić dla Field.
AuthTypeWyliczenie definiujące typy uwierzytelniania, które można ustawić dla oprogramowania sprzęgającego.
BigQueryConfigObiekt konfiguracji natywnego oprogramowania sprzęgającego BigQuery.
BigQueryParameterTypeWyliczenie definiujące typy parametrów BigQuery, które możesz ustawić.
CheckboxZawiera informacje o polach wyboru konfiguracji.
CommunityConnectorCommunityConnector umożliwia skryptom dostęp do kreatorów i narzędzi, aby ułatwić tworzenie oprogramowania sprzęgającego społeczności dla Studia danych.
ConfigZawiera wpisy konfiguracji oprogramowania sprzęgającego.
DataStudioAppDataStudioApp umożliwia skryptom interakcję z funkcjami zorientowanymi na programistów w Studio danych.
DebugErrorBłąd widoczny tylko dla administratorów oprogramowania sprzęgającego.
FieldZawiera dane związane z polami.
FieldTypeWyliczenie definiujące typy, które można ustawić dla Field.
FieldsZawiera zestaw komponentów Field na potrzeby społecznościowego oprogramowania sprzęgającego.
GetAuthTypeResponseKreator odpowiedzi getAuthType() dla projektu skryptu.
GetDataResponseKreator odpowiedzi getData() dla projektu skryptu.
GetSchemaResponseKreator odpowiedzi getSchema() dla projektu skryptu.
InfoZawiera informacje o konfiguracji.
OptionBuilderKreator do tworzenia opcji dla komponentów SelectSingle i SelectMultiple.
SelectMultipleZawiera kilka informacji wybranych do konfiguracji.
SelectSingleZawiera jedną informację do konfiguracji.
SetCredentialsResponseKreator odpowiedzi setCredentials() dla projektu skryptu.
TextAreaZawiera informacje o obszarze tekstowym konfiguracji.
TextInputZawiera dane wejściowe konfiguracji.
UserErrorBłąd wyświetlany użytkownikom oprogramowania sprzęgającego.

AggregationType

Właściwości

WłaściwośćTypOpis
AVGEnumPrzeciętna.
COUNTEnumLiczba.
COUNT_DISTINCTEnumLiczba unikalnych wartości.
MAXEnumMaks.
MINEnumMin.
SUMEnumSuma
AUTOEnumAutomatyczny.

AuthType

Właściwości

WłaściwośćTypOpis
NONEEnumAutoryzacja nie jest wymagana.
OAUTH2EnumWymagana jest autoryzacja OAuth2.
USER_PASSEnumWymagane są nazwa użytkownika i hasło.
PATH_USER_PASSEnumWymagane są nazwa użytkownika, ścieżka i hasło.
PATH_KEYEnumPotrzebna jest ścieżka i klucz.
KEYEnumWymagany klucz interfejsu API lub token.
USER_TOKENEnumWymagane są nazwa użytkownika i token.

BigQueryConfig

Metody

MetodaZwracany typKrótki opis
addQueryParameter(name, type, value)BigQueryConfigDodaje parametr zapytania do tego parametru BigQueryConfig.
build()ObjectWeryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringDrukuje reprezentację tego obiektu w formacie JSON.
setAccessToken(accessToken)BigQueryConfigUstawia token dostępu tego urządzenia BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigUstawia identyfikator projektu rozliczeniowego BigQueryConfig.
setQuery(query)BigQueryConfigUstawia zapytanie SQL tego obiektu BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigOkreśla, czy zapytanie jest interpretowane jako standardowy czy starszy 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)CheckboxUmożliwia zastępowanie 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()ObjectWeryfikuje obiekt 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 konstruktor opcji.
newSelectMultiple()SelectMultipleZwraca nowy wpis konfiguracji z możliwością wyboru wielu elementów.
newSelectSingle()SelectSingleZwraca nowy, pojedynczy wpis konfiguracji.
newTextArea()TextAreaZwraca nowy wpis konfiguracji obszaru tekstowego.
newTextInput()TextInputZwraca nowy wpis konfiguracji wprowadzania tekstu.
printJson()StringDrukuje reprezentację tego obiektu w formacie JSON.
setDateRangeRequired(dateRangeRequired)ConfigJeśli ustawiona jest wartość true, dla żądań getData() podany jest zakres dat.
setIsSteppedConfig(isSteppedConfig)ConfigJeśli ustawiona jest wartość true, metoda getConfig() jest wywoływana ponownie z zastosowaniem bieżącej konfiguracji 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()StringDrukuje reprezentację tego obiektu w formacie JSON.
setText(text)DebugErrorUstawia tekst błędu debugowania, który jest widoczny tylko dla administratorów.
throwException()voidWywołuje zgłoszenie tego wyjątku.

Field

Metody

MetodaZwracany typKrótki opis
getAggregation()AggregationTypeZwraca AggregationType elementu Field.
getDescription()StringZwraca opis elementu Field.
getFormula()StringZwraca formułę tej funkcji Field.
getGroup()StringZwraca grupę Field.
getId()StringZwraca identyfikator elementu Field.
getIsReaggregatable()BooleanZwraca wartość true, jeśli można ponownie zagregować to pole. W przeciwnym razie zwraca wartość false.
getName()StringZwraca nazwę tego elementu (Field).
getType()FieldTypeZwraca FieldType elementu Field.
isDefault()BooleanZwraca wartość true, jeśli ta Field jest domyślnymi danymi lub wymiarami.
isDimension()BooleanZwraca wartość true, jeśli to pole jest wymiarem.
isHidden()BooleanZwraca wartość true, jeśli parametr Field jest ukryty.
isMetric()BooleanZwraca wartość true, jeśli to pole zawiera dane.
setAggregation(aggregation)FieldUstawia typ agregacji obiektu Field.
setDescription(description)FieldUstawia opis obiektu Field.
setFormula(formula)FieldUstawia formułę tej funkcji: Field.
setGroup(group)FieldUstawia grupę urządzeń Field.
setId(id)FieldUstawia identyfikator tego zasobu (Field).
setIsHidden(isHidden)FieldUstawia stan ukryty dla obiektu Field.
setIsReaggregatable(isReaggregatable)FieldWyznacza stan zezwolenia na ponowną agregację dla obiektu Field.
setName(name)FieldUstawia nazwę tego urządzenia Field.
setType(type)FieldUstawia FieldType tego komponentu (Field).

FieldType

Właściwości

WłaściwośćTypOpis
YEAREnumRok w formacie RRRR, na przykład 2017.
YEAR_QUARTEREnumRok i kwartał w formacie RRRRQ, np. 20171.
YEAR_MONTHEnumRok i miesiąc w formacie RRRRMM, np. 201703.
YEAR_WEEKEnumRok i tydzień w formacie RRRRtt, 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 RRRRMMDDGGmmss, 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 HH, np. 13.
MINUTEEnumMinuta w formacie mm, np. 12.
DURATIONEnumCzas trwania w sekundach.
COUNTRYEnumKraj, np. Polska.
COUNTRY_CODEEnumKod kraju, np. PL.
CONTINENTEnumKontynent, taki jak Ameryki.
CONTINENT_CODEEnumKod kontynentu, np. 019.
SUB_CONTINENTEnumSubkontynent, np. Ameryka Północna.
SUB_CONTINENT_CODEEnumKod subkontynentu, np. 003.
REGIONEnumRegion, np. Kalifornia.
REGION_CODEEnumKod regionu, na przykład urząd certyfikacji.
CITYEnumMiasto, np. Warszawa.
CITY_CODEEnumKod miasta, np. 1014044.
METROEnumObszar miejski, np. San Francisco-Oakland-San Jose, Kalifornia.
METRO_CODEEnumKod obszaru miejskiego, np. 200807.
LATITUDE_LONGITUDEEnumPara szerokości i długości geograficznej, np.51.5074, -0,1278.
NUMBEREnumLiczba dziesiętna.
PERCENTEnumProcent dziesiętny (może być większy niż 1,0).
TEXTEnumDowolny tekst.
BOOLEANEnumWartość logiczna true lub false.
URLEnumAdres URL, np. https://google.com.
HYPERLINKEnumHiperłącze.
IMAGEEnumObraz.
IMAGE_LINKEnumLink do zdjęcia.
CURRENCY_AEDEnumWaluta z AED.
CURRENCY_ALLEnumWaluta ze WSZYSTKICH.
CURRENCY_ARSEnumWaluta z ARS.
CURRENCY_AUDEnumWaluta z AUD.
CURRENCY_BDTEnumWaluta z BDT.
CURRENCY_BGNEnumWaluta z BGN.
CURRENCY_BOBEnumWaluta z BOB.
CURRENCY_BRLEnumWaluta z BRL.
CURRENCY_CADEnumWaluta z CAD.
CURRENCY_CDFEnumWaluta z CDF.
CURRENCY_CHFEnumWaluta z CHF.
CURRENCY_CLPEnumWaluta z CLP.
CURRENCY_CNYEnumWaluta z CNY.
CURRENCY_COPEnumWaluta z COP.
CURRENCY_CRCEnumWaluta z CRC.
CURRENCY_CZKEnumWaluta z CZK.
CURRENCY_DKKEnumWaluta z DKK.
CURRENCY_DOPEnumWaluta z DOP.
CURRENCY_EGPEnumWaluta z EGP.
CURRENCY_ETBEnumWaluta z ETB.
CURRENCY_EUREnumWaluta z EUR.
CURRENCY_GBPEnumWaluta z GBP.
CURRENCY_HKDEnumWaluta z HKD.
CURRENCY_HRKEnumWaluta z HRK.
CURRENCY_HUFEnumWaluta z HUF.
CURRENCY_IDREnumWaluta z IDR.
CURRENCY_ILSEnumWaluta to ILS.
CURRENCY_INREnumWaluta z INR.
CURRENCY_IRREnumWaluta z IRR.
CURRENCY_ISKEnumWaluta z ISK.
CURRENCY_JMDEnumWaluta od JMD.
CURRENCY_JPYEnumWaluta z JPY.
CURRENCY_KRWEnumWaluta z KRW.
CURRENCY_LKREnumWaluta z LKR.
CURRENCY_LTLEnumWaluta z LTL.
CURRENCY_MNTEnumWaluta z MNT.
CURRENCY_MVREnumWaluta z MVR.
CURRENCY_MXNEnumWaluta z MXN.
CURRENCY_MYREnumWaluta z MYR.
CURRENCY_NGNEnumWaluta z NGN.
CURRENCY_NOKEnumWaluta z NOK.
CURRENCY_NZDEnumWaluta z NZD.
CURRENCY_PABEnumWaluta z PAB.
CURRENCY_PENEnumWaluta z PEN.
CURRENCY_PHPEnumWaluta z PHP.
CURRENCY_PKREnumWaluta z PKR.
CURRENCY_PLNEnumWaluta od złotych.
CURRENCY_RONEnumWaluta z RON.
CURRENCY_RSDEnumWaluta z RSD.
CURRENCY_RUBEnumWaluta z RUB.
CURRENCY_SAREnumWaluta z SAR.
CURRENCY_SEKEnumWaluta – SEK.
CURRENCY_SGDEnumWaluta z SGD.
CURRENCY_THBEnumWaluta z THB.
CURRENCY_TRYEnumWaluta z TRY.
CURRENCY_TWDEnumWaluta z TWD.
CURRENCY_TZSEnumWaluta z TZS.
CURRENCY_UAHEnumWaluta z UAH.
CURRENCY_USDEnumWaluta z USD.
CURRENCY_UYUEnumWaluta z UYU.
CURRENCY_VEFEnumWaluta z VEF.
CURRENCY_VNDEnumWaluta z VND.
CURRENCY_YEREnumWaluta z YER.
CURRENCY_ZAREnumWaluta z ZAR.

Fields

Metody

MetodaZwracany typKrótki opis
asArray()Field[]Zwraca widok tego obiektu jako tablicę.
build()Object[]Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
forIds(ids)FieldsZwraca nowy obiekt Fields przefiltrowany według kryteriów Field z identyfikatorem w ids.
getDefaultDimension()FieldZwraca wymiar domyślny do użycia w zbiorze pól.
getDefaultMetric()FieldZwraca domyślny wskaźnik, który ma być używany w zbiorze pól.
getFieldById(fieldId)FieldZwraca pole o podanym identyfikatorze lub null, jeśli w obiekcie Fields nie ma pola o takim identyfikatorze.
newDimension()FieldZwraca nowy wymiar Field.
newMetric()FieldZwraca nowy wskaźnik Field.
setDefaultDimension(fieldId)voidOkreśla domyślny wymiar, który ma być używany dla zbioru pól.
setDefaultMetric(fieldId)voidOkreśla domyślny wskaźnik do użycia w zbiorze pól.

GetAuthTypeResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectWeryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringDrukuje reprezentację tego obiektu w formacie JSON.
setAuthType(authType)GetAuthTypeResponseKonfiguruje AuthType konstruktora.
setHelpUrl(helpUrl)GetAuthTypeResponseUstawia adres URL pomocy kreatora.

GetDataResponse

Metody

MetodaZwracany typKrótki opis
addAllRows(rows)GetDataResponseDodaje wiele wierszy danych do tabeli GetDataResponse.
addRow(row)GetDataResponseDodaje wiersz danych do: GetDataResponse.
build()ObjectWeryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
setFields(fields)GetDataResponseKonfiguruje Fields konstruktora.
setFiltersApplied(filtersApplied)GetDataResponseUstawia stan zastosowanych filtrów w tym konstruktorze.

GetSchemaResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectWeryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringDrukuje reprezentację tego obiektu w formacie JSON.
setFields(fields)GetSchemaResponseKonfiguruje Fields konstruktora.

Info

Metody

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

OptionBuilder

Metody

MetodaZwracany typKrótki opis
setLabel(label)OptionBuilderUstawia etykietę tego konstruktora opcji.
setValue(value)OptionBuilderUstawia wartość tego kreatora opcji.

SelectMultiple

Metody

MetodaZwracany typKrótki opis
addOption(optionBuilder)SelectMultipleDodaje nową opcję wyboru.
setAllowOverride(allowOverride)SelectMultipleUmożliwia zastępowanie 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)SelectSingleUmożliwia zastępowanie 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()ObjectWeryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringDrukuje reprezentację tego obiektu w formacie JSON.
setIsValid(isValid)SetCredentialsResponseOkreśla prawidłowy stan urządzenia SetCredentialsResponse.

TextArea

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)TextAreaUmożliwia zastępowanie 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 tej pozycji konfiguracji.

TextInput

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)TextInputUmożliwia zastępowanie 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 tej pozycji konfiguracji.

UserError

Metody

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