Ta usługa umożliwia skryptom dostęp do społecznościowego oprogramowania sprzęgającego w Studiu danych oraz ich modyfikowanie.
Zajęcia
Nazwa | Krótki opis |
---|---|
AggregationType | Wyliczenie definiujące typy agregacji, które można ustawić dla Field . |
AuthType | Wyliczenie definiujące typy uwierzytelniania, które można ustawić dla oprogramowania sprzęgającego. |
BigQueryConfig | Obiekt konfiguracji natywnego oprogramowania sprzęgającego BigQuery. |
BigQueryParameterType | Wyliczenie definiujące typy parametrów BigQuery, które możesz ustawić. |
Checkbox | Zawiera informacje o polach wyboru konfiguracji. |
CommunityConnector | CommunityConnector 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. |
Config | Zawiera wpisy konfiguracji oprogramowania sprzęgającego. |
DataStudioApp | DataStudioApp umożliwia skryptom interakcję z funkcjami zorientowanymi na programistów w Studio danych. |
DebugError | Błąd widoczny tylko dla administratorów oprogramowania sprzęgającego. |
Field | Zawiera dane związane z polami. |
FieldType | Wyliczenie definiujące typy, które można ustawić dla Field . |
Fields | Zawiera zestaw komponentów Field na potrzeby społecznościowego oprogramowania sprzęgającego. |
GetAuthTypeResponse | Kreator odpowiedzi getAuthType() dla projektu skryptu. |
GetDataResponse | Kreator odpowiedzi getData() dla projektu skryptu. |
GetSchemaResponse | Kreator odpowiedzi getSchema() dla projektu skryptu. |
Info | Zawiera informacje o konfiguracji. |
OptionBuilder | Kreator do tworzenia opcji dla komponentów SelectSingle i SelectMultiple . |
SelectMultiple | Zawiera kilka informacji wybranych do konfiguracji. |
SelectSingle | Zawiera jedną informację do konfiguracji. |
SetCredentialsResponse | Kreator odpowiedzi setCredentials() dla projektu skryptu. |
TextArea | Zawiera informacje o obszarze tekstowym konfiguracji. |
TextInput | Zawiera dane wejściowe konfiguracji. |
UserError | Błąd wyświetlany użytkownikom oprogramowania sprzęgającego. |
AggregationType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
AVG | Enum | Przeciętna. |
COUNT | Enum | Liczba. |
COUNT_DISTINCT | Enum | Liczba unikalnych wartości. |
MAX | Enum | Maks. |
MIN | Enum | Min. |
SUM | Enum | Suma |
AUTO | Enum | Automatyczny. |
AuthType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
NONE | Enum | Autoryzacja nie jest wymagana. |
OAUTH2 | Enum | Wymagana jest autoryzacja OAuth2. |
USER_PASS | Enum | Wymagane są nazwa użytkownika i hasło. |
PATH_USER_PASS | Enum | Wymagane są nazwa użytkownika, ścieżka i hasło. |
PATH_KEY | Enum | Potrzebna jest ścieżka i klucz. |
KEY | Enum | Wymagany klucz interfejsu API lub token. |
USER_TOKEN | Enum | Wymagane są nazwa użytkownika i token. |
BigQueryConfig
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addQueryParameter(name, type, value) | BigQueryConfig | Dodaje parametr zapytania do tego parametru BigQueryConfig . |
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setAccessToken(accessToken) | BigQueryConfig | Ustawia token dostępu tego urządzenia BigQueryConfig . |
setBillingProjectId(billingProjectId) | BigQueryConfig | Ustawia identyfikator projektu rozliczeniowego BigQueryConfig . |
setQuery(query) | BigQueryConfig | Ustawia zapytanie SQL tego obiektu BigQueryConfig . |
setUseStandardSql(useStandardSql) | BigQueryConfig | Określa, czy zapytanie jest interpretowane jako standardowy czy starszy SQL. |
BigQueryParameterType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
STRING | Enum | Ciąg tekstowy. |
INT64 | Enum | 64-bitowa liczba całkowita. |
BOOL | Enum | Wartość logiczna. |
FLOAT64 | Enum | 64-bitowa liczba zmiennoprzecinkowa. |
Checkbox
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setAllowOverride(allowOverride) | Checkbox | Umożliwia zastępowanie tego wpisu konfiguracji. |
setHelpText(helpText) | Checkbox | Ustawia tekst pomocy dla tego wpisu konfiguracji. |
setId(id) | Checkbox | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setIsDynamic(isDynamic) | Checkbox | Ustawia stan dynamiczny dla tego wpisu konfiguracji. |
setName(name) | Checkbox | Ustawia wyświetlaną nazwę tego wpisu konfiguracji. |
CommunityConnector
Właściwości
Właściwość | Typ | Opis |
---|---|---|
AggregationType | AggregationType | Wyliczenie AggregationType . |
AuthType | AuthType | Wyliczenie AuthType . |
BigQueryParameterType | BigQueryParameterType | Wyliczenie BigQueryParameterType . |
FieldType | FieldType | Wyliczenie FieldType . |
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getConfig() | Config | Zwraca obiekt Config . |
getFields() | Fields | Zwraca obiekt Fields . |
newAuthTypeResponse() | GetAuthTypeResponse | Zwraca nowy obiekt GetAuthTypeResponse . |
newBigQueryConfig() | BigQueryConfig | Zwraca nowy obiekt BigQueryConfig . |
newDebugError() | DebugError | Zwraca nowy obiekt DebugError . |
newGetDataResponse() | GetDataResponse | Zwraca nowy obiekt GetDataResponse . |
newGetSchemaResponse() | GetSchemaResponse | Zwraca nowy obiekt GetSchemaResponse . |
newSetCredentialsResponse() | SetCredentialsResponse | Zwraca nowy obiekt SetCredentialsResponse . |
newUserError() | UserError | Zwraca nowy obiekt UserError . |
Config
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
newCheckbox() | Checkbox | Zwraca nowy wpis konfiguracji pola wyboru. |
newInfo() | Info | Zwraca nowy wpis konfiguracji informacji. |
newOptionBuilder() | OptionBuilder | Zwraca nowy konstruktor opcji. |
newSelectMultiple() | SelectMultiple | Zwraca nowy wpis konfiguracji z możliwością wyboru wielu elementów. |
newSelectSingle() | SelectSingle | Zwraca nowy, pojedynczy wpis konfiguracji. |
newTextArea() | TextArea | Zwraca nowy wpis konfiguracji obszaru tekstowego. |
newTextInput() | TextInput | Zwraca nowy wpis konfiguracji wprowadzania tekstu. |
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setDateRangeRequired(dateRangeRequired) | Config | Jeśli ustawiona jest wartość true , dla żądań getData() podany jest zakres dat. |
setIsSteppedConfig(isSteppedConfig) | Config | Jeśli ustawiona jest wartość true , metoda getConfig() jest wywoływana ponownie z zastosowaniem bieżącej konfiguracji użytkownika. |
DataStudioApp
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
createCommunityConnector() | CommunityConnector | Tworzy nowe społecznościowe oprogramowanie sprzęgające. |
DebugError
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setText(text) | DebugError | Ustawia tekst błędu debugowania, który jest widoczny tylko dla administratorów. |
throwException() | void | Wywołuje zgłoszenie tego wyjątku. |
Field
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getAggregation() | AggregationType | Zwraca AggregationType elementu Field . |
getDescription() | String | Zwraca opis elementu Field . |
getFormula() | String | Zwraca formułę tej funkcji Field . |
getGroup() | String | Zwraca grupę Field . |
getId() | String | Zwraca identyfikator elementu Field . |
getIsReaggregatable() | Boolean | Zwraca wartość true , jeśli można ponownie zagregować to pole. W przeciwnym razie zwraca wartość false . |
getName() | String | Zwraca nazwę tego elementu (Field ). |
getType() | FieldType | Zwraca FieldType elementu Field . |
isDefault() | Boolean | Zwraca wartość true , jeśli ta Field jest domyślnymi danymi lub wymiarami. |
isDimension() | Boolean | Zwraca wartość true , jeśli to pole jest wymiarem. |
isHidden() | Boolean | Zwraca wartość true , jeśli parametr Field jest ukryty. |
isMetric() | Boolean | Zwraca wartość true , jeśli to pole zawiera dane. |
setAggregation(aggregation) | Field | Ustawia typ agregacji obiektu Field . |
setDescription(description) | Field | Ustawia opis obiektu Field . |
setFormula(formula) | Field | Ustawia formułę tej funkcji: Field . |
setGroup(group) | Field | Ustawia grupę urządzeń Field . |
setId(id) | Field | Ustawia identyfikator tego zasobu (Field ). |
setIsHidden(isHidden) | Field | Ustawia stan ukryty dla obiektu Field . |
setIsReaggregatable(isReaggregatable) | Field | Wyznacza stan zezwolenia na ponowną agregację dla obiektu Field . |
setName(name) | Field | Ustawia nazwę tego urządzenia Field . |
setType(type) | Field | Ustawia FieldType tego komponentu (Field ). |
FieldType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
YEAR | Enum | Rok w formacie RRRR, na przykład 2017. |
YEAR_QUARTER | Enum | Rok i kwartał w formacie RRRRQ, np. 20171. |
YEAR_MONTH | Enum | Rok i miesiąc w formacie RRRRMM, np. 201703. |
YEAR_WEEK | Enum | Rok i tydzień w formacie RRRRtt, np. 201707. |
YEAR_MONTH_DAY | Enum | Rok, miesiąc i dzień w formacie RRRRMMDD, np. 20170317. |
YEAR_MONTH_DAY_HOUR | Enum | Rok, miesiąc, dzień i godzina w formacie RRRRMMDDGG, np. 2017031703. |
YEAR_MONTH_DAY_MINUTE | Enum | Rok, miesiąc, dzień, godzina i minuta w formacie RRRRMMDDGGmm, np. 201703170230. |
YEAR_MONTH_DAY_SECOND | Enum | Rok, miesiąc, dzień, godzina, minuta i sekunda w formacie RRRRMMDDGGmmss, np. 20170317023017. |
QUARTER | Enum | Kwartał w formacie 1, 2, 3 lub 4). |
MONTH | Enum | Miesiąc w formacie MM, np. 03. |
WEEK | Enum | Tydzień w formacie ww, np. 07. |
MONTH_DAY | Enum | Miesiąc i dzień w formacie MMDD, np. 0317. |
DAY_OF_WEEK | Enum | Liczba z zakresu [0,6], gdzie 0 oznacza niedzielę. |
DAY | Enum | Dzień w formacie DD, np. 17. |
HOUR | Enum | Godzina w formacie HH, np. 13. |
MINUTE | Enum | Minuta w formacie mm, np. 12. |
DURATION | Enum | Czas trwania w sekundach. |
COUNTRY | Enum | Kraj, np. Polska. |
COUNTRY_CODE | Enum | Kod kraju, np. PL. |
CONTINENT | Enum | Kontynent, taki jak Ameryki. |
CONTINENT_CODE | Enum | Kod kontynentu, np. 019. |
SUB_CONTINENT | Enum | Subkontynent, np. Ameryka Północna. |
SUB_CONTINENT_CODE | Enum | Kod subkontynentu, np. 003. |
REGION | Enum | Region, np. Kalifornia. |
REGION_CODE | Enum | Kod regionu, na przykład urząd certyfikacji. |
CITY | Enum | Miasto, np. Warszawa. |
CITY_CODE | Enum | Kod miasta, np. 1014044. |
METRO | Enum | Obszar miejski, np. San Francisco-Oakland-San Jose, Kalifornia. |
METRO_CODE | Enum | Kod obszaru miejskiego, np. 200807. |
LATITUDE_LONGITUDE | Enum | Para szerokości i długości geograficznej, np.51.5074, -0,1278. |
NUMBER | Enum | Liczba dziesiętna. |
PERCENT | Enum | Procent dziesiętny (może być większy niż 1,0). |
TEXT | Enum | Dowolny tekst. |
BOOLEAN | Enum | Wartość logiczna true lub false . |
URL | Enum | Adres URL, np. https://google.com. |
HYPERLINK | Enum | Hiperłącze. |
IMAGE | Enum | Obraz. |
IMAGE_LINK | Enum | Link do zdjęcia. |
CURRENCY_AED | Enum | Waluta z AED. |
CURRENCY_ALL | Enum | Waluta ze WSZYSTKICH. |
CURRENCY_ARS | Enum | Waluta z ARS. |
CURRENCY_AUD | Enum | Waluta z AUD. |
CURRENCY_BDT | Enum | Waluta z BDT. |
CURRENCY_BGN | Enum | Waluta z BGN. |
CURRENCY_BOB | Enum | Waluta z BOB. |
CURRENCY_BRL | Enum | Waluta z BRL. |
CURRENCY_CAD | Enum | Waluta z CAD. |
CURRENCY_CDF | Enum | Waluta z CDF. |
CURRENCY_CHF | Enum | Waluta z CHF. |
CURRENCY_CLP | Enum | Waluta z CLP. |
CURRENCY_CNY | Enum | Waluta z CNY. |
CURRENCY_COP | Enum | Waluta z COP. |
CURRENCY_CRC | Enum | Waluta z CRC. |
CURRENCY_CZK | Enum | Waluta z CZK. |
CURRENCY_DKK | Enum | Waluta z DKK. |
CURRENCY_DOP | Enum | Waluta z DOP. |
CURRENCY_EGP | Enum | Waluta z EGP. |
CURRENCY_ETB | Enum | Waluta z ETB. |
CURRENCY_EUR | Enum | Waluta z EUR. |
CURRENCY_GBP | Enum | Waluta z GBP. |
CURRENCY_HKD | Enum | Waluta z HKD. |
CURRENCY_HRK | Enum | Waluta z HRK. |
CURRENCY_HUF | Enum | Waluta z HUF. |
CURRENCY_IDR | Enum | Waluta z IDR. |
CURRENCY_ILS | Enum | Waluta to ILS. |
CURRENCY_INR | Enum | Waluta z INR. |
CURRENCY_IRR | Enum | Waluta z IRR. |
CURRENCY_ISK | Enum | Waluta z ISK. |
CURRENCY_JMD | Enum | Waluta od JMD. |
CURRENCY_JPY | Enum | Waluta z JPY. |
CURRENCY_KRW | Enum | Waluta z KRW. |
CURRENCY_LKR | Enum | Waluta z LKR. |
CURRENCY_LTL | Enum | Waluta z LTL. |
CURRENCY_MNT | Enum | Waluta z MNT. |
CURRENCY_MVR | Enum | Waluta z MVR. |
CURRENCY_MXN | Enum | Waluta z MXN. |
CURRENCY_MYR | Enum | Waluta z MYR. |
CURRENCY_NGN | Enum | Waluta z NGN. |
CURRENCY_NOK | Enum | Waluta z NOK. |
CURRENCY_NZD | Enum | Waluta z NZD. |
CURRENCY_PAB | Enum | Waluta z PAB. |
CURRENCY_PEN | Enum | Waluta z PEN. |
CURRENCY_PHP | Enum | Waluta z PHP. |
CURRENCY_PKR | Enum | Waluta z PKR. |
CURRENCY_PLN | Enum | Waluta od złotych. |
CURRENCY_RON | Enum | Waluta z RON. |
CURRENCY_RSD | Enum | Waluta z RSD. |
CURRENCY_RUB | Enum | Waluta z RUB. |
CURRENCY_SAR | Enum | Waluta z SAR. |
CURRENCY_SEK | Enum | Waluta – SEK. |
CURRENCY_SGD | Enum | Waluta z SGD. |
CURRENCY_THB | Enum | Waluta z THB. |
CURRENCY_TRY | Enum | Waluta z TRY. |
CURRENCY_TWD | Enum | Waluta z TWD. |
CURRENCY_TZS | Enum | Waluta z TZS. |
CURRENCY_UAH | Enum | Waluta z UAH. |
CURRENCY_USD | Enum | Waluta z USD. |
CURRENCY_UYU | Enum | Waluta z UYU. |
CURRENCY_VEF | Enum | Waluta z VEF. |
CURRENCY_VND | Enum | Waluta z VND. |
CURRENCY_YER | Enum | Waluta z YER. |
CURRENCY_ZAR | Enum | Waluta z ZAR. |
Fields
Metody
Metoda | Zwracany typ | Kró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) | Fields | Zwraca nowy obiekt Fields przefiltrowany według kryteriów Field z identyfikatorem w ids . |
getDefaultDimension() | Field | Zwraca wymiar domyślny do użycia w zbiorze pól. |
getDefaultMetric() | Field | Zwraca domyślny wskaźnik, który ma być używany w zbiorze pól. |
getFieldById(fieldId) | Field | Zwraca pole o podanym identyfikatorze lub null , jeśli w obiekcie Fields nie ma pola o takim identyfikatorze. |
newDimension() | Field | Zwraca nowy wymiar Field . |
newMetric() | Field | Zwraca nowy wskaźnik Field . |
setDefaultDimension(fieldId) | void | Określa domyślny wymiar, który ma być używany dla zbioru pól. |
setDefaultMetric(fieldId) | void | Określa domyślny wskaźnik do użycia w zbiorze pól. |
GetAuthTypeResponse
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setAuthType(authType) | GetAuthTypeResponse | Konfiguruje AuthType konstruktora. |
setHelpUrl(helpUrl) | GetAuthTypeResponse | Ustawia adres URL pomocy kreatora. |
GetDataResponse
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addAllRows(rows) | GetDataResponse | Dodaje wiele wierszy danych do tabeli GetDataResponse . |
addRow(row) | GetDataResponse | Dodaje wiersz danych do: GetDataResponse . |
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
setFields(fields) | GetDataResponse | Konfiguruje Fields konstruktora. |
setFiltersApplied(filtersApplied) | GetDataResponse | Ustawia stan zastosowanych filtrów w tym konstruktorze. |
GetSchemaResponse
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setFields(fields) | GetSchemaResponse | Konfiguruje Fields konstruktora. |
Info
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setId(id) | Info | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setText(text) | Info | Ustawia tekst tego wpisu konfiguracji. |
OptionBuilder
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setLabel(label) | OptionBuilder | Ustawia etykietę tego konstruktora opcji. |
setValue(value) | OptionBuilder | Ustawia wartość tego kreatora opcji. |
SelectMultiple
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addOption(optionBuilder) | SelectMultiple | Dodaje nową opcję wyboru. |
setAllowOverride(allowOverride) | SelectMultiple | Umożliwia zastępowanie tego wpisu konfiguracji. |
setHelpText(helpText) | SelectMultiple | Ustawia tekst pomocy dla tego wpisu konfiguracji. |
setId(id) | SelectMultiple | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setIsDynamic(isDynamic) | SelectMultiple | Ustawia stan dynamiczny dla tego wpisu konfiguracji. |
setName(name) | SelectMultiple | Ustawia wyświetlaną nazwę tego wpisu konfiguracji. |
SelectSingle
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addOption(optionBuilder) | SelectSingle | Dodaje nową opcję wyboru. |
setAllowOverride(allowOverride) | SelectSingle | Umożliwia zastępowanie tego wpisu konfiguracji. |
setHelpText(helpText) | SelectSingle | Ustawia tekst pomocy dla tego wpisu konfiguracji. |
setId(id) | SelectSingle | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setIsDynamic(isDynamic) | SelectSingle | Ustawia stan dynamiczny dla tego wpisu konfiguracji. |
setName(name) | SelectSingle | Ustawia wyświetlaną nazwę tego wpisu konfiguracji. |
SetCredentialsResponse
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
build() | Object | Weryfikuje obiekt i zwraca go w formacie wymaganym przez Studio danych. |
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setIsValid(isValid) | SetCredentialsResponse | Określa prawidłowy stan urządzenia SetCredentialsResponse . |
TextArea
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setAllowOverride(allowOverride) | TextArea | Umożliwia zastępowanie tego wpisu konfiguracji. |
setHelpText(helpText) | TextArea | Ustawia tekst pomocy dla tego wpisu konfiguracji. |
setId(id) | TextArea | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setIsDynamic(isDynamic) | TextArea | Ustawia stan dynamiczny dla tego wpisu konfiguracji. |
setName(name) | TextArea | Ustawia wyświetlaną nazwę tego wpisu konfiguracji. |
setPlaceholder(placeholder) | TextArea | Ustawia tekst zastępczy tej pozycji konfiguracji. |
TextInput
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
setAllowOverride(allowOverride) | TextInput | Umożliwia zastępowanie tego wpisu konfiguracji. |
setHelpText(helpText) | TextInput | Ustawia tekst pomocy dla tego wpisu konfiguracji. |
setId(id) | TextInput | Ustawia unikalny identyfikator tego wpisu konfiguracji. |
setIsDynamic(isDynamic) | TextInput | Ustawia stan dynamiczny dla tego wpisu konfiguracji. |
setName(name) | TextInput | Ustawia wyświetlaną nazwę tego wpisu konfiguracji. |
setPlaceholder(placeholder) | TextInput | Ustawia tekst zastępczy tej pozycji konfiguracji. |
UserError
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
printJson() | String | Drukuje reprezentację tego obiektu w formacie JSON. |
setDebugText(text) | UserError | Ustawia tekst błędu debugowania, który jest widoczny tylko dla administratorów. |
setText(text) | UserError | Ustawia tekst błędu użytkownika. |
throwException() | void | Wywołuje zgłoszenie tego wyjątku. |