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

Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

Arguments

Parameters
range

string

Required. The A1 notation or R1C1 notation of the values to clear.
spreadsheetId

string

Required. The ID of the spreadsheet to update.

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

Subworkflow snippet

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

YAML

- clear:
    call: googleapis.sheets.v4.spreadsheets.values.clear
    args:
        range: ...
        spreadsheetId: ...
    result: clearResult

JSON

[
  {
    "clear": {
      "call": "googleapis.sheets.v4.spreadsheets.values.clear",
      "args": {
        "range": "...",
        "spreadsheetId": "..."
      },
      "result": "clearResult"
    }
  }
]