prebid.js 8.4.0 → 8.5.0

package/modules/liveIntentIdSystem.js

@@ -242,6 +242,59 @@ export const liveIntentIdSubmodule = {
     }
 
     return { callback: result };
+  },
+  eids: {
+    'lipb': {
+      getValue: function(data) {
+        return data.lipbid;
+      },
+      source: 'liveintent.com',
+      atype: 3,
+      getEidExt: function(data) {
+        if (Array.isArray(data.segments) && data.segments.length) {
+          return {
+            segments: data.segments
+          };
+        }
+      }
+    },
+    'bidswitch': {
+      source: 'bidswitch.net',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+    'medianet': {
+      source: 'media.net',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+    'magnite': {
+      source: 'rubiconproject.com',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+
   }
 };
 

package/modules/lotamePanoramaIdSystem.js

@@ -368,6 +368,12 @@ export const lotamePanoramaIdSubmodule = {
 
     return { callback: resolveIdFunction };
   },
+  eids: {
+    lotamePanoramaId: {
+      source: 'crwdcntrl.net',
+      atype: 1,
+    },
+  },
 };
 
 submodule('userId', lotamePanoramaIdSubmodule);

package/modules/merkleIdSystem.js

@@ -196,6 +196,30 @@ export const merkleIdSubmodule = {
 
     logInfo('User ID - merkleId not refreshed');
     return {id: storedId};
+  },
+  eids: {
+    'merkleId': {
+      atype: 3,
+      getSource: function(data) {
+        if (data?.ext?.ssp) {
+          return `${data.ext.ssp}.merkleinc.com`
+        }
+        return 'merkleinc.com'
+      },
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.keyID) {
+          return {
+            keyID: data.keyID
+          }
+        }
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
   }
 
 };

package/modules/mwOpenLinkIdSystem.js

@@ -137,6 +137,12 @@ export const mwOpenLinkIdSubModule = {
     const submoduleConfigParams = (submoduleConfig && submoduleConfig.params) || {};
     if (!isValidConfig(submoduleConfigParams)) return undefined;
     return setID(submoduleConfigParams);
+  },
+  eids: {
+    'mwOpenLinkId': {
+      source: 'mediawallahscript.com',
+      atype: 1
+    },
   }
 };
 

package/modules/naveggIdSystem.js

@@ -107,6 +107,12 @@ export const naveggIdSubmodule = {
       }
     }
     return undefined;
+  },
+  eids: {
+    'naveggId': {
+      source: 'navegg.com',
+      atype: 1
+    },
   }
 };
 submodule('userId', naveggIdSubmodule);

package/modules/netIdSystem.js

@@ -34,6 +34,12 @@ export const netIdSubmodule = {
   getId(config) {
     /* currently not possible */
     return {};
+  },
+  eids: {
+    'netId': {
+      source: 'netid.de',
+      atype: 1
+    },
   }
 };
 

package/modules/novatiqIdSystem.js

@@ -259,6 +259,18 @@ export const novatiqIdSubmodule = {
       srcId = configParams.sourceid;
     }
     return srcId;
+  },
+  eids: {
+    'novatiq': {
+      getValue: function(data) {
+        if (data.snowflake.id === undefined) {
+          return data.snowflake;
+        }
+
+        return data.snowflake.id;
+      },
+      source: 'novatiq.com',
+    },
   }
 };
 submodule('userId', novatiqIdSubmodule);

package/modules/oneKeyIdSystem.js

@@ -72,6 +72,32 @@ export const oneKeyIdSubmodule = {
     return {
       callback: getIdsAndPreferences
     };
+  },
+  eids: {
+    'oneKeyData': {
+      getValue: function(data) {
+        if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
+          return data.identifiers[0].value;
+        }
+      },
+      source: 'paf',
+      atype: 1,
+      getEidExt: function(data) {
+        if (data && data.preferences) {
+          return {preferences: data.preferences};
+        }
+      },
+      getUidExt: function(data) {
+        if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
+          const id = data.identifiers[0];
+          return {
+            version: id.version,
+            type: id.type,
+            source: id.source
+          };
+        }
+      }
+    }
   }
 };
 

package/modules/ozoneBidAdapter.js

@@ -7,7 +7,8 @@ import {
   isArray,
   contains,
   mergeDeep,
-  parseUrl
+  parseUrl,
+  generateUUID
 } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
@@ -16,12 +17,12 @@ import {getPriceBucketString} from '../src/cpmBucketManager.js';
 import { Renderer } from '../src/Renderer.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 const BIDDER_CODE = 'ozone';
-const ORIGIN = 'https://elb.the-ozone-project.com'; // applies only to auction & cookie
+const ORIGIN = 'https://elb.the-ozone-project.com' // applies only to auction & cookie
 const AUCTIONURI = '/openrtb2/auction';
 const OZONECOOKIESYNC = '/static/load-cookie.html';
 const OZONE_RENDERER_URL = 'https://prebid.the-ozone-project.com/ozone-renderer.js';
 const ORIGIN_DEV = 'https://test.ozpr.net';
-const OZONEVERSION = '2.8.0';
+const OZONEVERSION = '2.9.0';
 export const spec = {
   gvlid: 524,
   aliases: [{code: 'lmc', gvlid: 524}],
@@ -36,7 +37,8 @@ export const spec = {
     'keyPrefix': 'oz',
     'auctionUrl': ORIGIN + AUCTIONURI,
     'cookieSyncUrl': ORIGIN + OZONECOOKIESYNC,
-    'rendererUrl': OZONE_RENDERER_URL
+    'rendererUrl': OZONE_RENDERER_URL,
+    'batchRequests': false /* you can change this to true OR override it in the config: config.ozone.batchRequests */
   },
   loadWhitelabelData(bid) {
     if (this.propertyBag.whitelabel) { return; }
@@ -73,6 +75,9 @@ export const spec = {
         this.propertyBag.whitelabel.auctionUrl = bidderConfig.endpointOverride.auctionUrl;
       }
     }
+    if (bidderConfig.hasOwnProperty('batchRequests')) {
+      this.propertyBag.whitelabel.batchRequests = bidderConfig.batchRequests;
+    }
     try {
       if (arr.hasOwnProperty('auction') && arr.auction === 'dev') {
         logInfo('GET: auction=dev');
@@ -94,11 +99,14 @@ export const spec = {
   getRendererUrl() {
     return this.propertyBag.whitelabel.rendererUrl;
   },
+  isBatchRequests() {
+    return this.propertyBag.whitelabel.batchRequests;
+  },
   isBidRequestValid(bid) {
     this.loadWhitelabelData(bid);
     logInfo('isBidRequestValid : ', config.getConfig(), bid);
     let adUnitCode = bid.adUnitCode; // adunit[n].code
-    let err1 = 'VALIDATION FAILED : missing {param} : siteId, placementId and publisherId are REQUIRED';
+    let err1 = 'VALIDATION FAILED : missing {param} : siteId, placementId and publisherId are REQUIRED'
     if (!(bid.params.hasOwnProperty('placementId'))) {
       logError(err1.replace('{param}', 'placementId'), adUnitCode);
       return false;
@@ -199,7 +207,7 @@ export const spec = {
       let placementId = placementIdOverrideFromGetParam || this.getPlacementId(ozoneBidRequest); // prefer to use a valid override param, else the bidRequest placement Id
       obj.id = ozoneBidRequest.bidId; // this causes an error if we change it to something else, even if you update the bidRequest object: "WARNING: Bidder ozone made bid for unknown request ID: mb7953.859498327448. Ignoring."
       obj.tagid = placementId;
-      let parsed = parseUrl(getRefererInfo().page);
+      let parsed = parseUrl(this.getRefererInfo().page);
       obj.secure = parsed.protocol === 'https' ? 1 : 0;
       let arrBannerSizes = [];
       if (!ozoneBidRequest.hasOwnProperty('mediaTypes')) {
@@ -262,9 +270,7 @@ export const spec = {
       obj.placementId = placementId;
       deepSetValue(obj, 'ext.prebid', {'storedrequest': {'id': placementId}});
       obj.ext[whitelabelBidder] = {};
-      // TODO: fix auctionId/transactionID leak: https://github.com/prebid/Prebid.js/issues/9781
       obj.ext[whitelabelBidder].adUnitCode = ozoneBidRequest.adUnitCode; // eg. 'mpu'
-      obj.ext[whitelabelBidder].transactionId = ozoneBidRequest.transactionId; // this is the transactionId PER adUnit, common across bidders for this unit
       if (ozoneBidRequest.params.hasOwnProperty('customData')) {
         obj.ext[whitelabelBidder].customData = ozoneBidRequest.params.customData;
       }
@@ -291,6 +297,10 @@ export const spec = {
       if (!schain && deepAccess(ozoneBidRequest, 'schain')) {
         schain = ozoneBidRequest.schain;
       }
+      let gpid = deepAccess(ozoneBidRequest, 'ortb2Imp.ext.gpid');
+      if (gpid) {
+        deepSetValue(obj, 'ext.gpid', gpid);
+      }
       return obj;
     });
     let extObj = {};
@@ -326,7 +336,7 @@ export const spec = {
     let userExtEids = deepAccess(validBidRequests, '0.userIdAsEids', []); // generate the UserIDs in the correct format for UserId module
     ozoneRequest.site = {
       'publisher': {'id': htmlParams.publisherId},
-      'page': getRefererInfo().page,
+      'page': this.getRefererInfo().page,
       'id': htmlParams.siteId
     };
     ozoneRequest.test = config.getConfig('debug') ? 1 : 0;
@@ -355,13 +365,33 @@ export const spec = {
     if (config.getConfig('coppa') === true) {
       deepSetValue(ozoneRequest, 'regs.coppa', 1);
     }
+    let ozUuid = generateUUID();
+    if (this.isBatchRequests()) {
+      logInfo('going to batch the requests');
+      let arrRet = []; // return an array of objects containing data describing max 10 bids
+      for (let i = 0; i < tosendtags.length; i += 10) {
+        ozoneRequest.id = ozUuid; // Unique ID of the bid request, provided by the exchange. (REQUIRED)
+        ozoneRequest.imp = tosendtags.slice(i, i + 10);
+        ozoneRequest.ext = extObj;
+        deepSetValue(ozoneRequest, 'user.ext.eids', userExtEids);
+        if (ozoneRequest.imp.length > 0) {
+          arrRet.push({
+            method: 'POST',
+            url: this.getAuctionUrl(),
+            data: JSON.stringify(ozoneRequest),
+            bidderRequest: bidderRequest
+          });
+        }
+      }
+      logInfo('batch request going to return : ', arrRet);
+      return arrRet;
+    }
+    logInfo('requests will not be batched.');
     if (singleRequest) {
       logInfo('buildRequests starting to generate response for a single request');
-      ozoneRequest.id = bidderRequest.auctionId; // Unique ID of the bid request, provided by the exchange.
-      ozoneRequest.auctionId = bidderRequest.auctionId; // not sure if this should be here?
+      ozoneRequest.id = ozUuid; // Unique ID of the bid request, provided by the exchange. (REQUIRED)
       ozoneRequest.imp = tosendtags;
       ozoneRequest.ext = extObj;
-      deepSetValue(ozoneRequest, 'source.tid', bidderRequest.auctionId);// RTB 2.5 : tid is Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
       deepSetValue(ozoneRequest, 'user.ext.eids', userExtEids);
       var ret = {
         method: 'POST',
@@ -377,12 +407,9 @@ export const spec = {
     let arrRet = tosendtags.map(imp => {
       logInfo('buildRequests starting to generate non-single response, working on imp : ', imp);
       let ozoneRequestSingle = Object.assign({}, ozoneRequest);
-      imp.ext[whitelabelBidder].pageAuctionId = bidderRequest['auctionId']; // make a note in the ext object of what the original auctionId was, in the bidderRequest object
-      ozoneRequestSingle.id = imp.ext[whitelabelBidder].transactionId; // Unique ID of the bid request, provided by the exchange.
-      ozoneRequestSingle.auctionId = imp.ext[whitelabelBidder].transactionId; // not sure if this should be here?
+      ozoneRequestSingle.id = generateUUID(); // Unique ID of the bid request, provided by the exchange. (REQUIRED)
       ozoneRequestSingle.imp = [imp];
       ozoneRequestSingle.ext = extObj;
-      deepSetValue(ozoneRequestSingle, 'source.tid', bidderRequest.auctionId);// RTB 2.5 : tid is Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
       deepSetValue(ozoneRequestSingle, 'user.ext.eids', userExtEids);
       logInfo('buildRequests RequestSingle (for non-single) = ', ozoneRequestSingle);
       return {
@@ -424,6 +451,7 @@ export const spec = {
     logInfo(`interpretResponse time: ${startTime} . Time between buildRequests done and interpretResponse start was ${startTime - this.propertyBag.buildRequestsEnd}ms`);
     logInfo(`serverResponse, request`, JSON.parse(JSON.stringify(serverResponse)), JSON.parse(JSON.stringify(request)));
     serverResponse = serverResponse.body || {};
+    let aucId = serverResponse.id; // this will be correct for single requests and non-single
     if (!serverResponse.hasOwnProperty('seatbid')) {
       return [];
     }
@@ -518,7 +546,7 @@ export const spec = {
           }
         }
         let {seat: winningSeat, bid: winningBid} = ozoneGetWinnerForRequestBid(thisBid.bidId, serverResponse.seatbid);
-        adserverTargeting[whitelabelPrefix + '_auc_id'] = String(request.bidderRequest.auctionId);
+        adserverTargeting[whitelabelPrefix + '_auc_id'] = String(aucId); // was request.bidderRequest.auctionId
         adserverTargeting[whitelabelPrefix + '_winner'] = String(winningSeat);
         adserverTargeting[whitelabelPrefix + '_bid'] = 'true';
         adserverTargeting[whitelabelPrefix + '_cache_id'] = deepAccess(thisBid, 'ext.prebid.targeting.hb_cache_id', 'no-id');
@@ -686,10 +714,29 @@ export const spec = {
     return null;
   },
   getGetParametersAsObject() {
-    let parsed = parseUrl(getRefererInfo().page);
+    let parsed = parseUrl(this.getRefererInfo().location);
     logInfo('getGetParametersAsObject found:', parsed.search);
     return parsed.search;
   },
+  getRefererInfo() {
+    if (getRefererInfo().hasOwnProperty('location')) {
+      logInfo('FOUND location on getRefererInfo OK (prebid >= 7); will use getRefererInfo for location & page');
+      return getRefererInfo();
+    } else {
+      logInfo('DID NOT FIND location on getRefererInfo (prebid < 7); will use legacy code that ALWAYS worked reliably to get location & page ;-)');
+      try {
+        return {
+          page: top.location.href,
+          location: top.location.href
+        };
+      } catch (e) {
+        return {
+          page: window.location.href,
+          location: window.location.href
+        };
+      }
+    }
+  },
   blockTheRequest() {
     let ozRequest = this.getWhitelabelConfigItem('ozone.oz_request');
     if (typeof ozRequest == 'boolean' && !ozRequest) {

package/modules/ozoneBidAdapter.md

@@ -73,6 +73,8 @@ adUnits = [{
                 }];
 ```
 
+
+```
 //Instream Video adUnit
 
 adUnits = [{
@@ -108,4 +110,4 @@ adUnits = [{
 							}
 						}]
 				};
-```
+```

package/modules/pairIdSystem.js

@@ -78,6 +78,12 @@ export const pairIdSubmodule = {
       return undefined;
     }
     return {'id': ids};
+  },
+  eids: {
+    'pairId': {
+      source: 'google.com',
+      atype: 571187
+    },
   }
 };
 

package/modules/parrableIdSystem.js

@@ -7,7 +7,17 @@
 
 // ci trigger: 1
 
-import {contains, deepClone, inIframe, isEmpty, isPlainObject, logError, logWarn, timestamp} from '../src/utils.js';
+import {
+  contains,
+  deepClone,
+  inIframe,
+  isEmpty,
+  isPlainObject,
+  logError,
+  logWarn,
+  pick,
+  timestamp
+} from '../src/utils.js';
 import {find} from '../src/polyfill.js';
 import {ajax} from '../src/ajax.js';
 import {submodule} from '../src/hook.js';
@@ -368,7 +378,33 @@ export const parrableIdSubmodule = {
   getId(config, gdprConsentData, currentStoredId) {
     const configParams = (config && config.params) || {};
     return fetchId(configParams, gdprConsentData);
-  }
+  },
+  eids: {
+    'parrableId': {
+      source: 'parrable.com',
+      atype: 1,
+      getValue: function(parrableId) {
+        if (parrableId.eid) {
+          return parrableId.eid;
+        }
+        if (parrableId.ccpaOptout) {
+          // If the EID was suppressed due to a non consenting ccpa optout then
+          // we still wish to provide this as a reason to the adapters
+          return '';
+        }
+        return null;
+      },
+      getUidExt: function(parrableId) {
+        const extendedData = pick(parrableId, [
+          'ibaOptout',
+          'ccpaOptout'
+        ]);
+        if (Object.keys(extendedData).length) {
+          return extendedData;
+        }
+      }
+    },
+  },
 };
 
 submodule('userId', parrableIdSubmodule);

package/modules/publinkIdSystem.js

@@ -140,6 +140,12 @@ export const publinkIdSubmodule = {
     if (!storedId) {
       return {callback: makeCallback(config, consentData)};
     }
-  }
+  },
+  eids: {
+    'publinkId': {
+      source: 'epsilon.com',
+      atype: 3
+    },
+  },
 };
 submodule('userId', publinkIdSubmodule);

package/modules/quantcastIdSystem.js

@@ -214,6 +214,12 @@ export const quantcastIdSubmodule = {
     }
 
     return { id: fpa ? { quantcastId: fpa } : undefined };
+  },
+  eids: {
+    'quantcastId': {
+      source: 'quantcast.com',
+      atype: 1
+    },
   }
 };
 

package/modules/rubiconBidAdapter.js

@@ -200,6 +200,10 @@ export const converter = ortbConverter({
     bidRequest.params.position === 'btf' && (imp.video.pos = 3);
     delete imp.ext?.prebid?.storedrequest;
 
+    if (bidRequest.params.bidonmultiformat === true && bidRequestType.length > 1) {
+      deepSetValue(imp, 'ext.prebid.bidder.rubicon.formats', bidRequestType);
+    }
+
     setBidFloors(bidRequest, imp);
 
     return imp;
@@ -497,6 +501,11 @@ export const spec = {
       data['rp_hard_floor'] = typeof floorInfo === 'object' && floorInfo.currency === 'USD' && !isNaN(parseInt(floorInfo.floor)) ? floorInfo.floor : undefined;
     }
 
+    // Send multiformat data if requested
+    if (params.bidonmultiformat === true && deepAccess(bidRequest, 'mediaTypes') && Object.keys(bidRequest.mediaTypes).length > 1) {
+      data['p_formats'] = Object.keys(bidRequest.mediaTypes).join(',');
+    }
+
     // add p_pos only if specified and valid
     // For SRA we need to explicitly put empty semi colons so AE treats it as empty, instead of copying the latter value
     let posMapping = {1: 'atf', 3: 'btf'};

package/modules/sharedIdSystem.js

@@ -174,6 +174,12 @@ export const sharedIdSystemSubmodule = {
   },
 
   domainOverride: domainOverrideToRootDomain(storage, 'sharedId'),
+  eids: {
+    'pubcid': {
+      source: 'pubcid.org',
+      atype: 1
+    },
+  }
 };
 
 submodule('userId', sharedIdSystemSubmodule);

package/modules/silverpushBidAdapter.js

@@ -12,7 +12,7 @@ const bidderConfig = 'sp_pb_ortb';
 const bidderVersion = '1.0.0';
 const DEFAULT_CURRENCY = 'USD';
 
-export const REQUEST_URL = 'https://apac.chocolateplatform.com/bidder/?identifier=prebidchoc';
+export const REQUEST_URL = 'https://prebid.chocolateplatform.co/bidder/?identifier=prebidchoc';
 export const SP_OUTSTREAM_PLAYER_URL = 'https://xaido.sgp1.cdn.digitaloceanspaces.com/prebid/spoutstream.min.js';
 
 const VIDEO_ORTB_PARAMS = [
@@ -110,7 +110,7 @@ export const CONVERTER = ortbConverter({
       bidResponse.meta.paf.content_id = utils.deepAccess(bid, 'ext.paf.content_id');
     }
 
-    bidResponse = buildVideoVastResponse(bidResponse)
+    bidResponse = buildVideoVastResponse(bidResponse);
     bidResponse = buildVideoOutstreamResponse(bidResponse, context)
 
     return bidResponse;