[Components] nextdoor - new action components

components/nextdoor/actions/create-ad-group/create-ad-group.mjs

@@ -0,0 +1,202 @@
+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.",
+    },
+    budgetType: {
+      type: "string",
+      label: "Budget Type",
+      description: "The budget type for the ad group.",
+      options: [
+        "DAILY_CAP_MONEY",
+      ],
+    },
+    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",
+            "MINUTES",
+            "HOUR",
+            "HOURS",
+            "DAY",
+            "DAYS",
+            "WEEK",
+            "WEEKS",
+            "MONTH",
+            "MONTHS",
+          ],
+        },
+      };
+    },
+    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,
+      budgetType,
+      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: budgetType,
+        },
+        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;
+  },
+};

components/nextdoor/actions/create-ad/create-ad.mjs

@@ -0,0 +1,86 @@
+import app from "../../nextdoor.app.mjs";
+
+export default {
+  key: "nextdoor-create-ad",
+  name: "Create Ad",
+  description: "Creates an ad based on the input payload for an existing NAM ad group. [See the documentation](https://developer.nextdoor.com/reference/ad-create).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    advertiserId: {
+      propDefinition: [
+        app,
+        "advertiserId",
+      ],
+    },
+    campaignId: {
+      propDefinition: [
+        app,
+        "campaignId",
+        ({ advertiserId }) => ({
+          advertiserId,
+        }),
+      ],
+    },
+    adGroupId: {
+      propDefinition: [
+        app,
+        "adGroupId",
+        ({
+          advertiserId,
+          campaignId,
+        }) => ({
+          advertiserId,
+          campaignId,
+        }),
+      ],
+    },
+    creativeId: {
+      propDefinition: [
+        app,
+        "creativeId",
+        ({ advertiserId }) => ({
+          advertiserId,
+        }),
+      ],
+    },
+    name: {
+      description: "The name of the ad.",
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+  },
+  methods: {
+    createAd(args = {}) {
+      return this.app.post({
+        path: "/ad/create",
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      createAd,
+      advertiserId,
+      adGroupId,
+      creativeId,
+      name,
+    } = this;
+
+    const response = await createAd({
+      $,
+      data: {
+        advertiser_id: advertiserId,
+        adgroup_id: adGroupId,
+        creative_id: creativeId,
+        name,
+      },
+    });
+
+    $.export("$summary", `Successfully created ad with ID \`${response.id}\`.`);
+    return response;
+  },
+};

components/nextdoor/actions/create-advertiser/create-advertiser.mjs

@@ -0,0 +1,59 @@
+import app from "../../nextdoor.app.mjs";
+
+export default {
+  key: "nextdoor-create-advertiser",
+  name: "Create Advertiser",
+  description: "Creates an advertiser that is tied to the NAM profile the API credentials are tied to. [See the documentation](https://developer.nextdoor.com/reference/advertiser-create).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    name: {
+      description: "The name of the advertiser.",
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    websiteUrl: {
+      propDefinition: [
+        app,
+        "websiteUrl",
+      ],
+    },
+    categoryId: {
+      propDefinition: [
+        app,
+        "categoryId",
+      ],
+    },
+  },
+  methods: {
+    createAdvertiser(args = {}) {
+      return this.app.post({
+        path: "/advertiser/create",
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      createAdvertiser,
+      name,
+      websiteUrl,
+      categoryId,
+    } = this;
+
+    const response = await createAdvertiser({
+      $,
+      data: {
+        name,
+        website_url: websiteUrl,
+        category_id: categoryId,
+      },
+    });
+
+    $.export("$summary", `Successfully created advertiser with ID \`${response.id}\`.`);
+    return response;
+  },
+};