Changes to Specific Files (Shared Drive) from Google Drive API

Pipedream makes it easy to connect APIs for Google Drive and 1000+ other apps remarkably fast.

Trigger workflow on

Changes to Specific Files (Shared Drive) from the Google Drive API

Next, do this

Connect to 1000+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on Changes to Specific Files (Shared Drive) with Google Drive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Changes to Specific Files (Shared Drive) trigger
1. Connect your Google Drive account
2. Select a Drive
3. Optional- Configure Watch for changes to file properties
4. Configure Push notification renewal schedule
5. Optional- Select one or more Files
Add steps to connect to 1000+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + Discord Webhook

Try it

Add Multiple Rows with Google Sheets API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + Google Sheets

Try it

Get Film with SWAPI - Star Wars API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + Airtable

Try it

Chat with OpenAI (ChatGPT) API on Changes to Specific Files (Shared Drive) from Google Drive API

Google Drive + OpenAI (ChatGPT)

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.

Changes to Specific Files (Shared Drive) on Google Drive

Description:Watches for changes to specific files in a shared drive, emitting an event any time a change is made to one of those files

Version:0.1.0

Key:google_drive-changes-to-specific-files-shared-drive

View on GitHub

Code#

// This source processes changes to specific files in a user's Google Drive,
// implementing strategy enumerated in the Push Notifications API docs:
// https://developers.google.com/drive/api/v3/push .
//
// This source has two interfaces:
//
// 1) The HTTP requests tied to changes in files in the user's Google Drive
// 2) A timer that runs on regular intervals, renewing the notification channel as needed

import common from "../common-webhook.mjs";

import {
  GOOGLE_DRIVE_NOTIFICATION_CHANGE,
  GOOGLE_DRIVE_NOTIFICATION_ADD,
  GOOGLE_DRIVE_NOTIFICATION_UPDATE,
} from "../../constants.mjs";

/**
 * This source uses the Google Drive API's
 * {@link https://developers.google.com/drive/api/v3/reference/changes/watch changes: watch}
 * endpoint to subscribe to changes to the user's drive or a shard drive.
 */
export default {
  ...common,
  key: "google_drive-changes-to-specific-files-shared-drive",
  name: "Changes to Specific Files (Shared Drive)",
  description: "Watches for changes to specific files in a shared drive, emitting an event any time a change is made to one of those files",
  version: "0.1.0",
  type: "source",
  // Dedupe events based on the "x-goog-message-number" header for the target channel:
  // https://developers.google.com/drive/api/v3/push#making-watch-requests
  dedupe: "unique",
  props: {
    ...common.props,
    files: {
      type: "string[]",
      label: "Files",
      description: "The files you want to watch for changes.",
      optional: true,
      default: [],
      options({ prevContext }) {
        const { nextPageToken } = prevContext;
        const baseOpts = {};
        const opts = this.isMyDrive()
          ? baseOpts
          : {
            ...baseOpts,
            corpora: "drive",
            driveId: this.getDriveId(),
            includeItemsFromAllDrives: true,
            supportsAllDrives: true,
          };
        return this.googleDrive.listFilesOptions(nextPageToken, opts);
      },
    },
  },
  methods: {
    ...common.methods,
    getUpdateTypes() {
      return [
        GOOGLE_DRIVE_NOTIFICATION_ADD,
        GOOGLE_DRIVE_NOTIFICATION_CHANGE,
        GOOGLE_DRIVE_NOTIFICATION_UPDATE,
      ];
    },
    generateMeta(data, headers) {
      const {
        id: fileId,
        name: fileName,
        modifiedTime: tsString,
      } = data;
      const {
        "x-goog-message-number": eventId,
        "x-goog-resource-state": resourceState,
      } = headers;

      return {
        id: `${fileId}-${eventId}`,
        summary: `${resourceState.toUpperCase()} - ${
          fileName || "Untitled"
        }`,
        ts: Date.parse(tsString),
      };
    },
    isFileRelevant(file) {
      return this.files.includes(file.id);
    },
    async processChange(file, headers) {
      const eventToEmit = {
        file,
        change: {
          state: headers["x-goog-resource-state"],
          resourceURI: headers["x-goog-resource-uri"],
          changed: headers["x-goog-changed"], // "Additional details about the changes. Possible values: content, parents, children, permissions"
        },
      };
      const meta = this.generateMeta(file, headers);
      this.$emit(eventToEmit, meta);
    },
    async processChanges(changedFiles, headers) {
      for (const file of changedFiles) {
        if (!this.isFileRelevant(file)) {
          console.log(`Skipping event for irrelevant file ${file.id}`);
          continue;
        }
        this.processChange(file, headers);
      }
    },
  },
};

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 Drive	`googleDrive`	`app`	This component uses the Google Drive app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This 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.
Drive	`drive`	`string`	Select a value from the drop down menu.
Watch for changes to file properties	`watchForPropertiesChanges`	`boolean`	Watch for changes to file properties in addition to changes to content. Defaults to `false`, watching for only changes to content.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Drive API requires occasional renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.
Files	`files`	`string[]`	Select a value from the drop down menu.

Authentication#

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

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

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

About Google Drive#

Internet-related services and products

More Ways to Use Google Drive#

Triggers#

Changes to Specific Files from the Google Drive API

Watches for changes to specific files, emitting an event any time a change is made to one of those files. To watch for changes to shared drive files, use the Changes to Specific Files (Shared Drive) source instead.

Try it

New Files (Instant) from the Google Drive API

Emit new event any time a new file is added in your linked Google Drive

Try it

New or Modified Comments from the Google Drive API

Emits a new event any time a file comment is added, modified, or deleted in your linked Google Drive

Try it

New or Modified Files from the Google Drive API

Emit new event any time any file in your linked Google Drive is added, modified, or deleted

Try it

New or Modified Folders from the Google Drive API

Emit new event any time any folder in your linked Google Drive is added, modified, or deleted

Try it

Actions#

Add File Sharing Preference with the Google Drive API

Add a sharing permission to the sharing preferences of a file and provide a sharing URL. See the docs for more information

Try it

Copy File with the Google Drive API

Create a copy of the specified file. See the docs for more information

Try it

Create a New File with the Google Drive API

Create a new file from a URL or /tmp/filepath. See the docs for more information

Try it

Create Folder with the Google Drive API

Create a new empty folder. See the docs for more information

Try it

Create New File From Template with the Google Drive API

Create a new Google Docs file from a template. Optionally include placeholders in the template document that will get replaced from this action. See documentation

Try it