Class DataSourceSheet

DataSourceSheet

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

Solo usa esta clase con datos que estén conectados a una base de datos.

Métodos

MétodoTipo de datos que se muestraDescripción breve
addFilter(columnName, filterCriteria)DataSourceSheetAgrega un filtro aplicado a la hoja de la fuente de datos.
asSheet()SheetDevuelve la hoja de la fuente de datos como un objeto de hoja normal.
autoResizeColumn(columnName)DataSourceSheetCambia automáticamente el tamaño del ancho de la columna especificada.
autoResizeColumns(columnNames)DataSourceSheetCambia automáticamente el tamaño del ancho de las columnas especificadas.
cancelDataRefresh()DataSourceSheetCancela la actualización de datos asociada a este objeto si se está ejecutando.
forceRefreshData()DataSourceSheetActualiza los datos de este objeto, independientemente del estado actual.
getColumnWidth(columnName)Integer|nullDevuelve el ancho de la columna especificada.
getDataSource()DataSourceObtiene 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[]Devuelve todos los valores de la hoja de la fuente de datos para el nombre de columna proporcionado, desde la fila inicial proporcionada (basada en 1) hasta el numRows proporcionado.
getSortSpecs()SortSpec[]Obtiene todas las especificaciones de ordenamiento en la hoja de la fuente de datos.
getStatus()DataExecutionStatusObtiene el estado de ejecución de datos del objeto.
refreshData()DataSourceSheetActualiza los datos del objeto.
removeFilters(columnName)DataSourceSheetQuita todos los filtros aplicados a la columna de la hoja de la fuente de datos.
removeSortSpec(columnName)DataSourceSheetQuita la especificación de ordenamiento de una columna en la hoja de la fuente de datos.
setColumnWidth(columnName, width)DataSourceSheetEstablece el ancho de la columna especificada.
setColumnWidths(columnNames, width)DataSourceSheetEstablece el ancho de las columnas especificadas.
setSortSpec(columnName, ascending)DataSourceSheetEstablece la especificación de ordenamiento en una columna de la hoja de la fuente de datos.
setSortSpec(columnName, sortOrder)DataSourceSheetEstablece la especificación de ordenamiento en una columna de la hoja de la fuente de datos.
waitForCompletion(timeoutInSeconds)DataExecutionStatusEspera 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 la fuente de datos.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna a la que se aplicará este filtro.
filterCriteriaFilterCriteriaSon los criterios de filtro que se aplicarán.

Volver

DataSourceSheet: Es la hoja de la 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 la fuente de datos como un objeto de hoja normal.

Volver

Sheet: Es la hoja regular.

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

NombreTipoDescripción
columnNameStringEl nombre de la columna.

Volver

DataSourceSheet: Es la hoja de esta 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

autoResizeColumns(columnNames)

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

Parámetros

NombreTipoDescripción
columnNamesString[]Es la lista de nombres de columnas que se actualizarán.

Volver

DataSourceSheet: Es la hoja de esta 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 una actualización de fórmula. 

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

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los 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 alcances:

  • 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 en ejecución de este objeto, consulta cancelDataRefresh().

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los 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 alcances:

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

getColumnWidth(columnName)

Devuelve el ancho de la columna especificada.

Parámetros

NombreTipoDescripción
columnNameStringEl nombre de la columna.

Volver

Integer|null: 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.

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

  • 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

NombreTipoDescripción
columnNameStringEs 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 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 la fuente de datos para el nombre de columna proporcionado, desde la fila inicial proporcionada (basada en 1) hasta el numRows proporcionado.

Parámetros

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la fuente de datos para la que se recuperarán los valores.
startRowIntegerEs la posición de la fila desde la que se comenzarán a recuperar valores.
numRowsIntegerCantidad 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 alcances:

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

getSortSpecs()

Obtiene todas las especificaciones de ordenamiento en 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 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

refreshData()

Actualiza los datos del objeto.

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

Se arroja una excepción si el tipo de fuente de datos no está habilitado. Usa los 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 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

NombreTipoDescripción
columnNameStringEs el nombre de la columna de la que se quitarán los filtros.

Volver

DataSourceSheet: Es la hoja de la 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 ordenamiento de una columna en la hoja de la fuente de datos.

Parámetros

NombreTipoDescripción
columnNameStringEs 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 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

NombreTipoDescripción
columnNameStringEl nombre de la columna.
widthIntegerEs el nuevo ancho de la columna.

Volver

DataSourceSheet: Es la hoja de esta 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

setColumnWidths(columnNames, width)

Establece el ancho de las columnas especificadas.

Parámetros

NombreTipoDescripción
columnNamesString[]Es la lista de nombres de columnas que se actualizarán.
widthIntegerEs el nuevo ancho de las columnas.

Volver

DataSourceSheet: Es la hoja de esta 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

setSortSpec(columnName, ascending)

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

Parámetros

NombreTipoDescripción
columnNameStringNombre de la columna por la que se ordenará.
ascendingBooleanSi 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 alcances:

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

setSortSpec(columnName, sortOrder)

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

Parámetros

NombreTipoDescripción
columnNameStringNombre de la columna por la que se ordenará.
sortOrderSortOrderEs 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 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. 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

NombreTipoDescripción
timeoutInSecondsIntegerTiempo de espera 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 alcances:

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