Class DataSource

DataSource

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

Usa esta clase solo con datos que estén conectados a una base de datos.

Métodos

MétodoTipo de datos que se muestraDescripción breve
cancelAllLinkedDataSourceObjectRefreshes()voidCancela todas las actualizaciones en ejecución de los objetos de fuente de datos vinculados a esta fuente de datos.
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 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 de la fuente de datos.
getDataSourceSheets()DataSourceSheet[]Muestra las hojas de la 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 especificación nueva.
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 agota el tiempo de espera después de la cantidad de segundos proporcionada.

Documentación detallada

cancelAllLinkedDataSourceObjectRefreshes()

Cancela todas las actualizaciones en ejecución de los objetos de fuente de datos vinculados a esta fuente de datos.

En este ejemplo, se muestra cómo cancelar todas las actualizaciones de una fuente de datos.

SpreadsheetApp.enableBigQueryExecution();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Muestra 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 del tipo específico 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

createCalculatedColumn(name, formula)

Crea una columna calculada.

Parámetros

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

Devolvedor

DataSourceColumn: Es 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 lateral, convierte a la hoja nueva en la hoja activa.

Devolvedor

DataSourcePivotTable: Es la tabla dinámica 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

createDataSourceTableOnNewSheet()

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

Devolvedor

DataSourceTable: Es 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 obtendrá.

Devolvedor

DataSourceColumn: Es la columna calculada que coincide con el nombre de la columna, o null si no existe tal 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.

Devolvedor

DataSourceColumn[]: Es un array 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 de la fuente de datos.

Devolvedor

DataSourceColumn[]: Es un array 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 la fuente de datos asociadas con esta fuente de datos.

Devolvedor

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

getSpec()

Obtiene la especificación de la fuente de datos.

Devolvedor

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

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 métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos del tipo específico 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

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 especificación nueva.

Muestra 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 del tipo específico de fuente de datos.

Parámetros

NombreTipoDescripción
specDataSourceSpecEs la especificación de fuente de datos con la que se actualizará.

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

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 métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos del tipo específico de fuente de datos.

Parámetros

NombreTipoDescripción
specDataSourceSpecEs la especificación de fuente de datos con la que se actualizará.
refreshAllLinkedObjectsBooleanSi es true, también actualiza todos los objetos de fuente de datos vinculados con esta fuente de datos.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Espera hasta que se completen todas las ejecuciones actuales de los objetos de fuente de datos vinculados y agota 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 cancela las ejecuciones de datos.

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerEl tiempo de espera para las ejecuciones de datos, en segundos. La cantidad máxima 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