View as Markdown
Google Sheets icon

Google Sheets ACTION

Add Protected Range

Add edit protection to cell range with permissions. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Sheets account once, then configure and run Add Protected Range from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_sheets-add-protected-range",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_sheets: { authProvisionId: "apn_xxxxxxx" },
    drive: "Drive",
    sheetId: "Spreadsheet ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Protected Range inputs
Property Type Description
drive Drive string
Select a specific drive to search. Defaults to All Drives (My Drive and all Shared Drives you have access to) when no selection is made. To limit to your personal drive or a Shared Drive, select it from this list.
Optional Dynamic
sheetId Spreadsheet ID string
Select a spreadsheet or provide a spreadsheet ID
Required Dynamic
worksheetId Worksheet ID integer
Select a worksheet or provide a worksheet ID
Required Dynamic
protectedRangeId Protected Range ID integer
The ID of the protected range (required for update and delete operations). This is a unique identifier assigned by Google Sheets
Optional
range Range string
The range of cells to protect (e.g., A1:A10). Required for add and update operations
Required
description Description string
A description of the protected range
Optional
requestingUserCanEdit Requesting User Can Edit boolean
If true, the user making this request can edit the protected range
Optional
protectors Protectors string[]
Email addresses of users/groups who can edit the protected range (e.g., user@example.com)
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_sheets-add-protected-range
Version
0.0.4
App
Google Sheets
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes