Prebid Core & Browsi RTD provider: Support Vendor Billing with Billable events

modules/browsiRtdProvider.js

@@ -15,13 +15,15 @@
  * @property {?string} keyName
  */
 
-import {deepClone, deepSetValue, isFn, isGptPubadsDefined, isNumber, logError} from '../src/utils.js';
+import {deepClone, deepSetValue, isFn, isGptPubadsDefined, isNumber, logError, logInfo, generateUUID} from '../src/utils.js';
 import {submodule} from '../src/hook.js';
 import {ajaxBuilder} from '../src/ajax.js';
 import {loadExternalScript} from '../src/adloader.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {find, includes} from '../src/polyfill.js';
 import {getGlobal} from '../src/prebidGlobal.js';
+import events from '../src/events.js';
+import CONSTANTS from '../src/constants.json';
 
 const storage = getStorageManager();
 
@@ -106,6 +108,7 @@ export function setData(data) {
 }
 
 function getRTD(auc) {
+  logInfo(`Browsi RTD provider is fetching data for ${auc}`);
   try {
     const _bp = (_browsiData && _browsiData.p) || {};
     return auc.reduce((rp, uc) => {
@@ -331,13 +334,23 @@ export const browsiSubmodule = {
   getBidRequestData: setBidRequestsData
 };
 
-function getTargetingData(uc) {
+function getTargetingData(uc, c, us, a) {
   const targetingData = getRTD(uc);
+  const auctionId = a.auctionId
   uc.forEach(auc => {
     if (isNumber(_ic[auc])) {
       _ic[auc] = _ic[auc] + 1;
     }
+    const transactionId = a.adUnits.find(adUnit => adUnit.code === auc).transactionId;
+    events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
+      vendor: 'browsi',
+      type: 'adRequest',
+      billingId: generateUUID(),
+      transactionId: transactionId,
+      auctionId: auctionId
+    })
   });
+  logInfo('Browsi RTD provider returned targeting data', targetingData, 'for', uc)
   return targetingData;
 }
 

modules/rtdModule/index.js

@@ -36,6 +36,7 @@
  * @param {string[]} adUnitsCodes
  * @param {SubmoduleConfig} config
  * @param {UserConsentData} userConsent
+ * @param {auction} auction
  */
 
 /**
@@ -339,7 +340,7 @@ export function getAdUnitTargeting(auction) {
   }
   let targeting = [];
   for (let i = relevantSubModules.length - 1; i >= 0; i--) {
-    const smTargeting = relevantSubModules[i].getTargetingData(adUnitCodes, relevantSubModules[i].config, _userConsent);
+    const smTargeting = relevantSubModules[i].getTargetingData(adUnitCodes, relevantSubModules[i].config, _userConsent, auction);
     if (smTargeting && typeof smTargeting === 'object') {
       targeting.push(smTargeting);
     } else {
@@ -353,6 +354,7 @@ export function getAdUnitTargeting(auction) {
     if (!kv) {
       return
     }
+    logInfo('RTD set ad unit targeting of', kv, 'for', adUnit);
     adUnit[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] = Object.assign(adUnit[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] || {}, kv);
   });
   return auction.adUnits;

src/AnalyticsAdapter.js

@@ -20,7 +20,8 @@ const {
     AD_RENDER_FAILED,
     AD_RENDER_SUCCEEDED,
     AUCTION_DEBUG,
-    ADD_AD_UNITS
+    ADD_AD_UNITS,
+    BILLABLE_EVENT
   }
 } = CONSTANTS;
 
@@ -117,6 +118,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
         [AD_RENDER_SUCCEEDED]: args => this.enqueue({ eventType: AD_RENDER_SUCCEEDED, args }),
         [AUCTION_DEBUG]: args => this.enqueue({ eventType: AUCTION_DEBUG, args }),
         [ADD_AD_UNITS]: args => this.enqueue({ eventType: ADD_AD_UNITS, args }),
+        [BILLABLE_EVENT]: args => this.enqueue({ eventType: BILLABLE_EVENT, args }),
         [AUCTION_INIT]: args => {
           args.config = typeof config === 'object' ? config.options || {} : {}; // enableAnaltyics configuration object
           this.enqueue({ eventType: AUCTION_INIT, args });

src/constants.json

@@ -43,7 +43,8 @@
     "TCF2_ENFORCEMENT": "tcf2Enforcement",
     "AUCTION_DEBUG": "auctionDebug",
     "BID_VIEWABLE": "bidViewable",
-    "STALE_RENDER": "staleRender"
+    "STALE_RENDER": "staleRender",
+    "BILLABLE_EVENT": "billableEvent"
   },
   "AD_RENDER_FAILED_REASON" : {
     "PREVENT_WRITING_ON_MAIN_DOCUMENT": "preventWritingOnMainDocument",

test/spec/modules/browsiRtdProvider_spec.js

@@ -1,6 +1,8 @@
 import * as browsiRTD from '../../../modules/browsiRtdProvider.js';
 import {makeSlot} from '../integration/faker/googletag.js';
 import * as utils from '../../../src/utils'
+import {default as events} from '../../../src/events';
+import * as sinon from 'sinon';
 
 describe('browsi Real time  data sub module', function () {
   const conf = {
@@ -15,6 +17,28 @@ describe('browsi Real time  data sub module', function () {
       }
     }]
   };
+  const auction = {adUnits: [
+    {
+      code: 'adMock',
+      transactionId: 1
+    },
+    {
+      code: 'hasPrediction',
+      transactionId: 1
+    }
+  ]};
+
+  let sandbox;
+  let eventsEmitSpy;
+
+  before(() => {
+    sandbox = sinon.sandbox.create();
+    eventsEmitSpy = sandbox.spy(events, ['emit']);
+  });
+
+  after(() => {
+    sandbox.restore();
+  });
 
   it('should init and return true', function () {
     browsiRTD.collectData();
@@ -61,13 +85,13 @@ describe('browsi Real time  data sub module', function () {
   describe('should return data to RTD module', function () {
     it('should return empty if no ad units defined', function () {
       browsiRTD.setData({});
-      expect(browsiRTD.browsiSubmodule.getTargetingData([])).to.eql({});
+      expect(browsiRTD.browsiSubmodule.getTargetingData([], null, null, auction)).to.eql({});
     });
 
     it('should return NA if no prediction for ad unit', function () {
       makeSlot({code: 'adMock', divId: 'browsiAd_2'});
       browsiRTD.setData({});
-      expect(browsiRTD.browsiSubmodule.getTargetingData(['adMock'])).to.eql({adMock: {bv: 'NA'}});
+      expect(browsiRTD.browsiSubmodule.getTargetingData(['adMock'], null, null, auction)).to.eql({adMock: {bv: 'NA'}});
     });
 
     it('should return prediction from server', function () {
@@ -78,7 +102,7 @@ describe('browsi Real time  data sub module', function () {
         pmd: undefined
       };
       browsiRTD.setData(data);
-      expect(browsiRTD.browsiSubmodule.getTargetingData(['hasPrediction'])).to.eql({hasPrediction: {bv: '0.20'}});
+      expect(browsiRTD.browsiSubmodule.getTargetingData(['hasPrediction'], null, null, auction)).to.eql({hasPrediction: {bv: '0.20'}});
     })
   })
 
@@ -135,4 +159,77 @@ describe('browsi Real time  data sub module', function () {
       expect(utils.deepAccess(fakeAdUnits[1], 'ortb2Imp.ext.data.browsi')).to.eql({bv: '0.10'});
     })
   })
+
+  describe('should emit billable event', function () {
+    beforeEach(() => {
+      eventsEmitSpy.resetHistory();
+    })
+    it('should send one event per ad unit code', function () {
+      const auction = {adUnits: [
+        {
+          code: 'a',
+          transactionId: 1
+        },
+        {
+          code: 'b',
+          transactionId: 2
+        },
+        {
+          code: 'a',
+          transactionId: 3
+        },
+      ]};
+
+      browsiRTD.browsiSubmodule.getTargetingData(['a', 'b'], null, null, auction);
+      expect(eventsEmitSpy.callCount).to.equal(2);
+    })
+    it('should send events only for received ad unit codes', function () {
+      const auction = {adUnits: [
+        {
+          code: 'a',
+          transactionId: 1
+        },
+        {
+          code: 'b',
+          transactionId: 2
+        },
+        {
+          code: 'c',
+          transactionId: 3
+        },
+      ]};
+
+      browsiRTD.browsiSubmodule.getTargetingData(['a'], null, null, auction);
+      expect(eventsEmitSpy.callCount).to.equal(1);
+      browsiRTD.browsiSubmodule.getTargetingData(['b'], null, null, auction);
+      expect(eventsEmitSpy.callCount).to.equal(2);
+    })
+    it('should use 1st transaction ID in case of twin ad unit codes', function () {
+      const auction = {
+        auctionId: '123',
+        adUnits: [
+          {
+            code: 'a',
+            transactionId: 1
+          },
+          {
+            code: 'a',
+            transactionId: 3
+          },
+        ]};
+
+      const expectedCall = {
+        vendor: 'browsi',
+        type: 'adRequest',
+        transactionId: 1,
+        auctionId: '123'
+      }
+
+      browsiRTD.browsiSubmodule.getTargetingData(['a'], null, null, auction);
+      const callArguments = eventsEmitSpy.getCalls()[0].args[1];
+      // billing id is random, we can't check its value
+      delete callArguments['billingId'];
+      expect(callArguments).to.eql(expectedCall);
+    })
+  })
 });

test/spec/modules/rubiconAnalyticsSchema.json

@@ -451,4 +451,4 @@
       }
     }
   }
-}
+}