@pipedream/linkedin_ads 0.1.0 → 0.3.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The LinkedIn Ads API on Pipedream enables you to automate and integrate your LinkedIn advertising efforts with other services. Fetch campaign data, manage ad accounts, or automate ad creation and adjustments. With Pipedream, you can trigger workflows with HTTP requests, emails, and on a schedule, and connect to thousands of other apps with minimal effort.
+
+# Example Use Cases
+
+- **Sync LinkedIn Ad Campaigns to Google Sheets**: Automate the syncing of LinkedIn Ad campaign data into a Google Sheets spreadsheet. This workflow makes it easy to analyze ad performance, share reports with your team, and maintain records without manual data entry.
+
+- **LinkedIn Ad Performance Alerts via Slack or Email**: Set up a workflow that monitors your LinkedIn Ad campaigns for key performance metrics, and sends an alert via Slack or Email when your ads meet certain criteria, such as cost per click (CPC) thresholds or impressions goals, ensuring prompt reaction to ad performance.
+
+- **Automatic Ad Pausing Based on Budget Constraints**: Create a workflow that checks your LinkedIn Ad spend against your set budget and automatically pauses campaigns if spend exceeds your budget. This helps maintain control over your advertising costs without needing to check in manually.

package/linkedin_ads.app.mjs

@@ -1,4 +1,5 @@
 import app from "../linkedin/linkedin.app.mjs";
+import utils from "./common/utils.mjs";
 
 export default {
   ...app,
@@ -71,6 +72,83 @@ export default {
         }));
       },
     },
+    eventId: {
+      type: "string",
+      label: "Event ID",
+      description: "The ID of the event to retrieve registrations for.",
+      async options({
+        organizationId, page,
+      }) {
+        if (!organizationId) {
+          return [];
+        }
+        const count = 20;
+        const { elements } = await this.searchEvents({
+          params: {
+            q: "organizerLeadGenFormEnabledEvents",
+            organizer: this.getOrganizationUrn(organizationId),
+            count,
+            start: page * count,
+          },
+        });
+        return elements?.map(({
+          id: value, localizedName: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    conversionId: {
+      type: "string",
+      label: "Conversion ID",
+      description: "The ID of the conversion event.",
+      async options({
+        adAccountId, page,
+      }) {
+        const count = 20;
+        const { elements } = await this.searchConversions({
+          params: {
+            q: "account",
+            account: this.getSponsoredAccountUrn(adAccountId),
+            count,
+            start: page * count,
+          },
+        });
+        return elements?.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    leadFormId: {
+      type: "string",
+      label: "Lead Form ID",
+      description: "Select the lead form to retrieve responses for.",
+      async options({
+        page, adAccountId,
+      }) {
+        const count = 20;
+        const { elements } = await this.searchLeadForms({
+          debug: true,
+          params: {
+            q: "owner",
+            owner: `(sponsoredAccount:${this.getSponsoredAccountUrn(adAccountId)})`,
+            count,
+            start: page * count,
+          },
+        });
+        return elements.map(({
+          id,
+          name: label,
+        }) => ({
+          label,
+          value: String(id),
+        }));
+      },
+    },
   },
   methods: {
     ...app.methods,
@@ -80,6 +158,18 @@ export default {
     getSponsoredCampaignUrn(id) {
       return `urn:li:sponsoredCampaign:${id}`;
     },
+    getOrganizationUrn(id) {
+      return `urn:li:organization:${id}`;
+    },
+    getConversionUrn(id) {
+      return `urn:lla:llaPartnerConversion:${id}`;
+    },
+    getEventUrn(id) {
+      return `urn:li:event:${id}`;
+    },
+    getVersionedLeadGenFormUrn(id, version = 1) {
+      return `urn:li:versionedLeadGenForm:(urn:li:leadGenForm:${id},${version})`;
+    },
     searchCampaigns({
       adAccountId, ...args
     } = {}) {
@@ -88,5 +178,57 @@ export default {
         ...args,
       });
     },
+    searchLeadForms(args = {}) {
+      const keys = [
+        "owner",
+      ];
+      return this._makeRequest({
+        path: "/leadForms",
+        paramsSerializer: utils.getParamsSerializer(utils.encodeParamKeys(keys)),
+        ...args,
+      });
+    },
+    getLeadForm({
+      leadFormId, ...args
+    } = {}) {
+      return this._makeRequest({
+        debug: true,
+        path: `/leadForms/${leadFormId}`,
+        ...args,
+      });
+    },
+    searchEvents(args = {}) {
+      const keys = [
+        "organizer",
+      ];
+      return this._makeRequest({
+        debug: true,
+        path: "/events",
+        paramsSerializer: utils.getParamsSerializer(utils.encodeParamKeys(keys)),
+        transformResponse: utils.transformResponse,
+        ...args,
+      });
+    },
+    searchConversions(args = {}) {
+      return this._makeRequest({
+        debug: true,
+        path: "/conversions",
+        paramsSerializer: utils.getParamsSerializer(utils.encodeFn),
+        ...args,
+      });
+    },
+    searchLeadFormResponses(args = {}) {
+      const keys = [
+        "owner",
+        "versionedLeadGenFormUrn",
+        "associatedEntity",
+      ];
+      return this._makeRequest({
+        debug: true,
+        path: "/leadFormResponses",
+        paramsSerializer: utils.getParamsSerializer(utils.encodeParamKeys(keys)),
+        ...args,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/linkedin_ads",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Pipedream LinkedIn Ads Components",
   "main": "linkedin_ads.app.mjs",
   "keywords": [