Method: googleapis.sheets.v4.spreadsheets.values.batchClearByDataFilter

Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Arguments

Parameters
spreadsheetId

string

Required. The ID of the spreadsheet to update.
body

object (BatchClearValuesByDataFilterRequest)

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 BatchClearValuesByDataFilterResponse.

Subworkflow snippet

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

YAML

- batchClearByDataFilter:
    call: googleapis.sheets.v4.spreadsheets.values.batchClearByDataFilter
    args:
        spreadsheetId: ...
        body:
            dataFilters: ...
    result: batchClearByDataFilterResult

JSON

[
  {
    "batchClearByDataFilter": {
      "call": "googleapis.sheets.v4.spreadsheets.values.batchClearByDataFilter",
      "args": {
        "spreadsheetId": "...",
        "body": {
          "dataFilters": "..."
        }
      },
      "result": "batchClearByDataFilterResult"
    }
  }
]