Data Studio Service

Data Studio

Questo servizio consente agli script di accedere ai connettori della community di Data Studio e modificarli.

Corsi

NomeBreve descrizione
AggregationTypeUn'enumerazione che definisce i tipi di aggregazione che è possibile impostare per un Field.
AuthTypeUn'enumerazione che definisce i tipi di autenticazione che è possibile impostare per un connettore.
BigQueryConfigUn oggetto di configurazione per un connettore BigQuery nativo.
BigQueryParameterTypeUn'enumerazione che definisce i tipi di parametri BigQuery che puoi impostare.
CheckboxContiene informazioni sulla casella di controllo per la configurazione.
CommunityConnectorCommunityConnector consente agli script di accedere a builder e utilità per agevolare lo sviluppo dei connettori della community per Data Studio.
ConfigContiene le voci di configurazione per un connettore.
DataStudioAppDataStudioApp consente agli script di interagire con le funzionalità orientate agli sviluppatori per Data Studio.
DebugErrorUn errore visibile solo agli amministratori del connettore.
FieldContiene dati relativi ai campi.
FieldTypeUn'enumerazione che definisce i tipi che è possibile impostare per un Field.
FieldsContiene un insieme di Field per un connettore della community.
GetAuthTypeResponseBuilder per creare una risposta getAuthType() per il tuo progetto di script.
GetDataResponseBuilder per creare una risposta getData() per il tuo progetto di script.
GetSchemaResponseBuilder per creare una risposta getSchema() per il tuo progetto di script.
InfoContiene informazioni e dati per la configurazione.
OptionBuilderUno strumento per la creazione di opzioni per SelectSingle e SelectMultiple.
SelectMultipleContiene la selezione di più informazioni per la configurazione.
SelectSingleContiene la selezione di singole informazioni per la configurazione.
SetCredentialsResponseBuilder per creare una risposta setCredentials() per il tuo progetto di script.
TextAreaContiene informazioni sull'area di testo per la configurazione.
TextInputContiene informazioni di input di testo per la configurazione.
UserErrorUn errore che viene mostrato agli utenti del connettore.

AggregationType

Proprietà

ProprietàTipoDescrizione
AVGEnumNella media.
COUNTEnumConteggio.
COUNT_DISTINCTEnumConteggio distinto.
MAXEnum% CPC
MINEnumMin.
SUMEnumSomma:
AUTOEnumAutomatico.

AuthType

Proprietà

ProprietàTipoDescrizione
NONEEnumNessuna autorizzazione necessaria.
OAUTH2EnumÈ necessaria l'autorizzazione OAuth2.
USER_PASSEnumSono necessarie le credenziali di nome utente e password.
PATH_USER_PASSEnumNome utente, percorso e password necessari.
PATH_KEYEnumPercorso e chiave necessari.
KEYEnumÈ necessaria la chiave o il token API.
USER_TOKENEnumNome utente e token necessari.

BigQueryConfig

Metodi

MetodoTipo restituitoBreve descrizione
addQueryParameter(name, type, value)BigQueryConfigAggiunge un parametro di ricerca a questo BigQueryConfig.
build()ObjectConvalida l'oggetto e lo restituisce nel formato richiesto da Data Studio.
printJson()StringStampa la rappresentazione JSON dell'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 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 di 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 l'oggetto e lo restituisce nel formato richiesto da 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 selezione di più configurazioni.
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 dell'oggetto.
setDateRangeRequired(dateRangeRequired)ConfigSe true, viene fornito un intervallo di date per le richieste getData().
setIsSteppedConfig(isSteppedConfig)ConfigSe true, viene richiamato getConfig() 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 dell'oggetto.
setText(text)DebugErrorImposta il testo dell'errore di debug, che viene mostrato solo agli amministratori.
throwException()voidAttiva la generazione di questa eccezione.

Field

Metodi

MetodoTipo restituitoBreve descrizione
getAggregation()AggregationTypeRestituisce il AggregationType di questo Field.
getDescription()StringRestituisce la descrizione di Field.
getFormula()StringRestituisce la formula di Field.
getGroup()StringRestituisce il gruppo di Field.
getId()StringRestituisce l'ID di Field.
getIsReaggregatable()BooleanRestituisce true se questo campo può essere riaggregato, altrimenti false.
getName()StringRestituisce il nome di 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 Field.
setDescription(description)FieldConsente di impostare la descrizione di Field.
setFormula(formula)FieldImposta la formula di Field.
setGroup(group)FieldConsente di impostare il gruppo di Field.
setId(id)FieldImposta l'ID di questo Field.
setIsHidden(isHidden)FieldImposta lo stato nascosto di Field.
setIsReaggregatable(isReaggregatable)FieldConsente di impostare lo stato consentito dalla riaggregazione per un elemento Field.
setName(name)FieldConsente di impostare il nome di Field.
setType(type)FieldImposta il valore FieldType di questo Field.

FieldType

Proprietà

ProprietàTipoDescrizione
YEAREnumAnno nel formato AAAA, ad esempio 2017.
YEAR_QUARTEREnumAnno e trimestre nel formato AAAAQ, 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.
QUARTEREnumUn quarto nel formato 1, 2, 3 o 4).
MONTHEnumMese nel formato MM, ad esempio 03.
WEEKEnumSettimana nel formato ww come 07.
MONTH_DAYEnumMese e giorno nel formato MMGG, ad esempio 0317.
DAY_OF_WEEKEnumUn numero compreso nell'intervallo [0,6], dove 0 rappresenta la domenica.
DAYEnumGiorno nel formato GG, ad esempio 17.
HOUREnumL'ora nel formato HH, ad esempio 13.
MINUTEEnumMinuto nel formato mm, ad esempio 12.
DURATIONEnumUna durata in secondi.
COUNTRYEnumUn paese, ad esempio 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, ad esempio il Nord America.
SUB_CONTINENT_CODEEnumUn codice del subcontinente come 003.
REGIONEnumUna regione come la California.
REGION_CODEEnumUn codice regione come CA.
CITYEnumUna città, ad esempio Mountain View.
CITY_CODEEnumUn codice città, ad esempio 1014044.
METROEnumUna metropolitana, ad esempio San Francisco-Oakland-San Jose CA.
METRO_CODEEnumUn codice area metropolitana come 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 immagine.
CURRENCY_AEDEnumValuta da AED.
CURRENCY_ALLEnumValuta da ALL.
CURRENCY_ARSEnumValuta da ARS.
CURRENCY_AUDEnumValuta da AUD.
CURRENCY_BDTEnumValuta da BDT.
CURRENCY_BGNEnumValuta da BGN.
CURRENCY_BOBEnumValuta da BOB.
CURRENCY_BRLEnumValuta da BRL.
CURRENCY_CADEnumValuta da CAD.
CURRENCY_CDFEnumValuta da CDF.
CURRENCY_CHFEnumValuta da CHF.
CURRENCY_CLPEnumValuta da CLP.
CURRENCY_CNYEnumValuta da CNY.
CURRENCY_COPEnumValuta da COP.
CURRENCY_CRCEnumValuta da CRC.
CURRENCY_CZKEnumValuta da CZK.
CURRENCY_DKKEnumValuta da DKK.
CURRENCY_DOPEnumValuta da DOP.
CURRENCY_EGPEnumValuta da EGP.
CURRENCY_ETBEnumValuta da ETB.
CURRENCY_EUREnumValuta da EUR.
CURRENCY_GBPEnumValuta da GBP.
CURRENCY_HKDEnumValuta da HKD.
CURRENCY_HRKEnumValuta da HRK.
CURRENCY_HUFEnumValuta da HUF.
CURRENCY_IDREnumValuta da IDR.
CURRENCY_ILSEnumValuta da ILS.
CURRENCY_INREnumValuta da INR.
CURRENCY_IRREnumValuta da IRR.
CURRENCY_ISKEnumValuta da ISK.
CURRENCY_JMDEnumValuta da JMD.
CURRENCY_JPYEnumValuta da JPY.
CURRENCY_KRWEnumValuta da KRW.
CURRENCY_LKREnumValuta da LKR.
CURRENCY_LTLEnumValuta da LTL.
CURRENCY_MNTEnumValuta da MNT.
CURRENCY_MVREnumValuta da MVR.
CURRENCY_MXNEnumValuta MXN.
CURRENCY_MYREnumValuta da MYR.
CURRENCY_NGNEnumValuta da NGN.
CURRENCY_NOKEnumValuta da NOK.
CURRENCY_NZDEnumValuta da NZD.
CURRENCY_PABEnumValuta da PAB.
CURRENCY_PENEnumValuta da PEN.
CURRENCY_PHPEnumValuta da PHP.
CURRENCY_PKREnumValuta da PKR.
CURRENCY_PLNEnumValuta da PLN.
CURRENCY_RONEnumValuta da RON.
CURRENCY_RSDEnumValuta da RSD.
CURRENCY_RUBEnumValuta da RUB.
CURRENCY_SAREnumValuta da SAR.
CURRENCY_SEKEnumValuta da SEK.
CURRENCY_SGDEnumValuta da SGD.
CURRENCY_THBEnumValuta da THB.
CURRENCY_TRYEnumValuta da TRY.
CURRENCY_TWDEnumValuta da TWD.
CURRENCY_TZSEnumValuta da TZS.
CURRENCY_UAHEnumValuta da UAH.
CURRENCY_USDEnumValuta da USD.
CURRENCY_UYUEnumValuta da UYU.
CURRENCY_VEFEnumValuta VEF.
CURRENCY_VNDEnumValuta da VND.
CURRENCY_YEREnumValuta da YER.
CURRENCY_ZAREnumValuta da ZAR.

Fields

Metodi

MetodoTipo restituitoBreve descrizione
asArray()Field[]Restituisce una visualizzazione dell'oggetto come array.
build()Object[]Convalida l'oggetto e lo restituisce nel formato richiesto da Data Studio.
forIds(ids)FieldsRestituisce un nuovo oggetto Fields filtrato in 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 oppure null se nell'oggetto Fields non è presente alcun campo con questo ID.
newDimension()FieldRestituisce una nuova dimensione Field.
newMetric()FieldRestituisce una nuova metrica Field.
setDefaultDimension(fieldId)voidConsente di impostare la dimensione predefinita da utilizzare per l'insieme di campi.
setDefaultMetric(fieldId)voidConsente di impostare la metrica predefinita da utilizzare per l'insieme di campi.

GetAuthTypeResponse

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida l'oggetto e lo restituisce nel formato richiesto da Data Studio.
printJson()StringStampa la rappresentazione JSON dell'oggetto.
setAuthType(authType)GetAuthTypeResponseImposta il valore AuthType del generatore.
setHelpUrl(helpUrl)GetAuthTypeResponseImposta l'URL della guida 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 l'oggetto e lo restituisce nel formato richiesto da Data Studio.
setFields(fields)GetDataResponseImposta il valore Fields del generatore.
setFiltersApplied(filtersApplied)GetDataResponseImposta lo stato dei filtri applicati per questo generatore.

GetSchemaResponse

Metodi

MetodoTipo restituitoBreve descrizione
build()ObjectConvalida l'oggetto e lo restituisce nel formato richiesto da Data Studio.
printJson()StringStampa la rappresentazione JSON dell'oggetto.
setFields(fields)GetSchemaResponseImposta il valore 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 di 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 di 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 l'oggetto e lo restituisce nel formato richiesto da Data Studio.
printJson()StringStampa la rappresentazione JSON dell'oggetto.
setIsValid(isValid)SetCredentialsResponseImposta lo stato valido di SetCredentialsResponse.

TextArea

Metodi

MetodoTipo restituitoBreve descrizione
setAllowOverride(allowOverride)TextAreaConsente l'override di 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 di 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 dell'oggetto.
setDebugText(text)UserErrorImposta il testo dell'errore di debug, che viene mostrato solo agli amministratori.
setText(text)UserErrorImposta il testo dell'errore utente.
throwException()voidAttiva la generazione di questa eccezione.