Add File Sharing Preference with Google Drive API on New or Modified Files from Google Drive API

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

Trigger workflow on

New or Modified Files from the Google Drive API

Next, do this

Add File Sharing Preference with the Google Drive 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 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 New or Modified Files 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
Configure the Add File Sharing Preference action
1. Connect your Google Drive account
2. Optional- Select a Drive
3. Select a File
4. Optional- Select a Role
5. Optional- Select a Type
6. Optional- Configure Domain
7. Optional- Configure Email Address
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#

New or Modified Files on Google Drive

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

Version:0.1.0

Key:google_drive-new-or-modified-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#

// This source processes changes to any files in a user's Google Drive,
// implementing strategy enumerated in the Push Notifications API docs:
// https://developers.google.com/drive/api/v3/push and here:
// https://developers.google.com/drive/api/v3/manage-changes
//
// This source has two interfaces:
//
// 1) The HTTP requests tied to changes 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_ADD,
  GOOGLE_DRIVE_NOTIFICATION_CHANGE,
  GOOGLE_DRIVE_NOTIFICATION_UPDATE,
} from "../../constants.mjs";

export default {
  ...common,
  key: "google_drive-new-or-modified-files",
  name: "New or Modified Files",
  description: "Emit new event any time any file in your linked Google Drive is added, modified, or deleted",
  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",
  methods: {
    ...common.methods,
    getUpdateTypes() {
      return [
        GOOGLE_DRIVE_NOTIFICATION_ADD,
        GOOGLE_DRIVE_NOTIFICATION_CHANGE,
        GOOGLE_DRIVE_NOTIFICATION_UPDATE,
      ];
    },
    generateMeta(data, headers) {
      const {
        id: fileId,
        name: summary,
        modifiedTime: tsString,
      } = data;
      const { "x-goog-message-number": eventId } = headers;
      return {
        id: `${fileId}-${eventId}`,
        summary,
        ts: Date.parse(tsString),
      };
    },
    async processChanges(changedFiles, headers) {
      for (const file of changedFiles) {
        const metadata = await this.googleDrive.getFileMetadata(`${headers["x-goog-resource-uri"]}&fields=*`);

        const eventToEmit = {
          file,
          ...metadata,
          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);
      }
    },
  },
};

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`	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.

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#

Add File Sharing Preference on Google Drive

Description:Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) for more information

Version:0.1.0

Key:google_drive-add-file-sharing-preference

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!

Action Code#

import googleDrive from "../../google_drive.app.mjs";

/**
 * Uses Google Drive API to create a permission for a file. The role granted by
 * the permission is one of `owner`,`organizer`,`fileOrganizer`,
 * `writer`,`commenter`, `reader`. See the [Google Drive API Reference for
 * Permissions](https://bit.ly/2XKKG1X) for more information.
 */
export default {
  key: "google_drive-add-file-sharing-preference",
  name: "Add File Sharing Preference",
  description:
    "Add a [sharing](https://support.google.com/drive/answer/7166529) permission to the sharing preferences of a file and provide a sharing URL. [See the docs](https://developers.google.com/drive/api/v3/reference/permissions/create) for more information",
  version: "0.1.0",
  type: "action",
  props: {
    googleDrive,
    drive: {
      propDefinition: [
        googleDrive,
        "watchedDrive",
      ],
      optional: true,
    },
    fileId: {
      propDefinition: [
        googleDrive,
        "fileId",
        (c) => ({
          drive: c.drive,
        }),
      ],
      optional: false,
      description: "The file to share",
    },
    role: {
      propDefinition: [
        googleDrive,
        "role",
      ],
    },
    type: {
      propDefinition: [
        googleDrive,
        "type",
      ],
    },
    domain: {
      propDefinition: [
        googleDrive,
        "domain",
      ],
    },
    emailAddress: {
      propDefinition: [
        googleDrive,
        "emailAddress",
      ],
    },
  },
  async run({ $ }) {
    const {
      fileId,
      role,
      type,
      domain,
      emailAddress,
    } = this;
    // Create the permission for the file
    await this.googleDrive.createPermission(fileId, {
      role,
      type,
      domain,
      emailAddress,
    });

    // Get the file to get the `webViewLink` sharing URL
    const resp = await this.googleDrive.getFile(this.fileId);
    const webViewLink = resp.webViewLink;
    $.export("$summary", `Successfully added a sharing permission to the file, "${resp.name}"`);
    return webViewLink;
  },
};

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.
File	`fileId`	`string`	Select a value from the drop down menu.
Role	`role`	`string`	Select a value from the drop down menu:`ownerorganizerfileOrganizerwritercommenterreader`
Type	`type`	`string`	Select a value from the drop down menu:`usergroupdomainanyone`
Domain	`domain`	`string`	The domain of the G Suite organization to which this permission refers if Type is `domain` (e.g., `yourcomapany.com`)
Email Address	`emailAddress`	`string`	The email address of the user or group to which this permission refers if Type is `user` or `group`

Action Authentication#

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

Add File Sharing Preference with Google Drive API on New or Modified Files from Google Drive API

Pipedream makes it easy to connect APIs for Google Drive, 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