← Google Sheets + Google Docs integrations

Append Text with Google Docs APIon New Worksheet (Instant) from Google Sheets API

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

Trigger workflow on
New Worksheet (Instant) from the Google Sheets API
Next, do this
Append Text with the Google Docs API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a Google Sheets trigger and Google Docs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Worksheet (Instant) trigger
    1. Connect your Google Sheets account
    2. Configure Push notification renewal schedule
    3. Select a Drive
    4. Select a Spreadsheet
  3. Configure the Append Text action
    1. Connect your Google Docs account
    2. Select a Document
    3. Configure text
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source components from Pipedream's GitHub repo. These components are 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.

Trigger

Description:Emit new event each time a new worksheet is created in a spreadsheet.
Version:0.0.7
Key:google_sheets-new-worksheet

Trigger Code

const common = require("../common");

module.exports = {
  ...common,
  key: "google_sheets-new-worksheet",
  type: "source",
  name: "New Worksheet (Instant)",
  description:
    "Emit new event each time a new worksheet is created in a spreadsheet.",
  version: "0.0.7",
  dedupe: "unique",
  props: {
    ...common.props,
    sheetID: {
      propDefinition: [
        common.props.googleSheets,
        "sheetID",
        (c) => ({
          driveId: common.methods.getDriveId(c.watchedDrive),
        }),
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      await this.processSpreadsheet({
        spreadsheetId: this.sheetID,
      });
    },
  },
  methods: {
    ...common.methods,
    generateMeta(worksheet) {
      return {
        id: worksheet.properties.sheetId,
        summary: worksheet.properties.title,
        ts: Date.now(),
      };
    },
    /**
     * Temporary transformation to ensure the format of the data is the
     * correct one. This will be fixed in the UI and backend, so that the data
     * format is guaranteed to be the one indicated in the `type` field of the
     * user prop.
     */
    getSheetId() {
      return this.sheetID.toString();
    },
    _getWorksheetIds() {
      return this.db.get("worksheetIds");
    },
    _setWorksheetIds(worksheetIds) {
      this.db.set("worksheetIds", worksheetIds);
    },
    async processSpreadsheet({ spreadsheetId }) {
      const { sheets: worksheets } = await this.googleSheets.getSpreadsheet(
        spreadsheetId,
      );
      let worksheetIds = this._getWorksheetIds() || [];
      for (const worksheet of worksheets) {
        if (worksheetIds.includes(worksheet.properties.sheetId)) continue;
        worksheetIds.push(worksheet.properties.sheetId);
        const meta = this.generateMeta(worksheet);
        this.$emit(worksheet, meta);
      }
      this._setWorksheetIds(worksheetIds);
    },
    takeSheetSnapshot() {},
  },
};

Trigger 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.
LabelPropTypeDescription
Google SheetsgoogleSheetsappThis component uses the Google Sheets app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
Push notification renewal scheduletimer$.interface.timer

The Google Drive API requires occasionally renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.

DrivewatchedDrivestringSelect a value from the drop down menu.
SpreadsheetsheetIDstringSelect a value from the drop down menu.

Trigger 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

About Google Sheets

With Google Sheets, you can create, edit, and collaborate wherever you are

Action

Description:Append text to an existing document
Version:0.0.12
Key:google_docs-append-text

Action Code

const googleDocs = require("../../google_docs.app");

module.exports = {
  key: "google_docs-append-text",
  name: "Append Text",
  description: "Append text to an existing document",
  version: "0.0.12",
  type: "action",
  props: {
    googleDocs,
    docId: {
      propDefinition: [
        googleDocs,
        "docId",
      ],
    },
    text: {
      type: "string",
      description: "Enter static text (e.g., `hello world`) or a reference to a string exported by a previous step (e.g., `{{steps.foo.$return_value}}`).",

    },
  },
  async run() {
    const docs = this.googleDocs.docs();
    return (await docs.documents.batchUpdate({
      documentId: this.docId,
      requestBody: {
        requests: [
          {
            insertText: {
              location: {
                index: 1,
              },
              text: this.text,
            },
          },
        ],
      },
    })).data;
  },
};

Action Configuration

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

LabelPropTypeDescription
Google DocsgoogleDocsappThis component uses the Google Docs app.
DocumentdocIdstringSelect a value from the drop down menu.
texttextstring

Enter static text (e.g., hello world) or a reference to a string exported by a previous step (e.g., {{steps.foo.$return_value}}).

Action Authentication

Google Docs uses OAuth authentication. When you connect your Google Docs account, Pipedream will open a popup window where you can sign into Google Docs 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 Docs API.

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

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

About Google Docs

Free Online Documents for Personal Use

More Ways to Connect Google Docs + Google Sheets

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.