List rows

googleSheets.listRows maps cells to records keyed by exact source headers.

Example

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

export default automation("List recent orders", () => {
  onDashboardRun({ title: "List recent orders" })

  googleSheets.listRows({
    spreadsheet: "spreadsheet-id",
    source: { sheet: "Orders", headerRow: 1 },
    from: "end",
    limit: 25,
  })
})

Inputs

Provide spreadsheet and source. A source is { sheet: string | number; headerRow?: number } or { table: string }. Sheet headers default to row 1, while table metadata supplies native headers and body bounds. from defaults to start, limit defaults to 100 and accepts up to 10,000, and offset defaults to 0. valueRender defaults to unformatted and also accepts formatted or formula. Second argument { account } selects the Google Account.

Output

interface SheetRow {
  rowNumber: number
  range: string
  values: Record<string, string | number | boolean | null>
}

rowNumber is one-based and range covers the source columns. Headers must be non-empty and unique after trimming. Keys match headers exactly. Missing and trailing cells become null.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output