Add Protected Range with Google Sheets API

Pipedream makes it easy to connect APIs for Google Sheets and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Protected Range with the Google Sheets API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Add Protected Range with the Google Sheets API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Protected Range action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet ID
4. Select a Worksheet ID
5. Optional- Configure Protected Range ID
6. Configure Range
7. Optional- Configure Description
8. Optional- Configure Requesting User Can Edit
9. Optional- Configure Protectors
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Protected Range with Google Sheets API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Sheets

Try it

Add Protected Range with Google Sheets API on New Submission from Typeform API

Typeform + Google Sheets

Try it

Add Protected Range with Google Sheets API on New Submission (Instant) from Jotform API

Jotform + Google Sheets

Try it

Add Protected Range with Google Sheets API on New Download Counts from npm API

npm + Google Sheets

Try it

Add Protected Range with Google Sheets API on New Activity Created Event from Strava API

Strava + Google Sheets

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Protected Range on Google Sheets

Description:Add edit protection to cell range with permissions. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#AddProtectedRangeRequest)

Version:0.0.1

Key:google_sheets-add-protected-range

View on GitHub

Code#

import googleSheets from "../../google_sheets.app.mjs"; export default { key: "google_sheets-add-protected-range", name: "Add Protected Range", description: "Add edit protection to cell range with permissions. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#AddProtectedRangeRequest)", version: "0.0.1", type: "action", annotations: { destructiveHint: false, openWorldHint: true, readOnlyHint: false, }, props: { googleSheets, drive: { propDefinition: [ googleSheets, "watchedDrive", ], }, sheetId: { propDefinition: [ googleSheets, "sheetID", (c) => ({ driveId: googleSheets.methods.getDriveId(c.drive), }), ], }, worksheetId: { propDefinition: [ googleSheets, "worksheetIDs", (c) => ({ sheetId: c.sheetId, }), ], }, protectedRangeId: { type: "integer", label: "Protected Range ID", description: "The ID of the protected range (required for update and delete operations). This is a unique identifier assigned by Google Sheets", optional: true, }, range: { propDefinition: [ googleSheets, "range", ], description: "The range of cells to protect (e.g., `A1:A10`). Required for add and update operations", }, description: { type: "string", label: "Description", description: "A description of the protected range", optional: true, }, requestingUserCanEdit: { type: "boolean", label: "Requesting User Can Edit", description: "If true, the user making this request can edit the protected range", optional: true, default: false, }, protectors: { type: "string[]", label: "Protectors", description: "Email addresses of users/groups who can edit the protected range (e.g., user@example.com)", optional: true, }, }, async run({ $ }) { const { startCol, endCol, startRow, endRow, } = this.googleSheets._parseRangeString(`${this.worksheetId}!${this.range}`); const request = { spreadsheetId: this.sheetId, requestBody: { requests: [ { addProtectedRange: { protectedRange: { protectedRangeId: this.protectedRangeId, range: { sheetId: this.worksheetId, startRowIndex: startRow, endRowIndex: endRow, startColumnIndex: startCol.charCodeAt(0) - 65, endColumnIndex: endCol.charCodeAt(0) - 64, }, description: this.description, requestingUserCanEdit: this.requestingUserCanEdit, editors: { users: this.protectors || [], }, }, }, }, ], }, }; const response = await this.googleSheets.batchUpdate(request); $.export("$summary", "Successfully added protected range."); return response; }, };

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Spreadsheet ID	`sheetId`	`string`	Select a value from the drop down menu.
Worksheet ID	`worksheetId`	`integer`	Select a value from the drop down menu.
Protected Range ID	`protectedRangeId`	`integer`	The ID of the protected range (required for update and delete operations). This is a unique identifier assigned by Google Sheets
Range	`range`	`string`	The range of cells to protect (e.g., `A1:A10`). Required for add and update operations
Description	`description`	`string`	A description of the protected range
Requesting User Can Edit	`requestingUserCanEdit`	`boolean`	If true, the user making this request can edit the protected range
Protectors	`protectors`	`string[]`	Email addresses of users/groups who can edit the protected range (e.g., user@example.com)

Authentication#

Google Sheets uses OAuth authentication. When you connect your Google Sheets account, Pipedream will open a popup window where you can sign into Google Sheets and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Sheets API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drive