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

Class DataSourceTable

Acceder a la tabla de fuente de datos existente y modificarla. Para crear una nueva tabla de fuente de datos en una hoja nueva, usa Spreadsheet.insertSheetWithDataSourceTable(spec).

Usa esta clase solo con fuentes de datos de BigQuery.

En este ejemplo, se muestra cómo crear una nueva tabla de fuentes de datos.

SpreadsheetApp.enableBigQueryExecution();
var spreadsheet = SpreadsheetApp.getActive();
var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();
// Starts data execution asynchronously.
var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
var dataSourceTable = dataSheet.getDataSourceTables()[0];
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

En este ejemplo, se muestra cómo editar una fuente de datos.

SpreadsheetApp.enableBigQueryExecution();
var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1");
var dataSourceTable = dataSheet.getDataSourceTables()[0];
var dataSource = dataSourceTable.getDataSource();
var newSpec = dataSource.getSpec()
              .copy()
              .asBigQuery()
              .setRawQuery('select name from table limit 2')
              .removeAllParameters()
              .build();
// Updates data source specification and starts data execution asynchronously.
dataSource.updateSpec(newSpec);
// Check status during execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addColumns(columnNames)`	`DataSourceTable`	Agrega columnas a la tabla de fuente de datos.
`addFilter(columnName, filterCriteria)`	`DataSourceTable`	Agrega un filtro aplicado a la tabla de la fuente de datos.
`addSortSpec(columnName, ascending)`	`DataSourceTable`	Agrega una especificación de orden en una columna de la tabla de fuente de datos.
`addSortSpec(columnName, sortOrder)`	`DataSourceTable`	Agrega una especificación de orden en una columna de la tabla de fuente de datos.
`cancelDataRefresh()`	`DataSourceTable`	Cancela la actualización de datos asociada a este objeto si se está ejecutando.
`forceRefreshData()`	`DataSourceTable`	Actualiza los datos de este objeto sin importar el estado actual.
`getColumns()`	`DataSourceTableColumn[]`	Obtiene todas las columnas de la fuente de datos que se agregaron a la tabla de la fuente de datos.
`getDataSource()`	`DataSource`	Obtiene la fuente de datos a la que está vinculado el objeto.
`getFilters()`	`DataSourceTableFilter[]`	Muestra todos los filtros aplicados a la tabla de fuente de datos.
`getRange()`	`Range`	Obtiene el `Range` que abarca esta tabla de fuente de datos.
`getRowLimit()`	`Integer`	Muestra el límite de filas de la tabla de fuente de datos.
`getSortSpecs()`	`SortSpec[]`	Obtiene todas las especificaciones de ordenamiento en la tabla de la fuente de datos.
`getStatus()`	`DataExecutionStatus`	Obtiene el estado de ejecución de datos del objeto.
`isSyncingAllColumns()`	`Boolean`	Muestra si la tabla de fuente de datos está sincronizando todas las columnas de la fuente de datos asociada.
`refreshData()`	`DataSourceTable`	Actualiza los datos del objeto.
`removeAllColumns()`	`DataSourceTable`	Quita todas las columnas de la tabla de fuente de datos.
`removeAllSortSpecs()`	`DataSourceTable`	Quita todas las especificaciones de orden de la tabla de fuente de datos.
`setRowLimit(rowLimit)`	`DataSourceTable`	Actualiza el límite de filas de la tabla de fuente de datos.
`syncAllColumns()`	`DataSourceTable`	Sincroniza todas las columnas actuales y futuras de la fuente de datos asociada con la tabla de la fuente de datos.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Espera hasta que se complete la ejecución actual y se agote el tiempo de espera después de la cantidad de segundos proporcionada.

Documentación detallada

`addColumns(columnNames)`

Agrega columnas a la tabla de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnNames`	`String[]`	La lista de los nombres de las columnas que se agregarán.

Volver

DataSourceTable: Es la tabla de fuente de datos para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`addFilter(columnName, filterCriteria)`

Agrega un filtro aplicado a la tabla de la fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna a la que se aplicará el filtro.
`filterCriteria`	`FilterCriteria`	Los criterios de filtro que se aplicarán.

Volver

DataSourceTable: Es la tabla de fuente de datos para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`addSortSpec(columnName, ascending)`

Agrega una especificación de orden en una columna de la tabla de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	Es el nombre de la columna que se ordenará.
`ascending`	`Boolean`	Si es `true`, ordena la columna de forma ascendente; si es `false`, ordenar la columna en orden descendente.

Volver

DataSourceTable: Es la hoja de fuente de datos, para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`addSortSpec(columnName, sortOrder)`

Agrega una especificación de orden en una columna de la tabla de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	Es el nombre de la columna que se ordenará.
`sortOrder`	`SortOrder`	Es el orden de clasificación.

Volver

DataSourceTable: Es la hoja de la fuente de datos para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`cancelDataRefresh()`

Cancela la actualización de datos asociada a este objeto si se está ejecutando.

En este ejemplo, se muestra cómo cancelar la actualización de una fórmula.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Arroja una excepción si el tipo de fuente de datos no está habilitado. Usar métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para una fuente de datos específica el tipo de letra.

Volver

DataSourceTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`forceRefreshData()`

Actualiza los datos de este objeto sin importar el estado actual. Consulta refreshData() para obtener más detalles. Si deseas cancelar una actualización en ejecución de este objeto, consulta cancelDataRefresh().

Genera una excepción si el tipo de fuente de datos no está habilitado. Usar métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para una fuente de datos específica el tipo de letra.

Volver

DataSourceTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getColumns()`

Obtiene todas las columnas de la fuente de datos agregadas a la tabla de la fuente de datos.

Volver

DataSourceTableColumn[]: Es una lista de columnas de la tabla de fuente de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDataSource()`

Obtiene la fuente de datos a la que está vinculado el objeto.

Volver

DataSource: Es la fuente de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getFilters()`

Muestra todos los filtros aplicados a la tabla de la fuente de datos.

Volver

DataSourceTableFilter[]: Es un array de todos los filtros aplicados a la tabla de fuente de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRange()`

Obtiene las Range que abarca esta tabla de fuente de datos.

Volver

Range: Es el rango.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRowLimit()`

Muestra el límite de filas de la tabla de fuente de datos.

Volver

Integer: el límite de filas de la tabla de fuente de datos, o null si no se establece ningún límite y utiliza el límite máximo predeterminado de la IU de Hojas de cálculo de Google.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSortSpecs()`

Obtiene todas las especificaciones de orden en la tabla de fuente de datos.

Volver

SortSpec[]: Es una lista de especificaciones de orden.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`getStatus()`

Obtiene el estado de ejecución de datos del objeto.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`isSyncingAllColumns()`

Muestra si la tabla de fuente de datos está sincronizando todas las columnas de la fuente de datos asociada.

Volver

Boolean: True si la tabla de fuente de datos sincroniza todas las columnas de los datos asociados fuente u false de lo contrario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`refreshData()`

Actualiza los datos del objeto.

Muestra una excepción si se encuentra en el estado error. Usa DataSource#updateSpec() para actualizar la especificación. El método es se prefiere en lugar de forceRefreshData() para evitar ediciones inesperadas en la fuente de datos.

Volver

DataSourceTable: Es el objeto de datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`removeAllColumns()`

Quita todas las columnas de la tabla de fuente de datos.

Volver

DataSourceTable: Es la tabla de fuente de datos para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`removeAllSortSpecs()`

Quita todas las especificaciones de orden de la tabla de fuente de datos.

Volver

DataSourceTable: Es la hoja de la fuente de datos para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`setRowLimit(rowLimit)`

Actualiza el límite de filas de la tabla de fuente de datos. Si el límite de filas proporcionado es null, Luego, actualiza la tabla de la fuente de datos para usar el límite máximo de filas predeterminado, como en la IU de Hojas de cálculo de Google.

Parámetros

Nombre	Tipo	Descripción
`rowLimit`	`Integer`	El nuevo límite de filas para la tabla de datos. Si es `null`, actualiza la tabla para usar. el límite de filas predeterminado.

Volver

DataSourceTable: Es la tabla de la fuente de datos para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`syncAllColumns()`

Sincroniza todas las columnas actuales y futuras de la fuente de datos asociada con la tabla de la fuente de datos.

Volver

DataSourceTable: Es la tabla de fuente de datos para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`waitForCompletion(timeoutInSeconds)`

Espera hasta que se complete la ejecución actual. El tiempo de espera se agota después de la cantidad de segundos proporcionada. Muestra una excepción si la ejecución no se completa cuando se agota el tiempo de espera, pero no cancela ejecución de los datos.

Parámetros

Nombre	Tipo	Descripción
`timeoutInSeconds`	`Integer`	El tiempo que se debe esperar para la ejecución de los datos, en segundos. El máximo es 300 segundos.

Volver

DataExecutionStatus: Es el estado de ejecución de los datos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets