PubMatic adapter: adding support for IAB bcat parameter

modules/pubmaticBidAdapter.js

@@ -707,6 +707,30 @@ function _parseNativeResponse(bid, newBid) {
   }
 }
 
+function _blockedIabCategoriesValidation(payload, blockedIabCategories) {
+  blockedIabCategories = blockedIabCategories
+    .filter(function(category) {
+      if (typeof category === 'string') { // only strings
+        return true;
+      } else {
+        utils.logWarn(LOG_WARN_PREFIX + 'bcat: Each category should be a string, ignoring category: ' + category);
+        return false;
+      }
+    })
+    .map(category => category.trim()) // trim all
+    .filter(function(category, index, arr) { // minimum 3 charaters length
+      if (category.length > 3) {
+        return arr.indexOf(category) === index; // unique value only
+      } else {
+        utils.logWarn(LOG_WARN_PREFIX + 'bcat: Each category should have a value of a length of more than 3 characters, ignoring category: ' + category)
+      }
+    });
+  if (blockedIabCategories.length > 1) {
+    utils.logWarn(LOG_WARN_PREFIX + 'bcat: Selected: ', blockedIabCategories);
+    payload.bcat = blockedIabCategories;
+  }
+}
+
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
@@ -756,6 +780,7 @@ export const spec = {
     var dctrLen;
     var dctrArr = [];
     var bid;
+    var blockedIabCategories = [];
     validBidRequests.forEach(originalBid => {
       bid = utils.deepClone(originalBid);
       _parseAdSlot(bid);
@@ -789,6 +814,9 @@ export const spec = {
       if (bid.params.hasOwnProperty('dctr') && utils.isStr(bid.params.dctr)) {
         dctrArr.push(bid.params.dctr);
       }
+      if (bid.params.hasOwnProperty('bcat') && utils.isArray(bid.params.bcat)) {
+        blockedIabCategories = blockedIabCategories.concat(bid.params.bcat);
+      }
       var impObj = _createImpressionObject(bid, conf);
       if (impObj) {
         payload.imp.push(impObj);
@@ -860,6 +888,7 @@ export const spec = {
     }
 
     _handleEids(payload);
+    _blockedIabCategoriesValidation(payload, blockedIabCategories);
     return {
       method: 'POST',
       url: ENDPOINT,

modules/pubmaticBidAdapter.md

@@ -34,7 +34,8 @@ var adUnits = [
         gender: 'M',                         // optional
         kadfloor: '0.50',                    // optional
         currency: 'AUD'                      // optional (Value configured only in the 1st adunit will be passed on. < br/> Values if present in subsequent adunits, will be ignored.)
-        dctr: 'key1=123|key2=345'            // optional (Value configured only in the 1st adunit will be passed on. < br/> Values if present in subsequent adunits, will be ignored.)
+        dctr: 'key1=123|key2=345',            // optional (Value configured only in the 1st adunit will be passed on. < br/> Values if present in subsequent adunits, will be ignored.)
+        bcat: ['IAB1-5', 'IAB1-7']                // Optional: Blocked IAB Categories. (Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
       }
     }]
 }];

test/spec/modules/pubmaticBidAdapter_spec.js

@@ -1805,6 +1805,100 @@ describe('PubMatic adapter', function () {
       expect(data.site.ext).to.not.exist;
     });
 
+    describe('Request param bcat checking', function() {
+      let multipleBidRequests = [
+        {
+          bidder: 'pubmatic',
+          params: {
+            publisherId: '301',
+            adSlot: '/15671365/DMDemo@300x250:0',
+            kadfloor: '1.2',
+            pmzoneid: 'aabc, ddef',
+            kadpageurl: 'www.publisher.com',
+            yob: '1986',
+            gender: 'M',
+            lat: '12.3',
+            lon: '23.7',
+            wiid: '1234567890',
+            profId: '100',
+            verId: '200',
+            currency: 'AUD',
+            dctr: 'key1=val1|key2=val2,!val3'
+          },
+          placementCode: '/19968336/header-bid-tag-1',
+          sizes: [[300, 250], [300, 600]],
+          bidId: '23acc48ad47af5',
+          requestId: '0fb4905b-9456-4152-86be-c6f6d259ba99',
+          bidderRequestId: '1c56ad30b9b8ca8',
+          transactionId: '92489f71-1bf2-49a0-adf9-000cea934729'
+        },
+        {
+          bidder: 'pubmatic',
+          params: {
+            publisherId: '301',
+            adSlot: '/15671365/DMDemo@300x250:0',
+            kadfloor: '1.2',
+            pmzoneid: 'aabc, ddef',
+            kadpageurl: 'www.publisher.com',
+            yob: '1986',
+            gender: 'M',
+            lat: '12.3',
+            lon: '23.7',
+            wiid: '1234567890',
+            profId: '100',
+            verId: '200',
+            currency: 'GBP',
+            dctr: 'key1=val3|key2=val1,!val3|key3=val123'
+          },
+          placementCode: '/19968336/header-bid-tag-1',
+          sizes: [[300, 250], [300, 600]],
+          bidId: '23acc48ad47af5',
+          requestId: '0fb4905b-9456-4152-86be-c6f6d259ba99',
+          bidderRequestId: '1c56ad30b9b8ca8',
+          transactionId: '92489f71-1bf2-49a0-adf9-000cea934729'
+        }
+      ];
+
+      it('bcat: pass only strings', function() {
+        multipleBidRequests[0].params.bcat = [1, 2, 3, 'IAB1', 'IAB2'];
+        let request = spec.buildRequests(multipleBidRequests);
+        let data = JSON.parse(request.data);
+        expect(data.bcat).to.exist.and.to.deep.equal(['IAB1', 'IAB2']);
+      });
+
+      it('bcat: pass strings with length greater than 3', function() {
+        multipleBidRequests[0].params.bcat = ['AB', 'CD', 'IAB1', 'IAB2'];
+        let request = spec.buildRequests(multipleBidRequests);
+        let data = JSON.parse(request.data);
+        expect(data.bcat).to.exist.and.to.deep.equal(['IAB1', 'IAB2']);
+      });
+
+      it('bcat: trim the strings', function() {
+        multipleBidRequests[0].params.bcat = ['   IAB1    ', '   IAB2   '];
+        let request = spec.buildRequests(multipleBidRequests);
+        let data = JSON.parse(request.data);
+        expect(data.bcat).to.exist.and.to.deep.equal(['IAB1', 'IAB2']);
+      });
+
+      it('bcat: pass only unique strings', function() {
+        // multi slot
+        multipleBidRequests[0].params.bcat = ['IAB1', 'IAB2', 'IAB1', 'IAB2', 'IAB1', 'IAB2'];
+        multipleBidRequests[1].params.bcat = ['IAB1', 'IAB2', 'IAB1', 'IAB2', 'IAB1', 'IAB3'];
+        let request = spec.buildRequests(multipleBidRequests);
+        let data = JSON.parse(request.data);
+        expect(data.bcat).to.exist.and.to.deep.equal(['IAB1', 'IAB2', 'IAB3']);
+      });
+
+      it('bcat: do not pass bcat if all entries are invalid', function() {
+        // multi slot
+        multipleBidRequests[0].params.bcat = ['', 'IAB', 'IAB'];
+        multipleBidRequests[1].params.bcat = ['    ', 22, 99999, 'IA'];
+        let request = spec.buildRequests(multipleBidRequests);
+        let data = JSON.parse(request.data);
+        expect(data.bcat).to.deep.equal(undefined);
+      });
+    });
+
     describe('Response checking', function () {
       it('should check for valid response values', function () {
         let request = spec.buildRequests(bidRequests);