@zapier/google-sheets-connector
v0.3.4
Published
Agent-callable Google Sheets tools — read and write spreadsheet data as rows or raw cells, manage worksheets and columns, and apply formatting, sorting, and validation. Use when the user mentions Google Sheets or wants to read, add, update, look up, or or
Maintainers
Readme
@zapier/google-sheets-connector
Agent-callable Google Sheets tools that operate on the data inside a spreadsheet. It wraps the Google Sheets API v4 (with spreadsheet discovery via the Google Drive API) and exposes two surfaces: a record surface — rows as objects keyed by their column headers, for "log this row", "update the status", "look up the customer" jobs — and a cell surface — raw A1-addressed values for formulas, precise numeric/text control, and arbitrary ranges. It also manages spreadsheet/worksheet structure and presentation (formatting, sorting, validation). Auth is Google OAuth 2.0 — recommended via a Zapier-managed connection (which also handles token refresh).
Independent, unofficial connector for Google Sheets. Not affiliated with, endorsed by, or sponsored by Google Sheets. "Google Sheets" is a trademark of its owner, used only to identify the service this connector works with.
When to use this
- An agent needs to read, search, or write data inside a Google spreadsheet — append/update rows, look up a record by a column value, read or write specific cells or ranges, or pull a window of rows.
- An agent needs to manage spreadsheet structure — create a spreadsheet, add/copy/rename/delete worksheets, add columns — or apply formatting, sorting, and validation.
When NOT to use this
- File-level Drive operations (move, share, set permissions, trash a whole spreadsheet) — use a Google Drive tool; this connector operates on spreadsheet contents, not the file.
- Charts, pivot tables, named/protected ranges, or filters — not exposed by this connector.
- Event triggers ("when a new row is added…") — connectors are non-trigger; use a Zapier trigger for change detection.
Install
This connector is the same artifact across four shapes: MCP server, CLI bin, importable Node module, and an Agent Skill anchored by SKILL.md. Pick the shape that matches how your agent runs.
# Run a script with zero install — npx fetches the package on first use
export <ENV_VAR>=xxx
npx @zapier/google-sheets-connector@latest run <script> '<input-json>' --connection env:<ENV_VAR>
# Install as a dependency to import the functions in your own code
npm install @zapier/google-sheets-connector
# Or install as an Agent Skill (https://agentskills.io)
npx skills add zapier/connectors --skill google-sheetsAuth is one [<resolver>:]<value> connection string passed with --connection — a selector, not the secret. The <resolver>: prefix is optional; a bare value is claimed by the first matching resolver. See Auth below for the with/without-Zapier tradeoffs and how to find a connection ID.
MCP server
Run the connector as an MCP server over stdio so any MCP-aware client (Claude Desktop, Cursor, Claude Code, …) auto-discovers the scripts as tools — add one stanza to the client's config:
// e.g. claude_desktop_config.json or .cursor/mcp.json
{
"mcpServers": {
"google-sheets": {
"command": "npx",
"args": ["@zapier/google-sheets-connector", "mcp"]
}
}
}--connection is optional — omit it to pass a connection per tool call, or add "--connection", "zapier:<connection-id>" (or "env:<ENV_VAR>" with "env": { "<ENV_VAR>": "xxx" }) to args to set a default.
Cloning the source
You don't need to clone anything to use this connector — the options above already cover that. Want the actual repo source instead, to read the script code, browse references/, run this connector's tests, or hack on it? Clone with a path filter so you only fetch this one connector, not the whole catalog:
git clone --filter=blob:none --sparse https://github.com/zapier/connectors.git
cd connectors && git sparse-checkout set apps/google-sheets
cd apps/google-sheets && npm installSee the main README to clone several connectors at once.
Scripts
| Script | Description |
| ------------ | ----------------------------------------------------------------------- |
| createRow | Append a single row, given values keyed by column header. |
| createRows | Append multiple rows in one batched call. |
| updateRow | Update specific columns of a row by row number (other cells preserved). |
| updateRows | Update multiple rows (each by row number) in one batched call. |
| lookupRow | Find the first row where a column matches a value. |
| findRows | Find all rows matching a column/value filter (bounded). |
| listRows | Read a window of rows as records. |
| clearRows | Clear the contents of specific rows (rows stay). |
| deleteRows | Delete specific rows; everything below shifts up. |
Cells — raw A1 values
| Script | Description |
| -------------- | -------------------------------------------------------- |
| getValues | Read a raw cell range in A1 notation. |
| updateValues | Write values to a raw cell range (RAW or USER_ENTERED). |
| clearValues | Clear the values in a raw cell range (formatting stays). |
Spreadsheets & worksheets
| Script | Description |
| --------------------------- | ---------------------------------------------------------------------- |
| createSpreadsheet | Create a new spreadsheet, optionally with worksheets and a header row. |
| getSpreadsheet | Get a spreadsheet's metadata and worksheet list. |
| listSpreadsheets | Find spreadsheets in Drive by name. |
| addWorksheet | Add a worksheet (tab), optionally with a header row. |
| listWorksheets | List the worksheets in a spreadsheet. |
| copyWorksheet | Copy a worksheet into another spreadsheet. |
| updateWorksheetProperties | Rename, move, freeze, hide, or recolor a worksheet. |
| deleteWorksheet | Permanently delete a worksheet and its data. |
| addColumn | Insert a column, optionally with a header label. |
Formatting & ranges
| Script | Description |
| -------------------------- | ----------------------------------------------------------------- |
| formatCells | Apply number/date/currency formatting or text styling to a range. |
| sortRange | Sort a range by one or more columns. |
| copyRange | Copy a range (values + formatting) to another location. |
| setDataValidation | Set a dropdown / number / date validation rule on a range. |
| addConditionalFormatRule | Add a conditional-formatting rule to a range. |
Run npx @zapier/google-sheets-connector@latest run <script> --help to see any script's exact input contract + the available resolvers.
Usage
Each named export is the consumer-facing (input, opts) => Promise<{ data, meta }> function. Pass auth as one [<resolver>:]<value> string, e.g. { connection: "env:<ENV_VAR>" }.
import { lookupRow } from "@zapier/google-sheets-connector";
// Each named export is the consumer-facing (input, opts) => Promise<{ data, meta }>.
const { data } = await lookupRow(
{
spreadsheet: "https://docs.google.com/spreadsheets/d/1AbC.../edit",
worksheet: "Sheet1",
column: "Email",
value: "[email protected]",
},
{ connection: "zapier:<connection-id>" }, // or "env:GOOGLE_SHEETS_ACCESS_TOKEN"
);
// data => { found: true, row_number: 12, values: { Name: "Sam", Email: "[email protected]", ... } }Every script returns a { data, meta } envelope; meta.outputDataValidation reports what output validation did. Pass { skipOutputDataValidation: true } in the run options for the raw, unvalidated result. See SKILL.md.
Auth
Already have a connection value? Pass it as shown above — --connection for the CLI/MCP shapes, { connection } for imported functions. No connection yet? Pick one:
| | Load |
| ------------------------------------ | ---------------------------------------------------------------------- |
| Pass the credential directly | references/use-without-zapier.md |
| Route it through a Zapier connection | references/use-with-zapier.md |
Links
- Google Sheets API reference — the upstream API this connector wraps
Legal
Scope of license. Zapier licenses only the connector code in this package. Zapier grants no rights in Google Sheets's API, services, data, schemas, documentation, or other materials, which remain the property of Google Sheets. Your use of Google Sheets's API is governed by your own agreement with Google Sheets.
Trademarks and affiliation. Google Sheets and its logos are trademarks of their owner, used here only to identify the service this connector works with. This connector is not affiliated with, endorsed by, or sponsored by Google Sheets.
Your responsibility. This connector calls Google Sheets's API using credentials you supply. You are responsible for holding a valid Google Sheets account, for complying with Google Sheets's API terms, developer policies, and acceptable use rules, and for the data you send and receive through it.
No warranty. This connector is provided "as is," without warranty of any kind, and is not an official Google Sheets product. Zapier is not responsible for changes Google Sheets makes to its API or for any consequence of your use of Google Sheets's API. See the repository LICENSE for the full disclaimer.
Forks. You may fork and modify this connector under the Elastic License 2.0. You may state that your fork is "based on" Zapier's connector, but you may not use the "Zapier" name or logo as the name or branding of your fork, or in any way that suggests Zapier produces, endorses, or supports it.
Licensed under the Elastic License 2.0. See the repository LICENSE and NOTICE.
