prebid.js 8.3.0 → 8.4.0

package/src/auction.js

@@ -4,7 +4,7 @@
  * In Prebid 0.x, $$PREBID_GLOBAL$$ had _bidsRequested and _bidsReceived as public properties.
  * Starting 1.0, Prebid will support concurrent auctions. Each auction instance will store private properties, bidsRequested and bidsReceived.
  *
- * AuctionManager will create instance of auction and will store all the auctions.
+ * AuctionManager will create an instance of auction and will store all the auctions.
  *
  */
 
@@ -820,6 +820,16 @@ export const getPriceByGranularity = (granularity) => {
   }
 }
 
+/**
+ * This function returns a function to get crid from bid response
+ * @returns {function}
+ */
+export const getCreativeId = () => {
+  return (bid) => {
+    return (bid.creativeId) ? bid.creativeId : '';
+  }
+}
+
 /**
  * This function returns a function to get first advertiser domain from bid response meta
  * @returns {function}
@@ -830,6 +840,16 @@ export const getAdvertiserDomain = () => {
   }
 }
 
+/**
+ * This function returns a function to get dsp name or id from bid response meta
+ * @returns {function}
+ */
+export const getDSP = () => {
+  return (bid) => {
+    return (bid.meta && (bid.meta.networkId || bid.meta.networkName)) ? deepAccess(bid, 'meta.networkName') || deepAccess(bid, 'meta.networkId') : '';
+  }
+}
+
 /**
  * This function returns a function to get the primary category id from bid response meta
  * @returns {function}
@@ -866,6 +886,8 @@ function defaultAdserverTargeting() {
     createKeyVal(TARGETING_KEYS.FORMAT, 'mediaType'),
     createKeyVal(TARGETING_KEYS.ADOMAIN, getAdvertiserDomain()),
     createKeyVal(TARGETING_KEYS.ACAT, getPrimaryCatId()),
+    createKeyVal(TARGETING_KEYS.DSP, getDSP()),
+    createKeyVal(TARGETING_KEYS.CRID, getCreativeId()),
   ]
 }
 
@@ -957,7 +979,7 @@ function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
 
     if (
       ((typeof bidderSettings.suppressEmptyKeys !== 'undefined' && bidderSettings.suppressEmptyKeys === true) ||
-      key === CONSTANTS.TARGETING_KEYS.DEAL || key === CONSTANTS.TARGETING_KEYS.ACAT) && // hb_deal & hb_acat are suppressed automatically if not set
+      key === CONSTANTS.TARGETING_KEYS.DEAL || key === CONSTANTS.TARGETING_KEYS.ACAT || key === CONSTANTS.TARGETING_KEYS.DSP || key === CONSTANTS.TARGETING_KEYS.CRID) && // hb_deal & hb_acat are suppressed automatically if not set
       (
         isEmptyStr(value) ||
         value === null ||

package/src/constants.json

@@ -77,7 +77,9 @@
     "CACHE_ID": "hb_cache_id",
     "CACHE_HOST": "hb_cache_host",
     "ADOMAIN": "hb_adomain",
-    "ACAT": "hb_acat"
+    "ACAT": "hb_acat",
+    "CRID": "hb_crid",
+    "DSP": "hb_dsp"
   },
   "DEFAULT_TARGETING_KEYS": {
     "BIDDER": "hb_bidder",

package/src/fpd/sua.js

@@ -15,6 +15,12 @@ export const HIGH_ENTROPY_HINTS = [
   'fullVersionList'
 ]
 
+export const LOW_ENTROPY_HINTS = [
+  'brands',
+  'mobile',
+  'platform'
+]
+
 /**
  * Returns low entropy UA client hints encoded as an ortb2.6 device.sua object; or null if no UA client hints are available.
  */
@@ -32,7 +38,7 @@ export const getLowEntropySUA = lowEntropySUAAccessor();
 export const getHighEntropySUA = highEntropySUAAccessor();
 
 export function lowEntropySUAAccessor(uaData = window.navigator?.userAgentData) {
-  const sua = isEmpty(uaData) ? null : Object.freeze(uaDataToSUA(SUA_SOURCE_LOW_ENTROPY, uaData));
+  const sua = (uaData && LOW_ENTROPY_HINTS.some(h => typeof uaData[h] !== 'undefined')) ? Object.freeze(uaDataToSUA(SUA_SOURCE_LOW_ENTROPY, uaData)) : null;
   return function () {
     return sua;
   }
@@ -85,7 +91,7 @@ export function uaDataToSUA(source, uaData) {
   if (uaData.fullVersionList || uaData.brands) {
     sua.browsers = (uaData.fullVersionList || uaData.brands).map(({brand, version}) => toBrandVersion(brand, version));
   }
-  if (uaData.hasOwnProperty('mobile')) {
+  if (typeof uaData['mobile'] !== 'undefined') {
     sua.mobile = uaData.mobile ? 1 : 0;
   }
   ['model', 'bitness', 'architecture'].forEach(prop => {

package/test/spec/auctionmanager_spec.js

@@ -185,9 +185,11 @@ describe('auctionmanager.js', function () {
       adId: '1adId',
       source: 'client',
       mediaType: 'banner',
+      creativeId: 'monkeys',
       meta: {
         advertiserDomains: ['adomain'],
-        primaryCatId: 'IAB-test'
+        primaryCatId: 'IAB-test',
+        networkId: '123987'
       }
     };
 
@@ -202,6 +204,8 @@ describe('auctionmanager.js', function () {
       expected[ CONSTANTS.TARGETING_KEYS.FORMAT ] = bid.mediaType;
       expected[ CONSTANTS.TARGETING_KEYS.ADOMAIN ] = bid.meta.advertiserDomains[0];
       expected[ CONSTANTS.TARGETING_KEYS.ACAT ] = bid.meta.primaryCatId;
+      expected[ CONSTANTS.TARGETING_KEYS.DSP ] = bid.meta.networkId;
+      expected[ CONSTANTS.TARGETING_KEYS.CRID ] = bid.creativeId;
       if (bid.mediaType === 'video') {
         expected[ CONSTANTS.TARGETING_KEYS.UUID ] = bid.videoCacheKey;
         expected[ CONSTANTS.TARGETING_KEYS.CACHE_ID ] = bid.videoCacheKey;
@@ -304,6 +308,18 @@ describe('auctionmanager.js', function () {
                 return bidResponse.meta.advertiserDomains[0];
               }
             },
+            {
+              key: CONSTANTS.TARGETING_KEYS.CRID,
+              val: function (bidResponse) {
+                return bidResponse.creativeId;
+              }
+            },
+            {
+              key: CONSTANTS.TARGETING_KEYS.DSP,
+              val: function (bidResponse) {
+                return bidResponse.meta.networkId;
+              }
+            },
             {
               key: CONSTANTS.TARGETING_KEYS.ACAT,
               val: function (bidResponse) {
@@ -388,6 +404,18 @@ describe('auctionmanager.js', function () {
                 return bidResponse.meta.advertiserDomains[0];
               }
             },
+            {
+              key: CONSTANTS.TARGETING_KEYS.CRID,
+              val: function (bidResponse) {
+                return bidResponse.creativeId;
+              }
+            },
+            {
+              key: CONSTANTS.TARGETING_KEYS.DSP,
+              val: function (bidResponse) {
+                return bidResponse.meta.networkId;
+              }
+            },
             {
               key: CONSTANTS.TARGETING_KEYS.ACAT,
               val: function (bidResponse) {

package/test/spec/fpd/enrichment_spec.js

@@ -275,7 +275,13 @@ describe('FPD enrichment', () => {
 
   describe('sua', () => {
     it('does not set device.sua if resolved sua is null', () => {
-      sandbox.stub(dep, 'getHighEntropySUA').returns(Promise.resolve())
+      sandbox.stub(dep, 'getHighEntropySUA').returns(Promise.resolve());
+      // Add hints so it will attempt to retrieve high entropy values
+      config.setConfig({
+        firstPartyData: {
+          uaHints: ['bitness'],
+        }
+      });
       return fpd().then(ortb2 => {
         expect(ortb2.device.sua).to.not.exist;
       })

package/test/spec/fpd/sua_spec.js

@@ -165,6 +165,14 @@ describe('uaDataToSUA', () => {
 });
 
 describe('lowEntropySUAAccessor', () => {
+  // Set up a mock data with readonly property
+  class MockUserAgentData {}
+  Object.defineProperty(MockUserAgentData.prototype, 'mobile', {
+    value: false,
+    writable: false,
+    enumerable: true
+  });
+
   function getSUA(uaData) {
     return lowEntropySUAAccessor(uaData)();
   }
@@ -181,6 +189,10 @@ describe('lowEntropySUAAccessor', () => {
   it('should return null if uaData is empty', () => {
     expect(getSUA({})).to.eql(null);
   })
+
+  it('should return mobile and source', () => {
+    expect(getSUA(new MockUserAgentData())).to.eql({mobile: 0, source: 1})
+  })
 });
 
 describe('highEntropySUAAccessor', () => {

package/test/spec/modules/33acrossBidAdapter_spec.js

@@ -200,6 +200,29 @@ describe('33acrossBidAdapter:', function () {
       return this;
     };
 
+    this.withCoppa = coppaValue => {
+      Object.assign(ttxRequest.regs, {
+        coppa: coppaValue
+      });
+
+      return this;
+    };
+
+    this.withGppConsent = (consentString, applicableSections) => {
+      Object.assign(ttxRequest, {
+        regs: {
+          gpp: consentString,
+          gpp_sid: applicableSections,
+          ext: Object.assign(
+            {},
+            ttxRequest.regs.ext
+          )
+        }
+      });
+
+      return this;
+    };
+
     this.withSite = site => {
       Object.assign(ttxRequest, { site });
       return this;
@@ -1049,11 +1072,11 @@ describe('33acrossBidAdapter:', function () {
       });
 
       it('returns corresponding test server requests with gdpr consent data', function() {
-        sandbox.stub(config, 'getConfig').callsFake(() => {
-          return {
+        sandbox.stub(config, 'getConfig')
+          .withArgs('ttxSettings')
+          .returns({
             'url': 'https://foo.com/hb/'
-          }
-        });
+          });
 
         const ttxRequest = new TtxRequestBuilder()
           .withBanner()
@@ -1085,11 +1108,11 @@ describe('33acrossBidAdapter:', function () {
       });
 
       it('returns corresponding test server requests with default gdpr consent data', function() {
-        sandbox.stub(config, 'getConfig').callsFake(() => {
-          return {
+        sandbox.stub(config, 'getConfig')
+          .withArgs('ttxSettings')
+          .returns({
             'url': 'https://foo.com/hb/'
-          }
-        });
+          });
 
         const ttxRequest = new TtxRequestBuilder()
           .withBanner()
@@ -1128,11 +1151,11 @@ describe('33acrossBidAdapter:', function () {
       });
 
       it('returns corresponding test server requests with us_privacy consent data', function() {
-        sandbox.stub(config, 'getConfig').callsFake(() => {
-          return {
+        sandbox.stub(config, 'getConfig')
+          .withArgs('ttxSettings')
+          .returns({
             'url': 'https://foo.com/hb/'
-          }
-        });
+          });
 
         const ttxRequest = new TtxRequestBuilder()
           .withBanner()
@@ -1164,15 +1187,102 @@ describe('33acrossBidAdapter:', function () {
       });
 
       it('returns corresponding test server requests with default us_privacy consent data', function() {
-        sandbox.stub(config, 'getConfig').callsFake(() => {
-          return {
+        sandbox.stub(config, 'getConfig')
+          .withArgs('ttxSettings')
+          .returns({
             'url': 'https://foo.com/hb/'
+          });
+
+        const ttxRequest = new TtxRequestBuilder()
+          .withBanner()
+          .withProduct()
+          .build();
+        const serverRequest = new ServerRequestBuilder()
+          .withData(ttxRequest)
+          .withUrl('https://foo.com/hb/')
+          .build();
+        const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+
+        validateBuiltServerRequest(builtServerRequest, serverRequest);
+      });
+    });
+
+    context('when coppa has been enabled', function() {
+      beforeEach(function() {
+        sandbox.stub(config, 'getConfig').withArgs('coppa').returns(true);
+      });
+
+      it('returns corresponding server requests with coppa: 1', function() {
+        const ttxRequest = new TtxRequestBuilder()
+          .withBanner()
+          .withProduct()
+          .withCoppa(1)
+          .build();
+
+        const serverRequest = new ServerRequestBuilder()
+          .withData(ttxRequest)
+          .build();
+        const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+
+        validateBuiltServerRequest(builtServerRequest, serverRequest);
+      });
+    });
+
+    context('when coppa has been disabled', function() {
+      beforeEach(function() {
+        sandbox.stub(config, 'getConfig').withArgs('coppa').returns(false);
+      });
+
+      it('returns corresponding server requests with coppa: 0', function() {
+        const ttxRequest = new TtxRequestBuilder()
+          .withBanner()
+          .withProduct()
+          .withCoppa(0)
+          .build();
+        const serverRequest = new ServerRequestBuilder()
+          .withData(ttxRequest)
+          .build();
+        const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+
+        validateBuiltServerRequest(builtServerRequest, serverRequest);
+      });
+    });
+
+    context('when GPP consent data exists', function() {
+      beforeEach(function() {
+        bidderRequest = {
+          ...bidderRequest,
+          gppConsent: {
+            gppString: 'foo',
+            applicableSections: '123'
           }
-        });
+        }
+      });
 
+      it('returns corresponding server requests with GPP consent data', function() {
         const ttxRequest = new TtxRequestBuilder()
           .withBanner()
           .withProduct()
+          .withGppConsent('foo', '123')
+          .build();
+        const serverRequest = new ServerRequestBuilder()
+          .withData(ttxRequest)
+          .build();
+        const [ builtServerRequest ] = spec.buildRequests(bidRequests, bidderRequest);
+
+        validateBuiltServerRequest(builtServerRequest, serverRequest);
+      });
+
+      it('returns corresponding test server requests with GPP consent data', function() {
+        sandbox.stub(config, 'getConfig').withArgs('ttxSettings')
+          .returns({
+            'url': 'https://foo.com/hb/'
+          });
+
+        const ttxRequest = new TtxRequestBuilder()
+          .withBanner()
+          .withProduct()
+          .withGppConsent('foo', '123')
           .build();
         const serverRequest = new ServerRequestBuilder()
           .withData(ttxRequest)
@@ -1747,11 +1857,11 @@ describe('33acrossBidAdapter:', function () {
 
     context('when SRA mode is enabled', function() {
       it('builds a single request with multiple imps corresponding to each group {siteId, productId}', function() {
-        sandbox.stub(config, 'getConfig').callsFake(() => {
-          return {
+        sandbox.stub(config, 'getConfig')
+          .withArgs('ttxSettings')
+          .returns({
             enableSRAMode: true
-          }
-        });
+          });
 
         const bidRequests = new BidRequestsBuilder()
           .addBid()
@@ -2219,11 +2329,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined`
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined`
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
             }
           ]
 
@@ -2239,11 +2349,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gdpr=1`
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=&gdpr=1`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gdpr=1`
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=&gdpr=1`
             }
           ];
 
@@ -2259,11 +2369,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined&gdpr=1`
+              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=&gdpr=1`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined&gdpr=1`
+              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=&gdpr=1`
             }
           ];
 
@@ -2279,11 +2389,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gdpr=0`
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=&gdpr=0`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gdpr=0`
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=&gdpr=0`
             }
           ];
           expect(syncResults).to.deep.equal(expectedSyncs);
@@ -2298,11 +2408,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined`
+              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined`
+              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=`
             }
           ];
           expect(syncResults).to.deep.equal(expectedSyncs);
@@ -2317,11 +2427,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined&gdpr=0`
+              url: `${syncs[0].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=&gdpr=0`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined&gdpr=0`
+              url: `${syncs[1].url}&gdpr_consent=consent123A&us_privacy=undefined&gpp=&gpp_sid=&gdpr=0`
             }
           ];
           expect(syncResults).to.deep.equal(expectedSyncs);
@@ -2336,11 +2446,11 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined`
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined`
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
             }
           ]
 
@@ -2356,11 +2466,54 @@ describe('33acrossBidAdapter:', function () {
           const expectedSyncs = [
             {
               type: 'iframe',
-              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=foo`
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=foo&gpp=&gpp_sid=`
+            },
+            {
+              type: 'iframe',
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=foo&gpp=&gpp_sid=`
+            }
+          ];
+
+          expect(syncResults).to.deep.equal(expectedSyncs);
+        });
+      });
+
+      context('when there is no GPP data', function() {
+        it('returns sync urls with empty GPP params', function() {
+          spec.buildRequests(bidRequests);
+
+          const syncResults = spec.getUserSyncs(syncOptions, {});
+          const expectedSyncs = [
+            {
+              type: 'iframe',
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
+            },
+            {
+              type: 'iframe',
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=&gpp_sid=`
+            }
+          ]
+
+          expect(syncResults).to.deep.equal(expectedSyncs);
+        })
+      });
+
+      context('when there is GPP data', function() {
+        it('returns sync urls with GPP consent string & GPP Section ID as params', function() {
+          spec.buildRequests(bidRequests);
+
+          const syncResults = spec.getUserSyncs(syncOptions, {}, {}, undefined, {
+            gppString: 'foo',
+            applicableSections: ['123', '456']
+          });
+          const expectedSyncs = [
+            {
+              type: 'iframe',
+              url: `${syncs[0].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=foo&gpp_sid=123%2C456`
             },
             {
               type: 'iframe',
-              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=foo`
+              url: `${syncs[1].url}&gdpr_consent=undefined&us_privacy=undefined&gpp=foo&gpp_sid=123%2C456`
             }
           ];