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.
Arguments
Parameters | |
---|---|
spreadsheetId |
Required. The ID of the spreadsheet to retrieve data from. |
body |
Required. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of BatchGetValuesByDataFilterResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- batchGetByDataFilter: call: googleapis.sheets.v4.spreadsheets.values.batchGetByDataFilter args: spreadsheetId: ... body: dataFilters: ... dateTimeRenderOption: ... majorDimension: ... valueRenderOption: ... result: batchGetByDataFilterResult
JSON
[ { "batchGetByDataFilter": { "call": "googleapis.sheets.v4.spreadsheets.values.batchGetByDataFilter", "args": { "spreadsheetId": "...", "body": { "dataFilters": "...", "dateTimeRenderOption": "...", "majorDimension": "...", "valueRenderOption": "..." } }, "result": "batchGetByDataFilterResult" } } ]