Class DataSource

DataSource

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

Usa esta clase solo con datos 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 de datos en la primera celda de una hoja nueva.
getCalculatedColumnByName(columnName)DataSourceColumnDevuelve 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[]Devuelve las hojas de fuente de datos asociadas a 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 fuente de datos y los objetos de la fuente de datos vinculados a esta fuente de datos con la nueva especificación.
updateSpec(spec, refreshAllLinkedObjects)DataSourceActualiza la especificación de fuente de datos y actualiza el data source sheets vinculado con la especificación nueva.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidEspera hasta que se completen todas las ejecuciones actuales de los objetos de la fuente de datos vinculados. Se agota el tiempo de espera. luego de la cantidad de segundos indicada.

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();

Arroja 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 específicos el tipo de fuente.

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. Este método solo está disponible para fuentes de datos de BigQuery.

Parámetros

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

Volver

DataSourceColumn: Es la columna calculada que se acaba de crear.

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, convierte la hoja nueva en la hoja activa.

Volver

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

  • 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 complemento hace que la hoja nueva se convierta en hoja activa.

Este método solo está disponible para fuentes de datos de BigQuery.

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 obtendrá.

Volver

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

Devuelve todas las columnas calculadas de la fuente de datos.

Las especificaciones de la fuente de datos del tipo DataSourceType.LOOKER muestran un array vacío.

Volver

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.

Volver

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

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

getDataSourceSheets()

Devuelve las hojas de fuente de datos asociadas a esta fuente de datos.

Volver

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.

Volver

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

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

refreshAllLinkedDataSourceObjects()

Actualiza todos los objetos de la fuente de datos vinculados a la fuente de datos.

Arroja 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 específicos el tipo de fuente.

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

updateSpec(spec)

Actualiza la especificación de fuente de datos y los objetos de la fuente de datos vinculados a esta fuente de datos con la nueva especificación.

Arroja 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 específicos el tipo de fuente.

Lanza una excepción si el tipo de especificación de la fuente de datos es diferente al tipo de fuente de datos actual.

Parámetros

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

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

updateSpec(spec, refreshAllLinkedObjects)

Actualiza la especificación de la fuente de datos y actualiza el data source sheets vinculado con la nueva especificación.

Arroja 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 específicos el tipo de fuente.

Lanza una excepción si el tipo de especificación de la fuente de datos es diferente al tipo de fuente de datos actual.

Parámetros

NombreTipoDescripción
specDataSourceSpecLa especificación de la fuente de datos con la que se actualizará.
refreshAllLinkedObjectsBooleanSi es true, también se actualizan todos los objetos de la fuente de datos. vinculada a esta fuente de datos.

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

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 no se completan las ejecuciones. cuando se agota el tiempo de espera, pero no cancela las ejecuciones de datos.

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerEl tiempo que se debe esperar para las ejecuciones de datos, en segundos. El máximo es 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