← Google Drive

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

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

Trigger workflow on
Changes to Specific Files (Shared Drive) from the Google Drive API
Next, do this
Connect to 800+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,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.

  1. 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
  2. Add steps to connect to 800+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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.0.1
Key:google_drive-changes-to-specific-files-shared-drive

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.0.1",
  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.
LabelPropTypeDescription
Google DrivegoogleDriveappThis component uses the Google Drive 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.
DrivedrivestringSelect a value from the drop down menu.
Watch for changes to file propertieswatchForPropertiesChangesboolean

Watch for changes to file properties
in addition to changes to content. Defaults to false, watching for only changes to content.

Push notification renewal scheduletimer$.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.

Filesfilesstring[]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

Actions