Clear Rows with Google Sheets API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Clear Rows 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 Clear Rows with the Google Sheets API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Clear Rows action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet
4. Select a Worksheet Id
5. Configure Start Index
6. Optional- Configure End Index
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#

Clear Rows with Google Sheets API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Sheets

Try it

Clear Rows with Google Sheets API on New Submission from Typeform API

Typeform + Google Sheets

Try it

Clear Rows with Google Sheets API on New Submission (Instant) from Jotform API

Jotform + Google Sheets

Try it

Clear Rows with Google Sheets API on New Scheduled Tasks from Pipedream API

Pipedream + Google Sheets

Try it

Clear Rows with Google Sheets API on npm Download Counts from npm API

npm + 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.

Clear Rows on Google Sheets

Description:Delete the content of a row or rows in a spreadsheet. Deleted rows will appear as blank rows. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/clear)

Version:0.1.8

Key:google_sheets-clear-rows

View on GitHub

Code#

import common from "../common/worksheet.mjs";

const { googleSheets } = common.props;

export default {
  ...common,
  key: "google_sheets-clear-rows",
  name: "Clear Rows",
  description: "Delete the content of a row or rows in a spreadsheet. Deleted rows will appear as blank rows. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/clear)",
  version: "0.1.8",
  type: "action",
  props: {
    googleSheets,
    drive: {
      propDefinition: [
        googleSheets,
        "watchedDrive",
      ],
      description: "The drive containing the spreadsheet to edit. If you are connected with any [Google Shared Drives](https://support.google.com/a/users/answer/9310351), you can select it here.",
    },
    sheetId: {
      propDefinition: [
        googleSheets,
        "sheetID",
        (c) => ({
          driveId: googleSheets.methods.getDriveId(c.drive),
        }),
      ],
    },
    worksheetId: {
      propDefinition: [
        googleSheets,
        "worksheetIDs",
        (c) => ({
          sheetId: c.sheetId,
        }),
      ],
      type: "string",
      label: "Worksheet Id",
    },
    startIndex: {
      type: "integer",
      label: "Start Index",
      description: "Row number of the start (inclusive) of the range of rows to clear",
    },
    endIndex: {
      type: "integer",
      label: "End Index",
      description: "Row number of the end (exclusive) of the range of rows to clear",
      optional: true,
    },
  },
  async run() {
    const worksheet = await this.getWorksheetById(this.sheetId, this.worksheetId);
    const request = {
      spreadsheetId: this.sheetId,
      range: `${worksheet?.properties?.title}!${this.startIndex}:${this.endIndex || this.startIndex}`,
    };
    return await this.googleSheets.clearSheetValues(request);
  },
};

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	`sheetId`	`string`	Select a value from the drop down menu.
Worksheet Id	`worksheetId`	`string`	Select a value from the drop down menu.
Start Index	`startIndex`	`integer`	Row number of the start (inclusive) of the range of rows to clear
End Index	`endIndex`	`integer`	Row number of the end (exclusive) of the range of rows to clear

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