prebid.js 7.18.0 → 7.19.0

package/modules/ixBidAdapter.js

@@ -13,7 +13,8 @@ import {
   logError,
   logWarn,
   mergeDeep,
-  parseQueryStringParameters
+  parseQueryStringParameters,
+  safeJSONParse
 } from '../src/utils.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
@@ -99,8 +100,46 @@ const VIDEO_PARAMS_ALLOW_LIST = [
   'playerSize', 'w', 'h'
 ];
 const LOCAL_STORAGE_KEY = 'ixdiag';
+export const LOCAL_STORAGE_FEATURE_TOGGLES_KEY = `${BIDDER_CODE}_features`;
 let hasRegisteredHandler = false;
 export const storage = getStorageManager({gvlid: GLOBAL_VENDOR_ID, bidderCode: BIDDER_CODE});
+export const FEATURE_TOGGLES = {
+  featureToggles: {},
+  isFeatureEnabled: function(ft) {
+    return deepAccess(this.featureToggles, `features.${ft}.activated`)
+  },
+  getFeatureToggles: function() {
+    if (storage.localStorageIsEnabled()) {
+      const parsedToggles = safeJSONParse(storage.getDataFromLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY));
+      if (deepAccess(parsedToggles, 'expiry') && parsedToggles.expiry >= new Date().getTime()) {
+        this.featureToggles = parsedToggles
+      } else {
+        this.clearFeatureToggles();
+      }
+    }
+  },
+  setFeatureToggles: function(serverResponse) {
+    const responseBody = serverResponse.body;
+    const expiryTime = new Date();
+    const toggles = deepAccess(responseBody, 'ext.features');
+
+    if (toggles) {
+      this.featureToggles = {
+        expiry: expiryTime.setHours(expiryTime.getHours() + 1),
+        features: toggles
+      }
+      if (storage.localStorageIsEnabled()) {
+        storage.setDataInLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY, JSON.stringify(this.featureToggles));
+      }
+    }
+  },
+  clearFeatureToggles: function() {
+    this.featureToggles = {};
+    if (storage.localStorageIsEnabled()) {
+      storage.removeDataFromLocalStorage(LOCAL_STORAGE_FEATURE_TOGGLES_KEY);
+    }
+  }
+};
 let siteID = 0;
 let gdprConsent = '';
 let usPrivacy = '';
@@ -578,6 +617,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   r.ext = {};
   r.ext.source = 'prebid';
   r.ext.ixdiag = {};
+  r.ext.ixdiag.ls = storage.localStorageIsEnabled();
   r.imp = [];
   r.at = 1;
 
@@ -602,13 +642,15 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     r.ext.ixdiag.err = cachedErrors;
   }
 
+  // set source.tid to auctionId for outgoing request to Exchange.
+  r.source = {
+    tid: validBidRequests[0].auctionId,
+  }
+
   // if an schain is provided, send it along
   if (validBidRequests[0].schain) {
-    r.source = {
-      ext: {
-        schain: validBidRequests[0].schain
-      }
-    };
+    r.source.ext = {};
+    r.source.ext.schain = validBidRequests[0].schain;
   }
 
   if (userEids.length > 0) {
@@ -665,14 +707,17 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   // Use the siteId in the first bid request as the main siteId.
   siteID = validBidRequests[0].params.siteId;
   payload.s = siteID;
-  if (version) {
-    payload.v = version;
-  }
-  payload.ac = 'j';
-  payload.sd = 1;
 
-  if (version === VIDEO_ENDPOINT_VERSION) {
-    payload.nf = 1;
+  if (!FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+    if (version) {
+      payload.v = version;
+    }
+    payload.ac = 'j';
+    payload.sd = 1;
+
+    if (version === VIDEO_ENDPOINT_VERSION) {
+      payload.nf = 1;
+    }
   }
 
   // Parse additional runtime configs.
@@ -718,9 +763,11 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       }
     }
 
-    // Create t in payload if timeout is configured.
-    if (typeof otherIxConfig.timeout === 'number') {
-      payload.t = otherIxConfig.timeout;
+    if (!FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+      // Create t in payload if timeout is configured.
+      if (typeof otherIxConfig.timeout === 'number') {
+        payload.t = otherIxConfig.timeout;
+      }
     }
   }
 
@@ -866,12 +913,27 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       requestSequenceNumber++;
       clonedPayload.r = JSON.stringify(r);
 
-      requests.push({
-        method: 'GET',
-        url: baseUrl,
-        data: clonedPayload,
-        validBidRequests
-      });
+      let requestData;
+
+      if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+        requestData = {
+          method: 'POST',
+          url: baseUrl + '?s=' + payload.s,
+          data: deepClone(r),
+          option: {
+            contentType: 'text/plain',
+          },
+          validBidRequests
+        }
+      } else {
+        requestData = {
+          method: 'GET',
+          url: baseUrl,
+          data: clonedPayload,
+          validBidRequests
+        }
+      }
+      requests.push(requestData);
 
       currentRequestSize = baseRequestSize;
       r.imp = [];
@@ -1381,6 +1443,7 @@ export const spec = {
     const videoImps = {}; // Stores created video impressions
     const nativeImps = {}; // Stores created native impressions
     const missingBannerSizes = {}; // To capture the missing sizes i.e not configured for ix
+    FEATURE_TOGGLES.getFeatureToggles();
 
     // Step 1: Create impresssions from IX params
     validBidRequests.forEach((validBidRequest) => {
@@ -1451,6 +1514,7 @@ export const spec = {
     let bid = null;
 
     if (!serverResponse.hasOwnProperty('body') || !serverResponse.body.hasOwnProperty('seatbid')) {
+      FEATURE_TOGGLES.setFeatureToggles(serverResponse);
       return bids;
     }
 
@@ -1463,7 +1527,13 @@ export const spec = {
 
       // Transform rawBid in bid response to the format that will be accepted by prebid.
       const innerBids = seatbid[i].bid;
-      let requestBid = JSON.parse(bidderRequest.data.r);
+      let requestBid;
+
+      if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_post')) {
+        requestBid = bidderRequest.data;
+      } else {
+        requestBid = safeJSONParse(bidderRequest.data.r);
+      }
 
       for (let j = 0; j < innerBids.length; j++) {
         const bidRequest = getBidRequest(innerBids[j].impid, requestBid.imp, bidderRequest.validBidRequests);
@@ -1491,6 +1561,7 @@ export const spec = {
       }
     }
 
+    FEATURE_TOGGLES.setFeatureToggles(serverResponse);
     return bids;
   },
 

package/modules/liveIntentIdSystem.js

@@ -14,6 +14,7 @@ import { MinimalLiveConnect } from 'live-connect-js/esm/minimal-live-connect.js'
 
 const MODULE_NAME = 'liveIntentId';
 export const storage = getStorageManager({gvlid: null, moduleName: MODULE_NAME});
+const defaultRequestedAttributes = {'nonId': true}
 const calls = {
   ajaxGet: (url, onSuccess, onError, timeout) => {
     ajaxBuilder(timeout)(
@@ -57,6 +58,23 @@ function parseLiveIntentCollectorConfig(collectConfig) {
   return config;
 }
 
+/**
+ * Create requestedAttributes array to pass to liveconnect
+ * @function
+ * @param {Object} overrides - object with boolean values that will override defaults { 'foo': true, 'bar': false }
+ * @returns {Array}
+ */
+function parseRequestedAttributes(overrides) {
+  function createParameterArray(config) {
+    return Object.entries(config).flatMap(([k, v]) => (typeof v === 'boolean' && v) ? [k] : []);
+  }
+  if (typeof overrides === 'object') {
+    return createParameterArray({...defaultRequestedAttributes, ...overrides})
+  } else {
+    return createParameterArray(defaultRequestedAttributes);
+  }
+}
+
 function initializeLiveConnect(configParams) {
   configParams = configParams || {};
   if (liveConnect) {
@@ -66,7 +84,8 @@ function initializeLiveConnect(configParams) {
   const publisherId = configParams.publisherId || 'any';
   const identityResolutionConfig = {
     source: 'prebid',
-    publisherId: publisherId
+    publisherId: publisherId,
+    requestedAttributes: parseRequestedAttributes(configParams.requestedAttributesOverrides)
   };
   if (configParams.url) {
     identityResolutionConfig.url = configParams.url
@@ -136,9 +155,24 @@ export const liveIntentIdSubmodule = {
   decode(value, config) {
     const configParams = (config && config.params) || {};
     function composeIdObject(value) {
-      const base = { 'lipbid': value.unifiedId };
-      delete value.unifiedId;
-      return { 'lipb': { ...base, ...value } };
+      const result = {};
+
+      // old versions stored lipbid in unifiedId. Ensure that we can still read the data.
+      const lipbid = value.nonId || value.unifiedId
+      if (lipbid) {
+        value.lipbid = lipbid
+        delete value.unifiedId
+        result.lipb = value
+      }
+
+      // Lift usage of uid2 by exposing uid2 if we were asked to resolve it.
+      // As adapters are applied in lexicographical order, we will always
+      // be overwritten by the 'proper' uid2 module if it is present.
+      if (value.uid2) {
+        result.uid2 = { 'id': value.uid2 }
+      }
+
+      return result
     }
 
     if (!liveConnect) {
@@ -146,7 +180,7 @@ export const liveIntentIdSubmodule = {
     }
     tryFireEvent();
 
-    return (value && typeof value['unifiedId'] === 'string') ? composeIdObject(value) : undefined;
+    return composeIdObject(value);
   },
 
   /**

package/modules/mediakeysBidAdapter.js

@@ -572,7 +572,12 @@ function nativeBidResponseHandler(bid) {
           native.impressionTrackers.push(tracker.url);
           break;
         case 2:
-          native.javascriptTrackers = `<script src=\"${tracker.url}\"></script>`;
+          const script = `<script async src=\"${tracker.url}\"></script>`;
+          if (!native.javascriptTrackers) {
+            native.javascriptTrackers = script;
+          } else {
+            native.javascriptTrackers += `\n${script}`;
+          }
           break;
       }
     });

package/modules/mediakeysBidAdapter.md

@@ -14,9 +14,10 @@ Connects to Mediakeys demand source to fetch bids.
 
 ## Banner only Ad Unit
 
-```
-var adUnits = [
-{
+The Mediakeys adapter accepts any valid OpenRTB Spec 2.5 property.
+
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         banner: {
@@ -27,20 +28,26 @@ var adUnits = [
         bidder: 'mediakeys',
         params: {} // no params required.
     }]
-},
+}]
 ```
 
 ## Native only Ad Unit
 
 The Mediakeys adapter accepts two optional params for native requests. Please see the [OpenRTB Native Ads Specification](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) for valid values.
 
-```
-var adUnits = [
-{
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         native: {
-            type: 'image',
+            title: {
+                required: true,
+                len: 120
+            },
+            image: {
+                required: true,
+                sizes: [300, 250]
+            }
         }
     },
     bids: [{
@@ -52,7 +59,7 @@ var adUnits = [
             }
         }
     }]
-},
+}]
 ```
 
 ## Video only Ad Unit
@@ -61,63 +68,65 @@ The Mediakeys adapter accepts any valid openRTB 2.5 video property. Properties c
 
 ### Outstream context
 
-```
-var adUnits = [
-{
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         video: {
             context: 'outstream',
-            playerSize: [300, 250],
+            playerSize: [1280, 720],
             // additional OpenRTB video params
             // placement: 2,
             // api: [1],
             // …
+            mimes: ['video/mp4'],
+            protocols: [2, 3],
+            skip: 0
         }
     },
     renderer: {
         url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js',
+        // the render method must fetch the vast xml document before displaying video
         render: function (bid) {
-            var bidReqConfig = pbjs.adUnits.find(bidReq => bidReq.bidId === bid.impid);
-
-            if (bidReqConfig && bidReqConfig.mediaTypes && bidReqConfig.mediaTypes.video && bidReqConfig.mediaTypes.video.context === 'outstream') {
-                var adResponse = fetch(bid.vastUrl).then(resp => resp.text()).then(text => ({
-                    ad: {
-                        video: {
-                            content: text,
-                            player_width: bid.width || bidReqConfig.mediaTypes.video.playerSize[0],
-                            player_height: bid.height || bidReqConfig.mediaTypes.video.playerSize[1],
-                        }
+            var adResponse = fetch(bid.vastUrl).then(resp => resp.text()).then(text => ({
+                ad: {
+                    video: {
+                        content: text,
+                        player_height: bid.playerHeight,
+                        player_width: bid.playerWidth
                     }
-                }))
-
-                adResponse.then((ad) => {
-                    bid.renderer.push(() => {
-                        ANOutstreamVideo.renderAd({
-                            targetId: bid.adUnitCode,
-                            adResponse: ad
-                        });
+                }
+            }))
+
+            adResponse.then((content) => {
+                bid.renderer.push(() => {
+                    ANOutstreamVideo.renderAd({
+                        targetId: bid.adUnitCode,
+                        adResponse: content
                     });
-                })
-            }
+                });
+            })
         }
     },
     bids: [{
         bidder: 'mediakeys',
         params: {
             video: {
-                // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+                // additional OpenRTB video params.
+                // will be merged with params defined at mediaTypes level
+                api: [1]
             }
         }
     }]
-},
+}]
 ```
 
 ### Instream context
 
-```
-var adUnits = [
-{
+For Instream Video, you have to enable the Instream Tracking Module to have Prebid emit the onBidWon required event.
+
+```javascript
+var adUnits = [{
     code: 'test',
     mediaTypes: {
         video: {
@@ -132,8 +141,9 @@ var adUnits = [
     bids: [{
         bidder: 'mediakeys',
         params: {
-            // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+            // additional OpenRTB video params.
+            // will be merged with params defined at mediaTypes level
         }
     }]
-},
+}]
 ```

package/modules/nativoBidAdapter.js

@@ -145,7 +145,7 @@ export const spec = {
         'params.url',
       )
       if (pageUrl == undefined || pageUrl === '') {
-        pageUrl = bidderRequest.refererInfo.page
+        pageUrl = bidderRequest.refererInfo.location
       }
 
       placementId = deepAccess(bidRequest, 'params.placementId')

package/modules/prebidServerBidAdapter/index.js

@@ -522,6 +522,8 @@ Object.assign(ORTB2.prototype, {
     let imps = [];
     let aliases = {};
     const firstBidRequest = bidRequests[0];
+    let floorMin = null;
+    let floorMinCur = null;
 
     // transform ad unit into array of OpenRTB impression objects
     let impIds = new Set();
@@ -671,21 +673,21 @@ Object.assign(ORTB2.prototype, {
 
       mergeDeep(imp, mediaTypes);
 
+      const convertCurrency = typeof getGlobal().convertCurrency !== 'function'
+        ? (amount) => amount
+        : (amount, from, to) => {
+          if (from === to) return amount;
+          let result = null;
+          try {
+            result = getGlobal().convertCurrency(amount, from, to);
+          } catch (e) {
+          }
+          return result;
+        }
+
       const floor = (() => {
         // we have to pick a floor for the imp - here we attempt to find the minimum floor
         // across all bids for this adUnit
-
-        const convertCurrency = typeof getGlobal().convertCurrency !== 'function'
-          ? (amount) => amount
-          : (amount, from, to) => {
-            if (from === to) return amount;
-            let result = null;
-            try {
-              result = getGlobal().convertCurrency(amount, from, to);
-            } catch (e) {
-            }
-            return result;
-          }
         const s2sCurrency = config.getConfig('currency.adServerCurrency') || DEFAULT_S2S_CURRENCY;
 
         return adUnit.bids
@@ -696,6 +698,7 @@ Object.assign(ORTB2.prototype, {
               const {currency, floor} = bid.getFloor({
                 currency: s2sCurrency
               });
+
               return {
                 currency,
                 floor: parseFloat(floor)
@@ -717,11 +720,13 @@ Object.assign(ORTB2.prototype, {
               min.ref = min.min = floor;
             } else {
               const value = convertCurrency(floor.floor, floor.currency, min.ref.currency);
+
               if (value != null && value < min.ref.floor) {
                 min.ref.floor = value;
                 min.min = floor;
               }
             }
+
             return min;
           }, {}).min
       })();
@@ -729,6 +734,26 @@ Object.assign(ORTB2.prototype, {
       if (floor) {
         imp.bidfloor = floor.floor;
         imp.bidfloorcur = floor.currency;
+
+        // logic below relates to https://github.com/prebid/Prebid.js/issues/8749 and does the following:
+        // 1. check client-side floors (ref bidfloor/bidfloorcur & ortb2Imp floorMin/floorMinCur (if present))
+        // 2. set pbs req wide floorMinCur to the first floor currency found when iterating over imp's
+        //    (if currency conversion logic present, convert all imp floor values to this currency)
+        // 3. compare/store ref to lowest floorMin value as each imp is iterated over
+        // 4. set req wide floorMin and floorMinCur values for pbs after iterations are done
+        if (floorMinCur == null) { floorMinCur = floor.currency }
+        const ortb2ImpFloorMin = imp.ext?.prebid?.floors?.floorMin || imp.ext?.prebid?.floorMin;
+        const ortb2ImpFloorCur = imp.ext?.prebid?.floors?.floorMinCur || imp.ext?.prebid?.floorMinCur || floorMinCur;
+
+        const convertedFloorMinValue = convertCurrency(floor.floor, floor.currency, floorMinCur);
+        const convertedOrtb2ImpFloorMinValue = ortb2ImpFloorMin && ortb2ImpFloorCur ? convertCurrency(ortb2ImpFloorMin, ortb2ImpFloorCur, floorMinCur) : false;
+
+        const lowestImpFloorMin = convertedOrtb2ImpFloorMinValue && convertedOrtb2ImpFloorMinValue < convertedFloorMinValue
+          ? convertedOrtb2ImpFloorMinValue
+          : convertedFloorMinValue;
+
+        deepSetValue(imp, 'ext.prebid.floors.floorMin', lowestImpFloorMin);
+        if (floorMin == null || floorMin > lowestImpFloorMin) { floorMin = lowestImpFloorMin }
       }
 
       if (imp.banner || imp.video || imp.native) {
@@ -742,7 +767,7 @@ Object.assign(ORTB2.prototype, {
     }
     const request = {
       id: firstBidRequest.auctionId,
-      source: {tid: s2sBidRequest.tid},
+      source: {tid: firstBidRequest.auctionId},
       tmax: s2sConfig.timeout,
       imp: imps,
       // to do: add setconfig option to pass test = 1
@@ -903,6 +928,12 @@ Object.assign(ORTB2.prototype, {
     addBidderFirstPartyDataToRequest(request, s2sBidRequest.ortb2Fragments?.bidder || {});
 
     request.imp.forEach((imp) => this.impRequested[imp.id] = imp);
+
+    if (request.ext?.prebid?.floors?.enabled) {
+      request.ext.prebid.floors.floorMin = floorMin;
+      request.ext.prebid.floors.floorMinCur = floorMinCur;
+    }
+
     return request;
   },
 

package/modules/readpeakBidAdapter.js

@@ -41,7 +41,7 @@ export const spec = {
       cur: [currency],
       source: {
         fd: 1,
-        tid: bidRequests[0].transactionId,
+        tid: bidderRequest.auctionId,
         ext: {
           prebid: '$prebid.version$'
         }

package/modules/rubiconBidAdapter.js

@@ -333,7 +333,7 @@ export const spec = {
       }
     });
 
-    if (rubiConf.singleRequest !== true) {
+    if (config.getConfig('rubicon.singleRequest') !== true) {
       // bids are not grouped if single request mode is not enabled
       requests = videoRequests.concat(bidRequests.filter(bidRequest => bidType(bidRequest) === 'banner').map(bidRequest => {
         const bidParams = spec.createSlotParams(bidRequest, bidderRequest);
@@ -1279,8 +1279,7 @@ export function hasValidSupplyChainParams(schain) {
 }
 
 /**
- * Creates a URL key value param, encoding the
- * param unless the key is schain
+ * Creates a URL key value param, encoding the param unless the key is schain
  * @param {String} key
  * @param {String} param
  * @returns {String}

package/modules/seedingAllianceBidAdapter.js

@@ -67,7 +67,7 @@ export const spec = {
     validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
 
     const pt = setOnAny(validBidRequests, 'params.pt') || setOnAny(validBidRequests, 'params.priceType') || 'net';
-    const tid = validBidRequests[0].transactionId;
+    const tid = bidderRequest.auctionId;
     const cur = [config.getConfig('currency.adServerCurrency') || DEFAULT_CUR];
     let url = bidderRequest.refererInfo.page;
 

package/modules/sharethroughBidAdapter.js

@@ -52,7 +52,7 @@ export const sharethroughAdapterSpec = {
         ext: {},
       },
       source: {
-        tid: bidRequests[0].transactionId,
+        tid: bidderRequest.auctionId,
         ext: {
           version: '$prebid.version$',
           str: VERSION,

package/modules/taboolaBidAdapter.js

@@ -237,7 +237,7 @@ function getBid(requestId, currency, bidResponse) {
     width,
     height,
     meta,
-    netRevenue: false
+    netRevenue: true
   };
 }
 

package/modules/talkadsBidAdapter.js

@@ -63,6 +63,7 @@ export const spec = {
       cur: CURRENCY,
       timeout: poBidderRequest.timeout,
       auction_id: paValidBidRequests[0].auctionId,
+      // TODO: should this use auctionId? see #8573
       transaction_id: paValidBidRequests[0].transactionId,
       bids: laBids,
       gdpr: { applies: false, consent: false },

package/modules/truereachBidAdapter.js

@@ -25,6 +25,7 @@ export const spec = {
 
     let siteId = deepAccess(validBidRequests[0], 'params.site_id');
 
+    // TODO: should this use auctionId? see #8573
     let url = BIDDER_URL + siteId + '?hb=1&transactionId=' + validBidRequests[0].transactionId;
 
     return {

package/modules/ttdBidAdapter.js

@@ -59,7 +59,7 @@ function getBidFloor(bid) {
 
 function getSource(validBidRequests) {
   let source = {
-    tid: validBidRequests[0].transactionId
+    tid: validBidRequests[0].auctionId
   };
   if (validBidRequests[0].schain) {
     utils.deepSetValue(source, 'ext.schain', validBidRequests[0].schain);