/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter

Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.

curl --location --request POST 'https://sheets.googleapis.com//v4/spreadsheets//values:batchGetByDataFilter' \ --header 'Content-Type: application/json' \ --data-raw '{ "dataFilters": [ { "a1Range": "string", "developerMetadataLookup": {}, "gridRange": {} } ], "dateTimeRenderOption": "SERIAL_NUMBER", "majorDimension": "DIMENSION_UNSPECIFIED", "valueRenderOption": "FORMATTED_VALUE" }'

{ "spreadsheetId": "string", "valueRanges": [ { "dataFilters": [ { "a1Range": "string", "developerMetadataLookup": {}, "gridRange": {} } ], "valueRange": { "majorDimension": "DIMENSION_UNSPECIFIED", "range": "string", "values": [ [ null ] ] } } ] }

Request

Path Params

spreadsheetId

string

required

The ID of the spreadsheet to retrieve data from.

Body Params application/json

The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.

dataFilters

array[object (DataFilter) {3}]

optional

The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response.

a1Range

string

optional

Selects data that matches the specified A1 range.

developerMetadataLookup

object

optional

gridRange

object

optional

dateTimeRenderOption

enum<string>

optional

How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Allowed values:

SERIAL_NUMBERFORMATTED_STRING

majorDimension

enum<string>

optional

The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then a request that selects that range and sets majorDimension=ROWS returns [[1,2],[3,4]], whereas a request that sets majorDimension=COLUMNS returns [[1,3],[2,4]].

Allowed values:

DIMENSION_UNSPECIFIEDROWSCOLUMNS

valueRenderOption

enum<string>

optional

How values should be represented in the output. The default render option is FORMATTED_VALUE.

Allowed values:

FORMATTED_VALUEUNFORMATTED_VALUEFORMULA

Examples

Responses

🟢200Successful response

application/json

Body

The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.

spreadsheetId

string

optional

The ID of the spreadsheet the data was retrieved from.

valueRanges

array[object (MatchedValueRange) {2}]

optional

The requested values with the list of data filters that matched them.

dataFilters

array[object (DataFilter) {3}]

optional

The DataFilters from the request that matched the range of values.

valueRange

object (ValueRange)

optional

The values matched by the DataFilter.