Create Ad Group with Nextdoor Ads API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Ad Group with the Nextdoor 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 Nextdoor 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 Ad Group action
1. Connect your Nextdoor Ads account
2. Select a Advertiser ID
3. Select a Campaign ID
4. Configure Name
5. Select one or more Placements
6. Configure Bid Amount
7. Select a Bid Pricing Type
8. Configure Budget Amount
9. Configure Start Time
10. Optional- Configure End Time
11. Configure Number Of Frequency Caps
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 Ad Group on Nextdoor Ads

Description:Creates an ad group based on the input payload for an existing campaign. [See the documentation](https://developer.nextdoor.com/reference/adgroup-create).

Version:0.0.1

Key:nextdoor-create-ad-group

View on GitHub

Action Code#

import app from "../../nextdoor.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "nextdoor-create-ad-group",
  name: "Create Ad Group",
  description: "Creates an ad group based on the input payload for an existing campaign. [See the documentation](https://developer.nextdoor.com/reference/adgroup-create).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    advertiserId: {
      propDefinition: [
        app,
        "advertiserId",
      ],
    },
    campaignId: {
      propDefinition: [
        app,
        "campaignId",
        ({ advertiserId }) => ({
          advertiserId,
        }),
      ],
    },
    name: {
      description: "The name of the ad group.",
      propDefinition: [
        app,
        "name",
      ],
    },
    placements: {
      type: "string[]",
      label: "Placements",
      description: "The placements for the ad group.",
      options: [
        "RHR",
        "FEED",
        "FSF",
      ],
    },
    bidAmount: {
      type: "string",
      label: "Bid Amount",
      description: "The bid amount for the ad group. The value must be a string in the format `USD 10` as an example.",
    },
    bidPricingType: {
      type: "string",
      label: "Bid Pricing Type",
      description: "The bid pricing type for the ad group. The value must be one of `CPM`.",
      options: [
        "CPM",
      ],
    },
    budgetAmount: {
      type: "string",
      label: "Budget Amount",
      description: "The budget amount for the ad group. The value must be a string in the format `USD 10` as an example.",
    },
    startTime: {
      propDefinition: [
        app,
        "startTime",
      ],
    },
    endTime: {
      propDefinition: [
        app,
        "endTime",
      ],
    },
    numberOfFrequencyCaps: {
      type: "integer",
      label: "Number Of Frequency Caps",
      description: "The number of frequency caps to be collected. Defaults to `1`.",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    frequencyCapsPropsMapper(prefix) {
      const {
        [`${prefix}maxImpressions`]: maxImpressions,
        [`${prefix}numTimeunits`]: numTimeunits,
        [`${prefix}timeunit`]: timeunit,
      } = this;

      return {
        max_impressions: maxImpressions,
        num_timeunits: numTimeunits,
        timeunit,
      };
    },
    getFrequencyCapsPropDefinitions({
      prefix,
      label,
    } = {}) {
      return {
        [`${prefix}maxImpressions`]: {
          type: "integer",
          label: `${label} - Max Impressions`,
          description: "The maximum number of impressions.",
        },
        [`${prefix}numTimeunits`]: {
          type: "integer",
          label: `${label} - Number of Time Units`,
          description: "The number of time units for frequency caps.",
        },
        [`${prefix}timeunit`]: {
          type: "string",
          label: `${label} - Time Unit`,
          description: "The time unit for frequency caps.",
          options: [
            "MINUTE",
            "HOUR",
            "DAY",
            "WEEK",
            "MONTH",
          ],
        },
      };
    },
    createAdGroup(args = {}) {
      return this.app.post({
        path: "/adgroup/create",
        ...args,
      });
    },
  },
  async additionalProps() {
    const {
      numberOfFrequencyCaps,
      getFrequencyCapsPropDefinitions,
    } = this;

    return utils.getAdditionalProps({
      numberOfFields: numberOfFrequencyCaps,
      fieldName: "frequency cap",
      getPropDefinitions: getFrequencyCapsPropDefinitions,
    });
  },
  async run({ $ }) {
    const {
      createAdGroup,
      advertiserId,
      campaignId,
      name,
      placements,
      bidAmount,
      bidPricingType,
      budgetAmount,
      startTime,
      endTime,
      numberOfFrequencyCaps,
      frequencyCapsPropsMapper,
    } = this;

    const response = await createAdGroup({
      $,
      data: {
        advertiser_id: advertiserId,
        campaign_id: campaignId,
        name,
        placements: utils.parseArray(placements),
        bid: {
          amount: bidAmount,
          pricing_type: bidPricingType,
        },
        budget: {
          amount: budgetAmount,
          budget_type: "DAILY_CAP_MONEY",
        },
        start_time: startTime,
        end_time: endTime,
        frequency_caps: utils.getFieldsProps({
          numberOfFields: numberOfFrequencyCaps,
          fieldName: "frequency cap",
          propsMapper: frequencyCapsPropsMapper,
        }),
      },
    });

    $.export("$summary", `Successfully created ad group 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
Nextdoor Ads	`app`	`app`	This component uses the Nextdoor Ads app.
Advertiser ID	`advertiserId`	`string`	Select a value from the drop down menu.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the ad group.
Placements	`placements`	`string[]`	Select a value from the drop down menu:`RHRFEEDFSF`
Bid Amount	`bidAmount`	`string`	The bid amount for the ad group. The value must be a string in the format `USD 10` as an example.
Bid Pricing Type	`bidPricingType`	`string`	Select a value from the drop down menu:`CPM`
Budget Amount	`budgetAmount`	`string`	The budget amount for the ad group. The value must be a string in the format `USD 10` as an example.
Start Time	`startTime`	`string`	The start time in ZonedDateTime format. This date time should be in the future. Eg. `2023-08-03T10:15:30-07:00[America/Los_Angeles]`. See the documentation
End Time	`endTime`	`string`	The end time in ZonedDateTime format. If the End Time is not passed in, then the AdGroup is assumed to be running continuously. Eg. `2023-08-03T10:15:30-07:00[America/Los_Angeles]`. See the documentation
Number Of Frequency Caps	`numberOfFrequencyCaps`	`integer`	The number of frequency caps to be collected. Defaults to `1`.

Action Authentication#

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

About Nextdoor Ads#

Nextdoor is an app for neighborhoods where you can get local tips, buy and sell items, and more.

More Ways to Connect Nextdoor Ads + npm#

Other Popular Integrations#

Create Advertiser with Nextdoor Ads API on New Download Counts from npm API

npm + Nextdoor Ads

Try it

Create Advertiser with Nextdoor Ads API on New Package Version from npm API

npm + Nextdoor Ads

Try it

Create Ad with Nextdoor Ads API on New Download Counts from npm API

npm + Nextdoor Ads

Try it

Create Ad with Nextdoor Ads API on New Package Version from npm API

npm + Nextdoor Ads

Try it

Create Ad Group with Nextdoor Ads API on New Package Version from npm API

npm + Nextdoor Ads

Try it

Popular Triggers#

New Download Counts from the npm API

Emit new event with the latest count of downloads for an npm package. See the documentation

Try it

New Package Version from the npm API

Emit new event when a new version of an npm package is published. See the documentation

Try it

Popular Actions#

Create Ad with the Nextdoor Ads API

Creates an ad based on the input payload for an existing NAM ad group. See the documentation

Try it

Create Ad Group with the Nextdoor Ads API

Creates an ad group based on the input payload for an existing campaign. See the documentation

Try it

Create Advertiser with the Nextdoor Ads API

Creates an advertiser that is tied to the NAM profile the API credentials are tied to. See the documentation

Try it

Create Campaign with the Nextdoor Ads API

Creates a campaign. See the documentation

Try it

Create Scheduled Report with the Nextdoor Ads API

Creates a scheduled report based on the input configuration. Upon a successful request the report will be sent out based on the schedule cadence. See the documentation

Try it