Class DataSource

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
DataSource

Acceder a una fuente de datos existente y modificarla Para crear una tabla de fuente de datos con una fuente de datos nueva, consulta DataSourceTable.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
createCalculatedColumn(name, formula)DataSourceColumnCrea una columna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCrea una tabla dinámica de fuente de datos a partir de esta fuente de datos en la primera celda de una hoja nueva.
createDataSourceTableOnNewSheet()DataSourceTableCrea una tabla de fuente de datos a partir de esta fuente de datos en la primera celda de una hoja nueva.
getCalculatedColumnByName(columnName)DataSourceColumnMuestra la columna calculada en la fuente de datos que coincide con el nombre de la columna.
getCalculatedColumns()DataSourceColumn[]Muestra todas las columnas calculadas en la fuente de datos.
getColumns()DataSourceColumn[]Muestra todas las columnas en la fuente de datos.
getDataSourceSheets()DataSourceSheet[]Muestra las hojas de fuente de datos asociadas con esta fuente de datos.
getSpec()DataSourceSpecObtiene la especificación de la fuente de datos.
refreshAllLinkedDataSourceObjects()voidActualiza todos los objetos de fuente de datos vinculados a la fuente de datos.
updateSpec(spec)DataSourceActualiza la especificación de la fuente de datos y actualiza los objetos de la fuente de datos vinculados con esta fuente de datos con la nueva especificación.
updateSpec(spec, refreshAllLinkedObjects)DataSourceActualiza la especificación de la fuente de datos y actualiza el data source sheets vinculado con la nueva especificación.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidEspera hasta que se completen todas las ejecuciones actuales de los objetos de fuente de datos vinculados y se agote el tiempo de espera después de la cantidad de segundos proporcionada.

Documentación detallada

createCalculatedColumn(name, formula)

Crea una columna calculada.

Parámetros

NombreTipoDescripción
nameStringEl nombre de la columna calculada.
formulaStringLa fórmula de la columna calculada

Volver

DataSourceColumn: la columna calculada recién creada.

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

createDataSourcePivotTableOnNewSheet()

Crea una tabla dinámica de fuente de datos a partir de esta fuente de datos en la primera celda de una hoja nueva. Como efecto secundario, la hoja nueva se convierte en la hoja activa.

Volver

DataSourcePivotTable: la tabla dinámica de la fuente de datos recién creada.

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

createDataSourceTableOnNewSheet()

Crea una tabla de fuente de datos a partir de esta fuente de datos en la primera celda de una hoja nueva. Como efecto secundario, hace que la hoja nueva sea la hoja activa.

Volver

DataSourceTable: la tabla de fuente de datos recién creada.

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

getCalculatedColumnByName(columnName)

Muestra la columna calculada en la fuente de datos que coincide con el nombre de la columna.

Parámetros

NombreTipoDescripción
columnNameStringEl nombre de la columna calculada que se debe obtener.

Volver

DataSourceColumn: La columna calculada que coincide con el nombre de la columna, o null si no existe esa columna calculada.

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

getCalculatedColumns()

Muestra todas las columnas calculadas en la fuente de datos.

Volver

DataSourceColumn[]: Es un arreglo de todas las columnas calculadas en 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

getColumns()

Muestra todas las columnas en la fuente de datos.

Volver

DataSourceColumn[]: Es un arreglo de todos los DataSourceColumn en 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

getDataSourceSheets()

Muestra las hojas de fuente de datos asociadas con esta fuente de datos.

Volver

DataSourceSheet[]: Es un arreglo de hojas de fuentes 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

getSpec()

Obtiene la especificación de la fuente de datos.

Volver

DataSourceSpec: la especificación 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

refreshAllLinkedDataSourceObjects()

Actualiza todos los objetos de fuente de datos vinculados a 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 el tipo de fuente de datos específico.

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

updateSpec(spec)

Actualiza la especificación de la fuente de datos y actualiza los objetos de la fuente de datos vinculados con esta fuente de datos con la nueva especificació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 el tipo de fuente de datos específico.

Parámetros

NombreTipoDescripción
specDataSourceSpecLa especificación de la fuente de datos para la actualización.

Volver

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

updateSpec(spec, refreshAllLinkedObjects)

Actualiza la especificación de la fuente de datos y actualiza el data source sheets vinculado con la nueva especificació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 el tipo de fuente de datos específico.

Parámetros

NombreTipoDescripción
specDataSourceSpecLa especificación de la fuente de datos para la actualización.
refreshAllLinkedObjectsBooleanSi es true, también actualiza todos los objetos de fuente de datos vinculados con esta fuente de datos.

Volver

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Espera hasta que se completen todas las ejecuciones actuales de los objetos de fuente de datos vinculados y se agote el tiempo de espera después de la cantidad de segundos proporcionada. Muestra una excepción si las ejecuciones no se completan cuando se agota el tiempo de espera, pero no se cancelan las ejecuciones de datos.

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerEl tiempo de espera para las ejecuciones de datos, en segundos. El máximo es de 300 segundos.

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