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 |
|---|---|
Aggregation | Es una enumeración que define los tipos de agregación que se pueden establecer para un Field. |
Auth | Es una enumeración que define los tipos de autenticación que se pueden establecer para un conector. |
Big | Es un objeto de configuración para un conector nativo de BigQuery. |
Big | Es una enumeración que define los tipos de parámetros de BigQuery que puedes establecer. |
Checkbox | Contiene información de la casilla de verificación para la configuración. |
Community | CommunityConnector 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. |
Config | Contiene las entradas de configuración de un conector. |
Data | DataStudioApp permite que las secuencias de comandos interactúen con las funciones orientadas a desarrolladores de Data Studio. |
Debug | Es un error que solo pueden ver los administradores del conector. |
Field | Contiene datos relacionados con el campo. |
Field | Es una enumeración que define los tipos que se pueden establecer para un Field. |
Fields | Contiene un conjunto de Fields para un conector de comunidad. |
Get | Es un compilador para crear una respuesta get para tu proyecto de secuencia de comandos. |
Get | Es un compilador para crear una respuesta get para tu proyecto de secuencia de comandos. |
Get | Es un compilador para crear una respuesta get para tu proyecto de secuencia de comandos. |
Info | Contiene datos de información para la configuración. |
Option | Es un compilador para crear opciones para Select y Select. |
Select | Contiene información de selección múltiple para la configuración. |
Select | Contiene información única seleccionada para la configuración. |
Set | Es un compilador para crear una respuesta set para tu proyecto de secuencia de comandos. |
Text | Contiene información del área de texto para la configuración. |
Text | Contiene información de entrada de texto para la configuración. |
User | Es un error que se muestra a los usuarios del conector. |
AggregationType
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
AVG | Enum | Promedio. |
COUNT | Enum | Es el recuento. |
COUNT_DISTINCT | Enum | Recuento de valores distintos |
MAX | Enum | Máx. |
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 necesitan credenciales de nombre de usuario y contraseña. |
PATH_USER_PASS | Enum | Se necesitan el nombre de usuario, la ruta de acceso y la contraseña. |
PATH_KEY | Enum | Se necesitan la ruta de acceso y la clave. |
KEY | Enum | Se necesita una clave o un token de API. |
USER_TOKEN | Enum | Se requieren el nombre de usuario y el token. |
BigQueryConfig
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
add | Big | Agrega un parámetro de consulta a este Big. |
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
print | String | Imprime la representación JSON de este objeto. |
set | Big | Establece el token de acceso de este Big. |
set | Big | Establece el ID del proyecto de facturación de este Big. |
set | Big | Establece la consulta en SQL de este Big. |
set | Big | 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 devuelve | Descripción breve |
|---|---|---|
set | Checkbox | Permite anular esta entrada de configuración. |
set | Checkbox | Establece el texto de ayuda para esta entrada de configuración. |
set | Checkbox | Establece el ID único para esta entrada de configuración. |
set | Checkbox | Establece el estado dinámico para esta entrada de configuración. |
set | Checkbox | Establece el nombre visible para esta entrada de configuración. |
CommunityConnector
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
Aggregation | Aggregation | Es la enumeración Aggregation. |
Auth | Auth | Es la enumeración Auth. |
Big | Big | Es la enumeración Big. |
Field | Field | Es la enumeración Field. |
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
get | Config | Muestra un objeto Config. |
get | Fields | Muestra un objeto Fields. |
new | Get | Devuelve un objeto Get nuevo. |
new | Big | Devuelve un objeto Big nuevo. |
new | Debug | Devuelve un objeto Debug nuevo. |
new | Get | Devuelve un objeto Get nuevo. |
new | Get | Devuelve un objeto Get nuevo. |
new | Set | Devuelve un objeto Set nuevo. |
new | User | Devuelve un objeto User nuevo. |
Config
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
new | Checkbox | Devuelve una nueva entrada de configuración de casilla de verificación. |
new | Info | Devuelve una nueva entrada de configuración de información. |
new | Option | Devuelve un nuevo compilador de opciones. |
new | Select | Devuelve una nueva entrada de configuración de selección múltiple. |
new | Select | Devuelve una nueva entrada de configuración de selección única. |
new | Text | Devuelve una nueva entrada de configuración de área de texto. |
new | Text | Devuelve una nueva entrada de configuración de entrada de texto. |
print | String | Imprime la representación JSON de este objeto. |
set | Config | Si es true, se proporciona un período para las solicitudes de getData(). |
set | Config | Si es true, se vuelve a llamar a get con la configuración del usuario actual. |
DataStudioApp
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
create | Community | Crea un nuevo conector de comunidad. |
DebugError
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
print | String | Imprime la representación JSON de este objeto. |
set | Debug | Establece el texto del error de depuración, que solo se muestra a los administradores. |
throw | void | Activa el lanzamiento de esta excepción. |
Field
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
get | Aggregation | Devuelve el Aggregation de este Field. |
get | String | Devuelve la descripción de este Field. |
get | String | Devuelve la fórmula de este Field. |
get | String | Devuelve el grupo de este Field. |
get | String | Devuelve el ID de este Field. |
get | Boolean | Devuelve true si este campo se puede volver a agregar; de lo contrario, devuelve false. |
get | String | Devuelve el nombre de este Field. |
get | Field | Devuelve el Field de este Field. |
is | Boolean | Devuelve true si este Field es la métrica o la dimensión predeterminada. |
is | Boolean | Devuelve true si este campo es una dimensión. |
is | Boolean | Devuelve true si este Field está oculto. |
is | Boolean | Devuelve true si este campo es una métrica. |
set | Field | Establece el tipo de agregación de este Field. |
set | Field | Establece la descripción de este Field. |
set | Field | Establece la fórmula de este Field. |
set | Field | Establece el grupo de este Field. |
set | Field | Establece el ID de este objeto Field. |
set | Field | Establece el estado oculto de este Field. |
set | Field | Establece el estado de reagregación permitida para un Field. |
set | Field | Establece el nombre de este Field. |
set | Field | Establece el Field de este Field. |
FieldType
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
YEAR | Enum | Año en formato AAAA, como 2017. |
YEAR_QUARTER | Enum | Año y trimestre en el formato AAAAT, como 20171. |
YEAR_MONTH | Enum | Año y mes en el formato AAAAMM, como 201703. |
YEAR_WEEK | Enum | Año y semana en el formato AAAAss, como 201707. |
YEAR_MONTH_DAY | Enum | Año, mes y día en formato AAAAMMDD, como 20170317. |
YEAR_MONTH_DAY_HOUR | Enum | Año, mes, día y hora en el formato AAAAMMDDHH, como 2017031703. |
YEAR_MONTH_DAY_MINUTE | Enum | Año, mes, día, hora y minuto en el formato AAAAMMDDHHmm, como 201703170230. |
YEAR_MONTH_DAY_SECOND | Enum | Año, mes, día, hora, minuto y segundo en el formato AAAAMMDDHHmmss, como 20170317023017. |
QUARTER | Enum | Cuarto en formato 1, 2, 3 o 4). |
MONTH | Enum | Mes en formato MM, como 03. |
WEEK | Enum | Semana en formato de ww, como 07. |
MONTH_DAY | Enum | Mes y día en formato MMDD, como 0317. |
DAY_OF_WEEK | Enum | Número en el rango [0, 6], en el que 0 representa el domingo. |
DAY | Enum | Día en formato DD, como 17. |
HOUR | Enum | Hora en formato HH, como 13. |
MINUTE | Enum | Minuto en formato mm, como 12. |
DURATION | Enum | Es un período en segundos. |
COUNTRY | Enum | Un país, como Estados Unidos. |
COUNTRY_CODE | Enum | Es un código de país, como US. |
CONTINENT | Enum | Es un continente, como América. |
CONTINENT_CODE | Enum | Es un código de continente, como 019. |
SUB_CONTINENT | Enum | Es un subcontinente, como América del Norte. |
SUB_CONTINENT_CODE | Enum | Es un código de subcontinente, como 003. |
REGION | Enum | Una región, como California. |
REGION_CODE | Enum | Es 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 | Una ciudad metropolitana, como San Francisco-Oakland-San José, CA. |
METRO_CODE | Enum | Es un código de área metropolitana, como 200807. |
LATITUDE_LONGITUDE | Enum | Es un par de latitud y longitud, como 51.5074, -0.1278. |
NUMBER | Enum | Es un número decimal. |
PERCENT | Enum | Es el porcentaje decimal (puede ser superior a 1.0). |
TEXT | Enum | Es texto de formato libre. |
BOOLEAN | Enum | Un valor booleano true o false. |
URL | Enum | Es una URL como texto, por ejemplo, https://google.com. |
HYPERLINK | Enum | Es un hipervínculo. |
IMAGE | Enum | Una imagen. |
IMAGE_LINK | Enum | Es un vínculo a una 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 | Es la moneda de BOB. |
CURRENCY_BRL | Enum | Moneda de BRL. |
CURRENCY_CAD | Enum | Moneda de CAD. |
CURRENCY_CDF | Enum | Es la moneda del 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 | Es la moneda del DOP. |
CURRENCY_EGP | Enum | Moneda de EGP. |
CURRENCY_ETB | Enum | Es la 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 del INR. |
CURRENCY_IRR | Enum | Es la moneda del 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 | Es la moneda de LTL. |
CURRENCY_MNT | Enum | Moneda del MNT. |
CURRENCY_MVR | Enum | Es la 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 del PAB. |
CURRENCY_PEN | Enum | Moneda de PEN. |
CURRENCY_PHP | Enum | Es la 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 | Es la moneda de RUB. |
CURRENCY_SAR | Enum | Moneda de 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 que no es 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 devuelve | Descripción breve |
|---|---|---|
as | 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. |
for | Fields | Devuelve un objeto Fields nuevo filtrado para incluir solo los objetos Field con un ID en ids. |
get | Field | Devuelve la dimensión predeterminada que se usará para el conjunto de campos. |
get | Field | Devuelve la métrica predeterminada que se usará para el conjunto de campos. |
get | Field | Devuelve un campo con un ID determinado o null si no hay ningún campo con ese ID en este objeto Fields. |
new | Field | Devuelve una nueva dimensión Field. |
new | Field | Devuelve una nueva métrica Field. |
set | void | Establece la dimensión predeterminada que se usará para el conjunto de campos. |
set | void | Establece la métrica predeterminada que se usará para el conjunto de campos. |
GetAuthTypeResponse
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
print | String | Imprime la representación JSON de este objeto. |
set | Get | Establece el Auth del compilador. |
set | Get | Establece la URL de ayuda del compilador. |
GetDataResponse
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
add | Get | Agrega varias filas de datos a este Get. |
add | Get | Agrega una fila de datos a este Get. |
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
set | Get | Establece el Fields del compilador. |
set | Get | Establece el estado de aplicación de los filtros para este compilador. |
GetSchemaResponse
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
print | String | Imprime la representación JSON de este objeto. |
set | Get | Establece el Fields del compilador. |
Info
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
set | Info | Establece el ID único para esta entrada de configuración. |
set | Info | Establece el texto para esta entrada de configuración. |
OptionBuilder
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
set | Option | Establece la etiqueta de este compilador de opciones. |
set | Option | Establece el valor de este compilador de opciones. |
SelectMultiple
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
add | Select | Agrega una nueva opción de selección. |
set | Select | Permite anular esta entrada de configuración. |
set | Select | Establece el texto de ayuda para esta entrada de configuración. |
set | Select | Establece el ID único para esta entrada de configuración. |
set | Select | Establece el estado dinámico para esta entrada de configuración. |
set | Select | Establece el nombre visible para esta entrada de configuración. |
SelectSingle
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
add | Select | Agrega una nueva opción de selección. |
set | Select | Permite anular esta entrada de configuración. |
set | Select | Establece el texto de ayuda para esta entrada de configuración. |
set | Select | Establece el ID único para esta entrada de configuración. |
set | Select | Establece el estado dinámico para esta entrada de configuración. |
set | Select | Establece el nombre visible para esta entrada de configuración. |
SetCredentialsResponse
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
build() | Object | Valida este objeto y lo devuelve en el formato que necesita Data Studio. |
print | String | Imprime la representación JSON de este objeto. |
set | Set | Establece el estado válido de este Set. |
TextArea
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
set | Text | Permite anular esta entrada de configuración. |
set | Text | Establece el texto de ayuda para esta entrada de configuración. |
set | Text | Establece el ID único para esta entrada de configuración. |
set | Text | Establece el estado dinámico para esta entrada de configuración. |
set | Text | Establece el nombre visible para esta entrada de configuración. |
set | Text | Establece el texto del marcador de posición para esta entrada de configuración. |
TextInput
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
set | Text | Permite anular esta entrada de configuración. |
set | Text | Establece el texto de ayuda para esta entrada de configuración. |
set | Text | Establece el ID único para esta entrada de configuración. |
set | Text | Establece el estado dinámico para esta entrada de configuración. |
set | Text | Establece el nombre visible para esta entrada de configuración. |
set | Text | Establece el texto del marcador de posición para esta entrada de configuración. |
UserError
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
print | String | Imprime la representación JSON de este objeto. |
set | User | Establece el texto del error de depuración, que solo se muestra a los administradores. |
set | User | Establece el texto del error del usuario. |
throw | void | Activa el lanzamiento de esta excepción. |