Skip to content

clear_google_sheet_range

Clear values from one explicit Google Sheet range.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
cell_rangeAnnotated[str, Field(min_length=1, max_length=200, description='Explicit A1 range to clear.')]Yes
spreadsheet_id`Annotated[strNone, Field(description=‘Google Spreadsheet ID; provide this or source_name.’)]`NoNone
source_name`Annotated[strNone, Field(description=‘Connected Sheet data-source name; provide this or spreadsheet_id.’)]`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • spreadsheet_id (string)
  • cleared_range (string)

See the response example below for the full payload shape.

{
"name": "clear_google_sheet_range",
"arguments": {
"model_name": "forecasts",
"cell_range": "Forecast!A2:B100",
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"cleared_range": "Forecast!A2:B100"
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.