Create Report 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 Report 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 Report action
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Select a Resource
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 Report on Google Ads

Description:Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v16/overview)

Version:0.1.0

Key:google_ads-create-report

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 common from "../common/common.mjs";
import { adGroup } from "../../common/resources/adGroup.mjs";
import { ad } from "../../common/resources/ad.mjs";
import { campaign } from "../../common/resources/campaign.mjs";
import { customer } from "../../common/resources/customer.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { DATE_RANGE_OPTIONS } from "./common-constants.mjs";
import { checkPrefix } from "../../common/utils.mjs";

const RESOURCES = [
  adGroup,
  ad,
  campaign,
  customer,
];

export default {
  ...common,
  key: "google_ads-create-report",
  name: "Create Report",
  description: "Generates a report from your Google Ads data. [See the documentation](https://developers.google.com/google-ads/api/fields/v16/overview)",
  version: "0.1.0",
  type: "action",
  props: {
    ...common.props,
    resource: {
      type: "string",
      label: "Resource",
      description: "The resource to generate a report for.",
      options: RESOURCES.map((r) => r.resourceOption),
      reloadProps: true,
    },
  },
  additionalProps() {
    const resource = RESOURCES.find((r) => r.resourceOption.value === this.resource);
    if (!resource) throw new ConfigurationError("Select one of the available resources.");

    const {
      label, value,
    } = resource.resourceOption;

    return {
      docsAlert: {
        type: "alert",
        alertType: "info",
        content: `[See the documentation](https://developers.google.com/google-ads/api/fields/v16/${value}) for more information on available fields, segments and metrics.`,
      },
      objectFilter: {
        type: "string[]",
        label: `Filter by ${label}s`,
        description: `Select the ${label}s to generate a report for (or leave blank for all ${label}s)`,
        optional: true,
        useQuery: true,
        options: async ({
          query, prevContext: { nextPageToken: pageToken },
        }) => {
          const {
            accountId, customerClientId, resource,
          } = this;
          const {
            results, nextPageToken,
          } = await this.googleAds.listResources({
            accountId,
            customerClientId,
            resource,
            query,
            pageToken,
          });
          const options = results?.map?.((item) => this.getResourceOption(item, resource));
          return {
            options,
            context: {
              nextPageToken,
            },
          };
        },
      },
      dateRange: {
        type: "string",
        label: "Date Range",
        description: "Select a date range for the report",
        options: DATE_RANGE_OPTIONS,
        optional: true,
        reloadProps: true,
      },
      ...(this.dateRange === "CUSTOM" && {
        startDate: {
          type: "string",
          label: "Start Date",
          description: "The start date, in `YYYY-MM-DD` format",
        },
        endDate: {
          type: "string",
          label: "End Date",
          description: "The end date, in `YYYY-MM-DD` format",
        },
      }),
      fields: {
        type: "string[]",
        label: "Fields",
        description: "Select any fields you want to include in your report.",
        options: resource.fields,
        optional: true,
        reloadProps: true,
      },
      segments: {
        type: "string[]",
        label: "Segments",
        description: "Select any segments you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v16/segments)",
        options: resource.segments,
        default: [
          "segments.date",
        ],
        optional: true,
        reloadProps: true,
      },
      metrics: {
        type: "string[]",
        label: "Metrics",
        description: "Select any metrics you want to include in your report. See the documentation [here](https://developers.google.com/google-ads/api/fields/v16/metrics)",
        options: resource.metrics,
        optional: true,
        reloadProps: true,
      },
      orderBy: {
        type: "string",
        label: "Order By",
        description: "The field to order the results by",
        optional: true,
        options: [
          this.fields,
          this.segments,
          this.metrics,
        ].filter((v) => v).flatMap((value) => {
          let returnValue = value;
          if (typeof value === "string") {
            try {
              returnValue = JSON.parse(value);
            } catch (err) {
              returnValue = value.split(",");
            }
          }
          return returnValue?.map?.((str) => str.trim());
        }),
      },
      direction: {
        type: "string",
        label: "Direction",
        description: "The direction to order the results by, if `Order By` is specified",
        optional: true,
        options: [
          {
            label: "Ascending",
            value: "ASC",
          },
          {
            label: "Descending",
            value: "DESC",
          },
        ],
        default: "ASC",
      },
      limit: {
        type: "integer",
        label: "Limit",
        description: "The maximum number of results to return",
        optional: true,
      },
    };
  },
  methods: {
    getResourceOption(item, resource) {
      let label, value;
      switch (resource) {
      case "campaign":
        label = item.campaign.name;
        value = item.campaign.id;
        break;

      case "customer":
        label = item.customer.descriptiveName;
        value = item.customer.id;
        break;

      case "ad_group":
        label = item.adGroup.name;
        value = item.adGroup.id;
        break;

      case "ad_group_ad":
        label = item.adGroupAd.ad.name;
        value = item.adGroupAd.ad.id;
        break;
      }

      return {
        label,
        value,
      };
    },
    buildQuery() {
      const {
        resource, fields, segments, metrics, limit, orderBy, direction, objectFilter, dateRange,
      } = this;

      const filteredSegments = dateRange
        ? segments
        : segments?.filter((i) => i !== "segments.date");

      const selection = [
        ...checkPrefix(fields, resource),
        ...checkPrefix(filteredSegments, "segments"),
        ...checkPrefix(metrics, "metrics"),
      ];

      if (!selection.length) {
        throw new ConfigurationError("Select at least one field, segment or metric.");
      }

      let query = `SELECT ${selection.join(", ")} FROM ${resource}`;
      if (objectFilter) {
        query += ` WHERE ${resource === "ad_group_ad"
          ? "ad_group_ad.ad"
          : resource}.id IN (${objectFilter.join?.(", ") ?? objectFilter})`;
      }
      if (dateRange) {
        const dateClause = dateRange === "CUSTOM"
          ? `BETWEEN '${this.startDate}' AND '${this.endDate}'`
          : `DURING ${dateRange}`;
        query += ` ${objectFilter
          ? "AND"
          : "WHERE"} segments.date ${dateClause}`;
      }

      if (orderBy && direction) {
        query += ` ORDER BY ${orderBy} ${direction}`;
      }
      if (limit) {
        query += ` LIMIT ${limit}`;
      }

      return query;
    },
  },
  async run({ $ }) {
    const query = this.buildQuery();
    const results = (await this.googleAds.createReport({
      $,
      accountId: this.accountId,
      customerClientId: this.customerClientId,
      data: {
        query,
      },
    })) ?? [];

    const { length } = results;

    $.export("$summary", `Successfully obtained ${length} result${length === 1
      ? ""
      : "s"}`);
    return {
      query,
      results,
    };
  },
};

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.
Resource	`resource`	`string`	Select a value from the drop down menu:`{ "label": "Ad Group", "value": "ad_group" }{ "label": "Ad", "value": "ad_group_ad" }{ "label": "Campaign", "value": "campaign" }{ "label": "Customer", "value": "customer" }`

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