New Updates from Google Sheets API

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

Trigger workflow on

New Updates from the Google Sheets API

Next, do this

Connect to 3,000+ APIs using code and no-code building blocks

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#

Trigger a workflow on New Updates with Google Sheets API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Updates trigger
1. Connect your Google Sheets account
2. Configure timer
3. Configure alert
4. Optional- Select a Drive
5. Select a Spreadsheet ID
6. Select one or more Worksheet ID(s)
7. Optional- Configure Monitoring Range
Add steps to connect to 3,000+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

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.

New Updates on Google Sheets

Description:Emit new event each time a row or cell is updated in a spreadsheet.

Version:0.0.1

Key:google_sheets-new-updates-polling

View on GitHub

Code#

import googleSheets from "../../google_sheets.app.mjs";
import common from "../common/new-updates.mjs";
import base from "../common/http-based/base.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  ...common,
  key: "google_sheets-new-updates-polling",
  name: "New Updates",
  description: "Emit new event each time a row or cell is updated in a spreadsheet.",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  props: {
    googleSheets,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    alert: {
      type: "alert",
      alertType: "info",
      content: "**Important**: If your sheet has more than 1000 rows, please set the **Monitoring Range** below to avoid performance issues and potential disruptions. Example: `A1:Z1000` to monitor the first 1000 rows with columns A through Z.",
    },
    watchedDrive: {
      propDefinition: [
        googleSheets,
        "watchedDrive",
      ],
      description: "Defaults to My Drive. To select a [Shared Drive](https://support.google.com/a/users/answer/9310351) instead, select it from this list.",
    },
    sheetID: {
      propDefinition: [
        googleSheets,
        "sheetID",
        (c) => ({
          driveId: googleSheets.methods.getDriveId(c.watchedDrive),
        }),
      ],
    },
    worksheetIDs: {
      propDefinition: [
        googleSheets,
        "worksheetIDs",
        (c) => ({
          sheetId: c.sheetID,
        }),
      ],
      type: "integer[]",
      label: "Worksheet ID(s)",
      description: "Select one or more worksheet(s), or provide an array of worksheet IDs.",
    },
    monitoringRange: {
      type: "string",
      label: "Monitoring Range",
      description: "The A1 notation range to monitor for changes (e.g., `A1:B100` or `Sheet1!A1:Z1000`). If not specified, the entire sheet will be monitored up to 10000 rows. **Recommended for sheets with more than 1000 rows**.",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    ...common.methods,
    getMonitoringRange() {
      return this.monitoringRange;
    },
    getRowCount(newValues, oldValues) {
      return Math.max(newValues.length, oldValues?.length || 0);
    },
    getColCount(newValues, oldValues, i) {
      let colCount = 0;
      if (
        typeof newValues[i] === "undefined" &&
        typeof oldValues?.[i] !== "undefined"
      )
        colCount = oldValues[i].length;
      else if (
        typeof oldValues?.[i] === "undefined" &&
        typeof newValues[i] !== "undefined"
      )
        colCount = newValues[i].length;
      else if (newValues[i] && oldValues?.[i])
        colCount =
          newValues[i].length > oldValues[i].length
            ? newValues[i].length
            : oldValues[i].length;
      return colCount;
    },
    getContentChanges(colCount, newValues, oldValues, changes, i) {
      // loop through comparing the values of each cell
      for (let j = 0; j < colCount; j++) {
        let newValue =
          typeof newValues[i] !== "undefined" &&
          typeof newValues[i][j] !== "undefined"
            ? newValues[i][j]
            : "";
        let oldValue =
          typeof oldValues?.[i] !== "undefined" &&
          typeof oldValues[i][j] !== "undefined"
            ? oldValues[i][j]
            : "";
        if (newValue !== oldValue) {
          changes.push({
            cell: `${this.indexToColumnLabel(j)}:${i + 1}`,
            previous_value: oldValue,
            new_value: newValue,
          });
        }
      }
      return changes;
    },
    async takeSheetSnapshot(offset = 0) {
      const sheetId = this.getSheetId();

      // If monitoring range is specified, use it to get values
      if (this.monitoringRange) {
        const currentValues = await this.googleSheets.getSpreadsheetValues(
          sheetId,
          this.monitoringRange,
        );

        // Get the worksheet ID from the spreadsheet
        const spreadsheet = await this.googleSheets.getSpreadsheet(sheetId);
        const worksheet = spreadsheet.sheets[0]; // Use first worksheet or extract from range
        const worksheetId = worksheet.properties.sheetId;

        const values = currentValues.values || [];
        const offsetLength = Math.max(values.length - offset, 0);
        const offsetValues = values.slice(0, offsetLength);
        const baseId = `${sheetId}${worksheetId}`;
        this._setBatchedSheetValues(baseId, offsetValues);
      } else {
        // Fall back to default behavior
        return common.methods.takeSheetSnapshot.call(this, offset);
      }
    },
    async getContentDiff(spreadsheet, worksheet) {
      const sheetId = this.getSheetId();
      const baseId = `${spreadsheet.spreadsheetId}${worksheet.properties.sheetId}`;
      const oldValues = this._getBatchedSheetValues(baseId) || null;

      // Use monitoring range if specified, otherwise use worksheet title
      const range = this.monitoringRange
        ? this.monitoringRange
        : worksheet.properties.title;

      const currentValues = await this.googleSheets.getSpreadsheetValues(
        sheetId,
        range,
      );
      return {
        oldValues,
        currentValues,
      };
    },
  },
  hooks: {
    async deploy() {
      await this.takeSheetSnapshot();
    },
  },
  async run() {
    const spreadsheet = await this.googleSheets.getSpreadsheet(this.sheetID);
    return this.processSpreadsheet(spreadsheet);
  },
};

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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Drive	`watchedDrive`	`string`	Select a value from the drop down menu.
Spreadsheet ID	`sheetID`	`string`	Select a value from the drop down menu.
Worksheet ID(s)	`worksheetIDs`	`integer[]`	Select a value from the drop down menu.
Monitoring Range	`monitoringRange`	`string`	The A1 notation range to monitor for changes (e.g., `A1:B100` or `Sheet1!A1:Z1000`). If not specified, the entire sheet will be monitored up to 10000 rows. Recommended for sheets with more than 1000 rows.

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