Skip to content

ensure_google_sheet_tab

Create a Google Sheet tab when it does not already exist.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
tab_titleAnnotated[str, Field(min_length=1, max_length=100, description='Tab title to create if missing.')]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
row_countAnnotated[int, Field(ge=1, le=10000)]No1000
column_countAnnotated[int, Field(ge=1, le=18278)]No26
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": "ensure_google_sheet_tab",
"arguments": {
"model_name": "forecasts",
"tab_title": "Forecast",
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"operation": "exists",
"detail": "Tab 'Forecast' already exists."
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.