Sign Up
Loading...

Google Sheets commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → Google Sheets, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands.

All connector references · Connect an account · AI setup and shared results

Clear Spreadsheet Row(s)

Clear cell values while keeping rows and the worksheet.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.
RowstextA1 cells or whole rows to empty, such as A2:D5 or 2:5. Without a sheet prefix, the selected tab's title is added. An explicit sheet prefix is used as written.

Result

No value is returned on success. Selected cells are emptied; rows are not removed.

Example

Account: choose your Google Sheets connector. Worksheet: select Sheet1; Rows: 2:5.

Errors and limits

Use positive row numbers and a valid range. To remove rows and shift later rows, use Delete spreadsheet rows instead. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Copy Worksheet

Copy a whole worksheet tab into another spreadsheet.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Source Spreadsheetgoogle sheets spreadsheetSelect the workbook to copy from or supply its spreadsheet ID. The account must be able to read it.
Source Worksheetgoogle sheets worksheetSelect the source worksheet or supply its numeric sheet ID, not its tab title.
Target Spreadsheetgoogle sheets spreadsheetSelect the destination workbook or supply its spreadsheet ID. The account must be able to edit it.

Result

Google's new sheet-properties object, including sheetId, title, index, sheetType and gridProperties when available. sheetId identifies the new destination tab.

Example

Account: choose your Google Sheets connector. Source Spreadsheet: source-book-id; Source Worksheet: select Sales; Target Spreadsheet: target-book-id.

Errors and limits

Check destination edit permissions and whether a copied tab already exists before retrying an uncertain result. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Copy Range

Copy a rectangular range within one worksheet.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.
Source RangetextA cell or rectangular A1 range, such as A1:C3. Use bare references without a sheet name or whole-column notation.
Target RangetextThe destination starting cell, such as E1. If a range is supplied, only its first cell determines the destination; the source determines the copied size.
Paste Typegoogle sheets paste typeRequired Google paste mode, such as PASTE_VALUES for values or PASTE_NORMAL for normal copying. There is no automatic default.

Result

No value is returned on success. The target starts at the destination's first cell and is sized to match the source.

Example

Account: choose your Google Sheets connector. Source Range: A1:C3; Target Range: E1; Paste Type: PASTE_VALUES.

Errors and limits

Check valid cell references and destination space. Existing destination cells can be overwritten. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Create Spreadsheet

Create a blank workbook or duplicate an existing spreadsheet.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
TitletextThe display title for the new workbook.
Source Spreadsheetgoogle sheets spreadsheetOptional source spreadsheet ID. Supplying it copies the entire workbook; leaving it empty creates a blank workbook.

Result

An object with spreadsheetId for the new workbook. This is a new ID, not the source ID.

Example

Account: choose your Google Sheets connector. Title: Monthly report; Source Spreadsheet: empty for a blank workbook.

Errors and limits

Copying needs Drive access. Check for an already-created workbook before retrying an uncertain result. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Create Worksheet

Add a tab, optionally replacing a tab with the same title.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
TitletextThe new worksheet title. Existing titles are matched exactly.
Overwrite Existing WorksheetbooleanFalse fails if the title exists. True deletes that worksheet and creates a new empty one, losing its old contents and ID.

Result

An object with worksheetId and title for the new tab. A replacement has a new worksheet ID.

Example

Account: choose your Google Sheets connector. Title: May; Overwrite Existing Worksheet: false.

Errors and limits

Confirm the title before enabling overwrite; replacing a worksheet removes its contents. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Delete Spreadsheet

Permanently delete an entire spreadsheet file.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.

Result

No value is returned on success. The workbook and all its tabs are deleted.

Example

Account: choose your Google Sheets connector. Use a disposable workbook: Spreadsheet: test-spreadsheet-id.

Errors and limits

This deletes the entire file, not one tab. Confirm its ID and deletion permissions. A missing-file response on retry can mean deletion succeeded. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Delete Worksheet

Delete one worksheet tab and its contents.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.

Result

No value is returned on success. The selected tab is removed.

Example

Account: choose your Google Sheets connector. Use a disposable tab: Spreadsheet: test-book-id; Worksheet: select Disposable.

Errors and limits

Check the tab belongs to this workbook. Google does not allow deleting the last remaining worksheet. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Delete Spreadsheet Row(s)

Remove whole rows and shift following rows upward.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.
RowstextAn inclusive interval in the exact form start:end, such as 2:5. Use positive whole numbers, with end at or after start. Cell ranges such as A2:A5 are not accepted.

Result

No value is returned on success. Rows are deleted, not just emptied.

Example

Account: choose your Google Sheets connector. Worksheet: select Disposable; Rows: 2:5.

Errors and limits

This shifts later rows. Use Clear spreadsheet rows to empty cells without shifting. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Rename Worksheet

Change a tab's title while keeping its contents.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.
New Worksheet NametextThe new tab title. Follow Google Sheets naming rules and do not duplicate another tab's title.

Result

No value is returned on success. Its worksheet ID stays the same.

Example

Account: choose your Google Sheets connector. Worksheet: select Sheet1; New Worksheet Name: Customers.

Errors and limits

Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Find Worksheet

Find a tab with an exactly matching title.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
TitletextThe exact tab title. Matching is case-sensitive and includes spaces.

Result

An object with spreadsheetId, title and worksheetId, or null if no title matches. A missing tab is not created.

Example

Account: choose your Google Sheets connector. Spreadsheet: spreadsheet-id; Title: Customers.

Errors and limits

A null result is normal when there is no match. Check spelling and spaces. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Get Data Range

Read a worksheet range as rows of values.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
Worksheetgoogle sheets worksheetSelect the worksheet tab or supply its numeric sheet ID, such as the gid in its address. Do not pass the tab title.
RangetextAn A1 range, such as A1:C20. The selected tab title is added unless you include an explicit sheet prefix, which is used as written.

Result

A list of row lists, such as [["Name","Count"],["Alex","3"]], or [] for an empty range. Google uses its default formatted cell values and may omit trailing empty rows or columns.

Example

Account: choose your Google Sheets connector. Worksheet: select Customers; Range: A1:C20.

Errors and limits

Rows can contain different numbers of values when cells are empty. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Get Spreadsheet

Read a workbook title and list its tabs.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
Spreadsheetgoogle sheets spreadsheetSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.

Result

An object with spreadsheetId, title and sheets. Each sheet has sheetId, title, index and hidden. Cell values are not included.

Example

Account: choose your Google Sheets connector. Spreadsheet: spreadsheet-id.

Errors and limits

Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Append rows

Append rows after an existing table.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
SpreadsheettextSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
RangetextA full A1 table-search range, such as 'Customers'!A1:B1. Google finds a table and appends after its last row, inserting rows. This is not a fixed destination cell.
ValueslistA nonempty list of rows, such as [["Alex",3],["Sam",5]]. Row values can be text, finite numbers, booleans or null. Maximum 1,000 rows and 1,000 values per row; the complete command inputs must fit within 64 KiB.
Value Input OptiontextOptional RAW stores values without interpreting them; USER_ENTERED lets Google interpret dates, numbers and formulas as if typed. Defaults to RAW. Use exactly one of these values.

Result

Google's append result with spreadsheetId, tableRange when found, and updates containing updatedRange, updatedRows, updatedColumns and updatedCells when supplied. Updated cell values are not echoed.

Example

Account: choose your Google Sheets connector. Range: 'Customers'!A1:B1; Values: [["Alex",3],["Sam",5]]; Value Input Option: RAW.

Errors and limits

Check the list-of-rows shape and split large writes into smaller requests. Inspect the sheet before retrying an uncertain append to avoid duplicate rows. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Update values

Write rows of values into a worksheet range.

Inputs

InputTypeHow to use it
AccountAccountChoose a saved Google Sheets connector from this organization. Create or reconnect it in Settings > Connectors. Do not enter an API key, password or email address here.
SpreadsheettextSelect the workbook or supply its Google spreadsheet ID from the /spreadsheets/d/ part of its address. This is not a worksheet tab ID.
RangetextThe full destination A1 range, including its tab name, such as 'Customers'!A2:B3. Written cells can overwrite existing values.
ValueslistA nonempty list of rows, such as [["Alex",3],["Sam",5]]. Row values can be text, finite numbers, booleans or null. Maximum 1,000 rows and 1,000 values per row; the complete command inputs must fit within 64 KiB.
Value Input OptiontextOptional RAW stores values without interpreting them; USER_ENTERED lets Google interpret dates, numbers and formulas as if typed. Defaults to RAW. Use exactly one of these values.

Result

Google's update result with spreadsheetId, updatedRange, updatedRows, updatedColumns and updatedCells when supplied. Updated cell values are not echoed.

Example

Account: choose your Google Sheets connector. Range: 'Customers'!A1:B1; Values: [["Alex",3],["Sam",5]]; Value Input Option: RAW.

Errors and limits

Check the list-of-rows shape and split large writes into smaller requests. Use RAW for untrusted text that must not become a formula. Reconnect the matching app in Settings if the connection is unavailable. Check the resource IDs and required read or edit permissions. Wait after provider rate limiting. Use live data is required; isolated tests and live debugging cannot contact these services. Provider requests time out after 30 seconds. Google responses are limited to 16 MiB.

Test safely

Isolated tests and live debugging do not call connected providers. Enable Use live data only when you intend to contact the account. Writes, messages and AI requests can change real data or incur provider charges. A successful connection check does not prove access to every action. These examples explain the command contract; they are not evidence of a completed live provider request.

Related Topics

ClickUp commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → ClickUp, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands. [All ...

Google Drive commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → Google Drive, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands. ...

Stripe commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → Stripe, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands. [All c...

Jira Cloud commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → Jira Cloud, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands. [A...

Cloudflare commands

Use these commands from an endpoint, server function or event. Choose Add Command → Connector → Cloudflare, select the action, then choose an Account. Selecting an account reveals the remaining inputs. When the command returns a result, open OUTPUT and use Return as to name it for later commands. [A...