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
AggregationTypeEs una enumeración que define los tipos de agregación que se pueden establecer para un Field.
AuthTypeEs una enumeración que define los tipos de autenticación que se pueden establecer para un conector.
BigQueryConfigEs un objeto de configuración para un conector nativo de BigQuery.
BigQueryParameterTypeEs una enumeración que define los tipos de parámetros de BigQuery que puedes establecer.
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 comunidad para Data Studio.
ConfigContiene las entradas de configuración de un conector.
DataStudioAppDataStudioApp permite que las secuencias de comandos interactúen con las funciones orientadas a desarrolladores de Data Studio.
DebugErrorEs un error que solo pueden ver los administradores del conector.
FieldContiene datos relacionados con el campo.
FieldTypeEs una enumeración que define los tipos que se pueden establecer para un Field.
FieldsContiene un conjunto de Fields para un conector de comunidad.
GetAuthTypeResponseEs un compilador para crear una respuesta getAuthType() para tu proyecto de secuencia de comandos.
GetDataResponseEs un compilador para crear una respuesta getData() para tu proyecto de secuencia de comandos.
GetSchemaResponseEs un compilador para crear una respuesta getSchema() para tu proyecto de secuencia de comandos.
InfoContiene datos de información para la configuración.
OptionBuilderEs un compilador para crear opciones para SelectSingle y SelectMultiple.
SelectMultipleContiene información de selección múltiple para la configuración.
SelectSingleContiene información única seleccionada para la configuración.
SetCredentialsResponseEs un compilador para crear una respuesta setCredentials() para tu proyecto de secuencia de comandos.
TextAreaContiene información del área de texto para la configuración.
TextInputContiene información de entrada de texto para la configuración.
UserErrorEs un error que se muestra a los usuarios del conector.

AggregationType

Propiedades

PropiedadTipoDescripción
AVGEnumPromedio.
COUNTEnumEs el recuento.
COUNT_DISTINCTEnumRecuento de valores distintos
MAXEnumMáx.
MINEnumMín.
SUMEnumSuma.
AUTOEnumAutomático

AuthType

Propiedades

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

BigQueryConfig

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addQueryParameter(name, type, value)BigQueryConfigAgrega un parámetro de consulta a este BigQueryConfig.
build()ObjectValida este objeto y lo devuelve 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)BigQueryConfigEstablece la consulta en 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 devuelveDescripción breve
setAllowOverride(allowOverride)CheckboxPermite anular 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 para esta entrada de configuración.

CommunityConnector

Propiedades

PropiedadTipoDescripción
AggregationTypeAggregationTypeEs la enumeración AggregationType.
AuthTypeAuthTypeEs la enumeración AuthType.
BigQueryParameterTypeBigQueryParameterTypeEs la enumeración BigQueryParameterType.
FieldTypeFieldTypeEs la enumeración FieldType.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
getConfig()ConfigMuestra un objeto Config.
getFields()FieldsMuestra un objeto Fields.
newAuthTypeResponse()GetAuthTypeResponseDevuelve un objeto GetAuthTypeResponse nuevo.
newBigQueryConfig()BigQueryConfigDevuelve un objeto BigQueryConfig nuevo.
newDebugError()DebugErrorDevuelve un objeto DebugError nuevo.
newGetDataResponse()GetDataResponseDevuelve un objeto GetDataResponse nuevo.
newGetSchemaResponse()GetSchemaResponseDevuelve un objeto GetSchemaResponse nuevo.
newSetCredentialsResponse()SetCredentialsResponseDevuelve un objeto SetCredentialsResponse nuevo.
newUserError()UserErrorDevuelve un objeto UserError nuevo.

Config

Métodos

MétodoTipo de datos que se devuelveDescripción breve
build()ObjectValida este objeto y lo devuelve en el formato que necesita Data Studio.
newCheckbox()CheckboxDevuelve una nueva entrada de configuración de casilla de verificación.
newInfo()InfoDevuelve una nueva entrada de configuración de información.
newOptionBuilder()OptionBuilderDevuelve un nuevo compilador de opciones.
newSelectMultiple()SelectMultipleDevuelve una nueva entrada de configuración de selección múltiple.
newSelectSingle()SelectSingleDevuelve una nueva entrada de configuración de selección única.
newTextArea()TextAreaDevuelve una nueva entrada de configuración de área de texto.
newTextInput()TextInputDevuelve 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 de getData().
setIsSteppedConfig(isSteppedConfig)ConfigSi es true, se vuelve a llamar a getConfig() con la configuración del usuario actual.

DataStudioApp

Métodos

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

DebugError

Métodos

MétodoTipo de datos que se devuelveDescripció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 el lanzamiento de esta excepción.

Field

Métodos

MétodoTipo de datos que se devuelveDescripción breve
getAggregation()AggregationTypeDevuelve el AggregationType de este Field.
getDescription()StringDevuelve la descripción de este Field.
getFormula()StringDevuelve la fórmula de este Field.
getGroup()StringDevuelve el grupo de este Field.
getId()StringDevuelve el ID de este Field.
getIsReaggregatable()BooleanDevuelve true si este campo se puede volver a agregar; de lo contrario, devuelve false.
getName()StringDevuelve el nombre de este Field.
getType()FieldTypeDevuelve el FieldType de este Field.
isDefault()BooleanDevuelve true si este Field es la métrica o la dimensión predeterminada.
isDimension()BooleanDevuelve true si este campo es una dimensión.
isHidden()BooleanDevuelve true si este Field está oculto.
isMetric()BooleanDevuelve 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 objeto Field.
setIsHidden(isHidden)FieldEstablece el estado oculto de este Field.
setIsReaggregatable(isReaggregatable)FieldEstablece el estado de reagregación permitida para un Field.
setName(name)FieldEstablece el nombre de este Field.
setType(type)FieldEstablece el FieldType de este Field.

FieldType

Propiedades

PropiedadTipoDescripción
YEAREnumAño en formato AAAA, como 2017.
YEAR_QUARTEREnumAño y trimestre en el formato AAAAT, como 20171.
YEAR_MONTHEnumAño y mes en el formato AAAAMM, como 201703.
YEAR_WEEKEnumAño y semana en el formato AAAAss, como 201707.
YEAR_MONTH_DAYEnumAño, mes y día en formato AAAAMMDD, como 20170317.
YEAR_MONTH_DAY_HOUREnumAño, mes, día y hora en el formato AAAAMMDDHH, como 2017031703.
YEAR_MONTH_DAY_MINUTEEnumAño, mes, día, hora y minuto en el formato AAAAMMDDHHmm, como 201703170230.
YEAR_MONTH_DAY_SECONDEnumAño, mes, día, hora, minuto y segundo en el formato AAAAMMDDHHmmss, como 20170317023017.
QUARTEREnumCuarto en formato 1, 2, 3 o 4).
MONTHEnumMes en formato MM, como 03.
WEEKEnumSemana en formato de ww, como 07.
MONTH_DAYEnumMes y día en formato MMDD, como 0317.
DAY_OF_WEEKEnumNúmero en el rango [0, 6], en el que 0 representa el domingo.
DAYEnumDía en formato DD, como 17.
HOUREnumHora en formato HH, como 13.
MINUTEEnumMinuto en formato mm, como 12.
DURATIONEnumEs un período en segundos.
COUNTRYEnumUn país, como Estados Unidos.
COUNTRY_CODEEnumEs un código de país, como US.
CONTINENTEnumEs un continente, como América.
CONTINENT_CODEEnumEs un código de continente, como 019.
SUB_CONTINENTEnumEs un subcontinente, como América del Norte.
SUB_CONTINENT_CODEEnumEs un código de subcontinente, como 003.
REGIONEnumUna región, como California.
REGION_CODEEnumEs un código de región, como CA.
CITYEnumUna ciudad, como Mountain View.
CITY_CODEEnumUn código de ciudad, como 1014044.
METROEnumUna ciudad metropolitana, como San Francisco-Oakland-San José, CA.
METRO_CODEEnumEs un código de área metropolitana, como 200807.
LATITUDE_LONGITUDEEnumEs un par de latitud y longitud, como 51.5074, -0.1278.
NUMBEREnumEs un número decimal.
PERCENTEnumEs el porcentaje decimal (puede ser superior a 1.0).
TEXTEnumEs texto de formato libre.
BOOLEANEnumUn valor booleano true o false.
URLEnumEs una URL como texto, por ejemplo, https://google.com.
HYPERLINKEnumEs un hipervínculo.
IMAGEEnumUna imagen.
IMAGE_LINKEnumEs un vínculo a una 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_BOBEnumEs la moneda de BOB.
CURRENCY_BRLEnumMoneda de BRL.
CURRENCY_CADEnumMoneda de CAD.
CURRENCY_CDFEnumEs la moneda del 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_DOPEnumEs la moneda del DOP.
CURRENCY_EGPEnumMoneda de EGP.
CURRENCY_ETBEnumEs la moneda 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 del INR.
CURRENCY_IRREnumEs la moneda del IRR.
CURRENCY_ISKEnumMoneda de ISK.
CURRENCY_JMDEnumMoneda de JMD.
CURRENCY_JPYEnumMoneda de JPY.
CURRENCY_KRWEnumMoneda de KRW.
CURRENCY_LKREnumMoneda de LKR.
CURRENCY_LTLEnumEs la moneda de LTL.
CURRENCY_MNTEnumMoneda del MNT.
CURRENCY_MVREnumEs la moneda de MVR.
CURRENCY_MXNEnumMoneda de MXN.
CURRENCY_MYREnumMoneda de MYR.
CURRENCY_NGNEnumMoneda de NGN.
CURRENCY_NOKEnumMoneda de NOK.
CURRENCY_NZDEnumMoneda de NZD.
CURRENCY_PABEnumMoneda del PAB.
CURRENCY_PENEnumMoneda de PEN.
CURRENCY_PHPEnumEs la moneda de PHP.
CURRENCY_PKREnumMoneda de PKR.
CURRENCY_PLNEnumMoneda de PLN.
CURRENCY_RONEnumMoneda de RON.
CURRENCY_RSDEnumMoneda de RSD.
CURRENCY_RUBEnumEs la moneda de RUB.
CURRENCY_SAREnumMoneda de 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 que no es 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 devuelveDescripción breve
asArray()Field[]Devuelve una vista de este objeto como un array.
build()Object[]Valida este objeto y lo devuelve en el formato que necesita Data Studio.
forIds(ids)FieldsDevuelve un objeto Fields nuevo filtrado para incluir solo los objetos Field con un ID en ids.
getDefaultDimension()FieldDevuelve la dimensión predeterminada que se usará para el conjunto de campos.
getDefaultMetric()FieldDevuelve la métrica predeterminada que se usará para el conjunto de campos.
getFieldById(fieldId)FieldDevuelve un campo con un ID determinado o null si no hay ningún campo con ese ID en este objeto Fields.
newDimension()FieldDevuelve una nueva dimensión Field.
newMetric()FieldDevuelve una nueva métrica Field.
setDefaultDimension(fieldId)voidEstablece la dimensión predeterminada que se usará 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 devuelveDescripción breve
build()ObjectValida este objeto y lo devuelve 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 devuelveDescripció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 devuelve en el formato que necesita Data Studio.
setFields(fields)GetDataResponseEstablece el Fields del compilador.
setFiltersApplied(filtersApplied)GetDataResponseEstablece el estado de aplicación de los filtros para este compilador.

GetSchemaResponse

Métodos

MétodoTipo de datos que se devuelveDescripción breve
build()ObjectValida este objeto y lo devuelve 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 devuelveDescripció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 devuelveDescripció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 devuelveDescripción breve
addOption(optionBuilder)SelectMultipleAgrega una nueva opción de selección.
setAllowOverride(allowOverride)SelectMultiplePermite anular 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 para esta entrada de configuración.

SelectSingle

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addOption(optionBuilder)SelectSingleAgrega una nueva opción de selección.
setAllowOverride(allowOverride)SelectSinglePermite anular 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 para esta entrada de configuración.

SetCredentialsResponse

Métodos

MétodoTipo de datos que se devuelveDescripción breve
build()ObjectValida este objeto y lo devuelve 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 devuelveDescripción breve
setAllowOverride(allowOverride)TextAreaPermite anular 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 para 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 devuelveDescripción breve
setAllowOverride(allowOverride)TextInputPermite anular 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 para 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 devuelveDescripció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 el lanzamiento de esta excepción.