Get spreadsheet

googleSheets.getSpreadsheet() returns spreadsheet metadata without cell values. Use it to find immutable IDs or inspect sheets, native tables, banded ranges, and conditional-format rules.

Example

import { automation, onDashboardRun } from "automate.ax"
import { googleSheets } from "automate.ax/google-sheets"

export default automation("Inspect a workbook", () => {
  onDashboardRun({ title: "Inspect a workbook" })

  googleSheets.getSpreadsheet({
    spreadsheet: "https://docs.google.com/spreadsheets/d/id/edit",
  })
})

Inputs

Provide spreadsheet as an ID or standard Google Sheets URL. Second argument { account } selects the Google Account. All action inputs accept compatible signals.

Output

Returns spreadsheetId, title, url, optional locale, timeZone, and autoRecalc, plus namedRanges and sheets. Each sheet includes its identity, position, grid settings, tables, bandedRanges, and conditionalFormats. Table metadata includes tableId, name, columns, range, and style. Banded ranges include their numeric bandedRangeId when Google supplies one, provider reference otherwise, range, and row or column colors. You can inspect reference-only banded ranges, but the numeric update and delete actions can’t target them. The action lists conditional rules in priority order with a zero-based index, resolved grid ranges, and a typed boolean or gradient rule. All returned ranges use Google’s zero-based, end-exclusive indexes and numeric sheetId. The action normalizes colors to either a six-digit hex string or a theme object using text, background, accent1 through accent6, or link.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output