Breadcrumbs

Google Sheets - Clear Data from Sheet

Overview

Easily wipe data from a single tab on Google Sheet. Typically used to start fresh before inserting new data.

If you leave the cell range blank, data will be wiped from the entire tab.

If you leave the tab name blank, the data will be cleared from the first tab.

Variables

Name

Reference

Type

Required

Default

Options

Description

Google Sheet Name or ID

SHEETS_SPREADSHEET_ID

Alphanumeric

None

-

Name or ID of the sheet to clear data from.

Tab Name

SHEETS_TAB_NAME

Alphanumeric

None

-

Name of the tab in the sheet to clear data from. This field is case sensitive.

Shared Drive Name

SHEETS_SHARED_DRIVE_NAME

Alphanumeric

None

-

Name of the Shared Drive the sheet exists in. This field is case sensitive. Leave blank if the file does not exist in a Shared Drive.

Cell Range

SHEETS_CELL_RANGE

Alphanumeric

None

-

Range to clear data from in the sheet formatted as `A1:B10`. If left blank the entire tab will be cleared.

YAML

Below is the YAML template

YAML

source:
  template: Google Sheets - Clear Data from Sheet
  inputs:
    SHEETS_SPREADSHEET_ID:
    SHEETS_TAB_NAME:
    SHEETS_SHARED_DRIVE_NAME:
    SHEETS_CELL_RANGE:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 101
    - 102
    - 200