Sort range - Automate.ax

googleSheets.sortRange rearranges rows within a structured range using one or more sort keys.

Example

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

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

  googleSheets.sortRange({
    spreadsheet: "spreadsheet-id",
    range: { sheet: "Orders", startRow: 2, startColumn: 1, endColumn: 4 },
    sortBy: [
      { column: 4, direction: "descending" },
      { column: 1, direction: "ascending" },
    ],
  })
})

Inputs

Provide spreadsheet, one-based structured range, and non-empty sortBy. Each sort column is an absolute one-based sheet column, not relative to the range. Direction defaults to ascending. Second argument { account } selects the Google Account.

Output

Returns the resolved zero-based grid range. Exclude a header row from range when it should remain fixed.