PostAffiliatePro Integration

integrations/PostAffiliatePro/browser.js

@@ -0,0 +1,137 @@
+/* eslint-disable class-methods-use-this */
+/* eslint-disable no-underscore-dangle */
+import get from "get-value";
+import updateSaleObject from "./utils";
+import ScriptLoader from "../ScriptLoader";
+import logger from "../../utils/logUtil";
+
+class PostAffiliatePro {
+  constructor(config) {
+    this.name = "POST_AFFILIATE_PRO";
+    this.url = config.url;
+    this.mergeProducts = config.mergeProducts;
+    this.accountId = config.accountId;
+    this.affLinkId = config.affLinkId;
+    this.idName = config.idName;
+    this.cookieLinkId = config.cookieLinkId;
+    this.cookieName = config.cookieName;
+    this.affiliateToCustomField = config.affiliateToCustomField;
+    this.campaignToCustomField = config.campaignToCustomField;
+    this.cookieDomain = config.cookieDomain;
+    this.cookieToCustomField = config.cookieToCustomField;
+    this.disableTrackingMethod = config.disableTrackingMethod;
+    this.paramNameUserId = config.paramNameUserId;
+    this.clickEvents = config.clickEvents;
+  }
+
+  init() {
+    logger.debug("===in init Post Affiliate Pro===");
+    if (!this.url) {
+      logger.debug("URL is missing");
+      return;
+    }
+    ScriptLoader("pap_x2s6df8d", this.url);
+  }
+
+  isLoaded() {
+    logger.debug("===In isLoaded Post Affiliate Pro===");
+    return !!window.PostAffTracker;
+  }
+
+  isReady() {
+    logger.debug("===In isReady Post Affiliate Pro===");
+
+    if (window.PostAffTracker) {
+      if (!this.disableTrackingMethod)
+        window.PostAffTracker.disableTrackingMethod("F");
+      if (this.paramNameUserId)
+        window.PostAffTracker.setParamNameUserId(this.paramNameUserId);
+      if (this.accountId) window.PostAffTracker.setAccountId(this.accountId);
+      if (this.cookieDomain)
+        window.PostAffTracker.setCookieDomain(this.cookieDomain);
+      if (this.cookieToCustomField)
+        window.PostAffTracker.writeCookieToCustomField(
+          this.cookieToCustomField
+        );
+      if (this.affiliateToCustomField)
+        window.PostAffTracker.writeAffiliateToCustomField(
+          this.affiliateToCustomField
+        );
+      if (this.campaignToCustomField)
+        window.PostAffTracker.writeCampaignToCustomField(
+          this.campaignToCustomField
+        );
+      if (this.affLinkId && this.idName)
+        window.PostAffTracker.writeAffiliateToLink(this.affLinkId, this.idName);
+      if (this.cookieName && this.cookieLinkId)
+        window.PostAffTracker.writeCookieToLink(
+          this.cookieLinkId,
+          this.cookieName
+        );
+      return true;
+    }
+    return false;
+  }
+
+  identify(rudderElement) {
+    logger.debug("===In Post Affiliate Pro identify===");
+    const { message } = rudderElement;
+    const visitorId = get(message, "userId");
+    window.PostAffTracker.setVisitorId(visitorId);
+  }
+  // eslint-disable-next-line lines-between-class-members
+  track(rudderElement) {
+    logger.debug("===In Post Affiliate Pro track===");
+    const clickEventsArr = this.clickEvents
+      ? this.clickEvents.split(",")
+      : null;
+    const { message } = rudderElement;
+    const { event } = message;
+    const { properties } = message;
+    // We are going to call click event, for the events given in dashboard only.
+    if (clickEventsArr && clickEventsArr.includes(event)) {
+      if (properties) {
+        if (properties.data1) window.Data1 = properties.data1;
+        if (properties.data2) window.Data2 = properties.data2;
+        if (properties.affiliateId) window.AffiliateID = properties.affiliateId;
+        if (properties.bannerId) window.BannerID = properties.bannerId;
+        if (properties.campaignId) window.CampaignID = properties.campaignId;
+        if (properties.channel) window.Channel = properties.channel;
+      }
+      window.PostAffTracker.track();
+    }
+    // We are supporting only one event for sale.
+    if (event === "Order Completed") {
+      const productsArr =
+        properties && properties.products ? properties.products : null;
+      if (productsArr) {
+        if (this.mergeProducts) {
+          window.sale = window.PostAffTracker.createSale();
+          if (window.sale) updateSaleObject(window.sale, properties);
+          const mergedProductId = [];
+          for (let i = 0; i < productsArr.length; i += 1)
+            if (productsArr[i].product_id)
+              mergedProductId.push(productsArr[i].product_id);
+          const merged = mergedProductId.join();
+          if (merged) window.sale.setProductID(merged);
+        } else {
+          for (let i = 0; i < productsArr.length; i += 1) {
+            window[`sale${i}`] = window.PostAffTracker.createSale();
+            updateSaleObject(window[`sale${i}`], properties);
+            if (productsArr[i].product_id)
+              window[`sale${i}`].setProductID(productsArr[i].product_id);
+          }
+        }
+      } else {
+        // If any product is not available.
+        window.sale = window.PostAffTracker.createSale();
+      }
+      window.PostAffTracker.register();
+    }
+  }
+
+  // reset() {
+  //   window.PostAffTracker.setVisitorId(null);
+  // }
+}
+export default PostAffiliatePro;

integrations/PostAffiliatePro/index.js

@@ -0,0 +1,3 @@
+import PostAffiliatePro from "./browser";
+
+export default PostAffiliatePro;

integrations/PostAffiliatePro/utils.js

@@ -0,0 +1,23 @@
+// This function helps to populate the sale object
+const updateSaleObject = (sale, properties) => {
+  if (properties.total) sale.setTotalCost(properties.total);
+  if (properties.fixedCost) sale.setFixedCost(properties.fixedCost);
+  if (properties.order_id) sale.setOrderID(properties.order_id);
+  // Post Affiliate Pro supports five extra data only.
+  if (properties.data1) sale.setData1(properties.data1);
+  if (properties.data2) sale.setData2(properties.data2);
+  if (properties.data3) sale.setData3(properties.data3);
+  if (properties.data4) sale.setData4(properties.data4);
+  if (properties.data5) sale.setData5(properties.data5);
+  if (properties.doNotDeleteCookies && properties.doNotDeleteCookies === true)
+    sale.doNotDeleteCookies();
+  if (properties.status) sale.setStatus(properties.status);
+  if (properties.currency) sale.setCurrency(properties.currency);
+  if (properties.customCommision)
+    sale.setCustomCommission(properties.customCommision);
+  if (properties.channel) sale.setChannelID(properties.channel);
+  if (properties.coupon) sale.setCoupon(properties.coupon);
+  if (properties.campaignId) sale.setCampaignID(properties.campaignId);
+  if (properties.affiliateId) sale.setAffiliateID(properties.affiliateId);
+};
+export default updateSaleObject;

integrations/client_server_name.js

@@ -41,6 +41,7 @@ const clientToServerNames = {
   MP: "Mixpanel",
   QUALTRICS: "Qualtrics",
   SENTRY: "Sentry",
+  POST_AFFILIATE_PRO: "PostAffiliatePro",
 };
 
 export { clientToServerNames };

integrations/index.js

@@ -40,10 +40,9 @@ import * as Sentry from "./Sentry";
 import * as SnapPixel from "./SnapPixel";
 import * as TVSquared from "./TVSquared";
 import * as VWO from "./VWO";
-
+import * as PostAffiliatePro from "./PostAffiliatePro";
 // the key names should match the destination.name value to keep partity everywhere
 // (config-plan name, native destination.name , exported integration name(this one below))
-
 const integrations = {
   ADOBE_ANALYTICS: AdobeAnalytics.default,
   AM: Amplitude.default,
@@ -87,6 +86,7 @@ const integrations = {
   SNAP_PIXEL: SnapPixel.default,
   TVSQUARED: TVSquared.default,
   VWO: VWO.default,
+  POST_AFFILIATE_PRO: PostAffiliatePro.default,
 };
 
 export { integrations };

integrations/integration_cname.js

@@ -124,6 +124,12 @@ const commonNames = {
   quantumMetric: "QUANTUMMETRIC",
   quantummetric: "QUANTUMMETRIC",
   Quantum_Metric: "QUANTUMMETRIC",
+  PostAffiliatePro: "POST_AFFILIATE_PRO",
+  Post_affiliate_pro: "POST_AFFILIATE_PRO",
+  "Post Affiliate Pro": "POST_AFFILIATE_PRO",
+  postaffiliatepro: "POST_AFFILIATE_PRO",
+  POSTAFFILIATEPRO: "POST_AFFILIATE_PRO",
+  POST_AFFILIATE_PRO: "POST_AFFILIATE_PRO",
 };
 
 export { commonNames };