Se usó la API de Cloud Translation para traducir esta página.

Data Studio Service

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

Clases

Nombre	Descripción breve
`AggregationType`	Una enumeración que define los tipos de agregación que se pueden configurar para una `Field`.
`AuthType`	Una enumeración que define los tipos de autenticación que se pueden configurar para un conector.
`BigQueryConfig`	Un objeto de configuración para un conector nativo de BigQuery.
`BigQueryParameterType`	Una enumeración que define los tipos de parámetros de BigQuery que puedes configurar
`Checkbox`	Contiene información de la casilla de verificación para la configuración.
`CommunityConnector`	CommunityConnector 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.
`Config`	Contiene las entradas de configuración para un conector.
`DataStudioApp`	DataStudioApp permite que las secuencias de comandos interactúen con funciones orientadas al desarrollador de Data Studio.
`DebugError`	Un error que solo es visible para los administradores del conector.
`Field`	Contiene datos relacionados con el campo.
`FieldType`	Una enumeración que define los tipos que se pueden configurar para una `Field`.
`Fields`	Contiene un conjunto de elementos `Field` para un conector de comunidad.
`GetAuthTypeResponse`	Es un compilador a fin de crear una respuesta `getAuthType()` para tu proyecto de secuencia de comandos.
`GetDataResponse`	Es un compilador a fin de crear una respuesta `getData()` para tu proyecto de secuencia de comandos.
`GetSchemaResponse`	Es un compilador a fin de crear una respuesta `getSchema()` para tu proyecto de secuencia de comandos.
`Info`	Contiene datos de información para la configuración.
`OptionBuilder`	Un compilador para crear opciones para `SelectSingle` y `SelectMultiple`.
`SelectMultiple`	Contiene información de selección múltiple para la configuración.
`SelectSingle`	Contiene información única de selección para la configuración.
`SetCredentialsResponse`	Es un compilador a fin de crear una respuesta `setCredentials()` para tu proyecto de secuencia de comandos.
`TextArea`	Contiene información de área de texto para la configuración.
`TextInput`	Contiene información de entrada de texto para la configuración.
`UserError`	Un error que se muestra a los usuarios del conector.

`AggregationType`

Propiedades

Propiedad	Tipo	Descripción
`AVG`	`Enum`	Promedio.
`COUNT`	`Enum`	Cantidad.
`COUNT_DISTINCT`	`Enum`	El recuento es diferente.
`MAX`	`Enum`	CPC porcentual
`MIN`	`Enum`	Mín.
`SUM`	`Enum`	Suma
`AUTO`	`Enum`	Automático.

`AuthType`

Propiedades

Propiedad	Tipo	Descripción
`NONE`	`Enum`	No se requiere autorización.
`OAUTH2`	`Enum`	Se requiere autorización de OAuth2.
`USER_PASS`	`Enum`	Se requieren credenciales de nombre de usuario y contraseña.
`PATH_USER_PASS`	`Enum`	Se requieren un nombre de usuario, una ruta de acceso y una contraseña.
`PATH_KEY`	`Enum`	Se necesitan la ruta y la clave.
`KEY`	`Enum`	Se necesita la clave de API o el token.
`USER_TOKEN`	`Enum`	Se necesitan un nombre de usuario y un token.

`BigQueryConfig`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addQueryParameter(name, type, value)`	`BigQueryConfig`	Agrega un parámetro de consulta a este `BigQueryConfig`.
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setAccessToken(accessToken)`	`BigQueryConfig`	Establece el token de acceso de este `BigQueryConfig`.
`setBillingProjectId(billingProjectId)`	`BigQueryConfig`	Establece el ID del proyecto de facturación de este `BigQueryConfig`.
`setQuery(query)`	`BigQueryConfig`	Configura la consulta de SQL de este `BigQueryConfig`.
`setUseStandardSql(useStandardSql)`	`BigQueryConfig`	Determina si la consulta se interpreta como SQL estándar o heredado.

`BigQueryParameterType`

Propiedades

Propiedad	Tipo	Descripción
`STRING`	`Enum`	String.
`INT64`	`Enum`	Número entero de 64 bits.
`BOOL`	`Enum`	Booleano.
`FLOAT64`	`Enum`	Número de punto flotante de 64 bits.

`Checkbox`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setAllowOverride(allowOverride)`	`Checkbox`	Habilita la anulación para esta entrada de configuración.
`setHelpText(helpText)`	`Checkbox`	Establece el texto de ayuda para esta entrada de configuración.
`setId(id)`	`Checkbox`	Establece el ID único para esta entrada de configuración.
`setIsDynamic(isDynamic)`	`Checkbox`	Establece el estado dinámico para esta entrada de configuración.
`setName(name)`	`Checkbox`	Establece el nombre visible de esta entrada de configuración.

`CommunityConnector`

Propiedades

Propiedad	Tipo	Descripción
`AggregationType`	`AggregationType`	La enumeración `AggregationType`.
`AuthType`	`AuthType`	La enumeración `AuthType`.
`BigQueryParameterType`	`BigQueryParameterType`	La enumeración `BigQueryParameterType`.
`FieldType`	`FieldType`	La enumeración `FieldType`.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`getConfig()`	`Config`	Muestra un objeto `Config`.
`getFields()`	`Fields`	Muestra un objeto `Fields`.
`newAuthTypeResponse()`	`GetAuthTypeResponse`	Muestra un objeto `GetAuthTypeResponse` nuevo.
`newBigQueryConfig()`	`BigQueryConfig`	Muestra un objeto `BigQueryConfig` nuevo.
`newDebugError()`	`DebugError`	Muestra un objeto `DebugError` nuevo.
`newGetDataResponse()`	`GetDataResponse`	Muestra un objeto `GetDataResponse` nuevo.
`newGetSchemaResponse()`	`GetSchemaResponse`	Muestra un objeto `GetSchemaResponse` nuevo.
`newSetCredentialsResponse()`	`SetCredentialsResponse`	Muestra un objeto `SetCredentialsResponse` nuevo.
`newUserError()`	`UserError`	Muestra un objeto `UserError` nuevo.

`Config`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`newCheckbox()`	`Checkbox`	Muestra una nueva entrada de configuración de la casilla de verificación.
`newInfo()`	`Info`	Muestra una nueva entrada de configuración de información.
`newOptionBuilder()`	`OptionBuilder`	Muestra un compilador de opciones nuevo.
`newSelectMultiple()`	`SelectMultiple`	Muestra una nueva entrada de configuración de selección múltiple.
`newSelectSingle()`	`SelectSingle`	Muestra una nueva entrada de configuración única seleccionada.
`newTextArea()`	`TextArea`	Muestra una nueva entrada de configuración de área de texto.
`newTextInput()`	`TextInput`	Muestra una nueva entrada de configuración de entrada de texto.
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setDateRangeRequired(dateRangeRequired)`	`Config`	Si es `true`, se proporciona un período para las solicitudes getData().
`setIsSteppedConfig(isSteppedConfig)`	`Config`	Si es `true`, se vuelve a llamar a `getConfig()` con la configuración de usuario actual.

`DataStudioApp`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`createCommunityConnector()`	`CommunityConnector`	Crea un nuevo conector de comunidad.

`DebugError`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setText(text)`	`DebugError`	Establece el texto del error de depuración, que solo se muestra a los administradores.
`throwException()`	`void`	Activa esta excepción.

`Field`

Métodos

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

`FieldType`

Propiedades

Propiedad	Tipo	Descripción
`YEAR`	`Enum`	Es el año con el formato AAAA, como 2017.
`YEAR_QUARTER`	`Enum`	Es el año y el trimestre en el formato AAAAQ, como 20171.
`YEAR_MONTH`	`Enum`	Es el año y el mes en el formato AAAAMM, como 201703.
`YEAR_WEEK`	`Enum`	Corresponde al año y la semana en el formato AAAAWW, como 201707.
`YEAR_MONTH_DAY`	`Enum`	Es el año, el mes y el día en el formato AAAAMMDD, como 20170317.
`YEAR_MONTH_DAY_HOUR`	`Enum`	Es el año, el mes, el día y la hora con el formato AAAAMMDDHH, como 2017031703.
`YEAR_MONTH_DAY_MINUTE`	`Enum`	El año, el mes, el día, la hora y los minutos con el formato AAAAMMDDH, como 201703170230.
`YEAR_MONTH_DAY_SECOND`	`Enum`	Año, mes, día, hora, minuto y segundo con el formato AAAAMMDDH, por ejemplo, 20170317023017.
`QUARTER`	`Enum`	el trimestre en el formato 1, 2, 3 o 4).
`MONTH`	`Enum`	Mes en formato MM, p. ej., 03
`WEEK`	`Enum`	Es la semana en formato WW, como 07.
`MONTH_DAY`	`Enum`	Es el mes y el día en formato MMDD, como 0317.
`DAY_OF_WEEK`	`Enum`	Número del rango de [0,6] en el que 0 representa el domingo.
`DAY`	`Enum`	Día en formato DD, como 17.
`HOUR`	`Enum`	Hora en el formato HH, como 13
`MINUTE`	`Enum`	Minuto en formato mm, como 12
`DURATION`	`Enum`	Es la duración en segundos.
`COUNTRY`	`Enum`	Un país, como Estados Unidos
`COUNTRY_CODE`	`Enum`	Un código de país, como US.
`CONTINENT`	`Enum`	Un continente como América.
`CONTINENT_CODE`	`Enum`	Un código de continente, como 019
`SUB_CONTINENT`	`Enum`	Un subcontinente, como Norteamérica
`SUB_CONTINENT_CODE`	`Enum`	Un código de subcontinente, como 003
`REGION`	`Enum`	Una región, como California.
`REGION_CODE`	`Enum`	Un código de región, como CA.
`CITY`	`Enum`	Una ciudad como Mountain View.
`CITY_CODE`	`Enum`	Un código de ciudad, como 1014044
`METRO`	`Enum`	Un área metropolitana como San Francisco-Oakland-San José, CA.
`METRO_CODE`	`Enum`	Un código de área metropolitana, como 200807.
`LATITUDE_LONGITUDE`	`Enum`	Un par de latitud y longitud, como 51.5074, -0.1278
`NUMBER`	`Enum`	Un número decimal.
`PERCENT`	`Enum`	Porcentaje decimal (puede ser superior a 1.0).
`TEXT`	`Enum`	Texto en formato libre.
`BOOLEAN`	`Enum`	Un valor booleano `true` o `false`.
`URL`	`Enum`	Una URL como texto, como https://google.com.
`HYPERLINK`	`Enum`	Un hipervínculo.
`IMAGE`	`Enum`	Una imagen.
`IMAGE_LINK`	`Enum`	Un vínculo de imagen
`CURRENCY_AED`	`Enum`	Moneda de AED.
`CURRENCY_ALL`	`Enum`	Moneda de ALL.
`CURRENCY_ARS`	`Enum`	Moneda de ARS.
`CURRENCY_AUD`	`Enum`	Moneda de AUD.
`CURRENCY_BDT`	`Enum`	Moneda de BDT.
`CURRENCY_BGN`	`Enum`	Moneda de BGN
`CURRENCY_BOB`	`Enum`	Moneda de BOB.
`CURRENCY_BRL`	`Enum`	Moneda de BRL.
`CURRENCY_CAD`	`Enum`	Moneda de CAD.
`CURRENCY_CDF`	`Enum`	Moneda de CDF.
`CURRENCY_CHF`	`Enum`	Moneda de CHF.
`CURRENCY_CLP`	`Enum`	Moneda de CLP.
`CURRENCY_CNY`	`Enum`	Moneda de CNY.
`CURRENCY_COP`	`Enum`	Moneda de COP.
`CURRENCY_CRC`	`Enum`	Moneda de CRC.
`CURRENCY_CZK`	`Enum`	Moneda de CZK.
`CURRENCY_DKK`	`Enum`	Moneda de DKK.
`CURRENCY_DOP`	`Enum`	Moneda de DOP.
`CURRENCY_EGP`	`Enum`	Moneda de EGP.
`CURRENCY_ETB`	`Enum`	Moneda de ETB
`CURRENCY_EUR`	`Enum`	Moneda de EUR.
`CURRENCY_GBP`	`Enum`	Moneda de GBP.
`CURRENCY_HKD`	`Enum`	Moneda de HKD.
`CURRENCY_HRK`	`Enum`	Moneda de HRK
`CURRENCY_HUF`	`Enum`	Moneda de HUF.
`CURRENCY_IDR`	`Enum`	Moneda de IDR.
`CURRENCY_ILS`	`Enum`	Moneda de ILS.
`CURRENCY_INR`	`Enum`	Moneda de INR.
`CURRENCY_IRR`	`Enum`	Moneda de IRR.
`CURRENCY_ISK`	`Enum`	Moneda de ISK.
`CURRENCY_JMD`	`Enum`	Moneda de JMD
`CURRENCY_JPY`	`Enum`	Moneda de JPY.
`CURRENCY_KRW`	`Enum`	Moneda de KRW.
`CURRENCY_LKR`	`Enum`	Moneda de LKR
`CURRENCY_LTL`	`Enum`	Moneda de LTL.
`CURRENCY_MNT`	`Enum`	Moneda de MNT.
`CURRENCY_MVR`	`Enum`	Moneda de MVR.
`CURRENCY_MXN`	`Enum`	Moneda de MXN.
`CURRENCY_MYR`	`Enum`	Moneda de MYR
`CURRENCY_NGN`	`Enum`	Moneda de NGN
`CURRENCY_NOK`	`Enum`	Moneda de NOK.
`CURRENCY_NZD`	`Enum`	Moneda de NZD.
`CURRENCY_PAB`	`Enum`	Moneda de PAB
`CURRENCY_PEN`	`Enum`	Moneda de PEN.
`CURRENCY_PHP`	`Enum`	Moneda de PHP.
`CURRENCY_PKR`	`Enum`	Moneda de PKR.
`CURRENCY_PLN`	`Enum`	Moneda de PLN.
`CURRENCY_RON`	`Enum`	Moneda de RON.
`CURRENCY_RSD`	`Enum`	Moneda de RSD.
`CURRENCY_RUB`	`Enum`	Moneda de RUB.
`CURRENCY_SAR`	`Enum`	Moneda de la SAR.
`CURRENCY_SEK`	`Enum`	Moneda de SEK
`CURRENCY_SGD`	`Enum`	Moneda de SGD.
`CURRENCY_THB`	`Enum`	Moneda de THB.
`CURRENCY_TRY`	`Enum`	Moneda de TRY.
`CURRENCY_TWD`	`Enum`	Moneda de TWD.
`CURRENCY_TZS`	`Enum`	Moneda de TZS.
`CURRENCY_UAH`	`Enum`	Moneda de UAH.
`CURRENCY_USD`	`Enum`	Moneda de USD.
`CURRENCY_UYU`	`Enum`	Moneda de UYU.
`CURRENCY_VEF`	`Enum`	Moneda de VEF.
`CURRENCY_VND`	`Enum`	Moneda de VND.
`CURRENCY_YER`	`Enum`	Moneda de YER.
`CURRENCY_ZAR`	`Enum`	Moneda de ZAR.

`Fields`

Métodos

Método	Tipo de datos que se muestra	Descripció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)`	`Fields`	Muestra un objeto `Fields` nuevo filtrado por `Field` con un ID en `ids`.
`getDefaultDimension()`	`Field`	Muestra la dimensión predeterminada que se utilizará para el conjunto de campos.
`getDefaultMetric()`	`Field`	Muestra la métrica predeterminada que se usará para el conjunto de campos.
`getFieldById(fieldId)`	`Field`	Muestra un campo con un ID determinado o `null` si no hay ningún campo con ese ID en este objeto `Fields`.
`newDimension()`	`Field`	Muestra una nueva dimensión `Field`.
`newMetric()`	`Field`	Muestra una métrica nueva `Field`.
`setDefaultDimension(fieldId)`	`void`	Establece la dimensión predeterminada que se utilizará para el conjunto de campos.
`setDefaultMetric(fieldId)`	`void`	Establece la métrica predeterminada que se usará para el conjunto de campos.

`GetAuthTypeResponse`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setAuthType(authType)`	`GetAuthTypeResponse`	Establece el `AuthType` del compilador.
`setHelpUrl(helpUrl)`	`GetAuthTypeResponse`	Establece la URL de ayuda del compilador.

`GetDataResponse`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addAllRows(rows)`	`GetDataResponse`	Agrega varias filas de datos a este `GetDataResponse`.
`addRow(row)`	`GetDataResponse`	Agrega una fila de datos a este `GetDataResponse`.
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`setFields(fields)`	`GetDataResponse`	Establece el `Fields` del compilador.
`setFiltersApplied(filtersApplied)`	`GetDataResponse`	Establece el estado de los filtros aplicados para este compilador.

`GetSchemaResponse`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setFields(fields)`	`GetSchemaResponse`	Establece el `Fields` del compilador.

`Info`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setId(id)`	`Info`	Establece el ID único para esta entrada de configuración.
`setText(text)`	`Info`	Establece el texto para esta entrada de configuración.

`OptionBuilder`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setLabel(label)`	`OptionBuilder`	Establece la etiqueta de este compilador de opciones.
`setValue(value)`	`OptionBuilder`	Establece el valor de este compilador de opciones.

`SelectMultiple`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addOption(optionBuilder)`	`SelectMultiple`	Agrega una nueva opción de selección.
`setAllowOverride(allowOverride)`	`SelectMultiple`	Habilita la anulación para esta entrada de configuración.
`setHelpText(helpText)`	`SelectMultiple`	Establece el texto de ayuda para esta entrada de configuración.
`setId(id)`	`SelectMultiple`	Establece el ID único para esta entrada de configuración.
`setIsDynamic(isDynamic)`	`SelectMultiple`	Establece el estado dinámico para esta entrada de configuración.
`setName(name)`	`SelectMultiple`	Establece el nombre visible de esta entrada de configuración.

`SelectSingle`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addOption(optionBuilder)`	`SelectSingle`	Agrega una nueva opción de selección.
`setAllowOverride(allowOverride)`	`SelectSingle`	Habilita la anulación para esta entrada de configuración.
`setHelpText(helpText)`	`SelectSingle`	Establece el texto de ayuda para esta entrada de configuración.
`setId(id)`	`SelectSingle`	Establece el ID único para esta entrada de configuración.
`setIsDynamic(isDynamic)`	`SelectSingle`	Establece el estado dinámico para esta entrada de configuración.
`setName(name)`	`SelectSingle`	Establece el nombre visible de esta entrada de configuración.

`SetCredentialsResponse`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`build()`	`Object`	Valida este objeto y lo muestra en el formato que necesita Data Studio.
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setIsValid(isValid)`	`SetCredentialsResponse`	Establece el estado válido de este `SetCredentialsResponse`.

`TextArea`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setAllowOverride(allowOverride)`	`TextArea`	Habilita la anulación para esta entrada de configuración.
`setHelpText(helpText)`	`TextArea`	Establece el texto de ayuda para esta entrada de configuración.
`setId(id)`	`TextArea`	Establece el ID único para esta entrada de configuración.
`setIsDynamic(isDynamic)`	`TextArea`	Establece el estado dinámico para esta entrada de configuración.
`setName(name)`	`TextArea`	Establece el nombre visible de esta entrada de configuración.
`setPlaceholder(placeholder)`	`TextArea`	Establece el texto del marcador de posición para esta entrada de configuración.

`TextInput`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`setAllowOverride(allowOverride)`	`TextInput`	Habilita la anulación para esta entrada de configuración.
`setHelpText(helpText)`	`TextInput`	Establece el texto de ayuda para esta entrada de configuración.
`setId(id)`	`TextInput`	Establece el ID único para esta entrada de configuración.
`setIsDynamic(isDynamic)`	`TextInput`	Establece el estado dinámico para esta entrada de configuración.
`setName(name)`	`TextInput`	Establece el nombre visible de esta entrada de configuración.
`setPlaceholder(placeholder)`	`TextInput`	Establece el texto del marcador de posición para esta entrada de configuración.

`UserError`

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`printJson()`	`String`	Imprime la representación JSON de este objeto.
`setDebugText(text)`	`UserError`	Establece el texto del error de depuración, que solo se muestra a los administradores.
`setText(text)`	`UserError`	Establece el texto del error del usuario.
`throwException()`	`void`	Activa esta excepción.