Accede a la hoja de fuente de datos existente y modifícala. Para crear una nueva hoja de fuente de datos, usa Spreadsheet.insertDataSourceSheet(spec).
Usa esta clase solo con datos que estén 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 | Muestra la hoja de fuente de datos como un objeto de hoja normal. |
autoResizeColumn(columnName) | DataSourceSheet | Cambia automáticamente el tamaño del ancho de la columna especificada. |
autoResizeColumns(columnNames) | DataSourceSheet | Cambia automáticamente el tamaño del ancho de las columnas especificadas. |
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[] | Muestra 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[] | Muestra todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado desde la fila de inicio proporcionada (based-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 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 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 y se agota 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 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 | Son los criterios de filtro que se deben aplicar. |
Devolvedor
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()
Muestra la hoja de fuente de datos como un objeto de hoja normal.
Devolvedor
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 automáticamente el tamaño del ancho de la columna especificada.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
columnName | String | El nombre de la columna. |
Devolvedor
DataSourceSheet: Esta hoja de fuente de datos se usa 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
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. |
Devolvedor
DataSourceSheet: Esta hoja de fuente de datos se usa 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
forceRefreshData()
Actualiza los datos de este objeto sin importar el estado actual. Consulta refreshData() para obtener más información.
Muestra una excepción si el tipo de fuente de datos no está habilitado Usa los métodos SpreadsheetApp#enable...Execution() a fin de habilitar la ejecución de datos para un tipo específico de fuente de datos.
Devolvedor
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. |
Devolvedor
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 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.
Devolvedor
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 hoja de fuente de datos.
Devolvedor
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 los que se recuperarán los valores. |
Devolvedor
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)
Muestra todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado desde la fila de inicio proporcionada (based-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 los que se recuperarán los valores. |
startRow | Integer | La posición de fila desde la que se comienza a recuperar valores. |
numRows | Integer | La cantidad de filas que se recuperarán. |
Devolvedor
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.
Devolvedor
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.
Devolvedor
DataExecutionStatus: Es el estado de ejecución 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
refreshData()
Actualiza los datos del objeto.
Muestra una excepción si está en el estado error. Usa DataSource#updateSpec() para actualizar la especificación. Se prefiere el método en lugar de forceRefreshData() para evitar ediciones inesperadas en la fuente de datos.
Muestra una excepción si el tipo de fuente de datos no está habilitado Usa los métodos SpreadsheetApp#enable...Execution() a fin de habilitar la ejecución de datos para un tipo específico de fuente de datos.
Devolvedor
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)
Quita todos los filtros aplicados a la columna de la hoja de la fuente de datos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
columnName | String | El nombre de la columna de la que se quitan los filtros. |
Devolvedor
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)
Quita 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 |
Devolvedor
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. |
Devolvedor
DataSourceSheet: Esta hoja de fuente de datos se usa 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
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. |
Devolvedor
DataSourceSheet: Esta hoja de fuente de datos se usa 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
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, ordena la columna en orden descendente. |
Devolvedor
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. |
Devolvedor
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 y se agota el tiempo de espera 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 la ejecución de los datos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
timeoutInSeconds | Integer | El tiempo de espera para la ejecución de los datos, en segundos. El máximo es 300 segundos. |
Devolvedor
DataExecutionStatus: Es el estado de ejecución 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