prebid.js 5.19.0 → 6.2.0

package/src/auction.js

@@ -59,7 +59,7 @@
 
 import {
   flatten, timestamp, adUnitsFilter, deepAccess, getBidRequest, getValue, parseUrl, generateUUID,
-  logMessage, bind, logError, logInfo, logWarn, isEmpty, _each, isFn, isEmptyStr
+  logMessage, bind, logError, logInfo, logWarn, isEmpty, _each, isFn, isEmptyStr, isAllowZeroCpmBidsEnabled
 } from './utils.js';
 import { getPriceBucketString } from './cpmBucketManager.js';
 import { getNativeTargeting } from './native.js';
@@ -567,7 +567,8 @@ function getPreparedBidForAuction({adUnitCode, bid, bidderRequest, auctionId}) {
 
 function setupBidTargeting(bidObject, bidderRequest) {
   let keyValues;
-  if (bidObject.bidderCode && (bidObject.cpm > 0 || bidObject.dealId)) {
+  const cpmCheck = (isAllowZeroCpmBidsEnabled(bidObject.bidderCode)) ? bidObject.cpm >= 0 : bidObject.cpm > 0;
+  if (bidObject.bidderCode && (cpmCheck || bidObject.dealId)) {
     let bidReq = find(bidderRequest.bids, bid => bid.adUnitCode === bidObject.adUnitCode);
     keyValues = getKeyValueTargetingPairs(bidObject.bidderCode, bidObject, bidReq);
   }
@@ -613,7 +614,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 +648,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 +663,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 +672,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 +717,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 +735,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 +749,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/targeting.js

@@ -1,6 +1,6 @@
 import {
   uniques, isGptPubadsDefined, getHighestCpm, getOldestHighestCpmBid, groupBy, isAdUnitCodeMatchingSlot, timestamp,
-  deepAccess, deepClone, logError, logWarn, logInfo, isFn, isArray, logMessage, isStr
+  deepAccess, deepClone, logError, logWarn, logInfo, isFn, isArray, logMessage, isStr, isAllowZeroCpmBidsEnabled
 } from './utils.js';
 import { config } from './config.js';
 import { NATIVE_TARGETING_KEYS } from './native.js';
@@ -438,7 +438,7 @@ export function newTargeting(auctionManager) {
     const adUnitCodes = getAdUnitCodes(adUnitCode);
     return bidsReceived
       .filter(bid => includes(adUnitCodes, bid.adUnitCode))
-      .filter(bid => bid.cpm > 0)
+      .filter(bid => (isAllowZeroCpmBidsEnabled(bid.bidderCode)) ? bid.cpm >= 0 : bid.cpm > 0)
       .map(bid => bid.adUnitCode)
       .filter(uniques)
       .map(adUnitCode => bidsReceived

package/src/utils.js

@@ -1,5 +1,6 @@
 /* eslint-disable no-console */
 import { config } from './config.js';
+import { getGlobal } from './prebidGlobal.js';
 import clone from 'just-clone';
 import find from 'core-js-pure/features/array/find.js';
 import includes from 'core-js-pure/features/array/includes.js';
@@ -1294,3 +1295,9 @@ export function cyrb53Hash(str, seed = 0) {
   h2 = imul(h2 ^ (h2 >>> 16), 2246822507) ^ imul(h1 ^ (h1 >>> 13), 3266489909);
   return (4294967296 * (2097151 & h2) + (h1 >>> 0)).toString();
 }
+
+export function isAllowZeroCpmBidsEnabled(bidderCode) {
+  const bidderSettings = getGlobal().bidderSettings;
+  return ((bidderSettings[bidderCode] && bidderSettings[bidderCode].allowZeroCpmBids === true) ||
+   (bidderSettings.standard && bidderSettings.standard.allowZeroCpmBids === true));
+}

package/test/spec/integration/faker/googletag.js

@@ -51,9 +51,15 @@ export function enable() {
   window.googletag = {
     _slots: [],
     _callbackMap: {},
+    _ppid: undefined,
+    cmd: [],
     pubads: function () {
       var self = this;
       return {
+        setPublisherProvidedId: function (ppid) {
+          self._ppid = ppid;
+        },
+
         getSlots: function () {
           return self._slots;
         },

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/adnuntiusBidAdapter_spec.js

@@ -251,6 +251,24 @@ describe('adnuntiusBidAdapter', function () {
       expect(request[0]).to.have.property('url')
       expect(request[0].url).to.equal(ENDPOINT_URL_SEGMENTS);
     });
+
+    it('should user user ID if present in ortb2.user.id field', function () {
+      config.setBidderConfig({
+        bidders: ['adnuntius', 'other'],
+        config: {
+          ortb2: {
+            user: {
+              id: usi
+            }
+          }
+        }
+      });
+
+      const request = config.runWithBidder('adnuntius', () => spec.buildRequests(bidRequests));
+      expect(request.length).to.equal(1);
+      expect(request[0]).to.have.property('url')
+      expect(request[0].url).to.equal(ENDPOINT_URL);
+    });
   });
 
   describe('user privacy', function () {

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/adplusBidAdapter_spec.js

@@ -0,0 +1,213 @@
+import {expect} from 'chai';
+import {spec, BIDDER_CODE, ADPLUS_ENDPOINT, } from 'modules/adplusBidAdapter.js';
+import {newBidder} from 'src/adapters/bidderFactory.js';
+
+describe('AplusBidAdapter', function () {
+  const adapter = newBidder(spec);
+
+  describe('inherited functions', function () {
+    it('exists and is a function', function () {
+      expect(adapter.callBids).to.be.exist.and.to.be.a('function');
+    });
+  });
+
+  describe('isBidRequestValid', function () {
+    it('should return true when required params found', function () {
+      let validRequest = {
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        },
+        params: {
+          inventoryId: '30',
+          adUnitId: '1',
+        }
+      };
+      expect(spec.isBidRequestValid(validRequest)).to.equal(true);
+    });
+
+    it('should return false when required params are not passed', function () {
+      let validRequest = {
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        },
+        params: {
+          inventoryId: '30',
+        }
+      };
+      expect(spec.isBidRequestValid(validRequest)).to.equal(false);
+    });
+
+    it('should return false when required param types are wrong', function () {
+      let validRequest = {
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        },
+        params: {
+          inventoryId: 30,
+          adUnitId: '1',
+        }
+      };
+      expect(spec.isBidRequestValid(validRequest)).to.equal(false);
+    });
+
+    it('should return false when size is not exists', function () {
+      let validRequest = {
+        params: {
+          inventoryId: 30,
+          adUnitId: '1',
+        }
+      };
+      expect(spec.isBidRequestValid(validRequest)).to.equal(false);
+    });
+
+    it('should return false when size is wrong', function () {
+      let validRequest = {
+        mediaTypes: {
+          banner: {
+            sizes: [[300]]
+          }
+        },
+        params: {
+          inventoryId: 30,
+          adUnitId: '1',
+        }
+      };
+      expect(spec.isBidRequestValid(validRequest)).to.equal(false);
+    });
+  });
+
+  describe('buildRequests', function () {
+    let validRequest = [
+      {
+        bidder: BIDDER_CODE,
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        },
+        params: {
+          inventoryId: '-1',
+          adUnitId: '-3',
+        },
+        bidId: '2bdcb0b203c17d'
+      },
+    ];
+
+    let bidderRequest = {
+      refererInfo: {
+        referer: 'https://test.domain'
+      }
+    };
+
+    it('bidRequest HTTP method', function () {
+      const request = spec.buildRequests(validRequest, bidderRequest);
+      expect(request[0].method).to.equal('GET');
+    });
+
+    it('bidRequest url', function () {
+      const request = spec.buildRequests(validRequest, bidderRequest);
+      expect(request[0].url).to.equal(ADPLUS_ENDPOINT);
+    });
+
+    it('tests bidRequest data is clean and has the right values', function () {
+      const request = spec.buildRequests(validRequest, bidderRequest);
+
+      expect(request[0].data.bidId).to.equal('2bdcb0b203c17d');
+      expect(request[0].data.inventoryId).to.equal('-1');
+      expect(request[0].data.adUnitId).to.equal('-3');
+      expect(request[0].data.adUnitWidth).to.equal(300);
+      expect(request[0].data.adUnitHeight).to.equal(250);
+      expect(request[0].data.sdkVersion).to.equal('1');
+      expect(typeof request[0].data.session).to.equal('string');
+      expect(request[0].data.session).length(36);
+      expect(request[0].data.interstitial).to.equal(0);
+      expect(request[0].data).to.not.have.deep.property('extraData');
+      expect(request[0].data).to.not.have.deep.property('yearOfBirth');
+      expect(request[0].data).to.not.have.deep.property('gender');
+      expect(request[0].data).to.not.have.deep.property('categories');
+      expect(request[0].data).to.not.have.deep.property('latitude');
+      expect(request[0].data).to.not.have.deep.property('longitude');
+    });
+  });
+
+  describe('interpretResponse', function () {
+    const requestData = {
+      language: window.navigator.language,
+      screenWidth: 1440,
+      screenHeight: 900,
+      sdkVersion: '1',
+      inventoryId: '-1',
+      adUnitId: '-3',
+      adUnitWidth: 300,
+      adUnitHeight: 250,
+      domain: 'tassandigi.com',
+      pageUrl: 'https%3A%2F%2Ftassandigi.com%2Fserafettin%2Fads.html',
+      interstitial: 0,
+      session: '1c02db03-5289-932a-93af-7b4022611fec',
+      token: '1c02db03-5289-937a-93df-7b4022611fec',
+      secure: 1,
+      bidId: '2bdcb0b203c17d',
+    };
+    const bidRequest = {
+      'method': 'GET',
+      'url': ADPLUS_ENDPOINT,
+      'data': requestData,
+    };
+
+    const bidResponse = {
+      body: [
+        {
+          'ad': '<div>ad</div>',
+          'advertiserDomains': [
+            'advertiser.com'
+          ],
+          'categoryIDs': [
+            'IAB-111'
+          ],
+          'cpm': 3.57,
+          'creativeID': '1',
+          'currency': 'TRY',
+          'dealID': '1',
+          'height': 300,
+          'mediaType': 'banner',
+          'netRevenue': true,
+          'requestID': '2bdcb0b203c17d',
+          'ttl': 300,
+          'width': 250
+        }
+      ],
+      headers: {}
+    };
+
+    const emptyBidResponse = {
+      body: null,
+    };
+
+    it('returns an empty array when the result body is not valid', function () {
+      const result = spec.interpretResponse(emptyBidResponse, bidRequest);
+      expect(result).to.deep.equal([]);
+    });
+
+    it('result is correct', function () {
+      const result = spec.interpretResponse(bidResponse, bidRequest);
+      expect(result[0].requestId).to.equal('2bdcb0b203c17d');
+      expect(result[0].cpm).to.equal(3.57);
+      expect(result[0].width).to.equal(250);
+      expect(result[0].height).to.equal(300);
+      expect(result[0].creativeId).to.equal('1');
+      expect(result[0].currency).to.equal('TRY');
+      expect(result[0].dealId).to.equal('1');
+      expect(result[0].mediaType).to.equal('banner');
+      expect(result[0].netRevenue).to.equal(true);
+      expect(result[0].ttl).to.equal(300);
+      expect(result[0].meta.advertiserDomains).to.deep.equal(['advertiser.com']);
+      expect(result[0].meta.secondaryCatIds).to.deep.equal(['IAB-111']);
+    });
+  });
+});

package/test/spec/modules/adyoulikeBidAdapter_spec.js

@@ -590,6 +590,32 @@ describe('Adyoulike Adapter', function () {
       expect(payload.gdprConsent.consentRequired).to.be.null;
     });
 
+    it('should add userid eids information to the request', function () {
+      let bidderRequest = {
+        'auctionId': '1d1a030790a475',
+        'bidderRequestId': '22edbae2733bf6',
+        'timeout': 3000,
+        'userId': {
+          pubcid: '01EAJWWNEPN3CYMM5N8M5VXY22',
+          unsuported: '666'
+        }
+      };
+
+      bidderRequest.bids = bidRequestWithSinglePlacement;
+
+      const request = spec.buildRequests(bidRequestWithSinglePlacement, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.userId).to.exist;
+      expect(payload.userId).to.deep.equal([{
+        'source': 'pubcid.org',
+        'uids': [{
+          'atype': 1,
+          'id': '01EAJWWNEPN3CYMM5N8M5VXY22'
+        }]
+      }]);
+    });
+
     it('sends bid request to endpoint with single placement', function () {
       const request = spec.buildRequests(bidRequestWithSinglePlacement, bidderRequest);
       const payload = JSON.parse(request.data);

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -1004,12 +1004,16 @@ describe('AppNexusAdapter', function () {
 
   describe('interpretResponse', function () {
     let bfStub;
+    let bidderSettingsStorage;
+
     before(function() {
       bfStub = sinon.stub(bidderFactory, 'getIabSubCategory');
+      bidderSettingsStorage = $$PREBID_GLOBAL$$.bidderSettings;
     });
 
     after(function() {
       bfStub.restore();
+      $$PREBID_GLOBAL$$.bidderSettings = bidderSettingsStorage;
     });
 
     let response = {
@@ -1047,7 +1051,8 @@ describe('AppNexusAdapter', function () {
                 'trackers': [
                   {
                     'impression_urls': [
-                      'https://lax1-ib.adnxs.com/impression'
+                      'https://lax1-ib.adnxs.com/impression',
+                      'https://www.test.com/tracker'
                     ],
                     'video_events': {}
                   }
@@ -1076,6 +1081,15 @@ describe('AppNexusAdapter', function () {
           'adUnitCode': 'code',
           'appnexus': {
             'buyerMemberId': 958
+          },
+          'meta': {
+            'dchain': {
+              'ver': '1.0',
+              'complete': 0,
+              'nodes': [{
+                'bsid': '958'
+              }]
+            }
           }
         }
       ];
@@ -1084,11 +1098,46 @@ describe('AppNexusAdapter', function () {
           bidId: '3db3773286ee59',
           adUnitCode: 'code'
         }]
-      }
+      };
       let result = spec.interpretResponse({ body: response }, {bidderRequest});
       expect(Object.keys(result[0])).to.have.members(Object.keys(expectedResponse[0]));
     });
 
+    it('should reject 0 cpm bids', function () {
+      let zeroCpmResponse = deepClone(response);
+      zeroCpmResponse.tags[0].ads[0].cpm = 0;
+
+      let bidderRequest = {
+        bidderCode: 'appnexus'
+      };
+
+      let result = spec.interpretResponse({ body: zeroCpmResponse }, { bidderRequest });
+      expect(result.length).to.equal(0);
+    });
+
+    it('should allow 0 cpm bids if allowZeroCpmBids setConfig is true', function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        appnexus: {
+          allowZeroCpmBids: true
+        }
+      };
+
+      let zeroCpmResponse = deepClone(response);
+      zeroCpmResponse.tags[0].ads[0].cpm = 0;
+
+      let bidderRequest = {
+        bidderCode: 'appnexus',
+        bids: [{
+          bidId: '3db3773286ee59',
+          adUnitCode: 'code'
+        }]
+      };
+
+      let result = spec.interpretResponse({ body: zeroCpmResponse }, { bidderRequest });
+      expect(result.length).to.equal(1);
+      expect(result[0].cpm).to.equal(0);
+    });
+
     it('handles nobid responses', function () {
       let response = {
         'version': '0.0.1',
@@ -1334,6 +1383,20 @@ describe('AppNexusAdapter', function () {
       expect(Object.keys(result[0].meta)).to.include.members(['advertiserId']);
     });
 
+    it('should add brand id', function() {
+      let responseBrandId = deepClone(response);
+      responseBrandId.tags[0].ads[0].brand_id = 123;
+
+      let bidderRequest = {
+        bids: [{
+          bidId: '3db3773286ee59',
+          adUnitCode: 'code'
+        }]
+      }
+      let result = spec.interpretResponse({ body: responseBrandId }, {bidderRequest});
+      expect(Object.keys(result[0].meta)).to.include.members(['brandId']);
+    });
+
     it('should add advertiserDomains', function() {
       let responseAdvertiserId = deepClone(response);
       responseAdvertiserId.tags[0].ads[0].adomain = ['123'];