string The locale of the spreadsheet in one of the following formats: an ISO 639-1 language code such as en an ISO 639-2 language code such as fil, if no 639-1 code exists a combination of the ISO language code and country code, such as en_US Note: when updating this field, not all locales/languages are supported.
autoRecalc
enum (RecalculationInterval) The amount of time to wait before volatile functions are recalculated.
timeZone
string The time zone of the spreadsheet, in CLDR format such as America/New_York. If the time zone isn't recognized, this may be a custom time zone such as GMT-07:00.
defaultFormat
object (CellFormat) The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only.
iterativeCalculationSettings
object (IterativeCalculationSettings) Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors.
boolean Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the allowlisting feature.
RecalculationInterval
An enumeration of the possible recalculation interval options.
Enums
RECALCULATION_INTERVAL_UNSPECIFIED
Default value. This value must not be used.
ON_CHANGE
Volatile functions are updated on every change.
MINUTE
Volatile functions are updated on every change and every minute.
HOUR
Volatile functions are updated on every change and hourly.
IterativeCalculationSettings
Settings to control how circular dependencies are resolved with iterative calculation.
JSON representation
{ "maxIterations": integer, "convergenceThreshold": number }
Fields
maxIterations
integer When iterative calculation is enabled, the maximum number of calculation rounds to perform.
convergenceThreshold
number When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.
object (DataSourceColumn) All calculated columns in the data source.
sheetId
integer The ID of the Sheet connected with the data source. The field cannot be changed once set.When creating a data source, an associated DATA_SOURCE sheet is also created, if the field is not specified, the ID of the created sheet will be randomly generated.
DataSourceSpec
This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.
JSON representation
{ "parameters": [ { object (DataSourceParameter) } ], // Union field spec can be only one of the following: "bigQuery": { object (BigQueryDataSourceSpec) }, "looker": { object (LookerDataSourceSpec) } // End of list of possible types for union field spec. }
Fields
parameters[]
object (DataSourceParameter) The parameters of the data source, used when querying the data source.
Union field spec. The actual specification per data source type. spec can be only one of the following:
The specification of a BigQuery data source that's connected to a sheet.
JSON representation
{ "projectId": string, // Union field spec can be only one of the following: "querySpec": { object (BigQueryQuerySpec) }, "tableSpec": { object (BigQueryTableSpec) } // End of list of possible types for union field spec. }
Fields
projectId
string The ID of a BigQuery enabled Google Cloud project with a billing account attached. For any queries executed against the data source, the project is charged.
Union field spec. The actual specification. spec can be only one of the following:
A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.
JSON representation
{ // Union field identifier can be only one of the following: "name": string // End of list of possible types for union field identifier. // Union field value can be only one of the following: "namedRangeId": string, "range": { object (GridRange) } // End of list of possible types for union field value. }
Fields
Union field identifier. The parameter identifier. identifier can be only one of the following:
name
string Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, BigQuery identifier.
Union field value. The parameter value. value can be only one of the following:
object (GridRange) A range that contains the value of the parameter. Its size must be 1x1.
DataSourceRefreshSchedule
Schedule for refreshing the data source.
Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8 AM , the refresh will take place between 8 AM and 12 PM every day.
object (TimeOfDay) The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
integer Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes
integer Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
seconds
integer Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
nanos
integer Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
DataSourceRefreshWeeklySchedule
A weekly schedule for data to refresh on specific days in a given time interval.
object (TimeOfDay) The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.
daysOfWeek[]
enum (DayOfWeek) Days of the week to refresh. At least one day must be specified.
DayOfWeek
Represents a day of the week.
Enums
DAY_OF_WEEK_UNSPECIFIED
The day of the week is unspecified.
MONDAY
Monday
TUESDAY
Tuesday
WEDNESDAY
Wednesday
THURSDAY
Thursday
FRIDAY
Friday
SATURDAY
Saturday
SUNDAY
Sunday
DataSourceRefreshMonthlySchedule
A monthly schedule for data to refresh on specific days in the month in a given time interval.
object (TimeOfDay) The start time of a time interval in which a data source refresh is scheduled. Only hours part is used. The time interval size defaults to that in the Sheets editor.
daysOfMonth[]
integer Days of the month to refresh. Only 1-28 are supported, mapping to the 1st to the 28th day. At least one day must be specified.
Interval
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
JSON representation
{ "startTime": string, "endTime": string }
Fields
startTime
string (Timestamp format) Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start.
endTime
string (Timestamp format) Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end.