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

Class DataSourceSheet

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

Usa esta clase solo con datos conectados a una base de datos.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addFilter(columnName, filterCriteria)`	`DataSourceSheet`	Agrega un filtro aplicado a la hoja de fuente de datos.
`asSheet()`	`Sheet`	Devuelve la hoja de fuente de datos como un objeto de hoja normal.
`autoResizeColumn(columnName)`	`DataSourceSheet`	Cambia el tamaño de la columna especificada de forma automática.
`autoResizeColumns(columnNames)`	`DataSourceSheet`	Cambia automáticamente el tamaño del ancho de las columnas especificadas.
`cancelDataRefresh()`	`DataSourceSheet`	Cancela la actualización de datos asociada a este objeto si se está ejecutando.
`forceRefreshData()`	`DataSourceSheet`	Actualiza los datos de este objeto sin importar el estado actual.
`getColumnWidth(columnName)`	`Integer`	Muestra el ancho de la columna especificada.
`getDataSource()`	`DataSource`	Obtiene la fuente de datos a la que está vinculado el objeto.
`getFilters()`	`DataSourceSheetFilter[]`	Devuelve todos los filtros aplicados a la hoja de fuente de datos.
`getSheetValues(columnName)`	`Object[]`	Muestra todos los valores de la hoja de fuente de datos para el nombre de columna proporcionado.
`getSheetValues(columnName, startRow, numRows)`	`Object[]`	Devuelve todos los valores de la hoja de fuente de datos para el nombre de columna proporcionado del proporcionado fila de inicio (basada en 1) y hasta el `numRows` proporcionado.
`getSortSpecs()`	`SortSpec[]`	Obtiene todas las especificaciones de orden en la hoja de fuente de datos.
`getStatus()`	`DataExecutionStatus`	Obtiene el estado de ejecución de los datos del objeto.
`refreshData()`	`DataSourceSheet`	Actualiza los datos del objeto.
`removeFilters(columnName)`	`DataSourceSheet`	Elimina todos los filtros aplicados a la columna de la hoja de fuente de datos.
`removeSortSpec(columnName)`	`DataSourceSheet`	Elimina la especificación de orden en una columna de la hoja de fuente de datos.
`setColumnWidth(columnName, width)`	`DataSourceSheet`	Establece el ancho de la columna especificada.
`setColumnWidths(columnNames, width)`	`DataSourceSheet`	Establece el ancho de las columnas especificadas.
`setSortSpec(columnName, ascending)`	`DataSourceSheet`	Establece la especificación de orden en una columna de la hoja de fuente de datos.
`setSortSpec(columnName, sortOrder)`	`DataSourceSheet`	Establece la especificación de orden en una columna de la hoja de fuente de datos.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Espera hasta que se complete la ejecución actual. El tiempo de espera se agota después de la cantidad de segundos proporcionada.

Documentación detallada

`addFilter(columnName, filterCriteria)`

Agrega un filtro aplicado a la hoja de 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 deben aplicar.

Volver

DataSourceSheet: Es la hoja de fuente de datos para el encadenamiento de métodos.

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

`asSheet()`

Devuelve la hoja de fuente de datos como un objeto de hoja normal.

Volver

Sheet: Es la hoja normal.

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

`autoResizeColumn(columnName)`

Cambia el tamaño de la columna especificada de forma automática.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna.

Volver

DataSourceSheet: Esta 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

`autoResizeColumns(columnNames)`

Cambia automáticamente el tamaño del ancho de las columnas especificadas.

Parámetros

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

Volver

DataSourceSheet: Esta 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

`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

DataSourceSheet: 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 más detalles. Si deseas cancelar una actualización en ejecución de este objeto, consulta cancelDataRefresh().

Volver

DataSourceSheet: 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

`getColumnWidth(columnName)`

Muestra el ancho de la columna especificada.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna.

Volver

Integer: El ancho de la columna, o null si la columna usa el ancho predeterminado.

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()`

Devuelve todos los filtros aplicados a la hoja de fuente de datos.

Volver

DataSourceSheetFilter[]: Es un array de todos los filtros aplicados a la hoja 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

`getSheetValues(columnName)`

Muestra todos los valores de la hoja de fuente de datos para el nombre de columna proporcionado.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna de la fuente de datos para la que se recuperarán los valores.

Volver

Object[]: Es un array de valores unidimensional.

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

`getSheetValues(columnName, startRow, numRows)`

Devuelve todos los valores de la hoja de fuente de datos para el nombre de columna proporcionado del proporcionado fila de inicio (basada en 1) y hasta el numRows proporcionado.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna de la fuente de datos para la que se recuperarán los valores.
`startRow`	`Integer`	La posición de la fila desde la que se comienzan a recuperar los valores.
`numRows`	`Integer`	La cantidad de filas que se recuperarán.

Volver

Object[]: Es un array de valores unidimensional.

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 hoja 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 los 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

`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

DataSourceSheet: 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

`removeFilters(columnName)`

Elimina todos los filtros aplicados a la columna de la hoja de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna de la que se quitarán los filtros.

Volver

DataSourceSheet: Es la hoja de fuente de datos para el encadenamiento de métodos.

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

`removeSortSpec(columnName)`

Elimina la especificación de orden en una columna de la hoja de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	Es el nombre de la columna

Volver

DataSourceSheet: 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

`setColumnWidth(columnName, width)`

Establece el ancho de la columna especificada.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	El nombre de la columna.
`width`	`Integer`	El nuevo ancho de la columna.

Volver

DataSourceSheet: Esta 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

`setColumnWidths(columnNames, width)`

Establece el ancho de las columnas especificadas.

Parámetros

Nombre	Tipo	Descripción
`columnNames`	`String[]`	La lista de nombres de columnas que se actualizarán.
`width`	`Integer`	El nuevo ancho de las columnas.

Volver

DataSourceSheet: Esta 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

`setSortSpec(columnName, ascending)`

Establece la especificación de orden en una columna de la hoja de fuente de datos.

Parámetros

Nombre	Tipo	Descripción
`columnName`	`String`	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

DataSourceSheet: 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

`setSortSpec(columnName, sortOrder)`

Establece la especificación de orden en una columna de la hoja de fuente de datos.

Parámetros

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

Volver

DataSourceSheet: 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

`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 alcances:

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