Access and modify an existing data source chart.
Only use this class with data that's connected to a BigQuery database.
Methods
| Method | Return type | Brief description |
|---|---|---|
Data
|
Cancels the data refresh associated with this object if it's currently running. | |
Data
|
Refreshes the data of this object regardless of the current state. | |
Data
|
Gets the data source the object is linked to. | |
Data
|
Gets the data execution status of the object. | |
Data
|
Refreshes the data of the object. | |
Data
|
Waits until the current execution completes, timing out after the provided number of seconds. |
Detailed documentation
cancel
Data
Refresh()
Cancels the data refresh associated with this object if it's currently running.
This example shows how to cancel a formula refresh.
const spreadsheet = SpreadsheetApp . getActive (); const formula = spreadsheet . getDataSourceFormulas ()[ 0 ]; // Cancel the ongoing refresh on the formula. formula . cancelDataRefresh ();
Throws an exception if the data source type is not enabled. Use Spreadsheet
methods to enable data execution for specific data source
type.
Return
Data
— The data object.
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
force
Refresh
Data()
Refreshes the data of this object regardless of the current state. See refresh
for
more details. If you want to cancel a currently running refresh of this object, see cancel
.
Throws an exception if the data source type is not enabled. Use Spreadsheet
methods to enable data execution for specific data source
type.
Return
Data
— The data object.
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
get
Data
Source()
Gets the data source the object is linked to.
Return
Data
— 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
get
Status()
Gets the data execution status of the object.
Return
Data
— The data execution status.
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
refresh
Data()
Refreshes the data of the object.
Throws an exception if currently in error
state. Use Data
to update the specification. The method is
preferred over force
to prevent unexpected edits on data source.
Throws an exception if the data source type is not enabled. Use Spreadsheet
methods to enable data execution for specific data source
type.
Return
Data
— The data object.
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
wait
For
Completion(timeoutInSeconds)
Waits until the current execution completes, timing out after the provided number of seconds. Throws an exception if the execution is not completed when timing out, but does not cancel the data execution.
Parameters
| Name | Type | Description |
|---|---|---|
timeout
|
Integer
|
The time to wait for data execution, in seconds. The maximum is 300 seconds. |
Return
Data
— The data execution status.
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
