Upsert Row with Google Sheets API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Upsert Row action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet ID
4. Select a Worksheet ID
5. Configure Insert - Cells / Column Values
6. Configure Key Column
7. Optional- Configure Key Value
8. Optional- Configure Update - Column / Values
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#

Upsert Row with Google Sheets API on New Record from Knack API

Knack + Google Sheets

Try it

Upsert Row with Google Sheets API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Sheets

Try it

Upsert Row with Google Sheets API on New Item in Feed from RSS API

RSS + Google Sheets

Try it

Upsert Row with Google Sheets API on New Message from Discord API

Discord + Google Sheets

Try it

Upsert Row with Google Sheets API on New Message In Channels (Instant) from Slack (legacy) API

Slack (legacy) + 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.

Upsert Row on Google Sheets

Description:Upsert a row of data in a Google Sheet. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)

Version:0.1.17

Key:google_sheets-upsert-row

View on GitHub

Code#

import { v4 as uuid } from "uuid";
import common from "../common/worksheet.mjs";
import { VALUE_RENDER_OPTION } from "../../common/constants.mjs";
import {
  omitEmptyKey, toSingleLineString,
} from "../../common/utils.mjs";

const { googleSheets } = common.props;

/**
 * This action performs an upsert operation, similar to the MySQL `INSERT INTO ... ON DUPLICATE KEY
 * UPDATE` operation, on a Google Spreadsheet. If a row in the spreadsheet has `value` in `column`
 * (i.e., a duplicated key), that row is updated. Otherwise, a new row is appended to the
 * spreadsheet.
 *
 * To determine if and where a duplicate key exists in the spreadsheet, this action uses [Google
 * Sheet's `MATCH` function](https://support.google.com/docs/answer/3093378) in a new temporary
 * hidden worksheet. Uses roughly the method described in [this stackoverflow
 * answer](https://stackoverflow.com/a/49439220) and [this GitHub
 * comment](https://github.com/PipedreamHQ/pipedream/issues/1824#issuecomment-949940177).
 */
export default {
  ...common,
  key: "google_sheets-upsert-row",
  name: "Upsert Row",
  description: "Upsert a row of data in a Google Sheet. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)",
  version: "0.1.17",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  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,
        }),
      ],
    },
    insert: {
      propDefinition: [
        googleSheets,
        "cells",
      ],
      label: "Insert - Cells / Column Values",
      description: toSingleLineString(`
        Insert statement: the row data you want to add to the Google sheet if the key *doesn't*
        exist. If the key *does* exist and **Update** is not set, the row will be updated using
        this array.
        Enter individual cell values or enter a custom expression to pass an
        array with each element representing a cell/column value (e.g. \`{{ [5, "test"] }}\`).
      `),
    },
    column: {
      propDefinition: [
        googleSheets,
        "column",
      ],
      label: "Key Column",
      description: "The column of the sheet to lookup (e.g. `A`). This column functions as the key column for the upsert operation.",
    },
    value: {
      type: "string",
      label: "Key Value",
      description: "The value of the key to search for in **Key Column**. Defaults to the value in **Insert**'s \"key\" column if left blank.",
      optional: true,
    },
    updates: {
      type: "object",
      label: "Update - Column / Values",
      description: toSingleLineString(`
        Update statment: if the spreadsheet contains duplicate key **Value** in some row in
        the specified **Column**, individual cells in the *first* duplicate row will be updated using
        this object's column-value pairs.<br />
        Enter the column name for the key (e.g. \`B\`) and the corresponding column value (e.g.
        \`test\`). You may also enter a custom expression and pass a JSON object with key/value pairs
        representing columns and values (e.g. \`{{ { A: 5, B: "test" } }}\`).
      `),
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      sheetId,
      worksheetId,
      insert,
      column,
      value,
      updates,
    } = this;
    const worksheet = await this.getWorksheetById(sheetId, worksheetId);
    const colIndex = this.googleSheets._getColumnIndex(column) - 1;
    const keyValue = value
      ? value
      : insert[colIndex];

    // Create hidden worksheet to add cell with `=MATCH()` formula, used to find duplicate key
    const hiddenWorksheetTitle = uuid();
    const addSheetResult = await this.googleSheets.createWorksheet(sheetId, {
      title: hiddenWorksheetTitle,
      hidden: true,
      gridProperties: {
        rowCount: 2,
        columnCount: 1,
      },
    });
    const hiddenSheetId = addSheetResult.properties.sheetId;

    try {
      const matchResult = await this.googleSheets.addRowsToSheet({
        spreadsheetId: sheetId,
        range: hiddenWorksheetTitle,
        rows: [
          [
            keyValue, // A1
          ],
          [
            this.googleSheets.buildMatchFormula("A1", worksheet?.properties?.title, {
              column,
              searchType: 0,
            }), // A2
          ],
        ],
        params: {
          includeValuesInResponse: true,
          responseValueRenderOption: VALUE_RENDER_OPTION.FORMATTED_VALUE,
        },
      });

      const matchedRow = matchResult.updatedData?.values?.[1]?.[0]; // A2

      const shouldUpdate = matchedRow && matchedRow !== "#N/A";

      if (!shouldUpdate) {
        // INSERT ROW
        const result = await this.googleSheets.addRowsToSheet({
          spreadsheetId: sheetId,
          range: worksheet?.properties?.title,
          rows: [
            insert,
          ],
        });
        $.export("$summary", `Couldn't find the key, "${keyValue}", so inserted new row: "${insert}"`);
        return result;
      }

      // UPDATE ROW
      const updateParams = [
        sheetId,
        worksheet?.properties?.title,
        matchedRow,
      ];
      const sanitizedUpdates = omitEmptyKey(updates);
      const updateRowCells = sanitizedUpdates && Object.keys(sanitizedUpdates).length;
      const updatePromise =
      updateRowCells
        ? this.googleSheets.updateRowCells(...updateParams, sanitizedUpdates)
        : this.googleSheets.updateRow(...updateParams, insert);

      const result = await updatePromise;
      $.export("$summary", `Successfully updated row ${matchedRow}`);
      return result;
    } finally {
      // Cleanup hidden worksheet
      await this.googleSheets.deleteWorksheet(sheetId, hiddenSheetId);
    }
  },
};

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.
Insert - Cells / Column Values	`insert`	`string[]`	Insert statement: the row data you want to add to the Google sheet if the key doesn't exist. If the key does exist and Update is not set, the row will be updated using this array. Enter individual cell values or enter a custom expression to pass an array with each element representing a cell/column value (e.g. `{{ [5, "test"] }}`).
Key Column	`column`	`string`	The column of the sheet to lookup (e.g. `A`). This column functions as the key column for the upsert operation.
Key Value	`value`	`string`	The value of the key to search for in Key Column. Defaults to the value in Insert's "key" column if left blank.
Update - Column / Values	`updates`	`object`	Update statment: if the spreadsheet contains duplicate key Value in some row in the specified Column, individual cells in the first duplicate row will be updated using this object's column-value pairs. Enter the column name for the key (e.g. `B`) and the corresponding column value (e.g. `test`). You may also enter a custom expression and pass a JSON object with key/value pairs representing columns and values (e.g. `{{ { A: 5, B: "test" } }}`).

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