- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- MatchedValueRange
- Try it!
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.
HTTP request
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
spreadsheetId |
The ID of the spreadsheet to retrieve data from. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "dataFilters": [ { object ( |
Fields | |
---|---|
dataFilters[] |
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. |
majorDimension |
The major dimension that results should use. For example, if the spreadsheet data is: |
valueRenderOption |
How values should be represented in the output. The default render option is |
dateTimeRenderOption |
How dates, times, and durations should be represented in the output. This is ignored if |
Response body
The response when retrieving more than one range of values in a spreadsheet selected by DataFilters
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"spreadsheetId": string,
"valueRanges": [
{
object ( |
Fields | |
---|---|
spreadsheetId |
The ID of the spreadsheet the data was retrieved from. |
valueRanges[] |
The requested values with the list of data filters that matched them. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/spreadsheets
For more information, see the Authorization guide.
MatchedValueRange
A value range that was matched by one or more data filers.
JSON representation |
---|
{ "valueRange": { object ( |
Fields | |
---|---|
valueRange |
The values matched by the |
dataFilters[] |
The |