younifyd
Menu

Sheets.spreadsheets.values.batch Clear

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

POST/v4/spreadsheets/{spreadsheetId}/values:batchClear

Use it in a workflow

  1. Add a step and choose the Google Sheets connector.
  2. Pick the Sheets.spreadsheets.values.batch Clear action (under spreadsheets).
  3. Fill in the fields below, then reference the result from later steps as {{sheetsSpreadsheetsValuesBatchClear.response.data}}.

Request

Path parameters

spreadsheetIdstringrequired

The ID of the spreadsheet to update.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Request body

Enter the body as JSON in the step's Body field.

rangesarray<string>

The ranges to clear, in [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell).

json
{
  "ranges": [
    "string"
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{sheetsSpreadsheetsValuesBatchClear.response.data.<field>}}.

clearedRangesarray<string>

The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits.

spreadsheetIdstring

The spreadsheet the updates were applied to.

json
{
  "clearedRanges": [
    "string"
  ],
  "spreadsheetId": "string"
}

Need more? See the Google Sheets guide for connection setup and behaviour shared by every action.