Data Studio Service

Data Studio

Questo servizio consente agli script di accedere e modificare i connettori della community di Data Studio.

Corsi

NomeBreve descrizione
AggregationTypeUn enum che definisce i tipi di aggregazione che possono essere impostati per un Field.
AuthTypeUn enum che definisce i tipi di autenticazione che possono essere impostati per un connettore.
BigQueryConfigUn oggetto di configurazione per un connettore BigQuery nativo.
BigQueryParameterTypeUn enum che definisce i tipi di parametri BigQuery che puoi impostare.
CheckboxContiene le informazioni sulle caselle di controllo per la configurazione.
CommunityConnectorIl connettore della community consente agli script di accedere a generatori e utilità per facilitare lo sviluppo dei connettori della community per Data Studio.
ConfigContiene le voci di configurazione per un connettore.
DataStudioAppL'app DataStudio consente agli script di interagire con le funzionalità per sviluppatori di Data Studio.
DebugErrorUn errore visibile solo agli amministratori del connettore.
FieldContiene dati relativi al campo.
FieldTypeUn enum che definisce i tipi che possono essere impostati per un Field.
FieldsContiene un insieme di Field per un connettore della community.
GetAuthTypeResponseGeneratore per creare una risposta getAuthType() per il progetto di script.
GetDataResponseGeneratore per creare una risposta getData() per il progetto di script.
GetSchemaResponseGeneratore per creare una risposta getSchema() per il progetto di script.
InfoContiene i dati di informazioni per la configurazione.
OptionBuilderUn generatore per creare opzioni per SelectSingle e SelectMultiple.
SelectMultipleContiene più informazioni selezionate per la configurazione.
SelectSingleContiene informazioni singole selezionate per la configurazione.
SetCredentialsResponseGeneratore per creare una risposta setCredentials() per il progetto di script.
TextAreaContiene le informazioni sull'area di testo per la configurazione.
TextInputContiene le informazioni di inserimento di testo per la configurazione.
UserErrorUn errore visualizzato agli utenti del connettore.

AggregationType

Proprietà

ProprietàTipoDescrizione
AVGEnumMedia.
COUNTEnumConteggio.
COUNT_DISTINCTEnumConteggio distinto.
MAXEnumMax.
MINEnumMin.
SUMEnumSomma:
AUTOEnumAutomatica.

AuthType

Proprietà

ProprietàTipoDescrizione
NONEEnumNessuna autorizzazione richiesta.
OAUTH2EnumÈ necessaria l'autorizzazione OAuth2.
USER_PASSEnumSono necessarie le credenziali di nome utente e password.
PATH_USER_PASSEnumSono necessari nome utente, percorso e password.
PATH_KEYEnumPercorso e chiave necessari.
KEYEnumÈ necessaria una chiave o un token API.
USER_TOKENEnumSono necessari nome utente e token.

BigQueryConfig

Metodi

MetodoTipo restituitoBreve descrizione
addQueryParameter(name, type, value)BigQueryConfigAggiunge un parametro di query a questo BigQueryConfig.
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setAccessToken(accessToken)BigQueryConfigImposta il token di accesso di questo BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigImposta l'ID progetto di fatturazione di questo BigQueryConfig.
setQuery(query)BigQueryConfigImposta la query SQL di questo BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigDetermina se la query viene interpretata come SQL standard o precedente.

BigQueryParameterType

Proprietà

ProprietàTipoDescrizione
STRINGEnumStringa.
INT64EnumNumero intero a 64 bit.
BOOLEnumBooleano.
FLOAT64EnumNumero in virgola mobile a 64 bit.

Checkbox

Metodi

MetodoTipo restituitoBreve descrizione
setAllowOverride(allowOverride)CheckboxConsente l'override per questa voce di configurazione.
setHelpText(helpText)CheckboxImposta il testo della guida per questa voce di configurazione.
setId(id)CheckboxImposta l'ID univoco per questa voce di configurazione.
setIsDynamic(isDynamic)CheckboxImposta lo stato dinamico per questa voce di configurazione.
setName(name)CheckboxImposta il nome visualizzato per questa voce di configurazione.

CommunityConnector

Proprietà

ProprietàTipoDescrizione
AggregationTypeAggregationTypeL'enumerazione AggregationType.
AuthTypeAuthTypeL'enumerazione AuthType.
BigQueryParameterTypeBigQueryParameterTypeL'enumerazione BigQueryParameterType.
FieldTypeFieldTypeL'enumerazione FieldType.

Metodi

MetodoTipo restituitoBreve descrizione
getConfig()ConfigRestituisce un oggetto Config.
getFields()FieldsRestituisce un oggetto Fields.
newAuthTypeResponse()GetAuthTypeResponseRestituisce un nuovo oggetto GetAuthTypeResponse.
newBigQueryConfig()BigQueryConfigRestituisce un nuovo oggetto BigQueryConfig.
newDebugError()DebugErrorRestituisce un nuovo oggetto DebugError.
newGetDataResponse()GetDataResponseRestituisce un nuovo oggetto GetDataResponse.
newGetSchemaResponse()GetSchemaResponseRestituisce un nuovo oggetto GetSchemaResponse.
newSetCredentialsResponse()SetCredentialsResponseRestituisce un nuovo oggetto SetCredentialsResponse.
newUserError()UserErrorRestituisce un nuovo oggetto UserError.

Config

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
newCheckbox()CheckboxRestituisce una nuova voce di configurazione della casella di controllo.
newInfo()InfoRestituisce una nuova voce di configurazione delle informazioni.
newOptionBuilder()OptionBuilderRestituisce un nuovo generatore di opzioni.
newSelectMultiple()SelectMultipleRestituisce una nuova voce di configurazione di selezione multipla.
newSelectSingle()SelectSingleRestituisce una nuova voce di configurazione singola selezionata.
newTextArea()TextAreaRestituisce una nuova voce di configurazione dell'area di testo.
newTextInput()TextInputRestituisce una nuova voce di configurazione dell'input di testo.
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setDateRangeRequired(dateRangeRequired)ConfigSe true, viene fornito un intervallo di date per le richieste getData().
setIsSteppedConfig(isSteppedConfig)ConfigSe true, getConfig() viene richiamato di nuovo con la configurazione utente corrente.

DataStudioApp

Metodi

MetodoTipo restituitoBreve descrizione
createCommunityConnector()CommunityConnectorCrea un nuovo connettore della community.

DebugError

Metodi

MetodoTipo restituitoBreve descrizione
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setText(text)DebugErrorImposta il testo dell'errore di debug, che viene mostrato solo agli amministratori.
throwException()voidAttiva l'eccezione.

Field

Metodi

MetodoTipo restituitoBreve descrizione
getAggregation()AggregationTypeRestituisce il AggregationType di questo Field.
getDescription()StringRestituisce la descrizione di questo Field.
getFormula()StringRestituisce la formula di questo Field.
getGroup()StringRestituisce il gruppo di questo Field.
getId()StringRestituisce l'ID di questo Field.
getIsReaggregatable()BooleanRestituisce true se questo campo può essere aggregato di nuovo, false in caso contrario.
getName()StringRestituisce il nome di questo Field.
getType()FieldTypeRestituisce il FieldType di questo Field.
isDefault()BooleanRestituisce true se Field è la metrica o la dimensione predefinita.
isDimension()BooleanRestituisce true se questo campo è una dimensione.
isHidden()BooleanRestituisce true se questo Field è nascosto.
isMetric()BooleanRestituisce true se questo campo è una metrica.
setAggregation(aggregation)FieldImposta il tipo di aggregazione di questo Field.
setDescription(description)FieldImposta la descrizione di questo Field.
setFormula(formula)FieldImposta la formula di questo Field.
setGroup(group)FieldImposta il gruppo di questo Field.
setId(id)FieldImposta l'ID di questo Field.
setIsHidden(isHidden)FieldImposta lo stato nascosto di questo Field.
setIsReaggregatable(isReaggregatable)FieldImposta lo stato di aggregazione consentita per un Field.
setName(name)FieldImposta il nome di questo Field.
setType(type)FieldImposta il FieldType di questo Field.

FieldType

Proprietà

ProprietàTipoDescrizione
YEAREnumAnno nel formato AAAA, ad esempio 2017.
YEAR_QUARTEREnumAnno e trimestre nel formato AAAAT, ad esempio 20171.
YEAR_MONTHEnumAnno e mese nel formato AAAAMM, ad esempio 201703.
YEAR_WEEKEnumAnno e settimana nel formato AAAAww, ad esempio 201707.
YEAR_MONTH_DAYEnumAnno, mese e giorno nel formato AAAAMMGG, ad esempio 20170317.
YEAR_MONTH_DAY_HOUREnumAnno, mese, giorno e ora nel formato AAAAMMGGHH, ad esempio 2017031703.
YEAR_MONTH_DAY_MINUTEEnumAnno, mese, giorno, ora e minuto nel formato AAAAMMGGHHmm, ad esempio 201703170230.
YEAR_MONTH_DAY_SECONDEnumAnno, mese, giorno, ora, minuto e secondo nel formato AAAAMMGGHHmmss, ad esempio 20170317023017.
QUARTEREnumTrimestre nel formato 1, 2, 3 o 4).
MONTHEnumMese nel formato MM, ad esempio 03.
WEEKEnumSettimana nel formato ww, ad esempio 07.
MONTH_DAYEnumMese e giorno nel formato MMGG, ad esempio 0317.
DAY_OF_WEEKEnumUn numero nell'intervallo [0,6] con 0 che rappresenta la domenica.
DAYEnumGiorno nel formato GG, ad esempio 17.
HOUREnumOra nel formato HH, ad esempio 13.
MINUTEEnumMinuto nel formato mm, ad esempio 12.
DURATIONEnumUna durata in secondi.
COUNTRYEnumUn paese come gli Stati Uniti.
COUNTRY_CODEEnumUn codice paese, ad esempio US.
CONTINENTEnumUn continente come le Americhe.
CONTINENT_CODEEnumUn codice continente, ad esempio 019.
SUB_CONTINENTEnumUn subcontinente come l'America del Nord.
SUB_CONTINENT_CODEEnumUn codice di subcontinente, ad esempio 003.
REGIONEnumUna regione come la California.
REGION_CODEEnumUn codice regione come CA.
CITYEnumUna città come Mountain View.
CITY_CODEEnumUn codice città, ad esempio 1014044.
METROEnumUna metropolitana come San Francisco-Oakland-San Jose CA.
METRO_CODEEnumUn codice area metropolitana, ad esempio 200807.
LATITUDE_LONGITUDEEnumUna coppia di latitudine e longitudine, ad esempio 51,5074, -0,1278.
NUMBEREnumUn numero decimale.
PERCENTEnumPercentuale decimale (può essere superiore a 1,0).
TEXTEnumTesto in formato libero.
BOOLEANEnumUn valore booleano true o false.
URLEnumUn URL come testo, ad esempio https://google.com.
HYPERLINKEnumUn link ipertestuale.
IMAGEEnumUn'immagine.
IMAGE_LINKEnumUn link a un'immagine.
CURRENCY_AEDEnumValuta in AED.
CURRENCY_ALLEnumValuta in ALL.
CURRENCY_ARSEnumValuta da ARS.
CURRENCY_AUDEnumValuta in AUD.
CURRENCY_BDTEnumValuta in BDT.
CURRENCY_BGNEnumValuta in leva bulgara.
CURRENCY_BOBEnumValuta da BOB.
CURRENCY_BRLEnumValuta in R$.
CURRENCY_CADEnumValuta in CAD.
CURRENCY_CDFEnumValuta da CDF.
CURRENCY_CHFEnumValuta da CHF.
CURRENCY_CLPEnumValuta da CLP.
CURRENCY_CNYEnumValuta in CNY.
CURRENCY_COPEnumValuta da COP.
CURRENCY_CRCEnumValuta del CRC.
CURRENCY_CZKEnumValuta in CZK.
CURRENCY_DKKEnumValuta da DKK.
CURRENCY_DOPEnumValuta da DOP.
CURRENCY_EGPEnumValuta in EGP.
CURRENCY_ETBEnumValuta da ETB.
CURRENCY_EUREnumValuta in euro.
CURRENCY_GBPEnumValuta da GBP.
CURRENCY_HKDEnumValuta da HKD.
CURRENCY_HRKEnumValuta in HRK.
CURRENCY_HUFEnumValuta da HUF.
CURRENCY_IDREnumValuta da IDR.
CURRENCY_ILSEnumValuta in ILS.
CURRENCY_INREnumValuta in INR.
CURRENCY_IRREnumValuta dell'IRR.
CURRENCY_ISKEnumValuta in ISK.
CURRENCY_JMDEnumValuta JMD.
CURRENCY_JPYEnumValuta in JPY.
CURRENCY_KRWEnumValuta in KRW.
CURRENCY_LKREnumValuta da LKR.
CURRENCY_LTLEnumValuta da LTL.
CURRENCY_MNTEnumValuta da MNT.
CURRENCY_MVREnumValuta da MVR.
CURRENCY_MXNEnumValuta da MXN.
CURRENCY_MYREnumValuta in RM.
CURRENCY_NGNEnumValuta in NGN.
CURRENCY_NOKEnumValuta da NOK.
CURRENCY_NZDEnumValuta da NZD.
CURRENCY_PABEnumValuta da PAB.
CURRENCY_PENEnumValuta da PEN.
CURRENCY_PHPEnumValuta da PHP.
CURRENCY_PKREnumValuta in PKR.
CURRENCY_PLNEnumValuta in PLN.
CURRENCY_RONEnumValuta in lei rumeni.
CURRENCY_RSDEnumValuta da RSD.
CURRENCY_RUBEnumValuta da RUB.
CURRENCY_SAREnumValuta da SAR.
CURRENCY_SEKEnumValuta in SEK.
CURRENCY_SGDEnumValuta in SGD.
CURRENCY_THBEnumValuta in ฿.
CURRENCY_TRYEnumValuta in TRY.
CURRENCY_TWDEnumValuta in TWD.
CURRENCY_TZSEnumValuta da TZS.
CURRENCY_UAHEnumValuta in UAH.
CURRENCY_USDEnumValuta da USD.
CURRENCY_UYUEnumValuta da UYU.
CURRENCY_VEFEnumValuta da VEF.
CURRENCY_VNDEnumValuta da VND.
CURRENCY_YEREnumValuta da YER.
CURRENCY_ZAREnumValuta da ZAR.

Fields

Metodi

MetodoTipo restituitoBreve descrizione
asArray()Field[]Restituisce una visualizzazione di questo oggetto come array.
build()Object[]Convalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
forIds(ids)FieldsRestituisce un nuovo oggetto Fields filtrato per Field con un ID in ids.
getDefaultDimension()FieldRestituisce la dimensione predefinita da utilizzare per l'insieme di campi.
getDefaultMetric()FieldRestituisce la metrica predefinita da utilizzare per l'insieme di campi.
getFieldById(fieldId)FieldRestituisce un campo con un determinato ID o null se non è presente alcun campo con questo ID in questo oggetto Fields.
newDimension()FieldRestituisce una nuova dimensione Field.
newMetric()FieldRestituisce una nuova metrica Field.
setDefaultDimension(fieldId)voidImposta la dimensione predefinita da utilizzare per l'insieme di campi.
setDefaultMetric(fieldId)voidImposta la metrica predefinita da utilizzare per l'insieme di campi.

GetAuthTypeResponse

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setAuthType(authType)GetAuthTypeResponseImposta il AuthType del generatore.
setHelpUrl(helpUrl)GetAuthTypeResponseImposta l'URL di assistenza dello strumento di creazione.

GetDataResponse

Metodi

MetodoTipo restituitoBreve descrizione
addAllRows(rows)GetDataResponseAggiunge più righe di dati a questo GetDataResponse.
addRow(row)GetDataResponseAggiunge una riga di dati a questo GetDataResponse.
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
setFields(fields)GetDataResponseImposta il Fields del generatore.
setFiltersApplied(filtersApplied)GetDataResponseImposta lo stato dei filtri applicati per questo generatore.

GetSchemaResponse

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setFields(fields)GetSchemaResponseImposta il Fields del generatore.

Info

Metodi

MetodoTipo restituitoBreve descrizione
setId(id)InfoImposta l'ID univoco per questa voce di configurazione.
setText(text)InfoImposta il testo per questa voce di configurazione.

OptionBuilder

Metodi

MetodoTipo restituitoBreve descrizione
setLabel(label)OptionBuilderImposta l'etichetta di questo generatore di opzioni.
setValue(value)OptionBuilderImposta il valore di questo generatore di opzioni.

SelectMultiple

Metodi

MetodoTipo restituitoBreve descrizione
addOption(optionBuilder)SelectMultipleAggiunge una nuova opzione di selezione.
setAllowOverride(allowOverride)SelectMultipleConsente l'override per questa voce di configurazione.
setHelpText(helpText)SelectMultipleImposta il testo della guida per questa voce di configurazione.
setId(id)SelectMultipleImposta l'ID univoco per questa voce di configurazione.
setIsDynamic(isDynamic)SelectMultipleImposta lo stato dinamico per questa voce di configurazione.
setName(name)SelectMultipleImposta il nome visualizzato per questa voce di configurazione.

SelectSingle

Metodi

MetodoTipo restituitoBreve descrizione
addOption(optionBuilder)SelectSingleAggiunge una nuova opzione di selezione.
setAllowOverride(allowOverride)SelectSingleConsente l'override per questa voce di configurazione.
setHelpText(helpText)SelectSingleImposta il testo della guida per questa voce di configurazione.
setId(id)SelectSingleImposta l'ID univoco per questa voce di configurazione.
setIsDynamic(isDynamic)SelectSingleImposta lo stato dinamico per questa voce di configurazione.
setName(name)SelectSingleImposta il nome visualizzato per questa voce di configurazione.

SetCredentialsResponse

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida questo oggetto e lo restituisce nel formato necessario per Data Studio.
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setIsValid(isValid)SetCredentialsResponseImposta lo stato valido di questo SetCredentialsResponse.

TextArea

Metodi

MetodoTipo restituitoBreve descrizione
setAllowOverride(allowOverride)TextAreaConsente l'override per questa voce di configurazione.
setHelpText(helpText)TextAreaImposta il testo della guida per questa voce di configurazione.
setId(id)TextAreaImposta l'ID univoco per questa voce di configurazione.
setIsDynamic(isDynamic)TextAreaImposta lo stato dinamico per questa voce di configurazione.
setName(name)TextAreaImposta il nome visualizzato per questa voce di configurazione.
setPlaceholder(placeholder)TextAreaImposta il testo segnaposto per questa voce di configurazione.

TextInput

Metodi

MetodoTipo restituitoBreve descrizione
setAllowOverride(allowOverride)TextInputConsente l'override per questa voce di configurazione.
setHelpText(helpText)TextInputImposta il testo della guida per questa voce di configurazione.
setId(id)TextInputImposta l'ID univoco per questa voce di configurazione.
setIsDynamic(isDynamic)TextInputImposta lo stato dinamico per questa voce di configurazione.
setName(name)TextInputImposta il nome visualizzato per questa voce di configurazione.
setPlaceholder(placeholder)TextInputImposta il testo segnaposto per questa voce di configurazione.

UserError

Metodi

MetodoTipo restituitoBreve descrizione
printJson()StringStampa la rappresentazione JSON di questo oggetto.
setDebugText(text)UserErrorImposta il testo dell'errore di debug, che viene mostrato solo agli amministratori.
setText(text)UserErrorImposta il testo dell'errore dell'utente.
throwException()voidAttiva l'eccezione.