Data Studio Service

Studio danych

Ta usługa umożliwia skryptom dostęp do łączników społeczności w Data Studio i 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 danego oprogramowania sprzęgającego.
BigQueryConfigObiekt konfiguracji dla natywnego oprogramowania sprzęgającego BigQuery.
BigQueryParameterTypeWyliczenie definiujące typy parametrów BigQuery, które możesz ustawić.
CheckboxZawiera informacje o poleceniach wyboru w konfiguracji.
CommunityConnectorŁącznik społeczności umożliwia skryptom dostęp do narzędzi do tworzenia i usług, które ułatwiają tworzenie łączników społeczności do Studia danych.
ConfigZawiera wpisy konfiguracji oprogramowania sprzęgającego.
DataStudioAppAplikacja Studio danych umożliwia skryptom interakcję z funkcjami Studia danych przeznaczonymi dla programistów.
DebugErrorBłąd widoczny tylko dla administratorów łącznika.
FieldZawiera dane związane z polem.
FieldTypeWyliczenie definiujące typy, które można ustawić dla Field.
FieldsZawiera zestaw Field dla społecznościowego oprogramowania sprzęgającego.
GetAuthTypeResponseBuilder, aby utworzyć odpowiedź getAuthType() dla projektu skryptu.
GetDataResponseBuilder, aby utworzyć odpowiedź getData() dla projektu skryptu.
GetSchemaResponseBuilder, aby utworzyć odpowiedź getSchema() dla projektu skryptu.
InfoZawiera dane konfiguracji.
OptionBuilderKreator opcji dla SelectSingle i SelectMultiple.
SelectMultipleZawiera wiele informacji o konfiguracji.
SelectSingleZawiera wybrane pojedyncze informacje o konfiguracji.
SetCredentialsResponseBuilder, aby utworzyć odpowiedź setCredentials() dla projektu skryptu.
TextAreaZawiera informacje o obszarze tekstowym w konfiguracji.
TextInputZawiera informacje tekstowe do wprowadzenia w konfiguracji.
UserErrorBłąd wyświetlany użytkownikom oprogramowania sprzęgającego.

AggregationType

Właściwości

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

AuthType

Właściwości

WłaściwośćTypOpis
NONEEnumNie wymaga autoryzacji.
OAUTH2EnumWymagana autoryzacja OAuth2.
USER_PASSEnumPotrzebne są dane logowania (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 lub token API.
USER_TOKENEnumPotrzebna jest nazwa użytkownika i token.

BigQueryConfig

Metody

MetodaZwracany typKrótki opis
addQueryParameter(name, type, value)BigQueryConfigDodaje parametr zapytania do tego BigQueryConfig.
build()ObjectSprawdza ten obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWypisuje reprezentację obiektu w formacie JSON.
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)CheckboxUmożliwia zastąpienie tego wpisu konfiguracji.
setHelpText(helpText)CheckboxUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)CheckboxUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)CheckboxUstawia dynamiczny stan 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 ten 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 kreator opcji.
newSelectMultiple()SelectMultipleZwraca nowy wpis konfiguracji wyboru wielu.
newSelectSingle()SelectSingleZwraca nowy wybrany wpis konfiguracji pojedynczej.
newTextArea()TextAreaZwraca nowy wpis konfiguracji obszaru tekstowego.
newTextInput()TextInputZwraca nowy wpis konfiguracji danych wejściowych tekstowych.
printJson()StringWypisuje reprezentację obiektu w formacie JSON.
setDateRangeRequired(dateRangeRequired)ConfigJeśli true, dla żądań getData() podany jest zakres dat.
setIsSteppedConfig(isSteppedConfig)ConfigJeśli true, funkcja getConfig() zostanie wywołana ponownie z obecną 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()StringWypisuje reprezentację obiektu w formacie JSON.
setText(text)DebugErrorUstawia tekst błędu debugowania, który jest widoczny tylko dla administratorów.
throwException()voidWyjątek jest zgłaszany.

Field

Metody

MetodaZwracany typKrótki opis
getAggregation()AggregationTypeZwraca AggregationType tego Field.
getDescription()StringZwraca opis tego elementu Field.
getFormula()StringZwraca formułę tego elementu Field.
getGroup()StringZwraca grupę tego elementu Field.
getId()StringZwraca identyfikator tego Field.
getIsReaggregatable()BooleanZwraca wartość true, jeśli to pole można ponownie zreagować, a w przeciwnym razie – wartość false.
getName()StringZwraca nazwę tego Field.
getType()FieldTypeZwraca FieldType tego Field.
isDefault()BooleanZwraca wartość true, jeśli ten element Field to domyślne dane lub wymiar.
isDimension()BooleanZwraca wartość true, jeśli to pole jest wymiarem.
isHidden()BooleanZwraca true, jeśli element Field jest ukryty.
isMetric()BooleanZwraca wartość true, jeśli to pole jest polem danych.
setAggregation(aggregation)FieldUstawia typ agregacji tego Field.
setDescription(description)FieldUstawia opis tego Field.
setFormula(formula)FieldUstawia formułę tego elementu Field.
setGroup(group)FieldUstawia grupę tego Field.
setId(id)FieldUstawia identyfikator tego Field.
setIsHidden(isHidden)FieldUstawia ukryty stan tego Field.
setIsReaggregatable(isReaggregatable)FieldUstawia stan dozwolonego ponownego zgrupowania 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 RRRRQ, 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 RRRRMMDDHHmm, 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], przy czym 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. Ameryka;
CONTINENT_CODEEnumKod kontynentu, np. 019.
SUB_CONTINENTEnumSubkontynent, np. Ameryka Północna.
SUB_CONTINENT_CODEEnumKod podkontynentu, np. 003.
REGIONEnumRegion, np. Kalifornia.
REGION_CODEEnumKod regionu, np. CA.
CITYEnumMiasto, np. Mountain View.
CITY_CODEEnumKod miasta, np. 1014044.
METROEnumMetro, 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.
PERCENTEnumWartość procentowa w postaci liczby dziesiętnej (może być większa niż 1,0).
TEXTEnumtekst niesformatowany,
BOOLEANEnumWartość logiczna true lub false.
URLEnumAdres URL jako tekst, np. https://google.com.
HYPERLINKEnumhiperlink,
IMAGEEnumobraz,
IMAGE_LINKEnumLink do zdjęcia.
CURRENCY_AEDEnumWaluta: dirhamy ZEA.
CURRENCY_ALLEnumWaluta z ALL.
CURRENCY_ARSEnumWaluta: ARS.
CURRENCY_AUDEnumWaluta: AUD.
CURRENCY_BDTEnumWaluta z BDT.
CURRENCY_BGNEnumWaluta: lewy bułgarski.
CURRENCY_BOBEnumWaluta z BOB.
CURRENCY_BRLEnumWaluta: BRL.
CURRENCY_CADEnumWaluta: CAD.
CURRENCY_CDFEnumWaluta z CDF.
CURRENCY_CHFEnumWaluta: CHF.
CURRENCY_CLPEnumWaluta z Chile.
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: funt egipski.
CURRENCY_ETBEnumWaluta: ETB.
CURRENCY_EUREnumWaluta: euro.
CURRENCY_GBPEnumWaluta: GBP.
CURRENCY_HKDEnumWaluta HKD.
CURRENCY_HRKEnumWaluta z HRK.
CURRENCY_HUFEnumWaluta: HUF.
CURRENCY_IDREnumWaluta IDR.
CURRENCY_ILSEnumWaluta ILS.
CURRENCY_INREnumWaluta: INR.
CURRENCY_IRREnumWaluta z IRR.
CURRENCY_ISKEnumWaluta ISK.
CURRENCY_JMDEnumWaluta: JMD.
CURRENCY_JPYEnumWaluta: JPY.
CURRENCY_KRWEnumWaluta z KRW.
CURRENCY_LKREnumWaluta LKR.
CURRENCY_LTLEnumWaluta z LTL.
CURRENCY_MNTEnumWaluta z MNT.
CURRENCY_MVREnumWaluta z MVR.
CURRENCY_MXNEnumWaluta: MXN.
CURRENCY_MYREnumWaluta: MYR.
CURRENCY_NGNEnumWaluta: NGN.
CURRENCY_NOKEnumWaluta z NOK.
CURRENCY_NZDEnumWaluta: NZD.
CURRENCY_PABEnumWaluta: PAB.
CURRENCY_PENEnumWaluta z PEN.
CURRENCY_PHPEnumWaluta z PHP.
CURRENCY_PKREnumWaluta: PKR.
CURRENCY_PLNEnumWaluta: PLN.
CURRENCY_RONEnumWaluta: RON.
CURRENCY_RSDEnumWaluta z RSD.
CURRENCY_RUBEnumWaluta: RUB.
CURRENCY_SAREnumWaluta z SAR.
CURRENCY_SEKEnumWaluta: SEK.
CURRENCY_SGDEnumWaluta Singapuru.
CURRENCY_THBEnumWaluta: THB.
CURRENCY_TRYEnumWaluta TRY.
CURRENCY_TWDEnumWaluta z TWD.
CURRENCY_TZSEnumWaluta TZS.
CURRENCY_UAHEnumWaluta z UAH.
CURRENCY_USDEnumWaluta: USD.
CURRENCY_UYUEnumWaluta z UYU.
CURRENCY_VEFEnumWaluta z VEF.
CURRENCY_VNDEnumWaluta VND.
CURRENCY_YEREnumWaluta: YER.
CURRENCY_ZAREnumWaluta: ZAR.

Fields

Metody

MetodaZwracany typKrótki opis
asArray()Field[]Zwraca widok tego obiektu jako tablicę.
build()Object[]Sprawdza ten obiekt 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ślne dane, których ma używać zestaw pól.
getFieldById(fieldId)FieldZwraca pole o danym identyfikatorze lub null, jeśli w 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 zestawu pól.
setDefaultMetric(fieldId)voidUstawia domyślny rodzaj danych, który ma być używany w przypadku zestawu pól.

GetAuthTypeResponse

Metody

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

GetDataResponse

Metody

MetodaZwracany typKrótki opis
addAllRows(rows)GetDataResponseDodaje do tego GetDataResponse kilka wierszy danych.
addRow(row)GetDataResponseDodaje wiersz danych do tego GetDataResponse.
build()ObjectSprawdza ten obiekt i zwraca go w formacie wymaganym przez Studio danych.
setFields(fields)GetDataResponseUstawia Fields kreatora.
setFiltersApplied(filtersApplied)GetDataResponseUstawia stan zastosowanych filtrów w tym kreatorze.

GetSchemaResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza ten obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWypisuje reprezentację obiektu w formacie JSON.
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 kreatora 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ąpienie tego wpisu konfiguracji.
setHelpText(helpText)SelectMultipleUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)SelectMultipleUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)SelectMultipleUstawia dynamiczny stan 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ąpienie tego wpisu konfiguracji.
setHelpText(helpText)SelectSingleUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)SelectSingleUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)SelectSingleUstawia dynamiczny stan dla tego wpisu konfiguracji.
setName(name)SelectSingleUstawia wyświetlaną nazwę tego wpisu konfiguracji.

SetCredentialsResponse

Metody

MetodaZwracany typKrótki opis
build()ObjectSprawdza ten obiekt i zwraca go w formacie wymaganym przez Studio danych.
printJson()StringWypisuje reprezentację obiektu w formacie JSON.
setIsValid(isValid)SetCredentialsResponseOkreśla prawidłowy stan tego elementu SetCredentialsResponse.

TextArea

Metody

MetodaZwracany typKrótki opis
setAllowOverride(allowOverride)TextAreaUmożliwia zastąpienie tego wpisu konfiguracji.
setHelpText(helpText)TextAreaUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)TextAreaUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)TextAreaUstawia dynamiczny stan 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)TextInputUmożliwia zastąpienie tego wpisu konfiguracji.
setHelpText(helpText)TextInputUstawia tekst pomocy dla tego wpisu konfiguracji.
setId(id)TextInputUstawia unikalny identyfikator tego wpisu konfiguracji.
setIsDynamic(isDynamic)TextInputUstawia dynamiczny stan 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()StringWypisuje reprezentację 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()voidWyjątek jest zgłaszany.