Resource that represents a spreadsheet.
FieldsspreadsheetId
string
The ID of the spreadsheet. This field is read-only.
properties
object (
SpreadsheetProperties
)
Overall properties of a spreadsheet.
sheets[]
object (
Sheet
)
The sheets that are part of a spreadsheet.
namedRanges[]
object (
NamedRange
)
The named ranges defined in a spreadsheet.
spreadsheetUrl
string
The url of the spreadsheet. This field is read-only.
developerMetadata[]
object (
DeveloperMetadata
)
The developer metadata associated with a spreadsheet.
dataSources[]
object (
DataSource
)
A list of external data sources connected with the spreadsheet.
dataSourceSchedules[]
object (
DataSourceRefreshSchedule
)
Output only. A list of data source refresh schedules.
SpreadsheetPropertiesProperties of a spreadsheet.
Fieldstitle
string
The title of the spreadsheet.
locale
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.
spreadsheetTheme
object (
SpreadsheetTheme
)
Theme applied to the spreadsheet.
importFunctionsExternalUrlAccessAllowed
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.
RecalculationIntervalAn enumeration of the possible recalculation interval options.
EnumsRECALCULATION_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.
SpreadsheetThemeRepresents spreadsheet theme
JSON representation{
"primaryFontFamily": string,
"themeColors": [
{
object (ThemeColorPair
)
}
]
}
Fields primaryFontFamily
string
Name of the primary font family.
themeColors[]
object (
ThemeColorPair
)
The spreadsheet theme color pairs. To update you must provide all theme color pairs.
ThemeColorPairA pair mapping a spreadsheet theme color type to the concrete color it represents.
FieldscolorType
enum (
ThemeColorType
)
The type of the spreadsheet theme color.
color
object (
ColorStyle
)
The concrete color corresponding to the theme color type.
NamedRangeA named range.
JSON representation{
"namedRangeId": string,
"name": string,
"range": {
object (GridRange
)
}
}
Fields namedRangeId
string
The ID of the named range.
name
string
The name of the named range.
range
object (
GridRange
)
The range this represents.
DataSourceInformation about an external data source in the spreadsheet.
JSON representation{ "dataSourceId": string, "spec": { object (FieldsDataSourceSpec
) }, "calculatedColumns": [ { object (DataSourceColumn
) } ], "sheetId": integer }
dataSourceId
string
The spreadsheet-scoped unique ID that identifies the data source. Example: 1080547365.
spec
object (
DataSourceSpec
)
The DataSourceSpec
for the data source connected with this spreadsheet.
calculatedColumns[]
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.
This specifies the details of the data source. For example, for BigQuery, this specifies information about the BigQuery source.
BigQueryDataSourceSpecThe specification of a BigQuery data source that's connected to a sheet.
JSON representation{ "projectId": string, // Union fieldFieldsspec
can be only one of the following: "querySpec": { object (BigQueryQuerySpec
) }, "tableSpec": { object (BigQueryTableSpec
) } // End of list of possible types for union fieldspec
. }
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 fieldspec
. The actual specification. spec
can be only one of the following: querySpec
object (
BigQueryQuerySpec
)
tableSpec
object (
BigQueryTableSpec
)
Specifies a custom BigQuery query.
JSON representation{ "rawQuery": string }Fields
rawQuery
string
The raw query string.
BigQueryTableSpecSpecifies a BigQuery table definition. Only native tables are allowed.
JSON representation{ "tableProjectId": string, "tableId": string, "datasetId": string }Fields
tableProjectId
string
The ID of a BigQuery project the table belongs to. If not specified, the projectId
is assumed.
tableId
string
The BigQuery table id.
datasetId
string
The BigQuery dataset id.
LookerDataSourceSpecThe specification of a Looker data source.
JSON representation{ "instanceUri": string, "model": string, "explore": string }Fields
instanceUri
string
A Looker instance URL.
model
string
Name of a Looker model.
explore
string
Name of a Looker model explore.
DataSourceParameterA 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 fieldFields Union fieldidentifier
can be only one of the following: "name": string // End of list of possible types for union fieldidentifier
. // Union fieldvalue
can be only one of the following: "namedRangeId": string, "range": { object (GridRange
) } // End of list of possible types for union fieldvalue
. }
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.
value
. The parameter value. value
can be only one of the following: namedRangeId
string
ID of a NamedRange
. Its size must be 1x1.
range
object (
GridRange
)
A range that contains the value of the parameter. Its size must be 1x1.
DataSourceRefreshScheduleSchedule 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.
DataSourceRefreshScopeThe data source refresh scopes.
EnumsDATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED
Default value, do not use. ALL_DATA_SOURCES
Refreshes all data sources and their associated data source objects in the spreadsheet. DataSourceRefreshDailySchedule
A schedule for data to refresh every day in a given time interval.
JSON representation{
"startTime": {
object (TimeOfDay
)
}
}
Fields startTime
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.
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
.
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer }Fields
hours
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.
DataSourceRefreshWeeklyScheduleA weekly schedule for data to refresh on specific days in a given time interval.
JSON representation{ "startTime": { object (FieldsTimeOfDay
) }, "daysOfWeek": [ enum (DayOfWeek
) ] }
startTime
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.
DayOfWeekRepresents a day of the week.
EnumsDAY_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.
JSON representation{
"startTime": {
object (TimeOfDay
)
},
"daysOfMonth": [
integer
]
}
Fields startTime
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.
IntervalRepresents 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.
MethodsbatchUpdate
Applies one or more updates to the spreadsheet. create
Creates a spreadsheet, returning the newly created spreadsheet. get
Returns the spreadsheet at the given ID. getByDataFilter
Returns the spreadsheet at the given ID.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4