Create Customer List with Google Ads API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Google Ads, npm and 2,400+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Customer List with the Google Ads 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 npm trigger and Google Ads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Customer List action
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Configure Name
5. Optional- Configure Description
6. Select a List 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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation.
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Customer List on Google Ads

Description:Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList)

Version:0.0.2

Key:google_ads-create-customer-list

View on GitHub

Google Ads Overview#

The Google Ads API lets you programmatically manage your Google Ads data and
campaigns. You can use the API to automate common tasks, such as:

Creating and managing campaigns
Adding and removing keywords
Adjusting bids

You can also use the API to get information about your campaigns, such as:

Campaign stats
Keyword stats
Ad performance

The Google Ads API is a powerful tool that lets you manage your Google Ads data
and campaigns programmatically. With the API, you can automate common tasks,
such as creating and managing campaigns, adding and removing keywords, and
adjusting bids. You can also use the API to get information about your
campaigns, such as campaign stats, keyword stats, and ad performance.

Action Code#

import {
  USER_LIST_TYPES, USER_LIST_TYPE_OPTIONS,
} from "./common-constants.mjs";
import {
  parseObject, parseStringObject,
} from "../../common/utils.mjs";
import common from "../common/common.mjs";
import {
  getAdditionalFields, getListTypeInfo,
} from "../common/props.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "google_ads-create-customer-list",
  name: "Create Customer List",
  description:
    "Create a new customer list in Google Ads. [See the documentation](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList)",
  version: "0.0.2",
  type: "action",
  props: {
    ...common.props,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the customer list.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the customer list.",
      optional: true,
    },
    listType: {
      type: "string",
      label: "List Type",
      description:
        "The [type of customer list](https://developers.google.com/google-ads/api/rest/reference/rest/v16/UserList#CrmBasedUserListInfo) to create.",
      options: USER_LIST_TYPE_OPTIONS.map(({
        label, value,
      }) => ({
        label,
        value,
      })),
      reloadProps: true,
    },
  },
  methods: {
    parseFields(obj) {
      switch (this.listType) {
      case USER_LIST_TYPES.CRM_BASED:
        break;

      case USER_LIST_TYPES.RULE_BASED:
        if (obj.prepopulationStatus) {
          obj.prepopulationStatus = "REQUESTED";
        }
        if (obj.flexibleRuleUserList) {
          obj.flexibleRuleUserList = parseObject(obj.flexibleRuleUserList);
        }
        break;

      case USER_LIST_TYPES.LOGICAL: {
        let { rules } = obj;
        if (rules) {
          rules = rules.map?.((rule) => parseStringObject(rule)) ?? parseStringObject(rules);
        }
        break;
      }

      case USER_LIST_TYPES.BASIC:
        if (obj?.conversionActions?.length || obj?.remarketingActions?.length) {
          obj.actions = [
            ...(obj.conversionActions ?? []).map((conversionAction) => ({
              conversionAction,
            })),
            ...(obj.remarketingActions ?? []).map((remarketingAction) => ({
              remarketingAction,
            })),
          ];
          delete obj.conversionActions;
          delete obj.remarketingActions;
        } else {
          throw new ConfigurationError("Select at least one Conversion or Remarketing action to build the list with");
        }
        break;

      case USER_LIST_TYPES.LOOKALIKE:
        break;
      }

      return obj;
    },
  },
  additionalProps() {
    const { listType } = this;

    const option = USER_LIST_TYPE_OPTIONS.find(
      ({ value }) => value === listType,
    );
    if (!option) {
      throw new ConfigurationError("Select a valid List Type to proceed.");
    }

    const {
      docsLink, props,
    } = option;

    const newProps = {
      listTypeInfo: getListTypeInfo(docsLink),
    };

    Object.assign(newProps, props);

    newProps.additionalFields = getAdditionalFields(docsLink);

    return newProps;
  },
  async run({ $ }) {
    const {
      googleAds,
      accountId,
      customerClientId,
      name,
      description,
      listType,
      additionalFields,
      ...data
    } = this;
    const { results: { [0]: response } } = await googleAds.createUserList({
      $,
      accountId,
      customerClientId,
      data: {
        operations: [
          {
            create: {
              name,
              description,
              [listType]: this.parseFields(data),
              ...parseObject(additionalFields),
            },
          },
        ],
      },
    });

    const id = response.resourceName.split("/").pop();

    $.export(
      "$summary",
      `Created customer list of type \`${listType}\` with ID \`${id}\``,
    );
    return {
      id,
      ...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
Google Ads	`googleAds`	`app`	This component uses the Google Ads app.
Use Google Ads As	`accountId`	`string`	Select a value from the drop down menu.
Managed Account	`customerClientId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the customer list.
Description	`description`	`string`	Description of the customer list.
List Type	`listType`	`string`	Select a value from the drop down menu:`{ "label": "CRM-based - a list of provided customers", "value": "crmBasedUserList" }{ "label": "Rule-Based - a customer list generated by a rule", "value": "ruleBasedUserList" }{ "label": "Logical - a custom combination of customer lists", "value": "logicalUserList" }{ "label": "Basic - a customer list targeting as a collection of conversions or remarketing actions", "value": "basicUserList" }{ "label": "Lookalike - a list composed of customers similar to those of a configurable seed", "value": "lookalikeUserList" }`

Action Authentication#

Google Ads uses OAuth authentication. When you connect your Google Ads account, Pipedream will open a popup window where you can sign into Google Ads 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 Ads API.

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

emailprofilehttps://www.googleapis.com/auth/adwords