Record whenever a user sees a screen with Segment API on Changes to Specific Files (Shared Drive) from Google Drive API

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

Trigger workflow on

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

Next, do this

Record whenever a user sees a screen with the Segment API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Drive trigger and Segment 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 (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
Configure the Record whenever a user sees a screen action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Optional- Configure Integrations
5. Optional- Configure Screen Name
6. Optional- Configure Screen Properties
7. Optional- Configure Timestamp
8. Optional- Configure User ID
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 (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.3

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

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 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 sampleEmit from "./test-event.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.3",
  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;
        return this.googleDrive.listFilesOptions(nextPageToken, this.getListFilesOpts());
      },
    },
  },
  hooks: {
    async deploy() {
      const daysAgo = new Date();
      daysAgo.setDate(daysAgo.getDate() - 30);
      const timeString = daysAgo.toISOString();

      const args = this.getListFilesOpts({
        q: `mimeType != "application/vnd.google-apps.folder" and modifiedTime > "${timeString}" and trashed = false`,
        fields: "files",
      });

      const { files } = await this.googleDrive.listFilesInPage(null, args);

      this.processChanges(files);
    },
    ...common.hooks,
  },
  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 ts = Date.parse(tsString);
      const eventId = headers && headers["x-goog-message-number"];
      const resourceState = headers && headers["x-goog-resource-state"];

      const summary = resourceState
        ? `${resourceState.toUpperCase()} - ${fileName || "Untitled"}`
        : fileName || "Untitled";

      return {
        id: `${fileId}-${eventId || ts}`,
        summary,
        ts,
      };
    },
    isFileRelevant(file) {
      return this.files.includes(file.id);
    },
    getChanges(headers) {
      if (!headers) {
        return;
      }
      return {
        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"
        },
      };
    },
    processChange(file, headers) {
      const changes = this.getChanges(headers);
      const eventToEmit = {
        file,
        ...changes,
      };
      const meta = this.generateMeta(file, headers);
      this.$emit(eventToEmit, meta);
    },
    processChanges(changedFiles, headers) {
      console.log(`Processing ${changedFiles.length} changed files`);
      console.log(`Changed files: ${JSON.stringify(changedFiles, null, 2)}!!!`);
      console.log(`Files: ${this.files}!!!`);
      for (const file of changedFiles) {
        if (!this.isFileRelevant(file)) {
          console.log(`Skipping event for irrelevant file ${file.id}`);
          continue;
        }
        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`	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.

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#

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#

Record whenever a user sees a screen on Segment

Description:The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#screen)

Version:0.1.4

Key:segment-screen

View on GitHub

Segment Overview#

You can do a lot of amazing things with Segment's API. Segment's API enables
you to collect and connect customer data quickly and easily. With it, you can
power your analytics, marketing, and data warehousing requirements, and improve
your customer experience and performance.

The Segment API provides you with full control over your customer data,
including file storage, ETL, data modeling, data enrichment and
transformations, and data queries. With it, you can build powerful solutions
that help you uncover useful customer insights in real-time. Here are a few
examples of what you can do using the Segment API:

Collect and store customer data from multiple sources: You can collect
customer data from multiple sources such as web traffic, mobile and web apps,
ecommerce stores, CRMs, and marketing automation platforms.
Build custom data models to gain deeper insights into customer behavior: With
the Segment API, you can build custom models that organize customer data into
meaningful categories to gain deeper consumer insights.
Automatically enrich customer data with 3rd party APIs: The Segment API
allows you to automatically map, enrich, and clean customer data, creating a
single source of truth for better segmentation and decision making.
Analyze customer data in real-time for better decision making: With the
Segment API, you can monitor customer data in real-time, uncovering patterns
and creating reports in a few clicks.
Automate data pipelines to quickly and easily access data: You can quickly
and easily create data pipelines with the Segment API, and get accurate data
delivered on demand.
Connect customer data to over 250 cloud services: With the Segment API, you
can quickly and easily connect customer data to over 250 cloud services and
systems, such as analytics, marketing automation platforms, CRMs, and data
warehouses.

Action Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-screen",
  name: "Record whenever a user sees a screen",
  description: "The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#screen)",
  version: "0.1.4",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    label: {
      type: "string",
      label: "Screen Name",
      description: "Name of the screen",
      optional: true,
    },
    properties: {
      type: "object",
      label: "Screen Properties",
      description: "Free-form dictionary of properties of the screen, like name",
      optional: true,
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.screen({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        integrations: this.integrations,
        label: this.name,
        properties: this.properties,
        timestamp: this.timestamp,
        userId: this.userId,
      },
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
Anonymous ID	`anonymousId`	`string`	A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Context	`context`	`object`	Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Screen Name	`label`	`string`	Name of the screen
Screen Properties	`properties`	`object`	Free-form dictionary of properties of the screen, like name
Timestamp	`timestamp`	`string`	Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, `2022-04-08T17:32:11.318Z`
User ID	`userId`	`string`	Unique identifier for the user in your database., A User ID or an Anonymous ID is required.

Action Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

More Ways to Connect Segment + Google Drive#

Other Popular Integrations#

Associate an identified user with a group with Segment API on Changes to Specific Files from Google Drive API

Google Drive + Segment