Class DataSource

Fuente de datos

Accede a la fuente de datos existente y modifícala. Para crear una tabla de fuentes de datos con una fuente de datos nueva, consulta DataSourceTable.

Solo usa esta clase 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 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[]Devuelve todas las columnas calculadas de 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.
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 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 se agote 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 spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

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

  • 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, hace que la hoja nueva sea la hoja activa.

Volver

DataSourcePivotTable: Es 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 á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 en la primera celda de una hoja nueva. Como efecto secundario, hace que la hoja nueva sea la hoja activa.

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

Volver

DataSourceTable: Es la tabla 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 ámbitos:

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

getCalculatedColumnByName(columnName)

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

Parámetros

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

Volver

DataSourceColumn: Es la columna calculada que coincide con el nombre de la columna o null si no hay una columna calculada de ese tipo.

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

getCalculatedColumns()

Devuelve todas las columnas calculadas de la fuente de datos.

Las especificaciones de la fuente de datos de 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 ámbitos:

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

  • 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.

Volver

DataSourceSheet[]: Es un array 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 ámbitos:

  • 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 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

refreshAllLinkedDataSourceObjects()

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

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

  • 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 fuente de datos vinculados con esta fuente de datos con la especificación nueva.

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

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

  • 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.

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

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.
refreshAllLinkedObjectsBooleanSi es true, también se actualizan todos los objetos de fuente de datos vinculados con esta fuente.

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

  • 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. Genera 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
timeoutInSecondsIntegerEs el tiempo que se debe esperar 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 ámbitos:

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