Objects

Model tree

ValueRange

Value

Struct

Value above

ListValue

Value above

DataFilter

DeveloperMetadataLookup

DeveloperMetadataLocation

DimensionRange

GridRange

DataFilterValueRange

DataFilter above

Value above

ValueRange

Data within a range of the spreadsheet.

Field	Type	Description
`range`	`string`	The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
`majorDimension`	Dimension	The major dimension of the values. For output, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then requesting range=A1:B2,majorDimension=ROWS will return [[1,2],[3,4]], whereas requesting range=A1:B2,majorDimension=COLUMNS will return [[1,3],[2,4]]. For input, with range=A1:B2,majorDimension=ROWS then [[1,2],[3,4]] will set A1=1,B1=2,A2=3,B2=4. With range=A1:B2,majorDimension=COLUMNS then [[1,2],[3,4]] will set A1=1,B1=3,A2=2,B2=4. When writing, if this field is not set, it defaults to ROWS.
`values`	Value[][] proto_json	The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.

Value

Value represents a dynamically typed value.

Field	Type	Description
`null_value`	`string`	Represents a null value.
`number_value`	`number`	Represents a double value.
`string_value`	`string`	Represents a string value.
`bool_value`	`boolean`	Represents a boolean value.
`struct_value`	Struct	Represents a structured value.
`list_value`	ListValue	Represents a repeated `Value`.

Struct

Struct represents structured data: fields mapping to dynamically typed values.

Field	Type	Description
`fields`	map of Value	Unordered map of dynamically typed values.

ListValue

ListValue is a wrapper around a repeated field of values.

Field	Type	Description
`values` *	Value[]	Repeated field of dynamically typed values.

DataFilter

Filter that describes what data should be selected or returned from a request. For more information, see Read, write, and search metadata.

Field	Type	Description
`developerMetadataLookup`	DeveloperMetadataLookup	Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
`gridRange`	GridRange	Selects data that matches the range described by the GridRange.
`a1Range`	`string`	Selects data that matches the specified A1 range.

DeveloperMetadataLookup

Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that match the intersection of all the specified fields; any field or combination of fields may be specified.

Field	Type	Description
`metadataId`	`integer`	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
`metadataValue`	`string`	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
`visibility`	DeveloperMetadataVisibility	Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visible to the requesting project is considered.
`metadataLocation`	DeveloperMetadataLocation	Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
`metadataKey`	`string`	Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
`locationMatchingStrategy`	DeveloperMetadataLocationMatchingStrategy	Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
`locationType`	DeveloperMetadataLocationType	Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location. Spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.

DeveloperMetadataLocation

A location where metadata may be associated in a spreadsheet.

Field	Type	Description
`spreadsheet`	`boolean`	True when metadata is associated with an entire spreadsheet.
`dimensionRange`	DimensionRange	Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column. It cannot be unbounded or span multiple rows or columns.
`sheetId`	`integer`	The ID of the sheet when metadata is associated with an entire sheet.

DimensionRange

A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.

Field	Type	Description
`endIndex`	`integer`	The end (exclusive) of the span, or not set if unbounded.
`startIndex`	`integer`	The start (inclusive) of the span, or not set if unbounded.
`dimension`	Dimension	The dimension of the span.
`sheetId`	`integer`	The sheet this span is on.

GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive — [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 123456, then: Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id: 123456 The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as #REF!.

Field	Type	Description
`sheetId`	`integer`	The sheet this range is on.
`startColumnIndex`	`integer`	The start column (inclusive) of the range, or not set if unbounded.
`endRowIndex`	`integer`	The end row (exclusive) of the range, or not set if unbounded.
`endColumnIndex`	`integer`	The end column (exclusive) of the range, or not set if unbounded.
`startRowIndex`	`integer`	The start row (inclusive) of the range, or not set if unbounded.

DataFilterValueRange

A range of values whose location is specified by a DataFilter.

Field	Type	Description
`dataFilter`	DataFilter	The data filter describing the location of the values in the spreadsheet.
`majorDimension`	Dimension	The major dimension of the values.
`values`	Value[][] proto_json	The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected.

DeveloperMetadataLocationMatchingStrategy

Value
`DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED`
`EXACT_LOCATION`
`INTERSECTING_LOCATION`

DeveloperMetadataLocationType

Value
`DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED`
`ROW`
`COLUMN`
`SHEET`
`SPREADSHEET`

DeveloperMetadataVisibility

Value
`DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED`
`DOCUMENT`
`PROJECT`

Dimension

Value
`DIMENSION_UNSPECIFIED`
`ROWS`
`COLUMNS`

DateTimeRenderOption

Value
`SERIAL_NUMBER`
`FORMATTED_STRING`

InsertDataOption

Value
`OVERWRITE`
`INSERT_ROWS`

ValueInputOption

Value
`INPUT_VALUE_OPTION_UNSPECIFIED`
`RAW`
`USER_ENTERED`

ValueRenderOption

Value
`FORMATTED_VALUE`
`UNFORMATTED_VALUE`
`FORMULA`

OAuth packs

API-key packs

Model tree

ValueRange

Value

Struct

ListValue

DataFilter

DeveloperMetadataLookup

DeveloperMetadataLocation

DimensionRange

GridRange

DataFilterValueRange

DeveloperMetadataLocationMatchingStrategy

DeveloperMetadataLocationType

DeveloperMetadataVisibility

Dimension

DateTimeRenderOption

InsertDataOption

ValueInputOption

ValueRenderOption

​Model tree

​ValueRange

​Value

​Struct

​ListValue

​DataFilter

​DeveloperMetadataLookup

​DeveloperMetadataLocation

​DimensionRange

​GridRange

​DataFilterValueRange

​DeveloperMetadataLocationMatchingStrategy

​DeveloperMetadataLocationType

​DeveloperMetadataVisibility

​Dimension

​DateTimeRenderOption

​InsertDataOption

​ValueInputOption

​ValueRenderOption

Model tree

ValueRange

Value

Struct

ListValue

DataFilter

DeveloperMetadataLookup

DeveloperMetadataLocation

DimensionRange

GridRange

DataFilterValueRange

DeveloperMetadataLocationMatchingStrategy

DeveloperMetadataLocationType

DeveloperMetadataVisibility

Dimension

DateTimeRenderOption

InsertDataOption

ValueInputOption

ValueRenderOption