prebid.js 7.18.0 → 7.20.0

package/modules/gridBidAdapter.js

@@ -72,10 +72,14 @@ export const spec = {
     let forceBidderName = false;
     let {bidderRequestId, auctionId, gdprConsent, uspConsent, timeout, refererInfo} = bidderRequest || {};
 
-    // TODO: is 'page' the right value here?
     const referer = refererInfo ? encodeURIComponent(refererInfo.page) : '';
+    const bidderTimeout = config.getConfig('bidderTimeout') || timeout;
+    const tmax = timeout ? Math.min(bidderTimeout, timeout) : bidderTimeout;
     const imp = [];
     const bidsMap = {};
+    const requests = [];
+    const sources = [];
+    const bidsArray = [];
 
     validBidRequests.forEach((bid) => {
       if (!bidderRequestId) {
@@ -93,7 +97,8 @@ export const spec = {
       if (!endpoint) {
         endpoint = ALIAS_CONFIG[bid.bidder] && ALIAS_CONFIG[bid.bidder].endpoint;
       }
-      const { params: { uid, keywords, forceBidder }, mediaTypes, bidId, adUnitCode, rtd, ortb2Imp } = bid;
+      const { params: { uid, keywords, forceBidder, multiRequest }, mediaTypes, bidId, adUnitCode, rtd, ortb2Imp } = bid;
+      const { pubdata, secid, pubid, source, content: bidParamsContent } = bid.params;
       bidsMap[bidId] = bid;
       const bidFloor = _getFloor(mediaTypes || {}, bid);
       const jwTargeting = rtd && rtd.jwplayer && rtd.jwplayer.targeting;
@@ -105,9 +110,10 @@ export const spec = {
           content = jwTargeting.content;
         }
       }
+
       let impObj = {
         id: bidId.toString(),
-        tagid: uid.toString(),
+        tagid: (secid || uid).toString(),
         ext: {
           divid: adUnitCode.toString()
         }
@@ -150,7 +156,54 @@ export const spec = {
       }
 
       if (impObj.banner || impObj.video) {
-        imp.push(impObj);
+        if (multiRequest) {
+          const reqSource = {
+            tid: bid.auctionId && bid.auctionId.toString(),
+            ext: {
+              wrapper: 'Prebid_js',
+              wrapper_version: '$prebid.version$'
+            }
+          };
+          if (bid.schain) {
+            reqSource.ext.schain = bid.schain;
+          }
+          const request = {
+            id: bid.bidderRequestId && bid.bidderRequestId.toString(),
+            site: {
+              page: referer,
+            },
+            tmax,
+            source: reqSource,
+            imp: [impObj]
+          };
+
+          if (pubid) {
+            request.site.publisher = { id: pubid };
+          }
+
+          const reqJwpseg = (pubdata && pubdata.jwpseg) || (jwTargeting && jwTargeting.segments);
+
+          const siteContent = bidParamsContent || (jwTargeting && jwTargeting.content);
+
+          if (siteContent) {
+            request.site.content = siteContent;
+          }
+
+          if (reqJwpseg && reqJwpseg.length) {
+            request.user = {
+              data: [{
+                name: 'iow_labs_pub_data',
+                segment: segmentProcessing(reqJwpseg, 'jwpseg'),
+              }]
+            };
+          }
+
+          requests.push(request);
+          sources.push(source);
+          bidsArray.push(bid);
+        } else {
+          imp.push(impObj);
+        }
       }
 
       if (!forceBidderName && forceBidder && ALIAS_CONFIG[forceBidder]) {
@@ -165,7 +218,7 @@ export const spec = {
       this.forceBidderName = forceBidderName;
     }
 
-    const source = {
+    const reqSource = {
       tid: auctionId && auctionId.toString(),
       ext: {
         wrapper: 'Prebid_js',
@@ -174,28 +227,25 @@ export const spec = {
     };
 
     if (schain) {
-      source.ext.schain = schain;
+      reqSource.ext.schain = schain;
     }
 
-    const bidderTimeout = config.getConfig('bidderTimeout') || timeout;
-    const tmax = timeout ? Math.min(bidderTimeout, timeout) : bidderTimeout;
-
-    let request = {
+    const mainRequest = (imp.length || !requests.length) ? {
       id: bidderRequestId && bidderRequestId.toString(),
       site: {
         page: referer
       },
       tmax,
-      source,
+      source: reqSource,
       imp
-    };
+    } : null;
 
     if (content) {
-      request.site.content = content;
+      mainRequest.site.content = content;
     }
 
     if (jwpseg && jwpseg.length) {
-      user = {
+      mainRequest.user = {
         data: [{
           name: 'iow_labs_pub_data',
           segment: segmentProcessing(jwpseg, 'jwpseg'),
@@ -203,131 +253,151 @@ export const spec = {
       };
     }
 
-    const ortb2UserData = deepAccess(bidderRequest, 'ortb2.user.data');
-    if (ortb2UserData && ortb2UserData.length) {
-      if (!user) {
-        user = { data: [] };
+    [...requests, mainRequest].forEach((request) => {
+      if (!request) {
+        return;
       }
-      user = mergeDeep(user, {
-        data: [...ortb2UserData]
-      });
-    }
 
-    if (gdprConsent && gdprConsent.consentString) {
-      userExt = {consent: gdprConsent.consentString};
-    }
+      const ortb2UserData = deepAccess(bidderRequest, 'ortb2.user.data');
+      if (ortb2UserData && ortb2UserData.length) {
+        user = request.user || { data: [] };
+        user = mergeDeep(user, {
+          data: [...ortb2UserData]
+        });
+      }
 
-    const ortb2UserExtDevice = deepAccess(bidderRequest, 'ortb2.user.ext.device');
-    if (ortb2UserExtDevice) {
-      userExt = userExt || {};
-      userExt.device = { ...ortb2UserExtDevice };
-    }
+      if (gdprConsent && gdprConsent.consentString) {
+        userExt = {consent: gdprConsent.consentString};
+      }
 
-    if (userIdAsEids && userIdAsEids.length) {
-      userExt = userExt || {};
-      userExt.eids = [...userIdAsEids];
-    }
+      const ortb2UserExtDevice = deepAccess(bidderRequest, 'ortb2.user.ext.device');
+      if (ortb2UserExtDevice) {
+        userExt = userExt || {};
+        userExt.device = { ...ortb2UserExtDevice };
+      }
 
-    if (userExt && Object.keys(userExt).length) {
-      user = user || {};
-      user.ext = userExt;
-    }
+      if (userIdAsEids && userIdAsEids.length) {
+        userExt = userExt || {};
+        userExt.eids = [...userIdAsEids];
+      }
 
-    const fpdUserId = getUserIdFromFPDStorage();
+      if (userExt && Object.keys(userExt).length) {
+        user = user || {};
+        user.ext = userExt;
+      }
 
-    if (fpdUserId) {
-      user = user || {};
-      user.id = fpdUserId.toString();
-    }
+      const fpdUserId = getUserIdFromFPDStorage();
 
-    if (user) {
-      request.user = user;
-    }
+      if (fpdUserId) {
+        user = user || {};
+        user.id = fpdUserId.toString();
+      }
 
-    const userKeywords = deepAccess(bidderRequest, 'ortb2.user.keywords') || null;
-    const siteKeywords = deepAccess(bidderRequest, 'ortb2.site.keywords') || null;
+      if (user) {
+        request.user = user;
+      }
 
-    if (userKeywords) {
-      pageKeywords = pageKeywords || {};
-      pageKeywords.user = pageKeywords.user || {};
-      pageKeywords.user.ortb2 = [
-        {
-          name: 'keywords',
-          keywords: userKeywords.split(','),
-        }
-      ];
-    }
-    if (siteKeywords) {
-      pageKeywords = pageKeywords || {};
-      pageKeywords.site = pageKeywords.site || {};
-      pageKeywords.site.ortb2 = [
-        {
-          name: 'keywords',
-          keywords: siteKeywords.split(','),
-        }
-      ];
-    }
+      const userKeywords = deepAccess(bidderRequest, 'ortb2.user.keywords') || null;
+      const siteKeywords = deepAccess(bidderRequest, 'ortb2.site.keywords') || null;
 
-    if (pageKeywords) {
-      pageKeywords = reformatKeywords(pageKeywords);
-      if (pageKeywords) {
-        request.ext = {
-          keywords: pageKeywords
-        };
+      if (userKeywords) {
+        pageKeywords = pageKeywords || {};
+        pageKeywords.user = pageKeywords.user || {};
+        pageKeywords.user.ortb2 = [
+          {
+            name: 'keywords',
+            keywords: userKeywords.split(','),
+          }
+        ];
+      }
+      if (siteKeywords) {
+        pageKeywords = pageKeywords || {};
+        pageKeywords.site = pageKeywords.site || {};
+        pageKeywords.site.ortb2 = [
+          {
+            name: 'keywords',
+            keywords: siteKeywords.split(','),
+          }
+        ];
       }
-    }
 
-    if (gdprConsent && gdprConsent.gdprApplies) {
-      request.regs = {
-        ext: {
-          gdpr: gdprConsent.gdprApplies ? 1 : 0
+      if (pageKeywords) {
+        pageKeywords = reformatKeywords(pageKeywords);
+        if (pageKeywords) {
+          request.ext = {
+            keywords: pageKeywords
+          };
         }
-      };
-    }
-
-    if (uspConsent) {
-      if (!request.regs) {
-        request.regs = {ext: {}};
       }
-      request.regs.ext.us_privacy = uspConsent;
-    }
 
-    if (config.getConfig('coppa') === true) {
-      if (!request.regs) {
-        request.regs = {};
+      if (gdprConsent && gdprConsent.gdprApplies) {
+        request.regs = {
+          ext: {
+            gdpr: gdprConsent.gdprApplies ? 1 : 0
+          }
+        };
       }
-      request.regs.coppa = 1;
-    }
 
-    const site = deepAccess(bidderRequest, 'ortb2.site');
-    if (site) {
-      const pageCategory = [...(site.cat || []), ...(site.pagecat || [])].filter((category) => {
-        return category && typeof category === 'string'
-      });
-      if (pageCategory.length) {
-        request.site.cat = pageCategory;
-      }
-      const genre = deepAccess(site, 'content.genre');
-      if (genre && typeof genre === 'string') {
-        request.site.content = {...request.site.content, genre};
+      if (uspConsent) {
+        if (!request.regs) {
+          request.regs = {ext: {}};
+        }
+        request.regs.ext.us_privacy = uspConsent;
       }
-      const data = deepAccess(site, 'content.data');
-      if (data && data.length) {
-        const siteContent = request.site.content || {};
-        request.site.content = mergeDeep(siteContent, { data });
+
+      if (config.getConfig('coppa') === true) {
+        if (!request.regs) {
+          request.regs = {};
+        }
+        request.regs.coppa = 1;
       }
-      const id = deepAccess(site, 'content.id');
-      if (id) {
-        request.site.content = {...request.site.content, id};
+
+      const site = deepAccess(bidderRequest, 'ortb2.site');
+      if (site) {
+        const pageCategory = [...(site.cat || []), ...(site.pagecat || [])].filter((category) => {
+          return category && typeof category === 'string'
+        });
+        if (pageCategory.length) {
+          request.site.cat = pageCategory;
+        }
+        const genre = deepAccess(site, 'content.genre');
+        if (genre && typeof genre === 'string') {
+          request.site.content = {...request.site.content, genre};
+        }
+        const data = deepAccess(site, 'content.data');
+        if (data && data.length) {
+          const siteContent = request.site.content || {};
+          request.site.content = mergeDeep(siteContent, { data });
+        }
+        const id = deepAccess(site, 'content.id');
+        if (id) {
+          request.site.content = {...request.site.content, id};
+        }
       }
-    }
+    });
 
-    return {
+    return [...requests.map((req, i) => {
+      let sp;
+      const url = (endpoint || ENDPOINT_URL).replace(/[?&]sp=([^?&=]+)/, (i, found) => {
+        if (found) {
+          sp = found;
+        }
+        return '';
+      });
+      let currentSource = sources[i] || sp;
+      const urlWithParams = url + (url.indexOf('?') > -1 ? '&' : '?') + 'no_mapping=1' + (currentSource ? `&sp=${currentSource}` : '');
+      return {
+        method: 'POST',
+        url: urlWithParams,
+        data: JSON.stringify(req),
+        bid: bidsArray[i],
+      };
+    }), ...(mainRequest ? [{
       method: 'POST',
       url: endpoint || ENDPOINT_URL,
-      data: JSON.stringify(request),
+      data: JSON.stringify(mainRequest),
       bidsMap
-    };
+    }] : [])];
   },
   /**
    * Unpack the response from the server into a list of bids.
@@ -395,7 +465,7 @@ export const spec = {
  */
 function _getFloor (mediaTypes, bid) {
   const curMediaType = mediaTypes.video ? 'video' : 'banner';
-  let floor = bid.params.bidFloor || 0;
+  let floor = bid.params.bidFloor || bid.params.floorcpm || 0;
 
   if (typeof bid.getFloor === 'function') {
     const floorInfo = bid.getFloor({
@@ -431,7 +501,7 @@ function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst, bid
   if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
   if (!errorMessage && !serverBid.adm && !serverBid.nurl) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
   else {
-    const bid = bidRequest.bidsMap[serverBid.impid];
+    const bid = bidRequest.bidsMap ? bidRequest.bidsMap[serverBid.impid] : bidRequest.bid;
     if (bid) {
       const bidResponse = {
         requestId: bid.bidId, // bid.bidderRequestId
@@ -483,7 +553,7 @@ function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst, bid
 }
 
 function createVideoRequest(bid, mediaType) {
-  const {playerSize, mimes, durationRangeSec, protocols} = mediaType;
+  const { playerSize, mimes, durationRangeSec, protocols } = mediaType;
   const size = (playerSize || bid.sizes || [])[0];
   if (!size) return;
 

package/modules/improvedigitalBidAdapter.js

@@ -307,10 +307,10 @@ const ID_REQUEST = {
     }
     // In the single request mode, split imps between those going to the ad server and those going to extend server
     if (extendImps.length) {
-      requests.push(formatRequest(extendImps, null, true));
+      requests.push(formatRequest(extendImps, bidderRequest.auctionId, true));
     }
     if (adServerImps.length) {
-      requests.push(formatRequest(adServerImps, null, false));
+      requests.push(formatRequest(adServerImps, bidderRequest.auctionId, false));
     }
 
     return requests;

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;
   },