Get Related UUIDs with Confection API on Changes to Specific Files from Google Drive API

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

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

Get Related UUIDs with the Confection API

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#

This integration creates a workflow with a Google Drive trigger and Confection 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. Optional- Configure Watch for changes to file properties
4. Configure Push notification renewal schedule
5. Optional- Select one or more Files
6. Select one or more Types of updates
Configure the Get Related UUIDs action
1. Connect your Confection account
2. Configure UUID
3. Optional- Configure Likeness Score
4. Optional- Configure Should the execution of this step be stopped if no results are found?
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 any time 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.1.0

Key:google_drive-changes-to-specific-files

View on GitHub

Google Drive Overview#

Using the Google Drive API, you can build applications that:

Create and manage files and folders
Download and upload files
Share and organize files
Search for files
Track changes to files
And much more!

Trigger Code#

import cronParser from "cron-parser";
import includes from "lodash/includes.js";
import { v4 as uuid } from "uuid";

import { MY_DRIVE_VALUE } from "../../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 any time 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.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: {
    ...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 = this._getChannelID() || 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) {
      // Assume subscription & channelID may all be undefined at
      // this point Handle their absence appropriately.
      const subscriptions = this._getSubscriptions() || {};
      const channelID = this._getChannelID() || 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,
          fileID,
          nextRunTimestamp,
        );
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }
      this._setSubscriptions(subscriptions);
      this._setChannelID(channelID);
    },
  },
  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;
    }

    this.processChange(file, headers);
  },
};

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.
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.
Types of updates	`updateTypes`	`string[]`	Select a value from the drop down menu:`syncaddremoveupdatetrashuntrashchange`

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:

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

About Google Drive#

Internet-related services and products

Action#

Get Related UUIDs on Confection

Description:This action will retrieve all UUIDs that have a likeness score of at least 50 (default) with the provided UUID. The likeness score can be customized in configuration.

Version:0.1.0

Key:confection-get-related-uuids

View on GitHub

Confection Overview#

Confection is an API that enables you to easily create and manage serverless
functions. Using Confection, you can deploy your functions to any number of
providers, including AWS Lambda, Google Cloud Functions, and Azure Functions.
Confection also provides a convenient command-line interface, making it easy to
manage your functions from your terminal.

Action Code#

import confection from "../../confection.app.mjs";

export default {
  key: "confection-get-related-uuids",
  name: "Get Related UUIDs",
  type: "action",
  version: "0.1.0",
  description:
    "This action will retrieve all UUIDs that have a likeness score of at least 50 (default) with the provided UUID. The likeness score can be customized in configuration.",
  props: {
    confection,
    uuid: {
      propDefinition: [
        confection,
        "uuid",
      ],
      description: "Provide the UUID to retrieve related UUIDs of.",
    },
    likeness: {
      propDefinition: [
        confection,
        "likeness",
      ],
      description:
        "Accepts values 50 to 100. 100 meaning only pull back records where we are certain the UUIDs are the same record",
    },
    stopOnNoResults: {
      propDefinition: [
        confection,
        "stopOnNoResults",
      ],
      description:
        "If set to true, action execution will be halted when no related UUIDs are found and any subsequent steps that rely on data from this step will not be run.",
    },
  },
  async run({ $ }) {
    const data = await this.confection.getRelatedUUIDs(
      this.uuid,
      this.likeness,
      $,
    );

    if (data.related.length === 0 && this.stopOnNoResults === true) {
      throw new Error(
        `No related UUIDs with likeness score greater than or equal to ${this.likeness} were found.`,
      );
    }
    return 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.

Label	Prop	Type	Description
Confection	`confection`	`app`	This component uses the Confection app.
UUID	`uuid`	`string`	Provide the UUID to retrieve related UUIDs of.
Likeness Score	`likeness`	`integer`	Accepts values 50 to 100. 100 meaning only pull back records where we are certain the UUIDs are the same record
Should the execution of this step be stopped if no results are found?	`stopOnNoResults`	`boolean`	If set to true, action execution will be halted when no related UUIDs are found and any subsequent steps that rely on data from this step will not be run.

Action Authentication#

Confection uses API keys for authentication. When you connect your Confection account, Pipedream securely stores the keys so you can easily authenticate to Confection APIs in both code and no-code steps.

Find your account ID and API keys here: https://dashboard.confection.io/my-keys

Need an account? Using Confection for the first time? Please see our quick-start guide: https://confection.io/quick-start/pipedream

About Confection#

Confection collects, stores, and distributes data in a way that's unaffected by client-side disruptions involving cookies, cross-domain scripts, and device IDs. It's also compliant with global privacy laws so it’s good for people too.

More Ways to Connect Confection + Google Drive#

Other Popular Integrations#

Get Related UUIDs with Confection API on New Files (Instant) from Google Drive API

Google Drive + Confection

Get Related UUIDs with Confection API on Changes to Specific Files from Google Drive API

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

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

Developers ♥ Pipedream

1-12of1000+apps by most popular

1
-
12
of
1000+
apps by most popular