Data Studio Service

Data Studio

Este servicio permite que las secuencias de comandos accedan a los conectores de la comunidad de Data Studio y los modifiquen.

Clases

NombreDescripción breve
AggregationTypeUna enumeración que define los tipos de agregación que se pueden configurar para una Field.
AuthTypeUna enumeración que define los tipos de autenticación que se pueden configurar para un conector.
BigQueryConfigUn objeto de configuración para un conector nativo de BigQuery.
BigQueryParameterTypeUna enumeración que define los tipos de parámetros de BigQuery que puedes configurar
CheckboxContiene información de la casilla de verificación para la configuración.
CommunityConnectorCommunityConnector permite que las secuencias de comandos accedan a los compiladores y las utilidades para ayudar con el desarrollo de conectores de la comunidad para Data Studio.
ConfigContiene las entradas de configuración para un conector.
DataStudioAppDataStudioApp permite que las secuencias de comandos interactúen con funciones orientadas al desarrollador de Data Studio.
DebugErrorUn error que solo es visible para los administradores del conector.
FieldContiene datos relacionados con el campo.
FieldTypeUna enumeración que define los tipos que se pueden configurar para una Field.
FieldsContiene un conjunto de elementos Field para un conector de comunidad.
GetAuthTypeResponseEs un compilador a fin de crear una respuesta getAuthType() para tu proyecto de secuencia de comandos.
GetDataResponseEs un compilador a fin de crear una respuesta getData() para tu proyecto de secuencia de comandos.
GetSchemaResponseEs un compilador a fin de crear una respuesta getSchema() para tu proyecto de secuencia de comandos.
InfoContiene datos de información para la configuración.
OptionBuilderUn compilador para crear opciones para SelectSingle y SelectMultiple.
SelectMultipleContiene información de selección múltiple para la configuración.
SelectSingleContiene información única de selección para la configuración.
SetCredentialsResponseEs un compilador a fin de crear una respuesta setCredentials() para tu proyecto de secuencia de comandos.
TextAreaContiene información de área de texto para la configuración.
TextInputContiene información de entrada de texto para la configuración.
UserErrorUn error que se muestra a los usuarios del conector.

AggregationType

Propiedades

PropiedadTipoDescripción
AVGEnumPromedio.
COUNTEnumCantidad.
COUNT_DISTINCTEnumEl recuento es diferente.
MAXEnumCPC porcentual
MINEnumMín.
SUMEnumSuma
AUTOEnumAutomático.

AuthType

Propiedades

PropiedadTipoDescripción
NONEEnumNo se requiere autorización.
OAUTH2EnumSe requiere autorización de OAuth2.
USER_PASSEnumSe requieren credenciales de nombre de usuario y contraseña.
PATH_USER_PASSEnumSe requieren un nombre de usuario, una ruta de acceso y una contraseña.
PATH_KEYEnumSe necesitan la ruta y la clave.
KEYEnumSe necesita la clave de API o el token.
USER_TOKENEnumSe necesitan un nombre de usuario y un token.

BigQueryConfig

Métodos

MétodoTipo de datos que se muestraDescripción breve
addQueryParameter(name, type, value)BigQueryConfigAgrega un parámetro de consulta a este BigQueryConfig.
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
printJson()StringImprime la representación JSON de este objeto.
setAccessToken(accessToken)BigQueryConfigEstablece el token de acceso de este BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigEstablece el ID del proyecto de facturación de este BigQueryConfig.
setQuery(query)BigQueryConfigConfigura la consulta de SQL de este BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigDetermina si la consulta se interpreta como SQL estándar o heredado.

BigQueryParameterType

Propiedades

PropiedadTipoDescripción
STRINGEnumString.
INT64EnumNúmero entero de 64 bits.
BOOLEnumBooleano.
FLOAT64EnumNúmero de punto flotante de 64 bits.

Checkbox

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAllowOverride(allowOverride)CheckboxHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)CheckboxEstablece el texto de ayuda para esta entrada de configuración.
setId(id)CheckboxEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)CheckboxEstablece el estado dinámico para esta entrada de configuración.
setName(name)CheckboxEstablece el nombre visible de esta entrada de configuración.

CommunityConnector

Propiedades

PropiedadTipoDescripción
AggregationTypeAggregationTypeLa enumeración AggregationType.
AuthTypeAuthTypeLa enumeración AuthType.
BigQueryParameterTypeBigQueryParameterTypeLa enumeración BigQueryParameterType.
FieldTypeFieldTypeLa enumeración FieldType.

Métodos

MétodoTipo de datos que se muestraDescripción breve
getConfig()ConfigMuestra un objeto Config.
getFields()FieldsMuestra un objeto Fields.
newAuthTypeResponse()GetAuthTypeResponseMuestra un objeto GetAuthTypeResponse nuevo.
newBigQueryConfig()BigQueryConfigMuestra un objeto BigQueryConfig nuevo.
newDebugError()DebugErrorMuestra un objeto DebugError nuevo.
newGetDataResponse()GetDataResponseMuestra un objeto GetDataResponse nuevo.
newGetSchemaResponse()GetSchemaResponseMuestra un objeto GetSchemaResponse nuevo.
newSetCredentialsResponse()SetCredentialsResponseMuestra un objeto SetCredentialsResponse nuevo.
newUserError()UserErrorMuestra un objeto UserError nuevo.

Config

Métodos

MétodoTipo de datos que se muestraDescripción breve
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
newCheckbox()CheckboxMuestra una nueva entrada de configuración de la casilla de verificación.
newInfo()InfoMuestra una nueva entrada de configuración de información.
newOptionBuilder()OptionBuilderMuestra un compilador de opciones nuevo.
newSelectMultiple()SelectMultipleMuestra una nueva entrada de configuración de selección múltiple.
newSelectSingle()SelectSingleMuestra una nueva entrada de configuración única seleccionada.
newTextArea()TextAreaMuestra una nueva entrada de configuración de área de texto.
newTextInput()TextInputMuestra una nueva entrada de configuración de entrada de texto.
printJson()StringImprime la representación JSON de este objeto.
setDateRangeRequired(dateRangeRequired)ConfigSi es true, se proporciona un período para las solicitudes getData().
setIsSteppedConfig(isSteppedConfig)ConfigSi es true, se vuelve a llamar a getConfig() con la configuración de usuario actual.

DataStudioApp

Métodos

MétodoTipo de datos que se muestraDescripción breve
createCommunityConnector()CommunityConnectorCrea un nuevo conector de comunidad.

DebugError

Métodos

MétodoTipo de datos que se muestraDescripción breve
printJson()StringImprime la representación JSON de este objeto.
setText(text)DebugErrorEstablece el texto del error de depuración, que solo se muestra a los administradores.
throwException()voidActiva esta excepción.

Field

Métodos

MétodoTipo de datos que se muestraDescripción breve
getAggregation()AggregationTypeMuestra el AggregationType de este Field.
getDescription()StringMuestra la descripción de este Field.
getFormula()StringMuestra la fórmula de este Field.
getGroup()StringMuestra el grupo de este Field.
getId()StringMuestra el ID de este Field.
getIsReaggregatable()BooleanMuestra true si este campo se puede volver a agregar; de lo contrario, muestra false.
getName()StringMuestra el nombre de este Field.
getType()FieldTypeMuestra el FieldType de este Field.
isDefault()BooleanMuestra true si Field es la métrica o dimensión predeterminada.
isDimension()BooleanMuestra true si este campo es una dimensión.
isHidden()BooleanMuestra true si este Field está oculto.
isMetric()BooleanMuestra true si este campo es una métrica.
setAggregation(aggregation)FieldEstablece el tipo de agregación de este Field.
setDescription(description)FieldEstablece la descripción de este Field.
setFormula(formula)FieldEstablece la fórmula de este Field.
setGroup(group)FieldEstablece el grupo de este Field.
setId(id)FieldEstablece el ID de este Field.
setIsHidden(isHidden)FieldEstablece el estado oculto de este Field.
setIsReaggregatable(isReaggregatable)FieldEstablece el estado permitido de reagregación para una Field.
setName(name)FieldEstablece el nombre de este Field.
setType(type)FieldEstablece el FieldType de este Field.

FieldType

Propiedades

PropiedadTipoDescripción
YEAREnumEs el año con el formato AAAA, como 2017.
YEAR_QUARTEREnumEs el año y el trimestre en el formato AAAAQ, como 20171.
YEAR_MONTHEnumEs el año y el mes en el formato AAAAMM, como 201703.
YEAR_WEEKEnumCorresponde al año y la semana en el formato AAAAWW, como 201707.
YEAR_MONTH_DAYEnumEs el año, el mes y el día en el formato AAAAMMDD, como 20170317.
YEAR_MONTH_DAY_HOUREnumEs el año, el mes, el día y la hora con el formato AAAAMMDDHH, como 2017031703.
YEAR_MONTH_DAY_MINUTEEnumEl año, el mes, el día, la hora y los minutos con el formato AAAAMMDDH, como 201703170230.
YEAR_MONTH_DAY_SECONDEnumAño, mes, día, hora, minuto y segundo con el formato AAAAMMDDH, por ejemplo, 20170317023017.
QUARTEREnumel trimestre en el formato 1, 2, 3 o 4).
MONTHEnumMes en formato MM, p. ej., 03
WEEKEnumEs la semana en formato WW, como 07.
MONTH_DAYEnumEs el mes y el día en formato MMDD, como 0317.
DAY_OF_WEEKEnumNúmero del rango de [0,6] en el que 0 representa el domingo.
DAYEnumDía en formato DD, como 17.
HOUREnumHora en el formato HH, como 13
MINUTEEnumMinuto en formato mm, como 12
DURATIONEnumEs la duración en segundos.
COUNTRYEnumUn país, como Estados Unidos
COUNTRY_CODEEnumUn código de país, como US.
CONTINENTEnumUn continente como América.
CONTINENT_CODEEnumUn código de continente, como 019
SUB_CONTINENTEnumUn subcontinente, como Norteamérica
SUB_CONTINENT_CODEEnumUn código de subcontinente, como 003
REGIONEnumUna región, como California.
REGION_CODEEnumUn código de región, como CA.
CITYEnumUna ciudad como Mountain View.
CITY_CODEEnumUn código de ciudad, como 1014044
METROEnumUn área metropolitana como San Francisco-Oakland-San José, CA.
METRO_CODEEnumUn código de área metropolitana, como 200807.
LATITUDE_LONGITUDEEnumUn par de latitud y longitud, como 51.5074, -0.1278
NUMBEREnumUn número decimal.
PERCENTEnumPorcentaje decimal (puede ser superior a 1.0).
TEXTEnumTexto en formato libre.
BOOLEANEnumUn valor booleano true o false.
URLEnumUna URL como texto, como https://google.com.
HYPERLINKEnumUn hipervínculo.
IMAGEEnumUna imagen.
IMAGE_LINKEnumUn vínculo de imagen
CURRENCY_AEDEnumMoneda de AED.
CURRENCY_ALLEnumMoneda de ALL.
CURRENCY_ARSEnumMoneda de ARS.
CURRENCY_AUDEnumMoneda de AUD.
CURRENCY_BDTEnumMoneda de BDT.
CURRENCY_BGNEnumMoneda de BGN
CURRENCY_BOBEnumMoneda de BOB.
CURRENCY_BRLEnumMoneda de BRL.
CURRENCY_CADEnumMoneda de CAD.
CURRENCY_CDFEnumMoneda de CDF.
CURRENCY_CHFEnumMoneda de CHF.
CURRENCY_CLPEnumMoneda de CLP.
CURRENCY_CNYEnumMoneda de CNY.
CURRENCY_COPEnumMoneda de COP.
CURRENCY_CRCEnumMoneda de CRC.
CURRENCY_CZKEnumMoneda de CZK.
CURRENCY_DKKEnumMoneda de DKK.
CURRENCY_DOPEnumMoneda de DOP.
CURRENCY_EGPEnumMoneda de EGP.
CURRENCY_ETBEnumMoneda de ETB
CURRENCY_EUREnumMoneda de EUR.
CURRENCY_GBPEnumMoneda de GBP.
CURRENCY_HKDEnumMoneda de HKD.
CURRENCY_HRKEnumMoneda de HRK
CURRENCY_HUFEnumMoneda de HUF.
CURRENCY_IDREnumMoneda de IDR.
CURRENCY_ILSEnumMoneda de ILS.
CURRENCY_INREnumMoneda de INR.
CURRENCY_IRREnumMoneda de IRR.
CURRENCY_ISKEnumMoneda de ISK.
CURRENCY_JMDEnumMoneda de JMD
CURRENCY_JPYEnumMoneda de JPY.
CURRENCY_KRWEnumMoneda de KRW.
CURRENCY_LKREnumMoneda de LKR
CURRENCY_LTLEnumMoneda de LTL.
CURRENCY_MNTEnumMoneda de MNT.
CURRENCY_MVREnumMoneda de MVR.
CURRENCY_MXNEnumMoneda de MXN.
CURRENCY_MYREnumMoneda de MYR
CURRENCY_NGNEnumMoneda de NGN
CURRENCY_NOKEnumMoneda de NOK.
CURRENCY_NZDEnumMoneda de NZD.
CURRENCY_PABEnumMoneda de PAB
CURRENCY_PENEnumMoneda de PEN.
CURRENCY_PHPEnumMoneda de PHP.
CURRENCY_PKREnumMoneda de PKR.
CURRENCY_PLNEnumMoneda de PLN.
CURRENCY_RONEnumMoneda de RON.
CURRENCY_RSDEnumMoneda de RSD.
CURRENCY_RUBEnumMoneda de RUB.
CURRENCY_SAREnumMoneda de la SAR.
CURRENCY_SEKEnumMoneda de SEK
CURRENCY_SGDEnumMoneda de SGD.
CURRENCY_THBEnumMoneda de THB.
CURRENCY_TRYEnumMoneda de TRY.
CURRENCY_TWDEnumMoneda de TWD.
CURRENCY_TZSEnumMoneda de TZS.
CURRENCY_UAHEnumMoneda de UAH.
CURRENCY_USDEnumMoneda de USD.
CURRENCY_UYUEnumMoneda de UYU.
CURRENCY_VEFEnumMoneda de VEF.
CURRENCY_VNDEnumMoneda de VND.
CURRENCY_YEREnumMoneda de YER.
CURRENCY_ZAREnumMoneda de ZAR.

Fields

Métodos

MétodoTipo de datos que se muestraDescripción breve
asArray()Field[]Muestra una vista de este objeto como un array.
build()Object[]Valida este objeto y lo muestra en el formato que necesita Data Studio.
forIds(ids)FieldsMuestra un objeto Fields nuevo filtrado por Field con un ID en ids.
getDefaultDimension()FieldMuestra la dimensión predeterminada que se utilizará para el conjunto de campos.
getDefaultMetric()FieldMuestra la métrica predeterminada que se usará para el conjunto de campos.
getFieldById(fieldId)FieldMuestra un campo con un ID determinado o null si no hay ningún campo con ese ID en este objeto Fields.
newDimension()FieldMuestra una nueva dimensión Field.
newMetric()FieldMuestra una métrica nueva Field.
setDefaultDimension(fieldId)voidEstablece la dimensión predeterminada que se utilizará para el conjunto de campos.
setDefaultMetric(fieldId)voidEstablece la métrica predeterminada que se usará para el conjunto de campos.

GetAuthTypeResponse

Métodos

MétodoTipo de datos que se muestraDescripción breve
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
printJson()StringImprime la representación JSON de este objeto.
setAuthType(authType)GetAuthTypeResponseEstablece el AuthType del compilador.
setHelpUrl(helpUrl)GetAuthTypeResponseEstablece la URL de ayuda del compilador.

GetDataResponse

Métodos

MétodoTipo de datos que se muestraDescripción breve
addAllRows(rows)GetDataResponseAgrega varias filas de datos a este GetDataResponse.
addRow(row)GetDataResponseAgrega una fila de datos a este GetDataResponse.
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
setFields(fields)GetDataResponseEstablece el Fields del compilador.
setFiltersApplied(filtersApplied)GetDataResponseEstablece el estado de los filtros aplicados para este compilador.

GetSchemaResponse

Métodos

MétodoTipo de datos que se muestraDescripción breve
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
printJson()StringImprime la representación JSON de este objeto.
setFields(fields)GetSchemaResponseEstablece el Fields del compilador.

Info

Métodos

MétodoTipo de datos que se muestraDescripción breve
setId(id)InfoEstablece el ID único para esta entrada de configuración.
setText(text)InfoEstablece el texto para esta entrada de configuración.

OptionBuilder

Métodos

MétodoTipo de datos que se muestraDescripción breve
setLabel(label)OptionBuilderEstablece la etiqueta de este compilador de opciones.
setValue(value)OptionBuilderEstablece el valor de este compilador de opciones.

SelectMultiple

Métodos

MétodoTipo de datos que se muestraDescripción breve
addOption(optionBuilder)SelectMultipleAgrega una nueva opción de selección.
setAllowOverride(allowOverride)SelectMultipleHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)SelectMultipleEstablece el texto de ayuda para esta entrada de configuración.
setId(id)SelectMultipleEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)SelectMultipleEstablece el estado dinámico para esta entrada de configuración.
setName(name)SelectMultipleEstablece el nombre visible de esta entrada de configuración.

SelectSingle

Métodos

MétodoTipo de datos que se muestraDescripción breve
addOption(optionBuilder)SelectSingleAgrega una nueva opción de selección.
setAllowOverride(allowOverride)SelectSingleHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)SelectSingleEstablece el texto de ayuda para esta entrada de configuración.
setId(id)SelectSingleEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)SelectSingleEstablece el estado dinámico para esta entrada de configuración.
setName(name)SelectSingleEstablece el nombre visible de esta entrada de configuración.

SetCredentialsResponse

Métodos

MétodoTipo de datos que se muestraDescripción breve
build()ObjectValida este objeto y lo muestra en el formato que necesita Data Studio.
printJson()StringImprime la representación JSON de este objeto.
setIsValid(isValid)SetCredentialsResponseEstablece el estado válido de este SetCredentialsResponse.

TextArea

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAllowOverride(allowOverride)TextAreaHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)TextAreaEstablece el texto de ayuda para esta entrada de configuración.
setId(id)TextAreaEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)TextAreaEstablece el estado dinámico para esta entrada de configuración.
setName(name)TextAreaEstablece el nombre visible de esta entrada de configuración.
setPlaceholder(placeholder)TextAreaEstablece el texto del marcador de posición para esta entrada de configuración.

TextInput

Métodos

MétodoTipo de datos que se muestraDescripción breve
setAllowOverride(allowOverride)TextInputHabilita la anulación para esta entrada de configuración.
setHelpText(helpText)TextInputEstablece el texto de ayuda para esta entrada de configuración.
setId(id)TextInputEstablece el ID único para esta entrada de configuración.
setIsDynamic(isDynamic)TextInputEstablece el estado dinámico para esta entrada de configuración.
setName(name)TextInputEstablece el nombre visible de esta entrada de configuración.
setPlaceholder(placeholder)TextInputEstablece el texto del marcador de posición para esta entrada de configuración.

UserError

Métodos

MétodoTipo de datos que se muestraDescripción breve
printJson()StringImprime la representación JSON de este objeto.
setDebugText(text)UserErrorEstablece el texto del error de depuración, que solo se muestra a los administradores.
setText(text)UserErrorEstablece el texto del error del usuario.
throwException()voidActiva esta excepción.