Method: googleapis.sheets.v4.spreadsheets.getByDataFilter

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a field mask listing your desired fields using the fields URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the includeGridData parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.

Arguments

Parameters
spreadsheetId	string Required. The spreadsheet to request.
body	object (GetSpreadsheetByDataFilterRequest) 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 Spreadsheet.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- getByDataFilter:
    call: googleapis.sheets.v4.spreadsheets.getByDataFilter
    args:
        spreadsheetId: ...
        body:
            dataFilters: ...
            includeGridData: ...
    result: getByDataFilterResult

JSON

[
  {
    "getByDataFilter": {
      "call": "googleapis.sheets.v4.spreadsheets.getByDataFilter",
      "args": {
        "spreadsheetId": "...",
        "body": {
          "dataFilters": "...",
          "includeGridData": "..."
        }
      },
      "result": "getByDataFilterResult"
    }
  }
]