prebid.js 5.18.0 → 6.1.0

package/src/adapterManager.js

@@ -262,14 +262,16 @@ adapterManager.makeBidRequests = hook('sync', function (adUnits, auctionStart, a
       }
 
       let adUnitsS2SCopy = getAdUnitCopyForPrebidServer(adUnits, s2sConfig);
-      let tid = generateUUID();
+
+      // uniquePbsTid is so we know which server to send which bids to during the callBids function
+      let uniquePbsTid = generateUUID();
       adaptersServerSide.forEach(bidderCode => {
         const bidderRequestId = getUniqueIdentifierStr();
         const bidderRequest = {
           bidderCode,
           auctionId,
           bidderRequestId,
-          tid,
+          uniquePbsTid,
           bids: hookedGetBids({bidderCode, auctionId, bidderRequestId, 'adUnits': deepClone(adUnitsS2SCopy), labels, src: CONSTANTS.S2S.SRC}),
           auctionStart: auctionStart,
           timeout: s2sConfig.timeout,
@@ -350,7 +352,7 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
   serverBidRequests.forEach(serverBidRequest => {
     var index = -1;
     for (var i = 0; i < uniqueServerBidRequests.length; ++i) {
-      if (serverBidRequest.tid === uniqueServerBidRequests[i].tid) {
+      if (serverBidRequest.uniquePbsTid === uniqueServerBidRequests[i].uniquePbsTid) {
         index = i;
         break;
       }
@@ -360,7 +362,10 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
     }
   });
 
-  let counter = 0
+  let counter = 0;
+
+  // $.source.tid MUST be a unique UUID and also THE SAME between all PBS Requests for a given Auction
+  const sourceTid = generateUUID();
   _s2sConfigs.forEach((s2sConfig) => {
     if (s2sConfig && uniqueServerBidRequests[counter] && includes(s2sConfig.bidders, uniqueServerBidRequests[counter].bidderCode)) {
       // s2s should get the same client side timeout as other client side requests.
@@ -370,13 +375,13 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
       } : undefined);
       let adaptersServerSide = s2sConfig.bidders;
       const s2sAdapter = _bidderRegistry[s2sConfig.adapter];
-      let tid = uniqueServerBidRequests[counter].tid;
+      let uniquePbsTid = uniqueServerBidRequests[counter].uniquePbsTid;
       let adUnitsS2SCopy = uniqueServerBidRequests[counter].adUnitsS2SCopy;
 
-      let uniqueServerRequests = serverBidRequests.filter(serverBidRequest => serverBidRequest.tid === tid)
+      let uniqueServerRequests = serverBidRequests.filter(serverBidRequest => serverBidRequest.uniquePbsTid === uniquePbsTid);
 
       if (s2sAdapter) {
-        let s2sBidRequest = {tid, 'ad_units': adUnitsS2SCopy, s2sConfig};
+        let s2sBidRequest = {tid: sourceTid, 'ad_units': adUnitsS2SCopy, s2sConfig};
         if (s2sBidRequest.ad_units.length) {
           let doneCbs = uniqueServerRequests.map(bidRequest => {
             bidRequest.start = timestamp();
@@ -391,7 +396,8 @@ adapterManager.callBids = (adUnits, bidRequests, addBidResponse, doneCb, request
 
           // fire BID_REQUESTED event for each s2s bidRequest
           uniqueServerRequests.forEach(bidRequest => {
-            events.emit(CONSTANTS.EVENTS.BID_REQUESTED, bidRequest);
+            // add the new sourceTid
+            events.emit(CONSTANTS.EVENTS.BID_REQUESTED, {...bidRequest, tid: sourceTid});
           });
 
           // make bid requests
@@ -621,4 +627,9 @@ adapterManager.callBidViewableBidder = function(bidder, bid) {
   tryCallBidderMethod(bidder, 'onBidViewable', bid);
 };
 
+adapterManager.callBidderError = function(bidder, error, bidderRequest) {
+  const param = { error, bidderRequest };
+  tryCallBidderMethod(bidder, 'onBidderError', param);
+};
+
 export default adapterManager;

package/src/adapters/bidderFactory.js

@@ -335,10 +335,11 @@ export function newBidder(spec) {
 
         // If the server responds with an error, there's not much we can do. Log it, and make sure to
         // call onResponse() so that we're one step closer to calling done().
-        function onFailure(err) {
+        function onFailure(errorMessage, error) {
           onTimelyResponse(spec.code);
-
-          logError(`Server call for ${spec.code} failed: ${err}. Continuing without bids.`);
+          adapterManager.callBidderError(spec.code, error, bidderRequest)
+          events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, { error, bidderRequest });
+          logError(`Server call for ${spec.code} failed: ${errorMessage} ${error.status}. Continuing without bids.`);
           onResponse();
         }
       }

package/src/auction.js

@@ -613,7 +613,8 @@ export const getPriceGranularity = (mediaType, bidReq) => {
  * @returns {function}
  */
 export const getPriceByGranularity = (granularity) => {
-  return (bid) => {
+  return (bid, bidReq) => {
+    granularity = granularity || getPriceGranularity(bid.mediaType, bidReq);
     if (granularity === CONSTANTS.GRANULARITY_OPTIONS.AUTO) {
       return bid.pbAg;
     } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.DENSE) {
@@ -646,14 +647,14 @@ export const getAdvertiserDomain = () => {
  * @param {BidRequest} bidReq
  * @returns {*}
  */
-export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
+export function getStandardBidderSettings(mediaType, bidderCode) {
   // factory for key value objs
   function createKeyVal(key, value) {
     return {
       key,
       val: (typeof value === 'function')
-        ? function (bidResponse) {
-          return value(bidResponse);
+        ? function (bidResponse, bidReq) {
+          return value(bidResponse, bidReq);
         }
         : function (bidResponse) {
           return getValue(bidResponse, value);
@@ -661,7 +662,6 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     };
   }
   const TARGETING_KEYS = CONSTANTS.TARGETING_KEYS;
-  const granularity = getPriceGranularity(mediaType, bidReq);
 
   let bidderSettings = $$PREBID_GLOBAL$$.bidderSettings;
   if (!bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD]) {
@@ -671,7 +671,7 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] = [
       createKeyVal(TARGETING_KEYS.BIDDER, 'bidderCode'),
       createKeyVal(TARGETING_KEYS.AD_ID, 'adId'),
-      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity(granularity)),
+      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity()),
       createKeyVal(TARGETING_KEYS.SIZE, 'size'),
       createKeyVal(TARGETING_KEYS.DEAL, 'dealId'),
       createKeyVal(TARGETING_KEYS.SOURCE, 'source'),
@@ -716,12 +716,12 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   // 1) set the keys from "standard" setting or from prebid defaults
   if (bidderSettings) {
     // initialize default if not set
-    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode, bidReq);
-    setKeys(keyValues, standardSettings, custBidObj);
+    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode);
+    setKeys(keyValues, standardSettings, custBidObj, bidReq);
 
     // 2) set keys from specific bidder setting override if they exist
     if (bidderCode && bidderSettings[bidderCode] && bidderSettings[bidderCode][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING]) {
-      setKeys(keyValues, bidderSettings[bidderCode], custBidObj);
+      setKeys(keyValues, bidderSettings[bidderCode], custBidObj, bidReq);
       custBidObj.sendStandardTargeting = bidderSettings[bidderCode].sendStandardTargeting;
     }
   }
@@ -734,7 +734,7 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   return keyValues;
 }
 
-function setKeys(keyValues, bidderSettings, custBidObj) {
+function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
   var targeting = bidderSettings[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING];
   custBidObj.size = custBidObj.getSize();
 
@@ -748,7 +748,7 @@ function setKeys(keyValues, bidderSettings, custBidObj) {
 
     if (isFn(value)) {
       try {
-        value = value(custBidObj);
+        value = value(custBidObj, bidReq);
       } catch (e) {
         logError('bidmanager', 'ERROR', e);
       }

package/src/constants.json

@@ -32,6 +32,7 @@
     "NO_BID": "noBid",
     "BID_WON": "bidWon",
     "BIDDER_DONE": "bidderDone",
+    "BIDDER_ERROR": "bidderError",
     "SET_TARGETING": "setTargeting",
     "BEFORE_REQUEST_BIDS": "beforeRequestBids",
     "BEFORE_BIDDER_HTTP": "beforeBidderHttp",

package/src/secureCreatives.js

@@ -60,7 +60,6 @@ export function receiveMessage(ev) {
       if (data.action === 'assetRequest') {
         const message = getAssetMessage(data, adObject);
         ev.source.postMessage(JSON.stringify(message), ev.origin);
-        return;
       } else if (data.action === 'allAssetRequest') {
         const message = getAllAssetsMessage(data, adObject);
         ev.source.postMessage(JSON.stringify(message), ev.origin);
@@ -68,13 +67,13 @@ export function receiveMessage(ev) {
         adObject.height = data.height;
         adObject.width = data.width;
         resizeRemoteCreative(adObject);
-      }
-
-      const trackerType = fireNativeTrackers(data, adObject);
-      if (trackerType === 'click') { return; }
+      } else {
+        const trackerType = fireNativeTrackers(data, adObject);
+        if (trackerType === 'click') { return; }
 
-      auctionManager.addWinningBid(adObject);
-      events.emit(BID_WON, adObject);
+        auctionManager.addWinningBid(adObject);
+        events.emit(BID_WON, adObject);
+      }
     }
   }
 }

package/src/targeting.js

@@ -123,17 +123,19 @@ export function newTargeting(auctionManager) {
     if (isGptPubadsDefined()) {
       const adUnitCodes = getAdUnitCodes(adUnitCode);
       const adUnits = auctionManager.getAdUnits().filter(adUnit => includes(adUnitCodes, adUnit.code));
+      let unsetKeys = pbTargetingKeys.reduce((reducer, key) => {
+        reducer[key] = null;
+        return reducer;
+      }, {});
       window.googletag.pubads().getSlots().forEach(slot => {
         let customSlotMatchingFunc = isFn(customSlotMatching) && customSlotMatching(slot);
-        pbTargetingKeys.forEach(function(key) {
-          // reset only registered adunits
-          adUnits.forEach(function(unit) {
-            if (unit.code === slot.getAdUnitPath() ||
-                unit.code === slot.getSlotElementId() ||
-                (isFn(customSlotMatchingFunc) && customSlotMatchingFunc(unit.code))) {
-              slot.setTargeting(key, null);
-            }
-          });
+        // reset only registered adunits
+        adUnits.forEach(unit => {
+          if (unit.code === slot.getAdUnitPath() ||
+              unit.code === slot.getSlotElementId() ||
+              (isFn(customSlotMatchingFunc) && customSlotMatchingFunc(unit.code))) {
+            slot.updateTargetingFromMap(unsetKeys);
+          }
         });
       });
     }

package/test/spec/modules/adfBidAdapter_spec.js

@@ -29,11 +29,34 @@ describe('Adf adapter', function () {
 
     it('should return true when required params found', function () {
       assert(spec.isBidRequestValid(bid));
+
+      bid.params = {
+        inv: 1234,
+        mname: 'some-placement'
+      };
+      assert(spec.isBidRequestValid(bid));
+
+      bid.params = {
+        mid: 4332,
+        inv: 1234,
+        mname: 'some-placement'
+      };
+      assert(spec.isBidRequestValid(bid));
     });
 
     it('should return false when required params are missing', function () {
       bid.params = { adxDomain: 'adx.adform.net' };
       assert.isFalse(spec.isBidRequestValid(bid));
+
+      bid.params = {
+        mname: 'some-placement'
+      };
+      assert.isFalse(spec.isBidRequestValid(bid));
+
+      bid.params = {
+        inv: 1234
+      };
+      assert.isFalse(spec.isBidRequestValid(bid));
     });
   });
 
@@ -331,6 +354,30 @@ describe('Adf adapter', function () {
         }
       });
 
+      describe('dynamic placement tag', function () {
+        it('should add imp parameters correctly', function () {
+          const validBidRequests = [
+            { bidId: 'bidId', params: { inv: 1000, mname: 'placement' }, mediaTypes: {video: {}} },
+            { bidId: 'bidId', params: { mid: 1234, inv: 1002, mname: 'placement2' }, mediaTypes: {video: {}} },
+            { bidId: 'bidId', params: { mid: 1234 }, mediaTypes: {video: {}} }
+          ];
+          const [ imp1, imp2, imp3 ] = getRequestImps(validBidRequests);
+
+          assert.equal(imp1.ext.bidder.inv, 1000);
+          assert.equal(imp1.ext.bidder.mname, 'placement');
+          assert.equal('tagid' in imp1, false);
+
+          assert.equal(imp2.ext.bidder.inv, 1002);
+          assert.equal(imp2.ext.bidder.mname, 'placement2');
+          assert.equal(imp2.tagid, 1234);
+
+          assert.ok(imp3.ext.bidder);
+          assert.equal('inv' in imp3.ext.bidder, false);
+          assert.equal('mname' in imp3.ext.bidder, false);
+          assert.equal(imp3.tagid, 1234);
+        });
+      });
+
       describe('price floors', function () {
         it('should not add if floors module not configured', function () {
           const validBidRequests = [{ bidId: 'bidId', params: {mid: 1000}, mediaTypes: {video: {}} }];
@@ -376,18 +423,14 @@ describe('Adf adapter', function () {
               return {
                 currency: currency,
                 floor
-              }
+              };
             }
           };
         }
-
-        function getRequestImps(validBidRequests) {
-          return JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data).imp;
-        }
       });
 
       describe('multiple media types', function () {
-        it('should use single media type for bidding', function () {
+        it('should use all configured media types for bidding', function () {
           let validBidRequests = [{
             bidId: 'bidId',
             params: { mid: 1000 },
@@ -414,20 +457,23 @@ describe('Adf adapter', function () {
               banner: {
                 sizes: [[100, 100], [200, 300]]
               },
-              native: {}
+              native: {},
+              video: {}
             }
           }];
-          let [ banner, video, native ] = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data).imp;
-
-          assert.ok(banner.banner);
-          assert.equal(banner.video, undefined);
-          assert.equal(banner.native, undefined);
-          assert.ok(video.video);
-          assert.equal(video.banner, undefined);
-          assert.equal(video.native, undefined);
-          assert.ok(native.native);
-          assert.equal(native.video, undefined);
-          assert.equal(native.banner, undefined);
+          let [ first, second, third ] = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data).imp;
+
+          assert.ok(first.banner);
+          assert.ok(first.video);
+          assert.equal(first.native, undefined);
+
+          assert.ok(second.video);
+          assert.equal(second.banner, undefined);
+          assert.equal(second.native, undefined);
+
+          assert.ok(third.native);
+          assert.ok(third.video);
+          assert.ok(third.banner);
         });
       });
 
@@ -626,6 +672,10 @@ describe('Adf adapter', function () {
         });
       });
     });
+
+    function getRequestImps(validBidRequests) {
+      return JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data).imp;
+    }
   });
 
   describe('interpretResponse', function () {
@@ -754,7 +804,12 @@ describe('Adf adapter', function () {
                   imptrackers: ['imptrackers url1', 'imptrackers url2']
                 },
                 dealid: 'deal-id',
-                adomain: [ 'demo.com' ]
+                adomain: [ 'demo.com' ],
+                ext: {
+                  prebid: {
+                    type: 'native'
+                  }
+                }
               }
             ]
           }],
@@ -767,7 +822,6 @@ describe('Adf adapter', function () {
           {
             bidId: 'bidId1',
             params: { mid: 1000 },
-            mediaType: 'native',
             nativeParams: {
               title: { required: true, len: 140 },
               image: { required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif'] },
@@ -899,7 +953,7 @@ describe('Adf adapter', function () {
         let serverResponse = {
           body: {
             seatbid: [{
-              bid: [{ impid: '1', adm: '<banner>' }]
+              bid: [{ impid: '1', adm: '<banner>', ext: { prebid: { type: 'banner' } } }]
             }]
           }
         };
@@ -908,8 +962,7 @@ describe('Adf adapter', function () {
           bids: [
             {
               bidId: 'bidId1',
-              params: { mid: 1000 },
-              mediaType: 'banner'
+              params: { mid: 1000 }
             }
           ]
         };
@@ -917,6 +970,8 @@ describe('Adf adapter', function () {
         bids = spec.interpretResponse(serverResponse, bidRequest);
         assert.equal(bids.length, 1);
         assert.equal(bids[0].ad, '<banner>');
+        assert.equal(bids[0].mediaType, 'banner');
+        assert.equal(bids[0].meta.mediaType, 'banner');
       });
     });
 
@@ -925,7 +980,7 @@ describe('Adf adapter', function () {
         let serverResponse = {
           body: {
             seatbid: [{
-              bid: [{ impid: '1', adm: '<vast>' }]
+              bid: [{ impid: '1', adm: '<vast>', ext: { prebid: { type: 'video' } } }]
             }]
           }
         };
@@ -934,8 +989,7 @@ describe('Adf adapter', function () {
           bids: [
             {
               bidId: 'bidId1',
-              params: { mid: 1000 },
-              mediaType: 'video'
+              params: { mid: 1000 }
             }
           ]
         };
@@ -943,13 +997,15 @@ describe('Adf adapter', function () {
         bids = spec.interpretResponse(serverResponse, bidRequest);
         assert.equal(bids.length, 1);
         assert.equal(bids[0].vastXml, '<vast>');
+        assert.equal(bids[0].mediaType, 'video');
+        assert.equal(bids[0].meta.mediaType, 'video');
       });
 
       it('should add renderer for outstream bids', function () {
         let serverResponse = {
           body: {
             seatbid: [{
-              bid: [{ impid: '1', adm: '<vast>' }, { impid: '2', adm: '<vast>' }]
+              bid: [{ impid: '1', adm: '<vast>', ext: { prebid: { type: 'video' } } }, { impid: '2', adm: '<vast>', ext: { prebid: { type: 'video' } } }]
             }]
           }
         };
@@ -959,7 +1015,6 @@ describe('Adf adapter', function () {
             {
               bidId: 'bidId1',
               params: { mid: 1000 },
-              mediaType: 'video',
               mediaTypes: {
                 video: {
                   context: 'outstream'
@@ -969,7 +1024,6 @@ describe('Adf adapter', function () {
             {
               bidId: 'bidId2',
               params: { mid: 1000 },
-              mediaType: 'video',
               mediaTypes: {
                 video: {
                   constext: 'instream'

package/test/spec/modules/adheseBidAdapter_spec.js

@@ -1,5 +1,6 @@
 import {expect} from 'chai';
 import {spec} from 'modules/adheseBidAdapter.js';
+import {config} from 'src/config.js';
 
 const BID_ID = 456;
 const TTL = 360;
@@ -131,12 +132,21 @@ describe('AdheseAdapter', function () {
       expect(JSON.parse(req.data)).to.not.have.key('eids');
     });
 
-    it('should request vast content as url', function () {
+    it('should request vast content as url by default', function () {
       let req = spec.buildRequests([ minimalBid() ], bidderRequest);
 
       expect(JSON.parse(req.data).vastContentAsUrl).to.equal(true);
     });
 
+    it('should request vast content as markup when configured', function () {
+      sinon.stub(config, 'getConfig').withArgs('adhese').returns({ vastContentAsUrl: false });
+
+      let req = spec.buildRequests([ minimalBid() ], bidderRequest);
+
+      expect(JSON.parse(req.data).vastContentAsUrl).to.equal(false);
+      config.getConfig.restore();
+    });
+
     it('should include bids', function () {
       let bid = minimalBid();
       let req = spec.buildRequests([ bid ], bidderRequest);
@@ -155,6 +165,22 @@ describe('AdheseAdapter', function () {
 
       expect(req.url).to.equal('https://ads-demo.adhese.com/json');
     });
+
+    it('should include params specified in the config', function () {
+      sinon.stub(config, 'getConfig').withArgs('adhese').returns({ globalTargets: { 'tl': [ 'all' ] } });
+      let req = spec.buildRequests([ minimalBid() ], bidderRequest);
+
+      expect(JSON.parse(req.data).parameters).to.deep.include({ 'tl': [ 'all' ] });
+      config.getConfig.restore();
+    });
+
+    it('should give priority to bid params over config params', function () {
+      sinon.stub(config, 'getConfig').withArgs('adhese').returns({ globalTargets: { 'xt': ['CONFIG_CONSENT_STRING'] } });
+      let req = spec.buildRequests([ minimalBid() ], bidderRequest);
+
+      expect(JSON.parse(req.data).parameters).to.deep.include({ 'xt': [ 'CONSENT_STRING' ] });
+      config.getConfig.restore();
+    });
   });
 
   describe('interpretResponse', () => {

package/test/spec/modules/adomikAnalyticsAdapter_spec.js

@@ -1,5 +1,6 @@
 import adomikAnalytics from 'modules/adomikAnalyticsAdapter.js';
 import {expect} from 'chai';
+
 let events = require('src/events');
 let adapterManager = require('src/adapterManager').default;
 let constants = require('src/constants.json');
@@ -8,6 +9,7 @@ describe('Adomik Prebid Analytic', function () {
   let sendEventStub;
   let sendWonEventStub;
   let clock;
+
   before(function () {
     clock = sinon.useFakeTimers();
   });
@@ -91,7 +93,7 @@ describe('Adomik Prebid Analytic', function () {
         type: 'request',
         event: {
           bidder: 'BIDDERTEST',
-          placementCode: 'placementtest',
+          placementCode: '0000',
         }
       });
 

package/test/spec/modules/adtelligentBidAdapter_spec.js

@@ -17,6 +17,7 @@ const aliasEP = {
   mediafuse: 'https://ghb.hbmp.mediafuse.com/v2/auction/',
   navelix: 'https://ghb.hb.navelix.com/v2/auction/',
   bidsxchange: 'https://ghb.hbd.bidsxchange.com/v2/auction/',
+  streamkey: 'https://ghb.hb.streamkey.net/v2/auction/',
 };
 
 const DEFAULT_ADATPER_REQ = { bidderCode: 'adtelligent' };