Datawrkz Analytics Adapter: add publisherId and apiKey options (prebid#13899)

* feat(analytics): added Datawrkz analytics adapter

* fix(analytics): lint fixes for Datawrkz Analytics Adapter

* fix(analytics): lint fixes for Datawrkz Analytics Adapter

* feat(analytics): add publisherId and apiKey config in Datawrkz Analytics Adapter

* Datawrkz Analytics Adapter: add tests for publisherId and apiKey config

---------

Co-authored-by: Monis Qadri <[email protected]>
Co-authored-by: Love Sharma <[email protected]>

Author: 3 people

modules/datawrkzAnalyticsAdapter.js

@@ -5,6 +5,7 @@ import { logInfo, logError } from '../src/utils.js';
 
 let ENDPOINT = 'https://prebid-api.highr.ai/analytics';
 const auctions = {};
+const adapterConfig = {};
 
 const datawrkzAnalyticsAdapter = Object.assign(adapter({ url: ENDPOINT, analyticsType: 'endpoint' }),
   {
@@ -125,15 +126,7 @@ const datawrkzAnalyticsAdapter = Object.assign(adapter({ url: ENDPOINT, analytic
             failureMessage: null,
           }
 
-          try {
-            fetch(ENDPOINT, {
-              method: 'POST',
-              body: JSON.stringify(payload),
-              headers: { 'Content-Type': 'application/json' }
-            });
-          } catch (e) {
-            logError('[DatawrkzAnalytics] Failed to send AD_RENDER_SUCCEEDED event', e, payload);
-          }
+          this.sendToEndPoint(payload)
 
           break;
         }
@@ -157,15 +150,7 @@ const datawrkzAnalyticsAdapter = Object.assign(adapter({ url: ENDPOINT, analytic
             failureMessage: message
           }
 
-          try {
-            fetch(ENDPOINT, {
-              method: 'POST',
-              body: JSON.stringify(payload),
-              headers: { 'Content-Type': 'application/json' }
-            });
-          } catch (e) {
-            logError('[DatawrkzAnalytics] Failed to send AD_RENDER_FAILED event', e, payload);
-          }
+          this.sendToEndPoint(payload)
 
           break;
         }
@@ -189,15 +174,7 @@ const datawrkzAnalyticsAdapter = Object.assign(adapter({ url: ENDPOINT, analytic
               adunits: adunitsArray
             };
 
-            try {
-              fetch(ENDPOINT, {
-                method: 'POST',
-                body: JSON.stringify(payload),
-                headers: { 'Content-Type': 'application/json' }
-              });
-            } catch (e) {
-              logError('[DatawrkzAnalytics] Sending failed', e, payload);
-            }
+            this.sendToEndPoint(payload)
 
             delete auctions[auctionId];
           }, 2000); // Wait 2 seconds for BID_WON to happen
@@ -208,13 +185,33 @@ const datawrkzAnalyticsAdapter = Object.assign(adapter({ url: ENDPOINT, analytic
         default:
           break;
       }
+    },
+    sendToEndPoint(payload) {
+      if (!adapterConfig.publisherId || !adapterConfig.apiKey) {
+        logError('[DatawrkzAnalytics] Missing mandatory config: publisherId or apiKey. Skipping event.');
+        return;
+      }
+
+      payload.publisherId = adapterConfig.publisherId
+      payload.apiKey = adapterConfig.apiKey
+
+      try {
+        fetch(ENDPOINT, {
+          method: 'POST',
+          body: JSON.stringify(payload),
+          headers: { 'Content-Type': 'application/json' }
+        });
+      } catch (e) {
+        logError('[DatawrkzAnalytics] Failed to send event', e, payload);
+      }
     }
   }
 );
 
 datawrkzAnalyticsAdapter.originEnableAnalytics = datawrkzAnalyticsAdapter.enableAnalytics;
 
 datawrkzAnalyticsAdapter.enableAnalytics = function (config) {
+  Object.assign(adapterConfig, config?.options || {});
   datawrkzAnalyticsAdapter.originEnableAnalytics(config);
   logInfo('[DatawrkzAnalytics] Enabled with config:', config);
 };

modules/datawrkzAnalyticsAdapter.md

@@ -19,5 +19,10 @@ Enable the adapter using:
 
 ```js
 pbjs.enableAnalytics({
-  provider: 'datawrkzanalytics'
+  provider: 'datawrkzanalytics',
+  options: {
+    publisherId: 'YOUR_PUBLISHER_ID',
+    apiKey: 'YOUR_API_KEY'
+  }
 });
+```

test/spec/modules/datawrkzAnalyticsAdapter_spec.js

@@ -25,7 +25,13 @@ describe("DatawrkzAnalyticsAdapter", function () {
     sandbox = sinon.createSandbox();
     fetchStub = sandbox.stub(window, "fetch");
 
-    adapterManager.enableAnalytics({ provider: "datawrkzanalytics" });
+    adapterManager.enableAnalytics({
+      provider: "datawrkzanalytics",
+      options: {
+        publisherId: "testPublisher",
+        apiKey: "testApiKey"
+      }
+    });
   });
 
   afterEach(function () {
@@ -126,6 +132,8 @@ describe("DatawrkzAnalyticsAdapter", function () {
     expect(options.headers["Content-Type"]).to.equal("application/json");
 
     const body = JSON.parse(options.body);
+    expect(body.publisherId).to.equal("testPublisher");
+    expect(body.apiKey).to.equal("testApiKey");
     expect(body.auctionId).to.equal(auctionId);
     expect(body.adunits[0].code).to.equal(adUnitCode);
     expect(body.adunits[0].bids[0].bidder).to.equal(bidder);
@@ -148,6 +156,8 @@ describe("DatawrkzAnalyticsAdapter", function () {
     const payload = JSON.parse(options.body);
 
     expect(payload.eventType).to.equal(AD_RENDER_SUCCEEDED);
+    expect(payload.publisherId).to.equal("testPublisher");
+    expect(payload.apiKey).to.equal("testApiKey");
     expect(payload.bidderCode).to.equal("appnexus");
     expect(payload.successDoc).to.be.a("string");
     expect(payload.failureReason).to.be.null;
@@ -170,6 +180,8 @@ describe("DatawrkzAnalyticsAdapter", function () {
     const payload = JSON.parse(options.body);
 
     expect(payload.eventType).to.equal(AD_RENDER_FAILED);
+    expect(payload.publisherId).to.equal("testPublisher");
+    expect(payload.apiKey).to.equal("testApiKey");
     expect(payload.bidderCode).to.equal("appnexus");
     expect(payload.successDoc).to.be.null;
     expect(payload.failureReason).to.equal("network");