Upload File with Google Drive API on Changes to Specific Files from Google Drive API

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

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

Upload File with the Google Drive 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#

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

Select this integration
Configure the Changes to Specific Files trigger
1. Connect your Google Drive account
2. Optional- Configure Drive
3. Configure Push notification renewal schedule
4. Select one or more Files
5. Configure intervalAlert
6. Optional- Configure Minimum Interval Per File
7. Select one or more Types of updates
Configure the Upload File action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Optional- Select a Folder
4. Configure File
5. Optional- Configure Name
6. Optional- Select a Mime Type
7. Optional- Select a Upload Type
8. Optional- Select a File to replace
9. Optional- Configure Metadata
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available 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#

Changes to Specific Files on Google Drive

Description:Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.

Version:0.2.6

Key:google_drive-changes-to-specific-files

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Trigger Code#

import cronParser from "cron-parser";
import sampleEmit from "./test-event.mjs";
import includes from "lodash/includes.js";
import { v4 as uuid } from "uuid";
import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";

/**
 * This source uses the Google Drive API's
 * {@link https://developers.google.com/drive/api/v3/reference/files/watch files: watch}
 * endpoint to subscribe to changes to specific files in the user's drive.
 */
export default {
  ...changesToSpecificFiles,
  key: "google_drive-changes-to-specific-files",
  name: "Changes to Specific Files",
  description: "Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.",
  version: "0.2.6",
  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: {
    ...changesToSpecificFiles.props,
    drive: {
      type: "string",
      label: "Drive",
      description: "Defaults to `My Drive`. To use a [Shared Drive](https://support.google.com/a/users/answer/9310351), use the **Changes to Specific Files (Shared Drive)** source instead.",
      optional: true,
      default: MY_DRIVE_VALUE,
    },
    updateTypes: {
      propDefinition: [
        changesToSpecificFiles.props.googleDrive,
        "updateTypes",
      ],
    },
  },
  hooks: {
    ...changesToSpecificFiles.hooks,
    async activate() {
      // Called when a component is created or updated. Handles all the logic
      // for starting and stopping watch notifications tied to the desired
      // files.

      // You can pass the same channel ID in watch requests for multiple files, so
      // our channel ID is fixed for this component to simplify the state we have to
      // keep track of.
      const channelID = uuid();

      // Subscriptions are keyed on Google's resourceID, "an opaque value that
      // identifies the watched resource". This value is included in request
      // headers, allowing us to look up the watched resource.
      let subscriptions = this._getSubscriptions() || {};

      const files = this.files;
      for (const fileID of files) {
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.activateFileHook(
          channelID,
          this.http.endpoint,
          fileID,
        );
        // The fileID must be kept with the subscription metadata so we can
        // renew the watch request for this specific file when it expires.
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }

      // Save metadata on the subscription so we can stop / renew later
      this._setSubscriptions(subscriptions);
      this._setChannelID(channelID);
    },
    async deactivate() {
      const channelID = this._getChannelID();
      if (!channelID) {
        console.log(
          "Channel not found, cannot stop notifications for non-existent channel",
        );
        return;
      }

      const subscriptions = this._getSubscriptions() || {};
      for (const resourceId of Object.keys(subscriptions)) {
        await this.googleDrive.stopNotifications(channelID, resourceId);
      }

      // Reset DB state
      this._setSubscriptions({});
      this._setChannelID(null);
    },
  },
  methods: {
    ...changesToSpecificFiles.methods,
    _getSubscriptions() {
      return this.db.get("subscriptions") || {};
    },
    _setSubscriptions(subscriptions) {
      this.db.set("subscriptions", subscriptions);
    },
    _getNextTimerEventTimestamp(event) {
      if (event.cron) {
        return cronParser
          .parseExpression(event.cron)
          .next()
          .getTime();
      }
      if (event.interval_seconds) {
        return Date.now() + event.interval_seconds * 1000;
      }
    },
    async renewFileSubscriptions(event) {
      const subscriptions = this._getSubscriptions() || {};
      const channelID = this._getChannelID();
      const newChannelID = uuid();

      const nextRunTimestamp = this._getNextTimerEventTimestamp(event);

      for (const [
        currentResourceId,
        metadata,
      ] of Object.entries(subscriptions)) {
        const { fileID } = metadata;

        const subscription = {
          ...metadata,
          resourceId: currentResourceId,
        };
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.renewFileSubscription(
          subscription,
          this.http.endpoint,
          channelID,
          newChannelID,
          fileID,
          nextRunTimestamp,
        );
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }
      this._setSubscriptions(subscriptions);
      this._setChannelID(newChannelID);
    },
  },
  async run(event) {
    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
    // watch requests for specific files, or via HTTP request (the change payloads from Google)

    // Component was invoked by timer
    if (event.timestamp) {
      return this.renewFileSubscriptions(event);
    }

    const channelID = this._getChannelID();
    let subscriptions = this._getSubscriptions() || {};

    const { headers } = event;

    if (
      !headers["x-goog-resource-state"] ||
      !headers["x-goog-resource-id"] ||
      !headers["x-goog-resource-uri"] ||
      !headers["x-goog-message-number"]
    ) {
      console.log("Request missing necessary headers: ", headers);
      return;
    }

    const incomingChannelID = headers["x-goog-channel-id"];
    if (incomingChannelID !== channelID) {
      console.log(
        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`,
      );
      return;
    }

    if (subscriptions[headers["x-goog-resource-id"]] === undefined) {
      console.log(
        `Resource ID of ${headers["x-goog-resource-id"]} not currently being tracked. Exiting`,
      );
      return;
    }

    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
      console.log(
        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
        this.updateTypes,
      );
      return;
    }

    // We observed false positives where a single change to a document would trigger two changes:
    // one to "properties" and another to "content,properties". But changes to properties
    // alone are legitimate, most users just won't want this source to emit in those cases.
    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
    if (
      !this.watchForPropertiesChanges &&
      headers["x-goog-changed"] === "properties"
    ) {
      console.log(
        "Change to properties only, which this component is set to ignore. Exiting",
      );
      return;
    }

    const file = await this.googleDrive.getFileMetadata(
      headers["x-goog-resource-uri"],
    );

    if (!file || !Object.keys(file).length) {
      console.log("No file metadata returned, nothing to emit");
      return;
    }

    const [
      checkedFile,
    ] = this.checkMinimumInterval([
      file,
    ]);
    if (checkedFile) {
      this.processChange(file, headers);
    }
  },
  sampleEmit,
};

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.

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`	Defaults to `My Drive`. To use a Shared Drive, use the Changes to Specific Files (Shared Drive) source instead.
Files	`files`	`string[]`	Select a value from the drop down menu.
Minimum Interval Per File	`perFileInterval`	`integer`	How many minutes to wait until the same file can emit another event. If set to `0`, this interval is disabled and all events will be emitted.
Types of updates	`updateTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "'sync' - A channel was successfully created. You can expect to start receiving notifications for it.", "value": "sync" }{ "label": "'add' - A resource was created or shared.", "value": "add" }{ "label": "'remove' - An existing resource was deleted or unshared.", "value": "remove" }{ "label": "'update' - One or more properties (metadata) of a resource have been updated.", "value": "update" }{ "label": "'trash' - A resource has been moved to the trash.", "value": "trash" }{ "label": "'untrash' - A resource has been removed from the trash.", "value": "untrash" }{ "label": "'change' - One or more changelog items have been added.", "value": "change" }`

Trigger 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:

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

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

Action#

Upload File on Google Drive

Description:Upload a file to Google Drive. [See the documentation](https://developers.google.com/drive/api/v3/manage-uploads) for more information

Version:1.1.0

Key:google_drive-upload-file

View on GitHub

Google Drive Overview#

Action Code#

import googleDrive from "../../google_drive.app.mjs";
import path from "path";
import {
  omitEmptyStringValues,
  parseObjectEntries,
} from "../../common/utils.mjs";
import { GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART } from "../../common/constants.mjs";
import {
  getFileStream, ConfigurationError,
} from "@pipedream/platform";

export default {
  key: "google_drive-upload-file",
  name: "Upload File",
  description: "Upload a file to Google Drive. [See the documentation](https://developers.google.com/drive/api/v3/manage-uploads) for more information",
  version: "1.1.0",
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    parentId: {
      propDefinition: [
        googleDrive,
        "folderId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      description:
        "The folder you want to upload the file to. If not specified, the file will be placed directly in the drive's top-level folder.",
      optional: true,
    },
    file: {
      type: "string",
      label: "File",
      description: "Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFlie.pdf).",
    },
    name: {
      propDefinition: [
        googleDrive,
        "fileName",
      ],
      description:
        "The name of the new file (e.g. `/myFile.csv`). By default, the name is the same as the source file's.",
    },
    mimeType: {
      propDefinition: [
        googleDrive,
        "mimeType",
      ],
      description:
        "The file's MIME type (e.g., `image/jpeg`). Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided.",
    },
    uploadType: {
      propDefinition: [
        googleDrive,
        "uploadType",
      ],
      default: GOOGLE_DRIVE_UPLOAD_TYPE_MULTIPART,
      optional: true,
    },
    fileId: {
      propDefinition: [
        googleDrive,
        "fileId",
      ],
      label: "File to replace",
      description: "ID of the file to replace. Leave it empty to upload a new file.",
      optional: true,
    },
    metadata: {
      type: "object",
      label: "Metadata",
      description: "Additional metadata to supply in the upload. [See the documentation](https://developers.google.com/workspace/drive/api/reference/rest/v3/files) for information on available fields. Values will be parsed as JSON where applicable. Example: `{ \"description\": \"my file description\" }`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      parentId,
      name,
      mimeType,
    } = this;
    let { uploadType } = this;
    const driveId = this.googleDrive.getDriveId(this.drive);

    const filename = name || path.basename(this.file);

    const file = await getFileStream(this.file);
    console.log(`Upload type: ${uploadType}.`);

    const metadata = this.metadata
      ? parseObjectEntries(this.metadata)
      : undefined;

    if (metadata?.mimeType && !mimeType) {
      throw new ConfigurationError(`Please include the file's original MIME type in the \`Mime Type\` prop. File will be converted to \`${metadata.mimeType}\`.`);
    }

    let result = null;
    if (this.fileId) {
      await this.googleDrive.updateFileMedia(this.fileId, file, omitEmptyStringValues({
        mimeType,
        uploadType,
      }));
      result = await this.googleDrive.updateFile(this.fileId, omitEmptyStringValues({
        name: filename,
        mimeType,
        uploadType,
        requestBody: metadata,
      }));
      $.export("$summary", `Successfully updated file, "${result.name}"`);
    } else {
      result = await this.googleDrive.createFile(omitEmptyStringValues({
        file,
        mimeType,
        name: filename,
        parentId,
        driveId,
        uploadType,
        requestBody: metadata,
      }));
      $.export("$summary", `Successfully uploaded a new file, "${result.name}"`);
    }
    return result;
  },
};

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.

Label	Prop	Type	Description
Google Drive	`googleDrive`	`app`	This component uses the Google Drive app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Folder	`parentId`	`string`	Select a value from the drop down menu.
File	`file`	`string`	Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFlie.pdf).
Name	`name`	`string`	The name of the new file (e.g. `/myFile.csv`). By default, the name is the same as the source file's.
Mime Type	`mimeType`	`string`	Select a value from the drop down menu.
Upload Type	`uploadType`	`string`	Select a value from the drop down menu:`{ "label": "Simple upload. Upload the media only, without any metadata.", "value": "media" }{ "label": "Resumable upload. Upload the file in a resumable fashion, using a series of at least two requests where the first request includes the metadata.", "value": "resumable" }{ "label": "Multipart upload. Upload both the media and its metadata, in a single request.", "value": "multipart" }`
File to replace	`fileId`	`string`	Select a value from the drop down menu.
Metadata	`metadata`	`object`	Additional metadata to supply in the upload. See the documentation for information on available fields. Values will be parsed as JSON where applicable. Example: `{ "description": "my file description" }`

Action Authentication#

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

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

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

More Ways to Connect Google Drive + Google Drive#

Other Popular Integrations#

Create a New File with Google Drive API on New or Modified Files from Google Drive API

Google Drive + Google Drive

Upload File with Google Drive API on Changes to Specific Files from Google Drive API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular