SupplyChain object support in Prebid

modules/pubmaticBidAdapter.js

@@ -738,6 +738,38 @@ function _blockedIabCategoriesValidation(payload, blockedIabCategories) {
   }
 }
 
+function _handleDealCustomTargetings(payload, dctrArr, validBidRequests) {
+  var dctr = '';
+  var dctrLen;
+  // set dctr value in site.ext, if present in validBidRequests[0], else ignore
+  if (dctrArr.length > 0) {
+    if (validBidRequests[0].params.hasOwnProperty('dctr')) {
+      dctr = validBidRequests[0].params.dctr;
+      if (utils.isStr(dctr) && dctr.length > 0) {
+        var arr = dctr.split('|');
+        dctr = '';
+        arr.forEach(val => {
+          dctr += (val.length > 0) ? (val.trim() + '|') : '';
+        });
+        dctrLen = dctr.length;
+        if (dctr.substring(dctrLen, dctrLen - 1) === '|') {
+          dctr = dctr.substring(0, dctrLen - 1);
+        }
+        payload.site.ext = {
+          key_val: dctr.trim()
+        }
+      } else {
+        utils.logWarn(LOG_WARN_PREFIX + 'Ignoring param : dctr with value : ' + dctr + ', expects string-value, found empty or non-string value');
+      }
+      if (dctrArr.length > 1) {
+        utils.logWarn(LOG_WARN_PREFIX + 'dctr value found in more than 1 adunits. Value from 1st adunit will be picked. Ignoring values from subsequent adunits');
+      }
+    } else {
+      utils.logWarn(LOG_WARN_PREFIX + 'dctr value not found in 1st adunit, ignoring values from subsequent adunits');
+    }
+  }
+}
+
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
@@ -779,11 +811,10 @@ export const spec = {
     var conf = _initConf(refererInfo);
     var payload = _createOrtbTemplate(conf);
     var bidCurrency = '';
-    var dctr = '';
-    var dctrLen;
     var dctrArr = [];
     var bid;
     var blockedIabCategories = [];
+    let schainConfig;
     validBidRequests.forEach(originalBid => {
       bid = utils.deepClone(originalBid);
       bid.params.adSlot = bid.params.adSlot || '';
@@ -818,6 +849,7 @@ export const spec = {
       if (impObj) {
         payload.imp.push(impObj);
       }
+      schainConfig = schainConfig || bid.schain;
     });
 
     if (payload.imp.length == 0) {
@@ -835,6 +867,19 @@ export const spec = {
     payload.ext.wrapper.wp = 'pbjs';
     payload.user.gender = (conf.gender ? conf.gender.trim() : UNDEFINED);
     payload.user.geo = {};
+    payload.user.geo.lat = _parseSlotParam('lat', conf.lat);
+    payload.user.geo.lon = _parseSlotParam('lon', conf.lon);
+    payload.user.yob = _parseSlotParam('yob', conf.yob);
+    payload.device.geo = payload.user.geo;
+    payload.site.page = conf.kadpageurl.trim() || payload.site.page.trim();
+    payload.site.domain = _getDomainFromURL(payload.site.page);
+    if (schainConfig) {
+      payload.source = {
+        ext: {
+          schain: schainConfig
+        }
+      };
+    }
 
     // Attaching GDPR Consent Params
     if (bidderRequest && bidderRequest.gdprConsent) {
@@ -849,43 +894,10 @@ export const spec = {
       };
     }
 
-    payload.user.geo.lat = _parseSlotParam('lat', conf.lat);
-    payload.user.geo.lon = _parseSlotParam('lon', conf.lon);
-    payload.user.yob = _parseSlotParam('yob', conf.yob);
-    payload.device.geo = payload.user.geo;
-    payload.site.page = conf.kadpageurl.trim() || payload.site.page.trim();
-    payload.site.domain = _getDomainFromURL(payload.site.page);
-
-    // set dctr value in site.ext, if present in validBidRequests[0], else ignore
-    if (dctrArr.length > 0) {
-      if (validBidRequests[0].params.hasOwnProperty('dctr')) {
-        dctr = validBidRequests[0].params.dctr;
-        if (utils.isStr(dctr) && dctr.length > 0) {
-          var arr = dctr.split('|');
-          dctr = '';
-          arr.forEach(val => {
-            dctr += (val.length > 0) ? (val.trim() + '|') : '';
-          });
-          dctrLen = dctr.length;
-          if (dctr.substring(dctrLen, dctrLen - 1) === '|') {
-            dctr = dctr.substring(0, dctrLen - 1);
-          }
-          payload.site.ext = {
-            key_val: dctr.trim()
-          }
-        } else {
-          utils.logWarn(LOG_WARN_PREFIX + 'Ignoring param : dctr with value : ' + dctr + ', expects string-value, found empty or non-string value');
-        }
-        if (dctrArr.length > 1) {
-          utils.logWarn(LOG_WARN_PREFIX + 'dctr value found in more than 1 adunits. Value from 1st adunit will be picked. Ignoring values from subsequent adunits');
-        }
-      } else {
-        utils.logWarn(LOG_WARN_PREFIX + 'dctr value not found in 1st adunit, ignoring values from subsequent adunits');
-      }
-    }
-
+    _handleDealCustomTargetings(payload, dctrArr, validBidRequests);
     _handleEids(payload, validBidRequests);
     _blockedIabCategoriesValidation(payload, blockedIabCategories);
+
     return {
       method: 'POST',
       url: ENDPOINT,
@@ -902,6 +914,8 @@ export const spec = {
   interpretResponse: (response, request) => {
     const bidResponses = [];
     var respCur = DEFAULT_CURRENCY;
+    let parsedRequest = JSON.parse(request.data);
+    let parsedReferrer = parsedRequest.site && parsedRequest.site.ref ? parsedRequest.site.ref : '';
     try {
       if (response.body && response.body.seatbid && utils.isArray(response.body.seatbid)) {
         // Supporting multiple bid responses for same adSize
@@ -910,7 +924,6 @@ export const spec = {
           seatbidder.bid &&
             utils.isArray(seatbidder.bid) &&
             seatbidder.bid.forEach(bid => {
-              let parsedRequest = JSON.parse(request.data);
               let newBid = {
                 requestId: bid.impid,
                 cpm: (parseFloat(bid.price) || 0).toFixed(2),
@@ -921,7 +934,7 @@ export const spec = {
                 currency: respCur,
                 netRevenue: NET_REVENUE,
                 ttl: 300,
-                referrer: parsedRequest.site && parsedRequest.site.ref ? parsedRequest.site.ref : '',
+                referrer: parsedReferrer,
                 ad: bid.adm
               };
               if (parsedRequest.imp && parsedRequest.imp.length > 0) {

modules/schain.js

@@ -0,0 +1,127 @@
+import {config} from '../src/config';
+import {getGlobal} from '../src/prebidGlobal';
+import { isNumber, isStr, isArray, isPlainObject, hasOwn, logError, isInteger } from '../src/utils';
+
+// validate the supply chanin object
+// https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md
+
+export function isSchainObjectValid(schainObject) {
+  const schainErrorPrefix = 'Invalid schain object found: ';
+  const shouldBeAString = ' should be a string';
+  const shouldBeAnInteger = ' should be an Integer';
+  const shouldBeAnObject = ' should be an object';
+  const shouldBeAnArray = ' should be an Array';
+
+  if (!isPlainObject(schainObject)) {
+    logError(schainErrorPrefix + `schain` + shouldBeAnObject);
+    return false;
+  }
+
+  // complete: Integer
+  if (!isNumber(schainObject.complete) || !isInteger(schainObject.complete)) {
+    logError(schainErrorPrefix + `schain.complete` + shouldBeAnInteger);
+    return false;
+  }
+
+  // ver: String
+  if (!isStr(schainObject.ver)) {
+    logError(schainErrorPrefix + `schain.ver` + shouldBeAString);
+    return false;
+  }
+
+  // ext: Object [optional]
+  if (hasOwn(schainObject, 'ext')) {
+    if (!isPlainObject(schainObject.ext)) {
+      logError(schainErrorPrefix + `schain.ext` + shouldBeAnObject);
+      return false;
+    }
+  }
+
+  // nodes: Array of objects
+  if (!isArray(schainObject.nodes)) {
+    logError(schainErrorPrefix + `schain.nodes` + shouldBeAnArray);
+    return false;
+  }
+
+  // now validate each node
+  let isEachNodeIsValid = true;
+  schainObject.nodes.forEach(node => {
+    // asi: String
+    if (!isStr(node.asi)) {
+      isEachNodeIsValid = isEachNodeIsValid && false;
+      logError(schainErrorPrefix + `schain.nodes[].asi` + shouldBeAString);
+    }
+
+    // sid: String
+    if (!isStr(node.sid)) {
+      isEachNodeIsValid = isEachNodeIsValid && false;
+      logError(schainErrorPrefix + `schain.nodes[].sid` + shouldBeAString);
+    }
+
+    // hp: Integer
+    if (!isNumber(node.hp) || !isInteger(node.hp)) {
+      isEachNodeIsValid = isEachNodeIsValid && false;
+      logError(schainErrorPrefix + `schain.nodes[].hp` + shouldBeAnInteger);
+    }
+
+    // rid: String [Optional]
+    if (hasOwn(node, 'rid')) {
+      if (!isStr(node.rid)) {
+        isEachNodeIsValid = isEachNodeIsValid && false;
+        logError(schainErrorPrefix + `schain.nodes[].rid` + shouldBeAString);
+      }
+    }
+
+    // name: String [Optional]
+    if (hasOwn(node, 'name')) {
+      if (!isStr(node.name)) {
+        isEachNodeIsValid = isEachNodeIsValid && false;
+        logError(schainErrorPrefix + `schain.nodes[].name` + shouldBeAString);
+      }
+    }
+
+    // domain: String [Optional]
+    if (hasOwn(node, 'domain')) {
+      if (!isStr(node.domain)) {
+        isEachNodeIsValid = isEachNodeIsValid && false;
+        logError(schainErrorPrefix + `schain.nodes[].domain` + shouldBeAString);
+      }
+    }
+
+    // ext: Object [Optional]
+    if (hasOwn(node, 'ext')) {
+      if (!isPlainObject(node.ext)) {
+        isEachNodeIsValid = isEachNodeIsValid && false;
+        logError(schainErrorPrefix + `schain.nodes[].ext` + shouldBeAnObject);
+      }
+    }
+  });
+
+  if (!isEachNodeIsValid) {
+    return false;
+  }
+
+  return true;
+}
+
+export function copySchainObjectInAdunits(adUnits, schainObject) {
+  // copy schain object in all adUnits as adUnit.bid.schain
+  adUnits.forEach(adUnit => {
+    adUnit.bids.forEach(bid => {
+      bid.schain = schainObject;
+    });
+  });
+}
+
+export function init(config) {
+  getGlobal().requestBids.before(function(fn, reqBidsConfigObj) {
+    let schainObject = config.getConfig('schain');
+    if (isSchainObjectValid(schainObject)) {
+      copySchainObjectInAdunits(reqBidsConfigObj.adUnits || getGlobal().adUnits, schainObject);
+      // calling fn allows prebid to continue processing
+      return fn.call(this, reqBidsConfigObj);
+    }
+  }, 40);
+}
+
+init(config)

modules/schain.md

@@ -0,0 +1,42 @@
+# schain module
+
+Aggregators who manage Prebid wrappers on behalf of multiple publishers need to declare their intermediary status in the Supply Chain Object.  
+As the spec prohibits us from adding upstream intermediaries, Prebid requests in this case need to come with the schain information.
+In this use case, it's seems cumbersome to have every bidder in the wrapper separately configured the same schain information.
+
+Refer:
+- https://iabtechlab.com/sellers-json/
+- https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md 
+
+## Sample code for passing the schain object
+```
+pbjs.setConfig( {
+    "schain": {
+		"ver":"1.0",
+		"complete": 1,
+		"nodes": [
+		    {
+			   "asi":"indirectseller.com",
+			   "sid":"00001",
+			   "hp":1
+		    },
+
+            {
+			   "asi":"indirectseller-2.com",
+			   "sid":"00002",
+			   "hp":2
+		    },
+		]     
+	}
+});
+```
+
+## Workflow
+The schain module is not enabled by default as it may not be neccessary for all publishers.
+If required, schain module can be included as following
+```
+    $ gulp build --modules=schain,pubmaticBidAdapter,openxBidAdapter,rubiconBidAdapter,sovrnBidAdapter
+```
+The schian module will validate the schain object passed using pbjs.setConfig API.
+If the schain object is valid then it will be passed on to bidders/adapters in ```validBidRequests[].schain```
+You may refer pubmaticBidAdapter implementaion for the same.

modules/widespaceBidAdapter.js

@@ -177,7 +177,10 @@ export const spec = {
 function storeData(data, name, stringify = true) {
   const value = stringify ? JSON.stringify(data) : data;
   if (LOCAL_STORAGE_AVAILABLE) {
-    localStorage.setItem(name, value);
+    try {
+      // adding try-catch as this code was breaking CI sometimes for IE-11
+      localStorage.setItem(name, value);
+    } catch (e) {}
     return true;
   } else if (COOKIE_ENABLED) {
     const theDate = new Date();

src/utils.js

@@ -571,7 +571,7 @@ export function _map(object, callback) {
   return output;
 }
 
-var hasOwn = function (objectToCheck, propertyToCheckFor) {
+export function hasOwn(objectToCheck, propertyToCheckFor) {
   if (objectToCheck.hasOwnProperty) {
     return objectToCheck.hasOwnProperty(propertyToCheckFor);
   } else {

test/spec/modules/pubmaticBidAdapter_spec.js

@@ -24,8 +24,27 @@ describe('PubMatic adapter', function () {
   let bannerVideoAndNativeBidRequests;
   let bannerBidResponse;
   let videoBidResponse;
+  let schainConfig;
 
   beforeEach(function () {
+    schainConfig = {
+      'ver': '1.0',
+      'complete': 1,
+      'nodes': [
+        {
+          'asi': 'indirectseller.com',
+          'sid': '00001',
+          'hp': 1
+        },
+
+        {
+          'asi': 'indirectseller-2.com',
+          'sid': '00002',
+          'hp': 2
+        }
+      ]
+    };
+
     bidRequests = [
       {
         bidder: 'pubmatic',
@@ -55,7 +74,8 @@ describe('PubMatic adapter', function () {
         bidId: '23acc48ad47af5',
         requestId: '0fb4905b-9456-4152-86be-c6f6d259ba99',
         bidderRequestId: '1c56ad30b9b8ca8',
-        transactionId: '92489f71-1bf2-49a0-adf9-000cea934729'
+        transactionId: '92489f71-1bf2-49a0-adf9-000cea934729',
+        schain: schainConfig
       }
     ];
 
@@ -728,6 +748,7 @@ describe('PubMatic adapter', function () {
   		  expect(data.imp[0].banner.h).to.equal(250); // height
   		  expect(data.imp[0].ext.pmZoneId).to.equal(bidRequests[0].params.pmzoneid.split(',').slice(0, 50).map(id => id.trim()).join()); // pmzoneid
         expect(data.imp[0].bidfloorcur).to.equal(bidRequests[0].params.currency);
+        expect(data.source.ext.schain).to.deep.equal(bidRequests[0].schain);
   		});
 
       it('Request params check: without adSlot', function () {