Skip to content

format_google_sheet_range

Apply direct formatting to one explicit Google Sheet range.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
sheet_idAnnotated[int, Field(ge=0, description='Numeric tab ID from metadata.')]Yes
start_rowAnnotated[int, Field(ge=0)]Yes
end_rowAnnotated[int, Field(ge=1)]Yes
start_colAnnotated[int, Field(ge=0)]Yes
end_colAnnotated[int, Field(ge=1)]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
bold`boolNone`NoNone
italic`boolNone`NoNone
font_size`Annotated[intNone, Field(ge=1, le=400)]`NoNone
number_format`strNone`NoNone
number_format_typestrNo'NUMBER'
bg_color`dict[str, float]None`NoNone
fg_color`dict[str, float]None`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • spreadsheet_id (string)
  • operation (string)
  • detail (string)

See the response example below for the full payload shape.

{
"name": "format_google_sheet_range",
"arguments": {
"model_name": "forecasts",
"sheet_id": 0,
"start_row": 0,
"end_row": 4,
"start_col": 0,
"end_col": 2,
"bold": true,
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"operation": "formatted",
"detail": "Applied formatting to sheet 0 range."
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.