Class DataSourceSheet

Hojadefuente de datos

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

Solo usa esta clase 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 la fuente de datos.
asSheet()	Sheet	Devuelve la hoja de la fuente de datos como un objeto de hoja normal.
autoResizeColumn(columnName)	DataSourceSheet	Cambia el tamaño del ancho de la columna especificada automáticamente.
autoResizeColumns(columnNames)	DataSourceSheet	Cambia el tamaño del ancho de las columnas especificadas automáticamente.
cancelDataRefresh()	DataSourceSheet	Cancela la actualización de datos asociada con este objeto si se está ejecutando.
forceRefreshData()	DataSourceSheet	Actualiza los datos de este objeto independientemente del 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 la fuente de datos.
getSheetValues(columnName)	Object[]	Devuelve todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado.
getSheetValues(columnName, startRow, numRows)	Object[]	Muestra todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado desde la fila de inicio proporcionada (basada en 1) hasta el numRows proporcionado.
getSortSpecs()	SortSpec[]	Obtiene todas las especificaciones de ordenamiento de la hoja de la fuente de datos.
getStatus()	DataExecutionStatus	Obtiene el estado de ejecución de datos del objeto.
refreshData()	DataSourceSheet	Actualiza los datos del objeto.
removeFilters(columnName)	DataSourceSheet	Quita todos los filtros aplicados a la columna de la hoja de la fuente de datos.
removeSortSpec(columnName)	DataSourceSheet	Quita la especificación de orden de una columna en la hoja de la 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 la fuente de datos.
setSortSpec(columnName, sortOrder)	DataSourceSheet	Establece la especificación de orden en una columna de la hoja 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

addFilter(columnName, filterCriteria)

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

Parámetros

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

Volver

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

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

---

asSheet()

Devuelve la hoja de la 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 ámbitos:

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

---

autoResizeColumn(columnName)

Cambia el tamaño del ancho de la columna especificada automáticamente.

Parámetros

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

Volver

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

---

autoResizeColumns(columnNames)

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

Parámetros

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

Volver

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

---

cancelDataRefresh()

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

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

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

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

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 ámbitos:

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

---

forceRefreshData()

Actualiza los datos de este objeto independientemente del estado actual. Consulta refreshData() para obtener más detalles. Si quieres cancelar una actualización de este objeto que se está ejecutando, consulta cancelDataRefresh().

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

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 ámbitos:

• 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: Es 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 ámbitos:

• 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 ámbitos:

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

---

getFilters()

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

Volver

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

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

---

getSheetValues(columnName)

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

Parámetros

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

Volver

Object[]: Es un array unidimensional de valores.

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

---

getSheetValues(columnName, startRow, numRows)

Muestra todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado desde la fila de inicio proporcionada (basada en 1) hasta el numRows proporcionado.

Parámetros

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

Volver

Object[]: Es un array unidimensional de valores.

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

---

getSortSpecs()

Obtiene todas las especificaciones de ordenamiento de la hoja de la 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 ámbitos:

• 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 ámbitos:

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

---

refreshData()

Actualiza los datos del objeto.

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

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

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 ámbitos:

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

---

removeFilters(columnName)

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

Parámetros

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

Volver

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

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

---

removeSortSpec(columnName)

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

Parámetros

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

Volver

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

---

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	Es el ancho nuevo de la columna.

Volver

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

---

setColumnWidths(columnNames, width)

Establece el ancho de las columnas especificadas.

Parámetros

Nombre	Tipo	Descripción
columnNames	String[]	Es la lista de nombres de columnas que se actualizarán.
width	Integer	Es el ancho nuevo de las columnas.

Volver

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

---

setSortSpec(columnName, ascending)

Establece la especificación de orden en una columna de la hoja de la 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, ordena la columna de forma descendente.

Volver

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

---

setSortSpec(columnName, sortOrder)

Establece la especificación de orden en una columna de la hoja de la 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

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

---

waitForCompletion(timeoutInSeconds)

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

Parámetros

Nombre	Tipo	Descripción
timeoutInSeconds	Integer	Es el tiempo que se debe esperar para la ejecución de datos, en segundos. El máximo es de 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