Google is committed to advancing racial equity for Black communities. See how.

Class DataSource

DataSource

Access and modify existing data source. To create a data source table with new data source, see DataSourceTable.

Methods

MethodReturn typeBrief description
createCalculatedColumn(name, formula)DataSourceColumnCreates a calculated column.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCreates a data source pivot table from this data source in the first cell of a new sheet.
createDataSourceTableOnNewSheet()DataSourceTableCreates a data source table from this data source in the first cell of a new sheet.
getCalculatedColumnByName(columnName)DataSourceColumnReturns the calculated column in the data source that matches the column name.
getCalculatedColumns()DataSourceColumn[]Returns all the calculated columns in the data source.
getColumns()DataSourceColumn[]Returns all the columns in the data source.
getDataSourceSheets()DataSourceSheet[]Returns the data source sheets associated with this data source.
getSpec()DataSourceSpecGets the data source specification.
refreshAllLinkedDataSourceObjects()voidRefreshes all data source objects linked to the data source.
updateSpec(spec)DataSourceUpdates the data source specification and refreshes the data source objects linked with this data source with the new specification.
updateSpec(spec, refreshAllLinkedObjects)DataSourceUpdates the data source specification and refreshes the linked data source sheets with the new specification.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWaits until all the current executions of the linked data source objects complete, timing out after the provided number of seconds.

Detailed documentation

createCalculatedColumn(name, formula)

Creates a calculated column.

Parameters

NameTypeDescription
nameStringThe name of the calculated column.
formulaStringThe calculated column formula.

Return

DataSourceColumn — The newly created calculated column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

createDataSourcePivotTableOnNewSheet()

Creates a data source pivot table from this data source in the first cell of a new sheet. As a side effect, makes the new sheet the active sheet.

Return

DataSourcePivotTable — The newly created data source pivot table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

createDataSourceTableOnNewSheet()

Creates a data source table from this data source in the first cell of a new sheet. As a side effect, makes the new sheet the active sheet.

Return

DataSourceTable — The newly created data source table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getCalculatedColumnByName(columnName)

Returns the calculated column in the data source that matches the column name.

Parameters

NameTypeDescription
columnNameStringThe name of the calculated column to get.

Return

DataSourceColumn — The calculated column that matches the column name, or null if there is no such calculated column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getCalculatedColumns()

Returns all the calculated columns in the data source.

Return

DataSourceColumn[] — An array of all the calculated columns in the data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getColumns()

Returns all the columns in the data source.

Return

DataSourceColumn[] — An array of all the DataSourceColumn in the data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getDataSourceSheets()

Returns the data source sheets associated with this data source.

Return

DataSourceSheet[] — An array of data source sheets.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getSpec()

Gets the data source specification.

Return

DataSourceSpec — The data source specification.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

refreshAllLinkedDataSourceObjects()

Refreshes all data source objects linked to the data source.

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for the specific data source type.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

updateSpec(spec)

Updates the data source specification and refreshes the data source objects linked with this data source with the new specification.

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for the specific data source type.

Parameters

NameTypeDescription
specDataSourceSpecThe data source specification to update with.

Return

DataSource — The data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

updateSpec(spec, refreshAllLinkedObjects)

Updates the data source specification and refreshes the linked data source sheets with the new specification.

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for the specific data source type.

Parameters

NameTypeDescription
specDataSourceSpecThe data source specification to update with.
refreshAllLinkedObjectsBooleanIf true, also refreshes all the data source objects linked with this data source.

Return

DataSource — The data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Waits until all the current executions of the linked data source objects complete, timing out after the provided number of seconds. Throws an exception if the executions are not completed when timing out, but does not cancel the data executions.

Parameters

NameTypeDescription
timeoutInSecondsIntegerThe time to wait for data executions, in seconds. The maximum is 300 seconds.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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