Skip to main content
Google Sheets logo
  • Category: spreadsheets
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 58
  • Triggers: 16
  • Slug: GOOGLESHEETS
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Google OAuth credentials with Composio, see How to create OAuth2 credentials for Google Apps.
The OAuth client is requesting scopes that Google hasn’t verified for that client. This usually happens when you add extra scopes beyond the defaults.Remove the additional scopes from your auth config, or create your own OAuth app and submit the scopes for verification. See How to create OAuth2 credentials for Google Apps.
When using custom OAuth credentials, the Google Sheets API must be enabled in the Google Cloud project that owns those credentials. Enable it in Google Cloud Console under APIs & Services, wait a few minutes, and retry.
The requested scopes are invalid or incorrectly formatted in the authorization URL. Verify your scope values against the Google OAuth scopes docs. If you’re creating auth configs programmatically, see the programmatic auth config guide.
The user’s access token is no longer valid. Common causes: the user revoked access, changed their password or 2FA, a Workspace admin policy changed, or Google’s refresh token limit was exceeded. Re-authenticating the user typically resolves this.
Google enforces per-minute and daily request quotas. These errors may also appear as a 429. If you’re using Composio’s default OAuth app, you share that quota with other users, which can cause limits to be hit faster. Use your own OAuth app credentials to get a dedicated quota, and add exponential backoff and retries to handle transient rate limits.

Tools

Slug: GOOGLESHEETS_ADD_SHEETAdd a GRID sheet with rows and columns to an existing spreadsheet. This action does not create chart-only or DATA_SOURCE sheets. Use properties to configure the GRID sheet’s dimensions, tab color, position, visibility, and text direction. Notes: - Sheet names must be unique; use forceUnique=true to auto-append suffix (_2, _3) if name exists - For tab colors, use EITHER rgbColor OR themeColor, not both - Avoid ‘index’ when creating sheets in parallel (causes errors)

Input Parameters

string
The name for the new sheet tab. Must be unique within the spreadsheet. Example: “Q3 Report”, “Sales Data 2025”. This is a convenience parameter - alternatively, you can set this via properties.title. Note: sheet_name is also accepted as an alias for title.
object
Advanced GRID sheet properties such as dimensions, tab color, position, visibility, and text direction. For simple cases, use the title parameter directly.
boolean
When True (default), automatically ensures the sheet name is unique by appending a numeric suffix (e.g., ‘_2’, ‘_3’) if the requested name already exists. This makes the action resilient to retries and parallel workflows. When False, the action fails with an error if a sheet with the same name already exists.
string
required
REQUIRED. Cannot be empty. The ID of the target spreadsheet where the new sheet will be added. This is the long alphanumeric string in the Google Sheet URL (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’). Use ‘Search Spreadsheets’ action to find the spreadsheet ID by name if you don’t have it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_AGGREGATE_COLUMN_DATAAggregates data from a column in a Google Sheet, either across all rows or rows matching column-value filters. Supports sum, average, count, minimum, maximum, and percentage.

Input Parameters

string ("sum" | "average" | "count" | "min" | "max" | "percentage")
required
The mathematical operation to perform on the target column values.
string
required
The name of the specific sheet within the spreadsheet. Matching is case-insensitive. If no exact match is found, partial matches will be attempted (e.g., ‘overview’ will match ‘Overview 2025’).
string
The exact value to search for in the search column. Case-sensitive by default. If not provided (or if search_column is not provided), all rows in the target column will be aggregated without filtering.
string
The column to search in for filtering rows. Can be a letter (e.g., ‘A’, ‘B’) or column name from header row (e.g., ‘Region’, ‘Department’). If not provided, all rows in the target column will be aggregated without filtering.
string
required
The column to aggregate data from. Can be a letter (e.g., ‘C’, ‘D’) or column name from header row (e.g., ‘Sales’, ‘Revenue’).
boolean
Whether the search should be case-sensitive.
boolean
Whether the first row contains column headers. If True, column names can be used for search_column and target_column.
string
required
The unique identifier of the Google Sheets spreadsheet.
number
For percentage operation, the total value to calculate percentage against. If not provided, uses sum of all values in target column.
array
Extra column=value conditions applied with AND logic on top of search_column/search_value. Use this to filter on multiple columns simultaneously. Example: [{“column”: “Region”, “value”: “APAC”}] combined with search_column=Product/search_value=Beacon returns only rows where Product=Beacon AND Region=APAC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_APPEND_DIMENSIONTool to append new rows or columns to a sheet, increasing its size. Use when you need to add empty rows or columns to an existing sheet.

Input Parameters

integer
required
The number of rows or columns to append.
integer
required
The numeric ID of the sheet (not the sheet name). This is a non-negative integer found in the sheet’s URL as the ‘gid’ parameter (e.g., gid=0) or in the sheet properties. The first sheet in a spreadsheet typically has sheet_id=0.
string ("ROWS" | "COLUMNS")
required
Specifies whether to append rows or columns.
string
required
The ID of the spreadsheet.
array
Limits the ranges of the spreadsheet to include in the response.
boolean
True if grid data should be included in the response (if includeSpreadsheetInResponse is true).
boolean
True if the updated spreadsheet should be included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_AUTO_RESIZE_DIMENSIONSAuto-fit column widths or row heights for a dimension range using batchUpdate.autoResizeDimensions. Use when you need to automatically adjust row heights or column widths to fit content after writing data.

Input Parameters

integer
The numeric ID of the sheet to resize. Either sheet_id or sheet_name must be provided. If both are provided, sheet_name takes precedence and will be resolved to sheet_id.
string ("ROWS" | "COLUMNS")
required
The dimension to auto-resize. Use ‘ROWS’ to auto-fit row heights or ‘COLUMNS’ to auto-fit column widths.
integer
required
The zero-based end index of the dimension range to resize (exclusive). Must be greater than start_index. For example, to resize columns A-C, use start_index=0 and end_index=3.
string
The name of the sheet to resize. Either sheet_id or sheet_name must be provided. Using sheet_name is recommended as it’s more intuitive. If both sheet_id and sheet_name are provided, sheet_name takes precedence.
integer
required
The zero-based start index of the dimension range to resize (inclusive). For columns, 0 = column A. For rows, 0 = row 1.
string
required
The ID of the spreadsheet containing the sheet to resize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_BATCH_CLEAR_VALUES_BY_DATA_FILTERClears one or more ranges of values from a spreadsheet using data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared — all other properties of the cell (such as formatting, data validation, etc..) are kept.

Input Parameters

array
required
The DataFilters used to determine which ranges to clear.
string
required
The ID of the spreadsheet to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_BATCH_GETRetrieves values from specified cell ranges in a Google Spreadsheet. If ranges are omitted or empty after filtering blank entries, it retrieves data from the first sheet.

Input Parameters

array
A list of cell ranges in A1 notation from which to retrieve data. If this list is omitted, empty, or contains only empty strings, all data from the first sheet of the spreadsheet will be fetched. Empty strings in the list are automatically filtered out. Supported formats: (1) Bare sheet name like ‘Sheet1’ to get all data from that sheet, (2) Sheet with range like ‘Sheet1!A1:B2’, (3) Just cell reference like ‘A1:B2’ (uses first sheet). For sheet names with spaces or special characters, enclose in single quotes (e.g., “‘My Sheet’” or “‘My Sheet’!A1:B2”). IMPORTANT: For large sheets, always use bounded ranges with explicit row limits (e.g., ‘Sheet1!A1:Z10000’ instead of ‘Sheet1!A:Z’). Unbounded column ranges like ‘A:Z’ on sheets with >10,000 rows may cause timeouts or errors. If you need all data from a large sheet, fetch in chunks of 10,000 rows at a time.
string ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS")
The major dimension for organizing data in results.
string
required
The unique identifier of the Google Spreadsheet from which data will be retrieved. This is the ID found in the spreadsheet URL after /d/. You can provide either the spreadsheet ID directly or a full Google Sheets URL (the ID will be extracted automatically).
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How values should be rendered in the output. FORMATTED_VALUE: Values are calculated and formatted (default). UNFORMATTED_VALUE: Values are calculated but not formatted. FORMULA: Values are not calculated; the formula is returned instead.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
How dates and times should be rendered in the output. SERIAL_NUMBER: Dates are returned as serial numbers (default). FORMATTED_STRING: Dates returned as formatted strings.
boolean
Indicates whether empty strings were filtered from the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_BATCH_UPDATEDeprecated: Writes values to one range in a Google Sheet, or appends rows when no start cell is given. It may expand the sheet grid; if a recognized default sheet name is not found, it uses the first sheet instead.

Input Parameters

array
required
A 2D array of cell values where each inner array represents a row. Values can be strings, numbers, booleans, or None/null for empty cells. Ensure columns are properly aligned across rows.
string
required
The name of the specific sheet (tab) within the spreadsheet to update (required, separate from cell reference). Case-insensitive matching is supported (e.g., ‘sheet1’ will match ‘Sheet1’). Note: Default sheet names are locale-dependent (e.g., ‘Sheet1’ in English, ‘Foglio1’ in Italian, ‘Hoja 1’ in Spanish, ‘시트1’ in Korean, ‘Feuille 1’ in French). If you specify a common default name like ‘Sheet1’ and it doesn’t exist, the action will automatically use the first sheet in the spreadsheet.
string
required
The unique identifier of the Google Sheets spreadsheet to be updated. Must be an alphanumeric string (with hyphens and underscores allowed) typically 44 characters long. Can be found in the spreadsheet URL between ‘/d/’ and ‘/edit’. Example: ‘https://docs.google.com/spreadsheets/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/edit’ has ID ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’.
string ("RAW" | "USER_ENTERED")
How input data should be interpreted. ‘USER_ENTERED’: Values are parsed as if typed by a user (e.g., strings may become numbers/dates, formulas are calculated). ‘RAW’: Values are stored exactly as provided without parsing (e.g., ‘123’ stays as string, ‘=SUM(A1:B1)’ is not calculated).
string
The starting cell for the update range, specified as a single cell in A1 notation WITHOUT sheet prefix (e.g., ‘A1’, ‘B2’, ‘AA931’). The update will extend from this cell to the right and down based on the provided values. Sheet name must be provided separately in the ‘sheet_name’ field. If omitted or set to null, values are appended as new rows to the sheet. Note: Use only a single cell reference (e.g., ‘AA931’), NOT a range (e.g., ‘AA931:AF931’) or sheet-prefixed notation (e.g., ‘Sheet1!A1’).
boolean
If set to True, the response will include the updated values in the ‘spreadsheet.responses[].updatedData’ field. The updatedData object contains ‘range’ (A1 notation), ‘majorDimension’ (ROWS), and ‘values’ (2D array of the actual cell values after the update).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_BATCH_UPDATE_VALUES_BY_DATA_FILTERTool to update values in ranges matching data filters. Use when you need to update specific data in a Google Sheet based on criteria rather than fixed cell ranges.

Input Parameters

array
required
The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges. Can be provided as a JSON string or as a list of DataFilterValueRange objects.
string
required
The ID of the spreadsheet to update.
string ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED")
required
How the input data should be interpreted. RAW: Values are stored exactly as entered, without parsing. USER_ENTERED: Values are parsed as if typed by a user (numbers stay numbers, strings prefixed with ’=’ become formulas, etc.). INPUT_VALUE_OPTION_UNSPECIFIED: Default input value option is not specified.
boolean
Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
Determines how dates, times, and durations in the response should be rendered. This is ignored if responseValueRenderOption is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CLEAR_BASIC_FILTERTool to clear the basic filter from a sheet. Use when you need to remove an existing basic filter from a specific sheet within a Google Spreadsheet.

Input Parameters

integer
required
The ID of the sheet on which the basic filter should be cleared.
string
required
The ID of the spreadsheet.
array
Limits the ranges included in the response spreadsheet. Only applicable when include_spreadsheet_in_response is true.
boolean
True if grid data should be returned in the response. Only applicable when include_spreadsheet_in_response is true.
boolean
Determines if the update response should include the spreadsheet resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CLEAR_VALUESClears cell content (preserving formatting and notes) from a specified A1 notation range in a Google Spreadsheet; the range must correspond to an existing sheet and cells.

Input Parameters

string
required
The A1 notation of the range to clear values from (e.g., ‘Sheet1!A1:B2’, ‘MySheet!C:C’, or ‘A1:D5’). If the sheet name is omitted (e.g., ‘A1:B2’), the operation applies to the first visible sheet.
string
required
The unique identifier of the Google Spreadsheet from which to clear values. This ID can be found in the URL of the spreadsheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CREATE_CHARTCreate a chart in a Google Sheets spreadsheet using a specified data range and chart type, or an optional full chart specification. The chart type and data range are required even when supplying a chart specification.

Input Parameters

string
Optional title for the chart.
integer
required
The numeric sheetId (not the sheet name/title) of the worksheet where the chart will be created. This is a unique integer identifier for the sheet within the spreadsheet. The first/default sheet typically has sheetId=0. IMPORTANT: Use ‘Get Spreadsheet Info’ action to retrieve valid sheetIds - look for sheets[].properties.sheetId in the response. The sheetId must exist in the target spreadsheet; using an ID from a different spreadsheet will fail.
string
Optional subtitle for the chart.
object
Optional full ChartSpec object to send to the Google Sheets API. Use this to support ALL chart types and advanced options. Must set exactly one of: basicChart, pieChart, bubbleChart, candlestickChart, histogramChart, treemapChart, waterfallChart, orgChart, scorecardChart. See https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/charts#ChartSpec.
string
required
Type of chart to create. Supported types: BAR, LINE, AREA, COLUMN, SCATTER, COMBO, STEPPED_AREA, PIE, HISTOGRAM, BUBBLE, CANDLESTICK, TREEMAP, WATERFALL, ORG, SCORECARD. Case-insensitive and whitespace-tolerant.
string
required
A single contiguous range of data for the chart in A1 notation (e.g., ‘A1:C10’ or ‘Sheet1!B2:D20’). Must be a single continuous range - comma-separated multi-ranges (e.g., ‘A1:A10,C1:C10’) are not supported. When chart_spec is not provided, the first column is used as the domain/labels and the remaining columns as series. IMPORTANT: PIE charts require at least 2 columns - the first column for category labels (domain) and the second column for numeric values (series). Single-column ranges are not supported for PIE charts.
string
Optional title for the X-axis.
string
Optional title for the Y-axis.
number
Red component of chart background color (0.0-1.0). If not specified, uses default.
string
required
The unique identifier of the Google Sheets spreadsheet where the chart will be created. Must be the actual spreadsheet ID from the URL (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’), NOT the spreadsheet name or title. Find it in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
number
Blue component of chart background color (0.0-1.0). If not specified, uses default.
string
Position of the chart legend. Options: BOTTOM_LEGEND, TOP_LEGEND, LEFT_LEGEND, RIGHT_LEGEND, NO_LEGEND.
number
Green component of chart background color (0.0-1.0). If not specified, uses default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CREATE_GOOGLE_SHEET1Creates a new Google Spreadsheet in Drive with an optional title and folder ID or exact folder name. Multiple matching folders return choices before creation; if moving a created spreadsheet to the requested folder fails, the response reports partial success.

Input Parameters

string
The title for the new Google Sheet. If omitted, Google will create a spreadsheet with a default name like ‘Untitled spreadsheet’.
string
Google Drive folder ID where the spreadsheet should be created. If provided, the spreadsheet will be moved to this folder after creation. Takes precedence over folder_name.
string
Google Drive folder name where the spreadsheet should be created. If provided and folder_id is not provided, the action will search for a folder with this exact name. If multiple folders match, you’ll receive a list to choose from. If no folder matches, an error is returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CREATE_SPREADSHEET_COLUMNInserts a new column in a Google Spreadsheet at a specified index. Select the target sheet by numeric ID or name; if neither is provided, sheet ID 0 is used.

Input Parameters

integer
The numeric identifier of the specific sheet (tab) within the spreadsheet. Defaults to 0 (the first sheet) if neither sheet_id nor sheet_name is provided. Use GOOGLESHEETS_GET_SHEET_NAMES or GOOGLESHEETS_FIND_WORKSHEET_BY_TITLE to obtain the sheet_id from a sheet name.
string
The name (title) of the sheet/tab where the column will be added. If provided, the action will look up the sheet_id automatically. If both sheet_id and sheet_name are provided, sheet_id takes precedence.
integer
The 0-based index at which the new column will be inserted. For example, an index of 0 inserts the column before the current first column (A), and an index of 1 inserts it between the current columns A and B.
string
required
The unique identifier of the Google Spreadsheet where the column will be created.
array
Limits the ranges of the spreadsheet to include in the response. Only used if includeSpreadsheetInResponse is true.
boolean
If true, the new column inherits properties (e.g., formatting, width) from the column immediately to its left (the preceding column). If false (default), it inherits from the column immediately to its right (the succeeding column). This is ignored if there is no respective preceding or succeeding column.
boolean
If true, grid data will be included in the response (only used if includeSpreadsheetInResponse is true).
boolean
If true, the updated spreadsheet will be included in the response. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_CREATE_SPREADSHEET_ROWInserts a new, empty row into a specified sheet of a Google Spreadsheet at a given index, optionally inheriting formatting from the row above.

Input Parameters

integer
The numeric identifier of the sheet (tab) within the spreadsheet where the row will be inserted. This ID (gid) is found in the URL of the spreadsheet (e.g., ‘0’ for the first sheet). Either sheet_id or sheet_name must be provided.
string
The human-readable name of the sheet (tab) within the spreadsheet where the row will be inserted (e.g., ‘Sheet1’). Either sheet_id or sheet_name must be provided. If both are provided, sheet_id takes precedence.
integer
The 0-based index at which the new row should be inserted. For example, an index of 0 inserts the row at the beginning of the sheet. If the index is greater than the current number of rows, the row is appended.
string
required
The unique identifier of the Google Spreadsheet. Can be provided as the ID (e.g., ‘1qpyC0XzHc_-_d824s2VfopkHh7D0jW4aXCS1D_AlGA’) or as a full URL (the ID will be extracted automatically).
array
Limits the ranges included in the response spreadsheet. Only meaningful when include_spreadsheet_in_response is True. Use A1 notation (e.g., [‘Sheet1!A1:D10’]).
boolean
If True, the newly inserted row will inherit formatting and properties from the row immediately preceding its insertion point. If False, it will have default formatting.
boolean
If True, grid data will be included in the response spreadsheet. Only meaningful when include_spreadsheet_in_response is True. Default is False.
boolean
If True, the response will include the full updated Spreadsheet resource. Default behavior includes the spreadsheet when this parameter is not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_DELETE_CHARTDelete an existing chart from a Google Sheets spreadsheet. Use this action when you need to remove a chart that is no longer needed or needs to be replaced. This action is irreversible — once a chart is deleted, it cannot be recovered. The chart data source (the cells containing the data) remains unchanged; only the chart visualization is removed.

Input Parameters

integer
required
The unique numeric identifier of the chart to delete (also known as objectId or chartId). This is the chart’s ID within the spreadsheet, not the sheet ID. You can retrieve chart IDs using the ‘Get Spreadsheet Info’ action - look for sheets[].charts[].chartId in the response. Each chart has a unique ID that persists until the chart is deleted.
string
required
The unique identifier of the Google Sheets spreadsheet containing the chart to delete. Must be the actual spreadsheet ID from the URL (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’), NOT the spreadsheet name or title. Find it in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_DELETE_DIMENSIONTool to delete specified rows or columns from a sheet in a Google Spreadsheet. Use when you need to remove a range of rows or columns.

Input Parameters

integer
The unique numeric ID of the sheet (not the index/position). This ID is assigned by Google Sheets and does not change when sheets are reordered. Use GOOGLESHEETS_GET_SPREADSHEET_INFO to find the sheet ID, or use sheet_name instead. Either sheet_id or sheet_name must be provided.
string ("ROWS" | "COLUMNS")
The dimension to delete (ROWS or COLUMNS).
integer
The zero-based end index of the range to delete, exclusive. Must be greater than start_index and at most equal to the sheet’s current row/column count. Note: Cannot delete all rows or columns from a sheet - at least one row and one column must remain.
string
The name/title of the sheet from which to delete the dimension. Using sheet_name is recommended as it’s more intuitive than sheet_id. Either sheet_id or sheet_name must be provided.
integer
The zero-based start index of the range to delete, inclusive. Must be less than end_index and within the sheet’s current row/column count. Note: Cannot delete all rows or columns from a sheet - at least one row and one column must remain.
string
required
The ID of the spreadsheet.
array
Limits the ranges of cells included in the response spreadsheet.
object
The details for the delete dimension request object.
boolean
True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
boolean
Determines if the update response should include the spreadsheet resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_DELETE_SHEETTool to delete a sheet (worksheet) from a spreadsheet. Use when you need to remove a specific sheet from a Google Sheet document.

Input Parameters

integer
required
The ID of the sheet to delete. Note: A spreadsheet must contain at least one sheet, so you cannot delete the last remaining sheet. If the sheet is of DATA_SOURCE type, the associated DataSource is also deleted.
string
required
The ID of the spreadsheet from which to delete the sheet.
array
Limits which ranges are returned when includeSpreadsheetInResponse is true. Only meaningful if includeSpreadsheetInResponse is set to true. Ranges should be in A1 notation (e.g., ‘Sheet1!A1:B10’).
boolean
True if grid data should be returned in the response spreadsheet. Only meaningful when includeSpreadsheetInResponse is true and no field mask is set on the request.
boolean
Determines if the spreadsheet resource should be returned in the response. If true, the response includes the updated spreadsheet resource with all its sheets, properties, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_EXECUTE_SQLDeprecated SQL facade for selecting, inserting, updating, and deleting data in automatically detected spreadsheet tables, including limited WITH queries; discovery reads at most 10,000 rows per sheet. For detected header-based tables, the first data row is skipped and update/delete row targeting can be offset.

Input Parameters

string
required
Complete SQL query to execute. Must begin with SELECT, INSERT, UPDATE, DELETE, or WITH. Supports Common Table Expressions (CTEs) using WITH clause for complex queries. Note: WITH clauses require the sqlglot library for full support; simple SELECT/INSERT/UPDATE/DELETE operations work without it. Use table names (sheet names) in FROM/INTO clauses, not A1 range notation. The query must include proper SQL clauses (e.g., SELECT columns FROM table, not just a column name or condition). Example: SELECT * FROM “Sheet1” WHERE A = ‘value’ (correct) instead of just A = ‘value’ (incorrect).
boolean
Preview changes without applying them (for write operations)
string ("clear" | "remove_rows")
For DELETE operations: ‘clear’ preserves row structure, ‘remove_rows’ shifts data up
string
required
The unique alphanumeric ID of the Google Spreadsheet extracted from the URL. Format: A long string of letters, numbers, hyphens, and underscores (typically 44 characters). Find it in the URL: https://docs.google.com/spreadsheets/d/{SPREADSHEET_ID}/edit. Must be a valid ID - values like ‘auto’ are NOT valid and will fail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_EXPORT_DRIVE_FILEExport an entire native spreadsheet as XLSX, ODS, PDF, ZIP, CSV, or TSV; use Export Sheet as PDF for print layout and range controls.

Input Parameters

string
required
Opaque Drive file ID of a native Google Sheets spreadsheet, not its title or URL.
string ("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.oasis.opendocument.spreadsheet" | "application/pdf" | "application/zip" | "text/csv" | "text/tab-separated-values")
required
Official Drive export MIME type for spreadsheets: XLSX, ODS, PDF, zipped HTML, CSV, or TSV. CSV and TSV export only the first sheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_EXPORT_SHEET_AS_PDFRender one sheet tab or rectangular range as PDF with orientation, gridline, margin, and fit-to-width controls.

Input Parameters

boolean
Whether to use portrait orientation, mapped to portrait.
integer
required
Numeric ID of the sheet tab to export (the gid in a Sheets URL), not the tab title or spreadsheet ID.
number
Top margin passed to the sample-backed top_margin control. Google does not formally document its unit or accepted range.
number
Left margin passed to the sample-backed left_margin control. Google does not formally document its unit or accepted range.
boolean
Value for the sample-backed fitw PDF print control.
boolean
Value for the sample-backed printtitle PDF print control.
number
Right margin passed to the sample-backed right_margin control. Google does not formally document its unit or accepted range.
number
Bottom margin passed to the sample-backed bottom_margin control. Google does not formally document its unit or accepted range.
integer
Sample-backed r2 range control. It must exceed start_row_index; Google does not formally document this browser-route key.
boolean
Whether to show sheet gridlines in the PDF.
string
required
Google Sheets spreadsheet ID or original docs.google.com Sheets URL, not the spreadsheet title. Published /d/e/ URLs are not supported.
boolean
Whether to print the sheet name, mapped to sheetnames.
integer
Sample-backed r1 range control. Supply it with all other range indices; Google does not formally document this browser-route key.
integer
Sample-backed c2 range control. It must exceed start_column_index; Google does not formally document this browser-route key.
boolean
Value for the sample-backed fzr PDF print control.
integer
Sample-backed c1 range control. Supply it with all other range indices; Google does not formally document this browser-route key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_FIND_REPLACEFinds and replaces text across cells in a Google Spreadsheet, scoped to a sheet, range, or all sheets; if no scope is specified, it searches all sheets. Formula cells can be included explicitly when fixing formula references or patterns.

Input Parameters

string
required
The text to find. Can be a literal string or a regular expression pattern.
string
A1 notation range string to search within (e.g., ‘A1:B10’, ‘Sheet1!A1:B10’). When using A1 notation with a sheet name, you must also provide range_sheet_id to specify the numeric sheet ID (the API requires numeric IDs). Alternatively, use the GridRange parameters (range_sheet_id with optional row/column indices) for explicit numeric control. Mutually exclusive with sheet_id and all_sheets.
string
required
The text to replace the found instances with.
integer
The numeric ID of the sheet to search the entire sheet (e.g., 0 for the first sheet). Mutually exclusive with sheet_name, range/range_sheet_id parameters, and all_sheets. You must specify exactly one scope: either sheet_id (entire sheet), sheet_name, range/range_sheet_id (specific range), or all_sheets.
boolean
Whether to search across all sheets in the spreadsheet. Mutually exclusive with sheet_id and range parameters.
boolean
Whether the search should be case-sensitive.
string
The name/title of the sheet (tab) to search within (e.g., ‘Sheet1’, ‘Sales Data’). The sheet name will be resolved to its numeric sheet ID. Mutually exclusive with sheet_id, range/range_sheet_id parameters, and all_sheets.
integer
The end row (0-indexed, exclusive) of the range. Only used when range_sheet_id is provided without a ‘range’ parameter.
integer
The numeric sheet ID for a GridRange-based search. Required when using the ‘range’ parameter with A1 notation. Can also be used alone or with row/column index parameters to define a specific range. Mutually exclusive with sheet_id and all_sheets.
boolean
Whether to treat the find text as a regular expression.
string
required
The ID of the spreadsheet to update.
integer
The start row (0-indexed, inclusive) of the range. Only used when range_sheet_id is provided without a ‘range’ parameter.
integer
The end column (0-indexed, exclusive) of the range. Column A = 0, B = 1, etc. Only used when range_sheet_id is provided without a ‘range’ parameter.
boolean
Whether to include cells with formulas in the search. If true, formulas are searched and can be replaced. If false, only cell values (not formulas) are searched. If not specified, the default API behavior applies (both formulas and values are searched).
boolean
Whether to match only cells that contain the entire search term.
integer
The start column (0-indexed, inclusive) of the range. Column A = 0, B = 1, etc. Only used when range_sheet_id is provided without a ‘range’ parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_FIND_WORKSHEET_BY_TITLEDEPRECATED: Finds a worksheet by its case-sensitive title within a Google Spreadsheet, after trimming input whitespace and decoding Unicode escapes. Returns a found boolean and matched worksheet metadata, or indicates no match.

Input Parameters

string
required
The unique identifier of the Google Spreadsheet from the URL (e.g., https://docs.google.com/spreadsheets/d/{spreadsheet_id}/edit). Important: This is NOT the spreadsheet’s display name/title. It is the long alphanumeric string (typically 40-45 characters) from the URL containing only letters, numbers, hyphens, and underscores.
string
required
The exact, case-sensitive title of the worksheet (tab name) to find.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_FORMAT_CELLFormats a specified cell range in a Google Sheets worksheet. It always applies text style, font size and background color defaults unless supplied; a sheet prefix in an A1 range is ignored, so select the worksheet separately.

Input Parameters

number
Red component of the background color (0.0-1.0).
number
Blue component of the background color (0.0-1.0).
boolean
Apply bold formatting.
number
Green component of the background color (0.0-1.0).
string
OPTION 1: Cell range in A1 notation (RECOMMENDED). Supports: single cells (‘A1’, ‘F9’), cell ranges (‘A1:B5’), entire columns (‘A’, ‘I:J’), entire rows (‘1’, ‘1:5’). Also accepts sheet-prefixed ranges (‘Sheet1!A1’, ‘Instagram Calendar!A1:E1’) for convenience - if provided, the sheet prefix is stripped and ignored. The actual sheet used is determined by the sheet_name or worksheet_id parameter. Provide EITHER this field OR all four index fields below, not both.
boolean
Apply italic formatting.
integer
Font size in points.
Cell-level text link URI. Must include a URI scheme, such as ‘https://’ or ‘mailto:’.
boolean
Apply underline formatting.
string
The worksheet name/title (e.g., ‘Sheet1’, ‘Q3 Report’). Provide either this field OR worksheet_id, not both. If both are provided, sheet_name takes precedence and will be resolved to worksheet_id.
string
Text color as 6-digit hex.
string
Font family.
integer
Top padding in pixels.
string
Border color as 6-digit hex.
string ("DOTTED" | "DASHED" | "SOLID" | "SOLID_MEDIUM" | "SOLID_THICK" | "NONE" | "DOUBLE")
Border styles supported by Google Sheets.
integer
Left padding in pixels.
integer
The worksheet identifier. Accepts EITHER: (1) The sheetId from the Google Sheets API (a large number like 1534097477, obtainable via GOOGLESHEETS_GET_SPREADSHEET_INFO), OR (2) The 0-based positional index of the worksheet (0 for first sheet, 1 for second, etc.). The action will first try to match by sheetId, then fall back to matching by index. Defaults to 0 (first sheet). Provide either this field OR sheet_name, not both.
integer
OPTION 2: 0-based index of the row AFTER the last row (exclusive). Required if ‘range’ is not provided. Must provide ALL four index fields together.
integer
Right padding in pixels.
boolean
Apply strikethrough formatting.
string ("OVERFLOW_CELL" | "LEGACY_WRAP" | "CLIP" | "WRAP")
How text wraps within cells.
integer
Bottom padding in pixels.
string
required
Identifier of the Google Sheets spreadsheet.
string ("LEFT_TO_RIGHT" | "RIGHT_TO_LEFT")
Text direction in a cell.
integer
OPTION 2: 0-based row index (row 1 = index 0, row 9 = index 8). Required if ‘range’ is not provided. Must provide ALL four index fields together.
number
Background alpha from 0.0 to 1.0.
string
Background color as 6-digit hex.
integer
OPTION 2: 0-based index of the column AFTER the last column (exclusive). Required if ‘range’ is not provided. Must provide ALL four index fields together.
string ("TEXT" | "NUMBER" | "PERCENT" | "CURRENCY" | "DATE" | "TIME" | "DATE_TIME" | "SCIENTIFIC")
How number values should be represented to the user.
integer
OPTION 2: 0-based column index (A = 0, B = 1, F = 5). Required if ‘range’ is not provided. Must provide ALL four index fields together.
string ("TOP" | "MIDDLE" | "BOTTOM")
Vertical alignment of text in a cell.
integer
Text rotation angle from -90 to 90.
string ("LEFT" | "CENTER" | "RIGHT")
Horizontal alignment of text in a cell.
string
Optional number/date pattern.
How a hyperlink should be displayed in a cell.
boolean
Make text read top to bottom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_BATCH_VALUESDEPRECATED: Use GOOGLESHEETS_BATCH_GET instead. Tool to return one or more ranges of values from a spreadsheet. Use when you need to retrieve data from multiple ranges in a single request.

Input Parameters

array
required
The A1 notation or R1C1 notation of the ranges to retrieve values from. Specify one or more ranges (e.g., [‘Sheet1!A1:B10’, ‘Sheet2!C1:D5’]). For sheet names with spaces or special characters, wrap in single quotes (e.g., “‘My Sheet’!A1:B10”).
string
required
The ID of the spreadsheet to retrieve data from. This is the unique identifier found in the spreadsheet URL between ‘/d/’ and ‘/edit’ (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’).
string ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS")
The major dimension for results.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How values should be rendered in the output.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
How dates, times, and durations should be represented in the output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_CONDITIONAL_FORMAT_RULESList conditional formatting rules for each sheet (or a selected sheet) in a normalized, easy-to-edit form. Use when you need to view, audit, or prepare to modify conditional format rules.

Input Parameters

integer
Optional filter: return rules only for the sheet with this exact numeric sheetId. If not provided, returns rules for all sheets. If both sheet_title and sheet_id are provided, sheet_id takes precedence.
string
Optional filter: return rules only for the sheet with this exact title. If not provided, returns rules for all sheets.
string
required
Unique identifier of the Google Spreadsheet, typically found in its URL.
boolean
True if tables should be excluded in the banded ranges. False if not set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_DATA_VALIDATION_RULESTool to extract data validation rules from a Google Sheets spreadsheet. Use when you need to understand dropdown lists, allowed values, custom formulas, or other validation constraints for cells.

Input Parameters

array
Optional list of A1 ranges to scan. If omitted, the entire sheet(s) will be scanned. WARNING: Scanning entire large sheets may be slow.
integer
Optional sheet ID to filter by. If omitted, all sheets will be scanned.
string
Optional sheet title to filter by. If omitted, all sheets will be scanned.
boolean
If true, include cells without validation rules in the output. Default is false.
string
required
The ID of the spreadsheet to request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_DRIVE_FILE_METADATAGet JSON metadata for one Drive file without downloading its content.

Input Parameters

string
Google partial-response field mask for any valid Drive File fields, for example id,name,mimeType,modifiedTime or permissions(id,emailAddress,role). Omit for Drive’s default metadata projection; use * only when the larger response is needed.
string
required
Opaque Drive file ID to inspect, not a file name. A Google Sheets spreadsheet ID is also its Drive file ID.
string
Comma-separated Drive label IDs to include in labelInfo. Include labelInfo in fields when using a custom projection.
boolean
Whether the caller supports both My Drive and shared-drive files. Defaults to true so a valid shared-drive file ID works.
string
Set to published to include permissions for the published view. Include permissions in fields when using a custom projection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_SHEET_NAMESLists all worksheet names from a specified Google Spreadsheet (which must exist), useful for discovering sheets before further operations.

Input Parameters

boolean
When True, hidden sheets will be excluded from the results. When False (default), all sheets including hidden ones are returned. Hidden sheets are sheets that have been hidden via the ‘Hide sheet’ option in Google Sheets UI.
string
required
The unique identifier of the Google Spreadsheet (alphanumeric string, typically 44 characters). Extract only the ID portion from URLs - do not include leading/trailing slashes, ‘/edit’ suffixes, query parameters, or URL fragments. From ‘https://docs.google.com/spreadsheets/d/1qpyC0XzvTcKT6EISywY/edit#gid=0’, use only ‘1qpyC0XzvTcKT6EISywY’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_SPREADSHEET_BY_DATA_FILTERReturns the spreadsheet at the given ID, filtered by the specified data filters. Use this tool when you need to retrieve specific subsets of data from a Google Sheet based on criteria like A1 notation, developer metadata, or grid ranges. Important: This action is designed for filtered data retrieval. While it accepts empty filters and returns full metadata in that case, GOOGLESHEETS_GET_SPREADSHEET_INFO is the recommended action for unfiltered spreadsheet retrieval.

Input Parameters

array
The DataFilters used to select which ranges to retrieve. Supports A1 notation (e.g., ‘Sheet1!A1:B2’), developer metadata lookup, or grid range filters. If empty or omitted, returns full spreadsheet metadata. Recommended: Use GOOGLESHEETS_GET_SPREADSHEET_INFO for unfiltered retrieval as it is the dedicated action for that purpose.
string
required
The ID of the spreadsheet to request.
boolean
True if grid data should be returned. Ignored if a field mask is set.
boolean
True if tables should be excluded in the banded ranges. False if not set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_SPREADSHEET_INFORetrieves metadata for a Google Spreadsheet using its ID. By default, returns essential information (ID, title, sheet properties) to avoid payload size issues. Use the fields parameter for comprehensive metadata or specific fields.

Input Parameters

string
Optional. Field mask specifying which fields to return. Uses Google’s field mask syntax (comma-separated, dot-notation for nested fields). If not specified, a default mask returning common fields (spreadsheet ID, title, sheet properties) is applied to avoid payload size issues. For full metadata, use ’*’ (not recommended for large spreadsheets). When set, includeGridData is ignored. Examples: ‘sheets.properties(sheetId,title)’, ‘properties.title,sheets.properties.sheetId’.
array
Optional. The ranges to retrieve from the spreadsheet, specified using A1 notation (e.g., ‘Sheet1!A1:D5’, ‘Sheet2!A1:C4’). Multiple ranges can be requested simultaneously. If not specified, metadata for the entire spreadsheet is returned without grid data.
string
Required. The Google Sheets spreadsheet ID or full URL. Accepts either the ID alone (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’) or a full Google Sheets URL (e.g., ‘https://docs.google.com/spreadsheets/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/edit’). The ID will be automatically extracted from URLs. Note: Published/embedded URLs (containing ‘/d/e/2PACX-…’) are not supported.
boolean
Optional. If true, grid data will be returned. This parameter is ignored if a field mask was set in the request. When false or not specified, only metadata is returned without cell values.
boolean
Optional. If true, tables within banded ranges will be omitted from the response. Default is false when not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_GET_TABLE_SCHEMADeprecated: Retrieves an inferred schema for a detected table in a Google Spreadsheet, including column names and types estimated from sampled data.

Input Parameters

string
Sheet/tab name if table_name is ambiguous across multiple sheets
string
required
Table name from LIST_TABLES response OR the visible Google Sheets tab name (e.g., ‘Sales Data’, ‘Projections’). Use ‘auto’ to analyze the largest/most prominent table.
integer
Number of rows to sample for type inference
string
required
The unique identifier of the Google Spreadsheet. Must be a valid Google Sheets ID (typically a 44-character alphanumeric string). Do NOT use ‘auto’ - only ‘table_name’ supports auto-detection. You can get this ID from the spreadsheet URL or from SEARCH_SPREADSHEETS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_INSERT_DIMENSIONTool to insert new rows or columns into a sheet at a specified location. Use when you need to add empty rows or columns within an existing Google Sheet.

Input Parameters

string
required
The ID of the spreadsheet to update.
array
Limits the ranges of the spreadsheet to include in the response.
object
required
The details for the insert dimension request.
boolean
True if grid data should be included in the response (if includeSpreadsheetInResponse is true).
boolean
True if the updated spreadsheet should be included in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_LIST_CHARTSLists all charts in a Google Sheets spreadsheet across all sheets, returning chart_id, sheet metadata, chart type, title, and position. Use this action when you need to discover what charts exist in a spreadsheet, retrieve chart IDs for update or delete operations, or inspect chart configurations. The default field mask in GOOGLESHEETS_GET_SPREADSHEET_INFO omits chart data, making this dedicated action necessary for chart discovery.

Input Parameters

integer
Optional. Filter to a specific chart by its numeric chart ID. When provided, returns only the matching chart if it exists in the spreadsheet.
integer
Optional. Filter results to a single sheet’s charts by providing the numeric sheet ID (not the sheet name). When omitted, returns charts from all sheets in the spreadsheet.
boolean
When true, include the full ChartSpec dictionary for each chart (contains all chart configuration details including series, axes, colors, etc.). When false (default), return only a compact summary with chart_id, type, title, and position. Set to false to keep responses small.
string
required
Required. The Google Sheets spreadsheet ID or full URL. Accepts either the ID alone (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’) or a full Google Sheets URL (e.g., ‘https://docs.google.com/spreadsheets/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/edit’). The ID will be automatically extracted from URLs. Note: Published/embedded URLs (containing ‘/d/e/2PACX-…’) are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_LIST_DRIVE_CHANGESStart a Drive change monitor or list one page after an existing token.

Input Parameters

string
Comma-separated Drive spaces to query. Each value must be drive or appDataFolder.
string
Shared-drive ID whose change feed to read. When supplied, supports_all_drives and include_items_from_all_drives are forced true.
integer
Maximum changes to return in this page (1-1000). Drive can return fewer changes than requested.
string
Opaque token from Drive changes.getStartPageToken or the previous response’s next_page_token. Omit it to start monitoring now; the action returns a fresh checkpoint without listing historical changes.
string
Comma-separated Drive label IDs whose data should be included in each changed file’s labelInfo.
boolean
Include changes representing deletion or loss of access. Keep true for a complete incremental sync.
boolean
Declare support for My Drive and shared drives. Automatically true when drive_id is supplied.
boolean
Restrict results to the My Drive hierarchy, excluding app data and shared files not added to My Drive.
boolean
Include the current file resource when it remains accessible even though it was removed from this change corpus. When true, include_removed is forced true.
string
Set to published to include permissions for the published view; no other value is supported.
boolean
Include items from My Drive and shared drives. Automatically true when drive_id is supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_LIST_TABLESDeprecated: Lists heuristically detected tables in a Google Spreadsheet. It scans up to the first 1,000 rows and skips sheets with more than 2,000 rows or 100 columns.

Input Parameters

integer
Minimum number of data rows to consider a valid table
integer
Minimum number of columns to consider a valid table
number
Minimum confidence score (0.0-1.0) to consider a valid table
string
required
The actual Google Spreadsheet ID (not a placeholder or spreadsheet name). Find it in the spreadsheet URL: https://docs.google.com/spreadsheets/d/&#123;SPREADSHEET_ID&#125;/edit. It is the alphanumeric string between ‘/d/’ and ‘/edit’ (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’). IMPORTANT: Do NOT pass the spreadsheet name - only pass the alphanumeric ID from the URL. Do NOT pass template placeholders like ‘{{spreadsheet_id}}’, ‘<spreadsheet_id>’, or ‘your-spreadsheet-id-here’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_LOOKUP_SPREADSHEET_ROWFinds the first row in a specified A1 range or the first sheet where a cell matches the query after Unicode and invisible-character normalization. Matching is case-insensitive and trims surrounding whitespace by default; both behaviors are configurable.

Input Parameters

string
required
Exact text value to find; matches the entire content of a cell in a row.
string
A1 notation range to search within. Supports cell ranges (e.g., ‘Sheet1!A1:D5’), column-only ranges (e.g., ‘Sheet1!A:Z’), and row-only ranges (e.g., ‘Sheet1!1:1’). Defaults to the first sheet if omitted. IMPORTANT: Sheet names with spaces must be single-quoted (e.g., “‘My Sheet’!A1:Z”). Bare sheet names without ranges (e.g., ‘Sheet1’) are not supported - always specify a range.
boolean
If True, the query string search is case-sensitive.
string
required
Identifier of the Google Spreadsheet to search.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How cell values are rendered in the returned row data. unformatted: raw values without display formatting — dates appear as serial numbers, e.g. 46009.47 (default, keeps consistency with UPSERT). formatted: display-formatted values — dates appear as strings, e.g. ‘2025-12-18’. formula: raw formulas instead of computed values.
boolean
If True, strips leading and trailing whitespace from cell values before matching. This helps match cells like ’ TOTAL ’ or ‘TOTAL ’ when searching for ‘TOTAL’.
string
How dates and times are represented. FORMATTED_STRING: human-readable strings (e.g. ‘2025-12-18 11:17’). SERIAL_NUMBER: Excel-style serial numbers. Works with all value_render_option settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_MOVE_CHARTMove or resize an existing chart on a Google Sheets spreadsheet. Use this action when you need to reposition a chart to a different location on the same or different sheet, move it to a brand-new sheet, or change its size. This action wraps the updateEmbeddedObjectPosition batchUpdate request type and supports three positioning modes: moving to a new sheet, moving to an existing sheet, or repositioning via pixel-perfect overlay coordinates.

Input Parameters

integer
required
The unique numeric identifier of the chart to move within the spreadsheet. This is the chartId value (also known as objectId) returned when the chart was created or can be retrieved using GOOGLESHEETS_LIST_CHARTS or ‘Get Spreadsheet Info’ action (look for sheets[].charts[].chartId in the response). The chart must already exist in the specified spreadsheet.
boolean
Set to true to move the chart to a brand-new sheet. Google Sheets will automatically create and name the new sheet. This is mutually exclusive with target_sheet_id and anchor_sheet_id.
integer
Width of the chart in pixels. Only valid when anchor_sheet_id is provided. If omitted, Google Sheets preserves the existing width.
integer
Height of the chart in pixels. Only valid when anchor_sheet_id is provided. If omitted, Google Sheets preserves the existing height.
string
required
The unique identifier of the Google Sheets spreadsheet containing the chart to move. Must be the actual spreadsheet ID from the URL (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’), NOT the spreadsheet name or title. Find it in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
integer
The numeric sheetId of the sheet to anchor the chart onto when repositioning via overlay coordinates. Required if any of anchor_row_index, anchor_column_index, offset_x_pixels, offset_y_pixels, width_pixels, or height_pixels is provided. This is mutually exclusive with new_sheet and target_sheet_id.
integer
Horizontal pixel offset from the anchor cell. Only valid when anchor_sheet_id is provided. If omitted, Google Sheets preserves the existing horizontal offset.
integer
Vertical pixel offset from the anchor cell. Only valid when anchor_sheet_id is provided. If omitted, Google Sheets preserves the existing vertical offset.
integer
The numeric sheetId of an existing sheet to move the chart to. The chart’s anchor position on that sheet will remain unchanged. This is mutually exclusive with new_sheet and anchor_sheet_id. Use ‘Get Spreadsheet Info’ to retrieve valid sheetIds.
integer
The 0-based row index of the anchor cell for overlay positioning. Required if anchor_sheet_id is set. Must be used together with anchor_column_index.
integer
The 0-based column index of the anchor cell for overlay positioning. Required if anchor_sheet_id is set. Must be used together with anchor_row_index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_MOVE_SPREADSHEET_TO_FOLDERMove an existing Google Spreadsheet to a different Google Drive folder.

Input Parameters

string
required
ID of the existing Google Spreadsheet to move.
string
required
ID of the Google Drive folder that should become the spreadsheet’s parent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_MUTATE_CONDITIONAL_FORMAT_RULESAdd, update, delete, or reorder conditional format rules on a Google Sheet. Use when you need to create, modify, or remove conditional formatting without manually building batchUpdate requests. Supports four operations: ADD (create new rule), UPDATE (replace existing rule), DELETE (remove rule), MOVE (reorder rules by changing index).

Input Parameters

object
Conditional format rule specification.
integer
Zero-based index for the operation. Required for UPDATE, DELETE, MOVE. Optional for ADD (defaults to end of list).
integer
required
The unique numeric identifier of the sheet/tab to modify (NOT a zero-based index). This is a specific ID assigned by Google Sheets when the sheet is created, not the position of the sheet. You MUST first call GOOGLESHEETS_GET_SPREADSHEET_INFO to retrieve the actual sheetId values from the ‘sheets’ array in the response. Common mistake: Do not assume sheet_id=0 exists - while some spreadsheets may have a sheet with ID 0, many do not.
integer
Destination index for MOVE operation. Required when operation is MOVE.
string ("ADD" | "UPDATE" | "DELETE" | "MOVE")
required
Operation type: ADD (add new rule), UPDATE (replace rule), DELETE (remove rule), MOVE (change rule order/index).
string
required
The ID of the spreadsheet containing the sheet to modify. Found in the Google Sheets URL between ‘/d/’ and ‘/edit’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_QUERY_TABLEExecutes SQL-like SELECT queries against detected tables in a native Google spreadsheet, with filtering, sorting, and limits. Sheet names can refer to the first detected table; detection and query processing are heuristic, and results may omit rows. DEPRECATED: Use GOOGLESHEETS_VALUES_GET or GOOGLESHEETS_BATCH_GET for table reads, and GOOGLESHEETS_LOOKUP_SPREADSHEET_ROW for row lookup or filtering.

Input Parameters

string
required
SQL SELECT query. The table name is the Google Sheets tab/sheet name (visible at the bottom of the spreadsheet). Use GOOGLESHEETS_LIST_TABLES to discover available table names if unknown. Supported: SELECT cols FROM table WHERE conditions ORDER BY col LIMIT n. Table names must be quoted with double quotes if they contain spaces or are numeric-only (e.g., SELECT * FROM “My Sheet” or SELECT * FROM “415”).
string
required
The unique identifier of a native Google Sheets file. Found in the spreadsheet URL after /d/ (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’). Only native Google Sheets files (MIME type: application/vnd.google-apps.spreadsheet) are supported. Files uploaded to Google Drive that are not native Google Sheets (such as Excel .xlsx files, PDFs, or Google Docs) will not work even if they can be viewed in Google Sheets.
boolean
Whether to return formula text instead of calculated values for formula columns

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SEARCH_DEVELOPER_METADATATool to search for developer metadata in a spreadsheet. Use when you need to find specific metadata entries based on filters.

Input Parameters

array
required
The data filters describing the criteria used to determine which DeveloperMetadata entries to return.
string
required
The ID of the spreadsheet to retrieve metadata from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SEARCH_SPREADSHEETSSearch for Google spreadsheets accessible in Drive by name, content, dates, and other filters, including starred and shared-with-me status. Results are paginated, with up to 1,000 items per page; shared drives are included by default and searches across them may be incomplete.

Input Parameters

string
Search query to filter spreadsheets. Behavior depends on the ‘search_type’ parameter. For advanced searches, use Google Drive query syntax with fields like ‘name contains’, ‘fullText contains’, or boolean filters like ‘sharedWithMe = true’. DO NOT use spreadsheet IDs as search terms. Leave empty to get all spreadsheets.
string
Sort order (comma-separated list for multi-field sorting). Valid fields: createdTime, folder, modifiedByMeTime, modifiedTime, name, name_natural, quotaBytesUsed, recency, sharedWithMeTime, starred, viewedByMeTime. Append ’ desc’ for descending order (default is ascending). Examples: ‘modifiedTime desc’, ‘folder,name’, ‘starred,modifiedTime desc’.
string
Token for retrieving the next page of results. Use the ‘next_page_token’ value from a previous response to get subsequent pages. Leave empty to get the first page.
integer
Maximum number of spreadsheets to return (1-1000). Defaults to 10.
string ("name" | "content" | "both")
How to search: ‘name’ searches filenames only (prefix matching from the START of filenames), ‘content’ uses fullText search which searches file content, name, description, and metadata (Google Drive API limitation: cannot search content exclusively without also matching filenames), ‘both’ explicitly searches both name OR content with an OR condition. Note: ‘name’ search only matches from the START of filenames (e.g., ‘Budget’ finds ‘Budget 2024’ but NOT ‘Q1 Budget’).
boolean
Whether to return only starred spreadsheets. Defaults to False.
string
Return spreadsheets created after this date. Use RFC 3339 format like ‘2024-01-01T00:00:00Z’.
string
Return spreadsheets modified after this date. Use RFC 3339 format like ‘2024-01-01T00:00:00Z’.
boolean
Whether to return only spreadsheets shared with the current user. Defaults to False.
boolean
Whether to include spreadsheets in trash. Defaults to False.
boolean
Whether to include spreadsheets from shared drives you have access to. Defaults to True.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SET_BASIC_FILTERTool to set a basic filter on a sheet in a Google Spreadsheet. Use when you need to filter or sort data within a specific range on a sheet.

Input Parameters

object
required
The filter to set.
string
required
The ID of the spreadsheet.
array
Limits the ranges included in the response spreadsheet. Meaningful only if includeSpreadsheetInResponse is true.
boolean
True if grid data should be returned. Meaningful only if includeSpreadsheetInResponse is true. Ignored if a field mask was set in the request.
boolean
Determines if the updated spreadsheet resource appears in the response. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SET_DATA_VALIDATION_RULETool to set or clear data validation rules (including dropdowns) on a range in Google Sheets. Use when you need to apply dropdown lists, range-based dropdowns, or custom formula validation to cells.

Input Parameters

string ("SET" | "CLEAR")
required
Operation mode: ‘SET’ applies a validation rule to the range, ‘CLEAR’ removes any existing validation from the range.
boolean
Whether to reject invalid data (true) or show a warning (false). Default is true.
array
List of allowed values for dropdown. Required when validation_type=‘ONE_OF_LIST’. Each item becomes a dropdown option.
string
Custom formula for validation. Required when validation_type=‘CUSTOM_FORMULA’. Formula should evaluate to TRUE/FALSE. Example: ‘=A1>10’.
integer
required
The unique sheet ID (numeric identifier) where the validation rule will be applied. The first sheet created in a spreadsheet typically has ID 0, while additional sheets get unique IDs (e.g., 1534097477). If a sheet is deleted, its ID is never reused - so if the original first sheet (ID 0) was deleted, attempting to use 0 will fail. Always verify the actual sheet ID exists using GOOGLESHEETS_GET_SPREADSHEET_INFO action (check ‘sheets[].properties.sheetId’ field).
integer
required
Ending row index (0-based, exclusive) for the validation range. To apply to row 1 only, use start_row_index=0 and end_row_index=1.
string
Optional message shown to the user when they select the cell. Helpful hint about what values are expected.
boolean
Whether to show a dropdown UI for list-based validation. Default is true. Set to true for dropdown lists.
string
required
The unique identifier of the Google Sheets spreadsheet. Can be found in the spreadsheet URL between ‘/d/’ and ‘/edit’.
string
Source range in A1 notation for dropdown values. Required when validation_type=‘ONE_OF_RANGE’. Example: ‘Sheet1!A1:A10’ or ‘A1:A10’.
integer
required
Starting row index (0-based, inclusive) for the validation range. Row 1 is index 0.
string ("ONE_OF_LIST" | "ONE_OF_RANGE" | "CUSTOM_FORMULA" | "NUMBER_GREATER" | "NUMBER_GREATER_THAN_EQ" | "NUMBER_LESS" | "NUMBER_LESS_THAN_EQ" | "NUMBER_EQ" | "NUMBER_NOT_EQ" | "NUMBER_BETWEEN" | "NUMBER_NOT_BETWEEN" | "TEXT_CONTAINS" | "TEXT_NOT_CONTAINS" | "TEXT_EQ" | "TEXT_NOT_EQ" | "TEXT_IS_EMAIL" | "TEXT_IS_URL" | "DATE_EQ" | "DATE_BEFORE" | "DATE_AFTER" | "DATE_ON_OR_BEFORE" | "DATE_ON_OR_AFTER" | "DATE_BETWEEN" | "DATE_NOT_BETWEEN" | "DATE_NOT_EQ" | "DATE_IS_VALID" | "BLANK" | "NOT_BLANK" | "BOOLEAN")
Type of validation rule to apply. Required when mode=‘SET’. Dropdown types: ‘ONE_OF_LIST’ (dropdown from list), ‘ONE_OF_RANGE’ (dropdown from range). Number validations: ‘NUMBER_GREATER’, ‘NUMBER_GREATER_THAN_EQ’, ‘NUMBER_LESS’, ‘NUMBER_LESS_THAN_EQ’, ‘NUMBER_EQ’, ‘NUMBER_NOT_EQ’, ‘NUMBER_BETWEEN’, ‘NUMBER_NOT_BETWEEN’. Text validations: ‘TEXT_CONTAINS’, ‘TEXT_NOT_CONTAINS’, ‘TEXT_EQ’, ‘TEXT_NOT_EQ’, ‘TEXT_IS_EMAIL’, ‘TEXT_IS_URL’ (Note: TEXT_STARTS_WITH and TEXT_ENDS_WITH are only for conditional formatting, not data validation). Date validations: ‘DATE_EQ’, ‘DATE_BEFORE’, ‘DATE_AFTER’, ‘DATE_ON_OR_BEFORE’, ‘DATE_ON_OR_AFTER’, ‘DATE_BETWEEN’, ‘DATE_NOT_BETWEEN’, ‘DATE_NOT_EQ’, ‘DATE_IS_VALID’. Other: ‘BLANK’, ‘NOT_BLANK’, ‘BOOLEAN’, ‘CUSTOM_FORMULA’.
array
Generic list of condition values for validation types that require specific values (e.g., NUMBER_GREATER requires one value, NUMBER_BETWEEN requires two values, TEXT_CONTAINS requires one value). For simple validations like TEXT_IS_EMAIL, BLANK, NOT_BLANK, BOOLEAN, DATE_IS_VALID, this can be omitted. Each value should be a string that will be parsed by Google Sheets.
integer
required
Ending column index (0-based, exclusive) for the validation range. To apply to column A only, use start_column_index=0 and end_column_index=1.
integer
required
Starting column index (0-based, inclusive) for the validation range. Column A is index 0.
boolean
Whether to apply validation to rows hidden by filters. Default is false. Set to true to ensure validation applies to both visible and filtered rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SHEET_FROM_JSONDEPRECATED: Creates a new Google Spreadsheet and populates its first worksheet from JSON rows; an empty list creates an empty worksheet. Headers use keys from the first row followed by additional keys found in later rows.

Input Parameters

string
required
The desired title for the new Google Spreadsheet.
array
required
A list of dictionaries representing the rows of the sheet. Each dictionary must have the same set of keys, which will form the header row. Values can be strings, numbers, booleans, or null (represented as empty cells). An empty list [] is allowed and will create a spreadsheet with an empty worksheet.
string
required
The name for the first worksheet within the newly created spreadsheet. This name will appear as a tab at the bottom of the sheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SORT_RANGESorts data within a specified range in a Google Sheet based on one or more sort criteria. Use this action when you need to reorder rows in a range by column values, with support for multi-level (cascading) sorts.

Input Parameters

object
required
The range to sort. All cells in this range will be reordered based on the sort specifications.
array
required
The sort order per column. Later specifications are used when values are equal in the earlier specifications (cascading sort). At least one sort specification is required.
array
Limits the ranges included in the response spreadsheet. Meaningful only if includeSpreadsheetInResponse is true.
string
required
The ID of the spreadsheet.
boolean
True if grid data should be returned. Meaningful only if includeSpreadsheetInResponse is true.
boolean
Determines if the updated spreadsheet resource appears in the response. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SPREADSHEETS_SHEETS_COPY_TOTool to copy a single sheet from a spreadsheet to another spreadsheet. Use when you need to duplicate a sheet into a different spreadsheet.

Input Parameters

integer
required
The ID of the sheet to copy.
string
required
The ID of the spreadsheet containing the sheet to copy.
string
required
The ID of the spreadsheet to copy the sheet to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SPREADSHEETS_VALUES_APPENDTool to append values to a spreadsheet. Use when you need to add new data to the end of an existing table in a Google Sheet.

Input Parameters

string
required
A1 notation range used to locate a logical table. New rows are appended after the last row of that table within this range. First call GOOGLESHEETS_GET_SHEET_NAMES with this exact spreadsheet_id and use one of the returned sheet names; sheet names are case-sensitive and default names like ‘Sheet1’ are unsafe guesses. Valid formats: exact sheet name only (e.g., ‘Sales Data’), sheet-qualified column range (e.g., ‘Sales Data!A:D’), or sheet-qualified cell range (e.g., ‘Sales Data!A1:D100’). Do not pass bare ranges like ‘A:F’ or ‘A1:D100’ because they omit the sheet name. If the needed sheet is not returned, create it or ask the user instead of inventing a name. Sheet names with spaces need single quotes (auto-added). IMPORTANT: The append may land in different columns than specified due to API table detection. For strict column placement, use GOOGLESHEETS_SPREADSHEETS_VALUES_UPDATE instead. Always check updates.updatedRange in the response to verify where data was actually written.
array
required
2D array of values to append. Typically, each inner list is a ROW (majorDimension=ROWS). Use null/None for empty cells.
string
required
The spreadsheet ID (typically 44 characters containing letters, numbers, hyphens, and underscores). Found in the URL between /d/ and /edit. NOT the sheet name (tab name) - that belongs in the ‘range’ parameter.
string ("ROWS" | "COLUMNS")
How to interpret the 2D values array. Use ROWS for row-wise data (most common for appends). Use COLUMNS for column-wise data. Example: if A1=1,B1=2,A2=3,B2=4 then majorDimension=ROWS yields [[1,2],[3,4]] and majorDimension=COLUMNS yields [[1,3],[2,4]].
string ("OVERWRITE" | "INSERT_ROWS")
How the input data should be inserted.
string ("RAW" | "USER_ENTERED")
required
How the input data should be interpreted.
boolean
Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
Determines how values in the response should be rendered. The default render option is FORMATTED_VALUE.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
Determines how dates, times, and durations in the response should be rendered. This is ignored if responseValueRenderOption is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SPREADSHEETS_VALUES_BATCH_CLEARTool to clear one or more ranges of values from a spreadsheet. Use when you need to remove data from specific cells or ranges while keeping formatting and other properties intact.

Input Parameters

array
required
The ranges to clear, in A1 notation (e.g., ‘Sheet1!A1:B2’) or R1C1 notation. Each range should be a clean string without surrounding brackets or extra quotes. Valid examples: ‘Sheet1!A1:B2’, ‘A1:Z100’, ‘Sheet1’. Invalid examples: ”[‘Sheet1!A1:B2’]”, ‘[Sheet1!A1]’.
string
required
The ID of the spreadsheet to update. Can be either a spreadsheet ID or a full Google Sheets URL (the ID will be extracted automatically).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_SPREADSHEETS_VALUES_BATCH_GET_BY_DATA_FILTERRetrieves one or more ranges of values from a Google Spreadsheet using data filters. Each filter specifies an A1 range or a grid range.

Input Parameters

array
required
Required. An array of data filter objects used to match ranges of values to retrieve. Each filter can specify either ‘a1Range’ (e.g., ‘Sheet1!A1:B5’) or ‘gridRange’. Must be provided as a list, e.g., [{‘a1Range’: ‘Sheet1!A1:B5’}]. A single filter object will be automatically wrapped in a list.
string
required
The ID of the spreadsheet to retrieve data from. This is the unique identifier found in the spreadsheet URL (e.g., in ‘https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit’, the ID is the SPREADSHEET_ID part). Typical Google Sheets IDs are approximately 44 characters long and contain alphanumeric characters, hyphens, and underscores.
string ("ROWS" | "COLUMNS")
The major dimension that results should use. For example, if the spreadsheet data is: A1=1,B1=2,A2=3,B2=4, then a request that selects that range and sets majorDimension=ROWS returns [[1,2],[3,4]], whereas a request that sets majorDimension=COLUMNS returns [[1,3],[2,4]].
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How values should be represented in the output. The default render option is FORMATTED_VALUE.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
How dates, times, and durations should be represented in the output. This is ignored if valueRenderOption is FORMATTED_VALUE. The default dateTime render option is SERIAL_NUMBER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPDATE_CHARTUpdates an existing chart in a Google Sheets spreadsheet by replacing its chart specification. The specification can change its title, chart type, data ranges, colors, axes, and other visual settings without moving or resizing the chart.

Input Parameters

integer
required
The unique numeric identifier of the chart to update within the spreadsheet. This is the chartId value returned when the chart was created or can be retrieved using the ‘Get Spreadsheet Info’ action (look for sheets[].charts[].chartId in the response). The chart must already exist in the specified spreadsheet.
object
required
The complete ChartSpec object defining the updated chart specification. This replaces the chart’s existing specification but does not move or resize the chart. Must set exactly one chart type field: basicChart, pieChart, bubbleChart, candlestickChart, histogramChart, treemapChart, waterfallChart, orgChart, or scorecardChart. To change chart position or size, use a separate UpdateEmbeddedObjectPosition request. See https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/charts#ChartSpec
string
required
The unique identifier of the Google Sheets spreadsheet containing the chart to update. Must be the actual spreadsheet ID from the URL (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’), NOT the spreadsheet name or title. Find it in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPDATE_DIMENSION_PROPERTIESTool to hide/unhide rows or columns and set row heights or column widths. Use when you need to change visibility or pixel sizing of dimensions in a Google Sheet.

Input Parameters

integer
The numeric ID of the sheet (tab). Either sheet_id or sheet_name must be provided. If both are provided, sheet_name will be resolved to sheet_id and override this value.
string ("ROWS" | "COLUMNS")
required
Whether to update rows or columns.
integer
required
The zero-based end index (exclusive) of the dimension range to update. For example, to update rows 5-9, use start_index=5 and end_index=10.
integer
The height (for rows) or width (for columns) in pixels. Must be a positive integer. At least one of hidden_by_user or pixel_size must be provided.
string
The name of the sheet (tab). If provided, this will be resolved to the numeric sheet_id using GOOGLESHEETS_GET_SPREADSHEET_INFO. Either sheet_id or sheet_name must be provided.
integer
required
The zero-based start index (inclusive) of the dimension range to update. For rows, 0 is the first row; for columns, 0 is column A.
boolean
Whether to hide (true) or unhide (false) the specified rows/columns. At least one of hidden_by_user or pixel_size must be provided.
string
required
The ID of the spreadsheet to update.
array
Limits the ranges included in the response spreadsheet (only if includeSpreadsheetInResponse is true).
boolean
Whether to include grid data in the response (only if includeSpreadsheetInResponse is true).
boolean
Whether to include the updated spreadsheet in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPDATE_SHEET_PROPERTIESTool to update properties of a sheet (worksheet) within a Google Spreadsheet, such as its title, index, visibility, tab color, or grid properties. Use this when you need to modify the metadata or appearance of a specific sheet.

Input Parameters

string
required
The ID of the spreadsheet containing the sheet to update.
array
Limits the ranges included in the response spreadsheet. Meaningful only if includeSpreadsheetInResponse is true. Ranges should be in A1 notation (e.g., ‘Sheet1!A1:B2’).
object
required
The details of the sheet properties to update.
boolean
True if grid data should be returned. Meaningful only if includeSpreadsheetInResponse is true. When true, the response will include cell data for the specified ranges.
boolean
Determines if the update response should include the spreadsheet resource. When true, the response will include the full updated spreadsheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPDATE_SPREADSHEET_PROPERTIESTool to update SPREADSHEET-LEVEL properties such as the spreadsheet’s title, locale, time zone, or auto-recalculation settings. Use when you need to modify the overall configuration of a Google Spreadsheet. NOTE: To update individual SHEET properties (like renaming a specific sheet/tab), use GOOGLESHEETS_UPDATE_SHEET_PROPERTIES instead.

Input Parameters

string
required
Field mask specifying which properties to update (comma-separated for multiple fields). Supports nested paths using dot notation (e.g., ‘iterativeCalculationSettings.maxIterations’) per Protocol Buffers FieldMask specification. The root ‘properties’ is implied and must not be included. Special case: When updating ‘spreadsheetTheme’, use the field mask ‘spreadsheetTheme’ (not nested paths like ‘spreadsheetTheme.primaryFontFamily’) and provide the complete theme object with all required fields. Wildcard ’*’ updates all properties.
object
required
The spreadsheet-level properties to update (e.g., title, locale, timeZone, autoRecalc). At least one field within properties must be set. NOTE: To update individual sheet/tab properties (like renaming a specific sheet), use GOOGLESHEETS_UPDATE_SHEET_PROPERTIES instead.
string
required
The ID of the spreadsheet to update.
array
Limits the ranges included in the response spreadsheet. Only meaningful if includeSpreadsheetInResponse is true. Ranges should be in A1 notation (e.g., ‘Sheet1!A1:B2’).
boolean
Determines if grid data (cell values) should be included in the response. Only meaningful if includeSpreadsheetInResponse is true. When true, the response will include cell data for the specified ranges or entire spreadsheet.
boolean
Determines if the update response should include the full spreadsheet resource. When true, the response will include the entire updated spreadsheet with all sheets, properties, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPDATE_VALUES_BATCHTool to set values in one or more ranges of a spreadsheet. Use when you need to update multiple ranges in a single operation for better performance.

Input Parameters

array
required
The new values to apply to the spreadsheet. Each ValueRange specifies a range and the values to write to that range. Multiple ranges can be updated in a single request.
string
required
The ID of the spreadsheet to update. This ID can be found in the URL of the spreadsheet (e.g., https://docs.google.com/spreadsheets/d/&#123;spreadsheet_id&#125;/edit). Must be a valid Google Sheets spreadsheet ID.
string ("INPUT_VALUE_OPTION_UNSPECIFIED" | "RAW" | "USER_ENTERED")
required
How the input data should be interpreted. RAW: Values are stored exactly as entered, without parsing. USER_ENTERED: Values are parsed as if typed by a user (numbers stay numbers, strings prefixed with ’=’ become formulas, etc.). INPUT_VALUE_OPTION_UNSPECIFIED: Default input value option is not specified.
boolean
Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
Determines how values in the response should be rendered. Only used if includeValuesInResponse is true. FORMATTED_VALUE (default): Values are formatted as displayed in the UI. UNFORMATTED_VALUE: Values are unformatted. FORMULA: Formulas are not evaluated.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
Determines how dates, times, and durations in the response should be rendered. Only used if includeValuesInResponse is true. SERIAL_NUMBER (default): Dates are returned as numbers. FORMATTED_STRING: Dates are returned as formatted strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_UPSERT_ROWSUpserts rows in a Google Sheet by matching a key column: updates matching rows and appends new ones. It maps columns by header name, adds missing columns, and supports partial updates.

Input Parameters

array
required
2D array of data rows to upsert. IMPORTANT: If ‘headers’ is NOT provided, the FIRST row is treated as column headers and remaining rows as data - so you need at least 2 rows (1 header + 1 data). If ‘headers’ IS provided separately, then ALL rows in this array are treated as data rows. Each row should have the same number of values as headers. If a row has MORE values than headers: with strict_mode=true (default), an error is returned showing which rows are affected; with strict_mode=false, extra values are silently truncated. If a row has FEWER values than headers, an error is returned during execution. Cell values can be strings, numbers, booleans, or null. Example with headers provided: headers=[‘Email’,‘Status’], rows=[[‘john@ex.com’,‘Active’]] (1 data row). Example without headers: rows=[[‘Email’,‘Status’],[‘john@ex.com’,‘Active’]] (row 1 = headers, row 2 = data).
array
List of column names for the data. These will be matched against sheet headers. If a column doesn’t exist in the sheet, it will be added automatically. Order doesn’t need to match sheet order. Can be auto-derived from the first row in ‘rows’ if not provided. Example inputs: [‘Email’, ‘Phone’, ‘Status’] for contact updates, [‘Lead ID’, ‘Name’, ‘Score’] for CRM, [‘SKU’, ‘Stock’, ‘Price’] for inventory.
string
The column NAME (header text) to use as unique identifier for matching rows. Must be an actual header name from the sheet (e.g., ‘Email’, ‘Lead ID’, ‘SKU’), NOT a column letter (e.g., ‘A’, ‘B’, ‘C’). If you provide a column letter like ‘A’, it will be automatically converted to the header name at that column position. If neither ‘key_column’ nor ‘key_column_index’ is provided, defaults to the first column (index 0).
string
required
The name of the sheet/tab within the spreadsheet. Note: Google Sheets creates default sheets with localized names based on account language (e.g., ‘Sheet1’ for English, ‘工作表1’ for Chinese, ‘Hoja1’ for Spanish, ‘Feuille1’ for French, ‘Planilha1’ for Portuguese, ‘Лист1’ for Russian). If you specify a common default name and the sheet is not found, the action will automatically use the first sheet if only one exists.
boolean
Controls how rows with mismatched column counts are handled. When True (default), an error is returned if any row has more values than headers - the error message shows exactly which rows are affected and what values would need to be removed. When False, extra values are silently truncated to match the header count. Set to False only if you explicitly want automatic truncation of extra values.
string
Cell where the table starts (where headers are located). Defaults to ‘A1’. Use this if your table is offset (e.g., ‘C5’, ‘D10’).
string
required
The ID of the spreadsheet. Must be a non-empty string, typically a 44-character alphanumeric string found in the spreadsheet URL.
string
The 0-based column index to use as unique identifier for matching rows. Alternative to ‘key_column’ - will be converted to column name using headers. If neither ‘key_column’ nor ‘key_column_index’ is provided, defaults to 0 (first column). Example: 0 for first column, 1 for second column.
string
Internal field to track input normalization (e.g., row truncation). Not part of API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_VALUES_GETReturns a range of values from a spreadsheet. Use when you need to read data from specific cells or ranges in a Google Sheet.

Input Parameters

string
required
The A1 notation or R1C1 notation of the range to retrieve values from. If the sheet name contains spaces or special characters, wrap the sheet name in single quotes (e.g., “‘My Sheet’!A1:B2”). Without single quotes, the API will return a 400 error for sheet names with spaces. Examples: ‘Sheet1!A1:B3’, “‘Sheet With Spaces’!A1:D5”, ‘A1:D5’ (no sheet name uses first visible sheet), ‘Sheet1!A:A’ (entire column), ‘SheetName’ (entire sheet).
integer
1-based row number to stop reading at (inclusive). Use with start_row for pagination to avoid large response errors. Example: start_row=501, end_row=1000 fetches rows 501-1000.
integer
1-based row number to start reading from (inclusive). Use with end_row for pagination to avoid large response errors. Example: start_row=1, end_row=500 fetches the first 500 rows.
string
required
The unique identifier of the Google Spreadsheet from which to retrieve values. This is the long alphanumeric string found in the spreadsheet URL between ‘/d/’ and ‘/edit’ (e.g., ‘1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms’). WARNING: Do NOT use the spreadsheet name or title (e.g., ‘My Sales Report’); you must use the actual ID from the URL.
string ("DIMENSION_UNSPECIFIED" | "ROWS" | "COLUMNS")
The major dimension for results.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How values should be rendered in the output. FORMATTED_VALUE: Values are calculated and formatted (default). UNFORMATTED_VALUE: Values are calculated but not formatted. FORMULA: Values are not calculated; the formula is returned instead.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
How dates, times, and durations should be represented in the output. SERIAL_NUMBER: Dates are returned as serial numbers (default). FORMATTED_STRING: Dates returned as formatted strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLESHEETS_VALUES_UPDATESets or overwrites values in a Google Spreadsheet range, adjusting the range to fit the supplied values and potentially expanding the sheet by default. Unmatched common default sheet names may resolve to the first sheet.

Input Parameters

string
required
The A1 notation of the range to update values in (e.g., ‘Sheet1!A1:C2’, ‘MySheet!C:C’, or ‘A1:D5’). Wrap sheet names containing spaces or special characters in single quotes; escape an apostrophe within a quoted sheet name by doubling it (e.g., ”‘[Draft] Fall”26’!A1:B2”). Must be actual cell references, not placeholder values. If the sheet name is omitted (e.g., ‘A1:B2’), the operation applies to the first visible sheet. IMPORTANT: The range must not exceed the sheet’s grid dimensions. By default, new sheets have 1000 rows and 26 columns (A-Z). If you need to write to columns beyond Z (e.g., AA, AB), first expand the sheet using GOOGLESHEETS_APPEND_DIMENSION or check the current dimensions using GOOGLESHEETS_GET_SPREADSHEET_INFO.
array
required
The data to write. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell.
string
required
The unique identifier of the Google Spreadsheet to update. This ID can be found in the URL of the spreadsheet (e.g., https://docs.google.com/spreadsheets/d/&#123;spreadsheet_id&#125;/edit). Must be a non-empty string.
string ("ROWS" | "COLUMNS")
The major dimension of the values. ROWS (default) means each inner array is a row of values. COLUMNS means each inner array is a column of values. Defaults to ROWS if unspecified.
boolean
If True (default), automatically expands the sheet’s dimensions (adds columns/rows) when the target range exceeds the current grid limits. If False, the operation will fail with an error if the range exceeds grid limits.
string ("RAW" | "USER_ENTERED")
required
How the input data should be interpreted. RAW: Values are stored exactly as entered, without parsing (dates, formulas, etc. remain as strings). USER_ENTERED: Values are parsed as if typed by a user (numbers stay numbers, strings prefixed with ’=’ become formulas, etc.).
boolean
Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values.
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
Determines how values in the response should be rendered. Only used if includeValuesInResponse is true. FORMATTED_VALUE (default): Values are formatted as displayed in the UI. UNFORMATTED_VALUE: Values are unformatted (numbers, booleans, formulas). FORMULA: Formulas are not evaluated and remain as text.
string ("SERIAL_NUMBER" | "FORMATTED_STRING")
Determines how dates, times, and durations in the response should be rendered. Only used if includeValuesInResponse is true. SERIAL_NUMBER (default): Dates are returned as numbers. FORMATTED_STRING: Dates are returned as strings formatted per the cell’s locale.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: GOOGLESHEETS_AGGREGATE_METRIC_CHANGED_TRIGGERType: pollTriggers when an aggregate metric (SUM/COUNT/AVG/MIN/MAX) changes in a Google Sheets spreadsheet. This trigger monitors an aggregate calculation on a target column (optionally filtered by a search column/value) and fires when the calculated result changes.

Configuration

boolean
Whether the search should be case-sensitive when filtering by search_column and search_value.
boolean
Whether the first row contains column headers. If True, column names can be used for search_column and target_column.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The mathematical operation to perform on the target column values. Supported operations: sum, average, count, min, max, percentage.
number
For percentage operation, the total value to calculate percentage against. If not provided, uses sum of all values in target column.
string
The column to search in for filtering rows. Can be a letter (e.g., ‘A’, ‘B’) or column name from header row (e.g., ‘Region’, ‘Department’). If not provided, all rows in the target column will be aggregated without filtering.
string
The exact value to search for in the search column. Case-sensitive by default. If not provided (or if search_column is not provided), all rows in the target column will be aggregated without filtering.
string
required
The name of the specific sheet within the spreadsheet to monitor. Matching is case-insensitive. If no exact match is found, partial matches will be attempted (e.g., ‘overview’ will match ‘Overview 2025’).
string
required
The unique identifier of the Google Sheets spreadsheet to monitor. This is the long alphanumeric string found in the spreadsheet URL between ‘/d/’ and ‘/edit’.
string
required
The column to aggregate data from. Can be a letter (e.g., ‘C’, ‘D’) or column name from header row (e.g., ‘Sales’, ‘Revenue’).

Payload

number
required
The current aggregate metric value
string
required
ISO timestamp when the change was detected
string
Type of event that occurred
integer
required
Number of rows that matched the search condition
string
required
The aggregation operation performed
number
required
The previous aggregate metric value
integer
required
Number of values that were processed in the aggregation
object
required
Details of the search/filter used to select rows prior to aggregation
string
required
The sheet name
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_CELL_RANGE_VALUES_CHANGED_TRIGGERType: pollTriggers when values in a specified A1 range change in Google Sheets. This trigger monitors a specific cell or range of cells and fires when any values change.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The A1 notation of the range to monitor for changes (can be a single cell or multi-cell range). If the sheet name contains spaces or special characters, wrap the sheet name in single quotes.
string
required
The unique identifier of the Google Spreadsheet to monitor. This is the long alphanumeric string found in the spreadsheet URL between ‘/d/’ and ‘/edit’.

Payload

array
required
The current values in the range
string
required
ISO timestamp when the change was detected
string
Type of event that occurred
array
required
The previous values in the range
string
required
The A1 notation of the monitored range
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_CONDITIONAL_FORMAT_RULE_CHANGED_TRIGGERType: pollTriggers when conditional formatting rules change in a Google Spreadsheet. Detects when rules are added, updated, or removed. Uses snapshot-based diffing to detect changes between polls.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Optional filter: monitor only the sheet with this exact numeric sheetId. If not provided, monitors all sheets. If both sheet_title and sheet_id are provided, sheet_id takes precedence.
string
Optional filter: monitor only the sheet with this exact title. If not provided, monitors all sheets.
string
required
The unique identifier of the Google Spreadsheet to monitor for conditional formatting rule changes

Payload

string
required
Type of change: ‘added’, ‘updated’, or ‘removed’
string
required
ISO timestamp when the change was detected
array
required
List of rules that changed
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_DATA_VALIDATION_RULE_CHANGED_TRIGGERType: pollTriggers when data validation rules change (added/updated/removed) in a Google Spreadsheet. Uses snapshot-based diffing to detect changes between polls.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Optional list of A1 ranges to monitor. If omitted, the entire sheet(s) will be monitored.
integer
Optional sheet ID to filter by. If omitted, all sheets will be monitored.
string
Optional sheet title to filter by. If omitted, all sheets will be monitored.
string
required
The unique identifier of the Google Spreadsheet to monitor for data validation rule changes.

Payload

string
required
Type of change: ‘added’, ‘updated’, or ‘removed’
string
required
ISO timestamp when the change was detected
array
required
List of validation rules that changed
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_DEVELOPER_METADATA_CHANGED_TRIGGERType: pollTriggers when developer metadata entries change (new/updated/removed) in a Google Spreadsheet. Uses snapshot-based diffing to detect changes between polls.

Configuration

array
The data filters describing the criteria used to determine which DeveloperMetadata entries to monitor. If not specified, monitors all developer metadata.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to monitor for developer metadata changes.

Payload

string
required
Type of change: ‘created’, ‘updated’, or ‘removed’
string
required
ISO timestamp when the change was detected
array
required
List of metadata items that changed
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_FILTERED_RANGE_VALUES_CHANGED_TRIGGERType: pollPolling trigger that monitors Google Sheets filtered ranges for value changes. Uses snapshot-based diffing to detect when values matching a data filter change. Emits the matched values when changes are detected.

Configuration

array
required
List of data filters specifying which ranges to monitor for changes. Each filter can specify either ‘a1Range’ (e.g., ‘Sheet1!A1:B10’) or ‘gridRange’.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string ("ROWS" | "COLUMNS")
The major dimension that results should use. ROWS returns [[1,2],[3,4]], COLUMNS returns [[1,3],[2,4]]
string
required
The unique identifier of the Google Spreadsheet to monitor
string ("FORMATTED_VALUE" | "UNFORMATTED_VALUE" | "FORMULA")
How values should be represented in the output

Payload

string ("created" | "updated" | "deleted")
required
Type of change detected
string
required
ISO timestamp when the change was detected
array
required
Current values in the range
array
Previous values in the range (None if new)
string
required
The A1 notation or identifier of the range that changed
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_NEW_ROWS_TRIGGERType: pollSimple polling trigger that monitors Google Sheets for new rows. Detects when new rows are added and returns the complete row data. Perfect for triggering any workflow based on new sheet entries.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
The name of the specific sheet within the spreadsheet to monitor
string
required
The unique identifier of the Google Spreadsheet to monitor
integer
The row number to start monitoring from (1-indexed, typically 2 to skip headers)

Payload

string
required
ISO timestamp when the row was detected
array
required
Complete row data as list of strings
integer
required
The row number in the sheet (1-indexed)
string
required
The sheet name
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_NEW_SHEET_ADDED_TRIGGERType: pollPolling trigger that detects when a new sheet is added to a Google Spreadsheet.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to monitor

Payload

string
required
ISO timestamp when the new sheet was detected
string
required
The name of the new sheet added
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_NEW_SPREADSHEET_CREATED_TRIGGERType: pollTriggers when a new Google Spreadsheet is created. This trigger monitors Google Spreadsheets and fires when new spreadsheets are detected. Uses timestamp filtering to efficiently detect newly created spreadsheets.

Configuration

boolean
Whether to include spreadsheets from shared drives you have access to. Defaults to True.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of spreadsheets to check in each poll (1-1000)
string
Optional search query to filter spreadsheets. Can search by name (name contains ‘Budget’), full text content (fullText contains ‘sales’), or use complex queries with operators. Leave empty to monitor all spreadsheets.

Payload

string
Type of event that occurred
object
required
The newly created Google Spreadsheet
Slug: GOOGLESHEETS_SPREADSHEET_METADATA_CHANGED_TRIGGERType: pollPolling trigger that detects when a Google Spreadsheet’s metadata changes. Uses snapshot-based diffing to detect any changes in spreadsheet properties, sheets, named ranges, developer metadata, data sources, etc.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to monitor for metadata changes

Payload

array
required
List of metadata changes detected
object
required
Current metadata snapshot
string
required
ISO timestamp when the change was detected
string
required
The spreadsheet ID
string
URL to view the spreadsheet
Slug: GOOGLESHEETS_SPREADSHEET_PROPERTIES_CHANGED_TRIGGERType: pollPolling trigger that detects when a Google Spreadsheet’s top-level properties change. Monitors properties such as title, locale, timeZone, and autoRecalc settings.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to monitor for property changes

Payload

array
required
List of properties that changed
string
required
ISO timestamp when the change was detected
string
required
The spreadsheet ID
string
URL to view the spreadsheet
Slug: GOOGLESHEETS_SPREADSHEET_ROW_CHANGED_TRIGGERType: pollTriggers when a looked-up spreadsheet row changes. This trigger monitors a specific row (located by searching for a query value within a user-specified range) and fires when the row’s values change, when the row appears, or when the row disappears.

Configuration

boolean
If True, the query string search is case-sensitive.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
boolean
If True, strips leading and trailing whitespace from cell values before matching. This helps match cells like ’ TOTAL ’ or ‘TOTAL ’ when searching for ‘TOTAL’.
string
required
Exact text value to find; matches the entire content of a cell in a row.
string
A1 notation range to search within. Supports cell ranges (e.g., ‘Sheet1!A1:D5’), column-only ranges (e.g., ‘Sheet1!A:Z’), and row-only ranges (e.g., ‘Sheet1!1:1’). Defaults to the first sheet if omitted. IMPORTANT: Sheet names with spaces must be single-quoted (e.g., “‘My Sheet’!A1:Z”). Bare sheet names without ranges (e.g., ‘Sheet1’) are not supported - always specify a range.
string
required
Identifier of the Google Spreadsheet to monitor.

Payload

string
required
Type of change: ‘created’ (row appeared), ‘updated’ (row values changed), or ‘deleted’ (row disappeared)
string
required
The current row data (empty dict if row is not found now)
string
required
ISO timestamp when the change was detected
string
Type of event that occurred
string
required
The previous row data (empty dict if row was not found before)
string
required
The query used to find the row
string
The A1 notation range that was searched
string
required
The spreadsheet ID
Slug: GOOGLESHEETS_SPREADSHEET_SEARCH_MATCH_TRIGGERType: pollTriggers when a new spreadsheet appears that matches a saved search. This trigger uses snapshot-based diffing to detect when spreadsheets matching the search criteria are newly created or become visible to the user.

Configuration

string
Return spreadsheets created after this date. Use RFC 3339 format like ‘2024-01-01T00:00:00Z’.
boolean
Whether to include spreadsheets from shared drives you have access to. Defaults to True.
boolean
Whether to include spreadsheets in trash. Defaults to False.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of spreadsheets to check in each poll (1-100)
string
Return spreadsheets modified after this date. Use RFC 3339 format like ‘2024-01-01T00:00:00Z’.
string
Order results by field. Common options: ‘modifiedTime desc’, ‘modifiedTime asc’, ‘name’, ‘createdTime desc’
string
Search query to filter spreadsheets. Behavior depends on the ‘search_type’ parameter. For advanced searches, use Google Drive query syntax with fields like ‘name contains’, ‘fullText contains’, or boolean filters like ‘sharedWithMe = true’. DO NOT use spreadsheet IDs as search terms. Leave empty to get all spreadsheets.
string ("name" | "content" | "both")
How to search: ‘name’ searches filenames only (prefix matching from the START of filenames), ‘content’ uses fullText search which searches file content, name, description, and metadata, ‘both’ explicitly searches both name OR content with an OR condition.
boolean
Whether to return only spreadsheets shared with the current user. Defaults to False.
boolean
Whether to return only starred spreadsheets. Defaults to False.

Payload

string
Type of event that occurred
object
required
The spreadsheet that matches the search criteria
Slug: GOOGLESHEETS_TABLE_QUERY_RESULT_CHANGED_TRIGGERType: pollTriggers when the result set of a saved table query changes in Google Sheets. Detects rows added, removed, or updated in the query output. This trigger monitors the result of a SQL query against a Google Sheets table and fires when changes are detected.

Configuration

boolean
Whether to return formula text instead of calculated values for formula columns
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to query. This is the long alphanumeric string found in the spreadsheet URL between ‘/d/’ and ‘/edit’.
string
required
SQL SELECT query to execute. The table name is the Google Sheets tab/sheet name (visible at the bottom of the spreadsheet). Supported: SELECT cols FROM table WHERE conditions ORDER BY col LIMIT n. Table names must be quoted with double quotes if they contain spaces or are numeric-only (e.g., SELECT * FROM “My Sheet” or SELECT * FROM “415”).

Payload

array
required
List of detected changes
string
required
ISO timestamp when the change was detected
string
Type of event that occurred
string
required
The spreadsheet ID
string
required
The SQL query that was executed
integer
required
Total number of rows after the change
integer
required
Total number of rows before the change
Slug: GOOGLESHEETS_TABLE_SCHEMA_CHANGED_TRIGGERType: pollPolling trigger that detects when a table’s schema changes in Google Sheets. Monitors columns added/removed/renamed and inferred type/format changes. Uses snapshot-based diffing to compare schemas between polls.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Number of rows to sample for type inference
string
Sheet/tab name if table_name is ambiguous across multiple sheets
string
required
The unique identifier of the Google Spreadsheet to monitor
string
required
Table name from LIST_TABLES response OR the visible Google Sheets tab name. Use ‘auto’ to monitor the largest/most prominent table.

Payload

string
required
Human-readable summary of the changes
array
required
List of column changes detected
integer
required
Number of columns in current schema
string
required
ISO timestamp when the change was detected
integer
required
Number of columns in previous schema
string
required
Sheet name where table is located
string
required
The spreadsheet ID
string
required
Name of the table that changed
Slug: GOOGLESHEETS_WORKSHEET_NAMES_CHANGED_TRIGGERType: pollTriggers when the set of worksheet/tab names changes in a Google Spreadsheet. Detects when sheets are added, deleted, or renamed.

Configuration

number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
The unique identifier of the Google Spreadsheet to monitor

Payload

string
required
Type of change: ‘added’, ‘deleted’, or ‘renamed’
array
required
Current list of all worksheet names after the change
string
required
ISO timestamp when the change was detected
string
Previous name if worksheet was renamed (only for renamed events)
string
required
The spreadsheet ID
string
required
The name of the worksheet that was added, deleted, or involved in the change