Grant User Access with Uscreen API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Uscreen, Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Attachment Received from the Gmail API

Next, do this

Grant User Access with the Uscreen 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 Gmail trigger and Uscreen action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Attachment Received trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
Configure the Grant User Access action
1. Connect your Uscreen account
2. Configure Email
3. Select a Product ID
4. Select a Product type
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 Attachment Received on Gmail

Description:Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

Version:0.0.6

Key:gmail-new-attachment-received

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  key: "gmail-new-attachment-received",
  name: "New Attachment Received",
  description: "Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    constructQuery(lastDate) {
      const { q: query } = this;
      const hasAttachment = query?.includes("has:attachment")
        ? ""
        : "has:attachment";
      const after = !query?.includes("after:") && lastDate
        ? `after:${lastDate / 1000}`
        : "";
      return [
        hasAttachment,
        after,
        query,
      ].join(" ").trim();
    },
    getLabels() {
      return this.labels;
    },
    generateMeta(attachment, message) {
      return {
        id: `${message.id}${attachment.partId}`,
        summary: `New Attachment: ${attachment.filename}`,
        ts: +message.internalDate,
      };
    },
    emitEvent(message) {
      if (message) {
        const { parts: attachments } = message.payload;

        attachments.filter((attachment) => attachment.body.attachmentId).forEach((attachment) => {
          this.$emit({
            message,
            attachment,
          }, this.generateMeta(attachment, message));
        });
      }
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Grant User Access on Uscreen

Description:Grant access to an user. [See the documentation](https://uscreen.io/api/publisher.html#/default/post_customers__customer_id__accesses)

Version:0.0.1

Key:uscreen-grant-user-access

View on GitHub

Uscreen Overview#

The Uscreen API lets you programmatically access your video on demand and OTT (over-the-top) service. With this API, you can pull data about videos, users, and sales, and carry out actions like creating and updating users, and more. By leveraging the Uscreen API on Pipedream, you can automate workflows involving video content management, user engagement tracking, and sales monitoring. This can significantly cut down manual effort and streamlines operations within your Uscreen account.

Action Code#

import app from "../../uscreen.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Grant User Access",
  version: "0.0.1",
  key: "uscreen-grant-user-access",
  description: "Grant access to an user. [See the documentation](https://uscreen.io/api/publisher.html#/default/post_customers__customer_id__accesses)",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "The email to grant access",
    },
    productId: {
      propDefinition: [
        app,
        "offerId",
      ],
    },
    productType: {
      type: "string",
      label: "Product type",
      description: "The type of the product",
      reloadProps: true,
      options: constants.PRODUCT_TYPES,
    },
  },
  async additionalProps() {
    let props = {};

    if (this.productType === "offer") {
      props.withManualBilling = {
        type: "boolean",
        label: "Manual billing",
        description: "Is with manual billing",
      };
    }

    return props;
  },
  async run({ $ }) {
    const response = await this.app.grantUserAccess({
      $,
      email: this.email,
      data: {
        product_id: this.productId,
        product_type: this.productType,
        with_manual_billing: this.withManualBilling,
      },
    });

    if (response) {
      $.export("$summary", `Successfully created user with ID \`${response.id}\``);
    }

    return response;
  },
};

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
Uscreen	`app`	`app`	This component uses the Uscreen app.
Email	`email`	`string`	The email to grant access
Product ID	`productId`	`string`	Select a value from the drop down menu.
Product type	`productType`	`string`	Select a value from the drop down menu:`{ "label": "Offer", "value": "offer" }{ "label": "Program", "value": "program" }`

Action Authentication#

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

The UScreen API is available to Uscreen Plus customers but if you're not on the Plus plan, you can contact the UScreen team to inquire about access. Your CSM can provide you with your authorization key to use in the API. See the documentation here.

About Uscreen#

Uscreen is an all-in-one membership platform designed for video creators.⚡ Follow us for the best free video streaming tips!

More Ways to Connect Uscreen + Gmail#

Other Popular Integrations#

Create User with Uscreen API on New Labeled Email from Gmail API

Gmail + Uscreen

Grant User Access with Uscreen API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Uscreen, Gmail and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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