Skip to content

read_google_sheet_ranges

Read bounded A1 ranges from one connected Google Sheet.

read-only · idempotent

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
rangesAnnotated[list[Annotated[str, Field(min_length=1, max_length=200)]], Field(min_length=1, max_length=100, description="Bounded A1-notation ranges, such as ['Sheet1!A1:D10'].")]Yes
spreadsheet_id`Annotated[strNone, Field(description=‘Google Spreadsheet ID from the sheet URL.’)]`NoNone
source_name`Annotated[strNone, Field(description=‘Logical name of the connected Google Sheet data source.’)]`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • spreadsheet_id (string)
  • ranges (array<object>)

See the response example below for the full payload shape.

{
"name": "read_google_sheet_ranges",
"arguments": {
"model_name": "forecasts",
"ranges": [
"Forecast!A1:C4"
],
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"ranges": [
{
"range": "Forecast!A1:C4",
"values": [
[
"Month",
"Revenue"
]
]
}
]
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.