prebid.js 7.54.0 → 7.54.2

package/modules/adqueryBidAdapter.js

@@ -1,7 +1,6 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
-import { logInfo, buildUrl, triggerPixel, parseSizesInput } from '../src/utils.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {buildUrl, getUniqueIdentifierStr, logInfo, parseSizesInput, triggerPixel} from '../src/utils.js';
 
 const ADQUERY_GVLID = 902;
 const ADQUERY_BIDDER_CODE = 'adquery';
@@ -11,7 +10,6 @@ const ADQUERY_USER_SYNC_DOMAIN = ADQUERY_BIDDER_DOMAIN_PROTOCOL + '://' + ADQUER
 const ADQUERY_DEFAULT_CURRENCY = 'PLN';
 const ADQUERY_NET_REVENUE = true;
 const ADQUERY_TTL = 360;
-const storage = getStorageManager({bidderCode: ADQUERY_BIDDER_CODE});
 
 /** @type {BidderSpec} */
 export const spec = {
@@ -57,8 +55,6 @@ export const spec = {
   interpretResponse: (response, request) => {
     logInfo(request);
     logInfo(response);
-
-    let qid = null;
     const res = response && response.body && response.body.data;
     let bidResponses = [];
 
@@ -87,17 +83,6 @@ export const spec = {
     bidResponses.push(bidResponse);
     logInfo('bidResponses', bidResponses);
 
-    if (res && res.qid) {
-      if (storage.getDataFromLocalStorage('qid')) {
-        qid = storage.getDataFromLocalStorage('qid');
-        if (qid && qid.includes('%7B%22')) {
-          storage.setDataInLocalStorage('qid', res.qid);
-        }
-      } else {
-        storage.setDataInLocalStorage('qid', res.qid);
-      }
-    }
-
     return bidResponses;
   },
 
@@ -189,8 +174,26 @@ export const spec = {
   }
 
 };
+
 function buildRequest(validBidRequests, bidderRequest) {
   let bid = validBidRequests;
+  logInfo('buildRequest: ', bid);
+
+  let userId = null;
+  if (window.qid) {
+    userId = window.qid;
+  }
+
+  if (bid.userId && bid.userId.qid) {
+    userId = bid.userId.qid
+  }
+
+  if (!userId) {
+    // onetime User ID
+    userId = (getUniqueIdentifierStr() + '_' + getUniqueIdentifierStr()).substring(0, 22);
+    window.qid = userId;
+  }
+
   let pageUrl = '';
   if (bidderRequest && bidderRequest.refererInfo) {
     pageUrl = bidderRequest.refererInfo.page || '';
@@ -199,10 +202,10 @@ function buildRequest(validBidRequests, bidderRequest) {
   return {
     v: '$prebid.version$',
     placementCode: bid.params.placementId,
-    auctionId: bid.auctionId,
+    auctionId: null,
     type: bid.params.type,
     adUnitCode: bid.adUnitCode,
-    bidQid: storage.getDataFromLocalStorage('qid') || null,
+    bidQid: userId,
     bidId: bid.bidId,
     bidder: bid.bidder,
     bidPageUrl: pageUrl,

package/modules/ixBidAdapter.js

@@ -104,7 +104,9 @@ let hasRegisteredHandler = false;
 export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
 export const FEATURE_TOGGLES = {
   // Update with list of CFTs to be requested from Exchange
-  REQUESTED_FEATURE_TOGGLES: [],
+  REQUESTED_FEATURE_TOGGLES: [
+    'pbjs_enable_multiformat'
+  ],
 
   featureToggles: {},
   isFeatureEnabled: function (ft) {
@@ -183,7 +185,7 @@ function bidToBannerImp(bid) {
  * @param  {object} bid A valid bid request config object.
  * @return {object}     A impression object that will be sent to ad server.
  */
-function bidToVideoImp(bid) {
+export function bidToVideoImp(bid) {
   const imp = bidToImp(bid, VIDEO);
   const videoAdUnitRef = deepAccess(bid, 'mediaTypes.video');
   const videoParamRef = deepAccess(bid, 'params.video');
@@ -266,7 +268,7 @@ function verifyVideoPlcmt(imp) {
  * @param  {object} bid A valid bid request config object.
  * @return {object}     A impression object that will be sent to ad server.
  */
-function bidToNativeImp(bid) {
+export function bidToNativeImp(bid) {
   const imp = bidToImp(bid, NATIVE);
 
   const request = bid.nativeOrtbRequest
@@ -364,14 +366,30 @@ function _applyFloor(bid, imp, mediaType) {
   }
 
   // Prioritize module floor over bidder.param floor
+  let setFloor = false;
   if (moduleFloor) {
     imp.bidfloor = moduleFloor.floor;
     imp.bidfloorcur = moduleFloor.currency;
     imp.ext.fl = FLOOR_SOURCE.PBJS;
+    setFloor = true;
   } else if (adapterFloor) {
     imp.bidfloor = adapterFloor.floor;
     imp.bidfloorcur = adapterFloor.currency;
     imp.ext.fl = FLOOR_SOURCE.IX;
+    setFloor = true;
+  }
+
+  if (setFloor) {
+    if (mediaType == BANNER) {
+      deepSetValue(imp, 'banner.ext.bidfloor', imp.bidfloor);
+      deepSetValue(imp, 'banner.ext.fl', imp.ext.fl);
+    } else if (mediaType == VIDEO) {
+      deepSetValue(imp, 'video.ext.bidfloor', imp.bidfloor);
+      deepSetValue(imp, 'video.ext.fl', imp.ext.fl);
+    } else {
+      deepSetValue(imp, 'native.ext.bidfloor', imp.bidfloor);
+      deepSetValue(imp, 'native.ext.fl', imp.ext.fl);
+    }
   }
 }
 
@@ -680,6 +698,9 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
     const isLastAdUnit = adUnitIndex === transactionIds.length - 1;
 
+    r = deduplicateImpExtFields(r);
+    r = removeSiteIDs(r);
+
     if (isLastAdUnit) {
       requests.push({
         method: 'POST',
@@ -889,61 +910,114 @@ function addImpressions(impressions, transactionIds, r, adUnitIndex) {
   const gpid = impressions[transactionIds[adUnitIndex]].gpid;
   const dfpAdUnitCode = impressions[transactionIds[adUnitIndex]].dfp_ad_unit_code;
   const tid = impressions[transactionIds[adUnitIndex]].tid;
-  const sid = impressions[transactionIds[adUnitIndex]].sid
-
-  if (impressionObjects.length && BANNER in impressionObjects[0]) {
-    const { id, banner: { topframe } } = impressionObjects[0];
-    const _bannerImpression = {
-      id,
-      banner: {
-        topframe,
-        format: impressionObjects.map(({ banner: { w, h }, ext }) => ({ w, h, ext }))
-      },
-    };
-
-    for (let i = 0; i < _bannerImpression.banner.format.length; i++) {
-      // We add sid in imp.ext.sid therefore, remove from banner.format[].ext
-      if (_bannerImpression.banner.format[i].ext != null && _bannerImpression.banner.format[i].ext.sid != null) {
-        delete _bannerImpression.banner.format[i].ext.sid;
+  const sid = impressions[transactionIds[adUnitIndex]].sid;
+  const bannerImpressions = impressionObjects.filter(impression => BANNER in impression);
+  const otherImpressions = impressionObjects.filter(impression => !(BANNER in impression));
+
+  if (bannerImpressions.length > 0) {
+    const bannerImpsKeyed = bannerImpressions.reduce((acc, bannerImp) => {
+      if (!acc[bannerImp.id]) {
+        acc[bannerImp.id] = []
       }
+      acc[bannerImp.id].push(bannerImp);
+      return acc;
+    }, {});
+    for (const impId in bannerImpsKeyed) {
+      const bannerImps = bannerImpsKeyed[impId];
+      const { id, banner: { topframe } } = bannerImps[0];
+      const _bannerImpression = {
+        id,
+        banner: {
+          topframe,
+          format: bannerImps.map(({ banner: { w, h }, ext }) => ({ w, h, ext }))
+        },
+      };
+
+      for (let i = 0; i < _bannerImpression.banner.format.length; i++) {
+        // We add sid in imp.ext.sid therefore, remove from banner.format[].ext
+        if (_bannerImpression.banner.format[i].ext != null && _bannerImpression.banner.format[i].ext.sid != null) {
+          delete _bannerImpression.banner.format[i].ext.sid;
+        }
 
-      // add floor per size
-      if ('bidfloor' in impressionObjects[i]) {
-        _bannerImpression.banner.format[i].ext.bidfloor = impressionObjects[i].bidfloor;
+        // add floor per size
+        if ('bidfloor' in bannerImps[i]) {
+          _bannerImpression.banner.format[i].ext.bidfloor = bannerImps[i].bidfloor;
+        }
       }
-    }
 
-    const position = impressions[transactionIds[adUnitIndex]].pos;
-    if (isInteger(position)) {
-      _bannerImpression.banner.pos = position;
-    }
+      const position = impressions[transactionIds[adUnitIndex]].pos;
+      if (isInteger(position)) {
+        _bannerImpression.banner.pos = position;
+      }
 
-    if (dfpAdUnitCode || gpid || tid || sid) {
-      _bannerImpression.ext = {};
-      _bannerImpression.ext.dfp_ad_unit_code = dfpAdUnitCode;
-      _bannerImpression.ext.gpid = gpid;
-      _bannerImpression.ext.tid = tid;
-      _bannerImpression.ext.sid = sid;
-    }
+      if (dfpAdUnitCode || gpid || tid || sid) {
+        _bannerImpression.ext = {};
+        _bannerImpression.ext.dfp_ad_unit_code = dfpAdUnitCode;
+        _bannerImpression.ext.gpid = gpid;
+        _bannerImpression.ext.tid = tid;
+        _bannerImpression.ext.sid = sid;
+      }
 
-    if ('bidfloor' in impressionObjects[0]) {
-      _bannerImpression.bidfloor = impressionObjects[0].bidfloor;
-    }
+      if ('bidfloor' in bannerImps[0]) {
+        _bannerImpression.bidfloor = bannerImps[0].bidfloor;
+      }
 
-    if ('bidfloorcur' in impressionObjects[0]) {
-      _bannerImpression.bidfloorcur = impressionObjects[0].bidfloorcur;
-    }
+      if ('bidfloorcur' in bannerImps[0]) {
+        _bannerImpression.bidfloorcur = bannerImps[0].bidfloorcur;
+      }
 
-    const adUnitFPD = impressions[transactionIds[adUnitIndex]].adUnitFPD
-    if (adUnitFPD) {
-      _bannerImpression.ext.data = adUnitFPD;
+      const adUnitFPD = impressions[transactionIds[adUnitIndex]].adUnitFPD
+      if (adUnitFPD) {
+        deepSetValue(_bannerImpression, 'ext.data', adUnitFPD);
+      }
+      r.imp.push(_bannerImpression);
     }
-
-    r.imp.push(_bannerImpression);
-  } else {
-    // set imp.ext.gpid to resolved gpid for each imp
-    impressionObjects.forEach(imp => deepSetValue(imp, 'ext.gpid', gpid));
-    r.imp.push(...impressionObjects);
+  }
+  if (otherImpressions.length > 0) {
+    // Creates multiformat imp if they have the same ID
+    // if not same ID, just add the imp to the imp array
+    // Removes imp.ext.bidfloor
+    // Sets imp.ext.siteID to one of the other [video/native].ext.siteid if imp.ext.siteID doesnt exist
+    otherImpressions.forEach(imp => {
+      deepSetValue(imp, 'ext.gpid', gpid);
+      if (r.imp.length > 0) {
+        let matchFound = false;
+        r.imp.forEach((rImp, index) => {
+          if (imp.id === rImp.id && VIDEO in imp) {
+            rImp.video = imp.video;
+            rImp.video.ext = Object.assign({}, imp.video.ext, imp.ext);
+            if (deepAccess(rImp, 'video.ext.bidfloor', false) && deepAccess(rImp, 'bidfloor', false)) {
+              if (rImp.video.ext.bidfloor < rImp.bidfloor) {
+                rImp.bidfloor = rImp.video.ext.bidfloor;
+              }
+            }
+            if (!deepAccess(rImp, 'ext.siteID', false) && deepAccess(imp, 'video.ext.siteID')) {
+              deepSetValue(rImp, 'ext.siteID', imp.video.ext.siteID);
+              deepSetValue(r, 'ext.ixdiag.usid', true);
+            }
+            matchFound = true;
+          } else if (imp.id === rImp.id && NATIVE in imp) {
+            rImp.native = imp.native;
+            rImp.native.ext = Object.assign({}, imp.native.ext, imp.ext);
+            if (deepAccess(rImp, 'native.ext.bidfloor', false) && deepAccess(rImp, 'bidfloor', false)) {
+              if (rImp.native.ext.bidfloor < rImp.bidfloor) {
+                rImp.bidfloor = rImp.native.ext.bidfloor;
+              }
+            }
+            if (!deepAccess(rImp, 'ext.siteID', false) && deepAccess(imp, 'native.ext.siteID', false)) {
+              deepSetValue(rImp, 'ext.siteID', imp.native.ext.siteID);
+              deepSetValue(r, 'ext.ixdiag.usid', true);
+            }
+            matchFound = true;
+          }
+        });
+        if (!matchFound) {
+          r.imp.push(imp);
+        }
+      } else {
+        r.imp.push(imp);
+      }
+    });
   }
 
   return r;
@@ -1643,15 +1717,30 @@ export const spec = {
       }
     }
 
-    // Step 4: Build banner, video & native requests
+    // Step 3: Build banner, video & native requests
+    let allImps = [];
     if (Object.keys(bannerImps).length > 0) {
-      reqs.push(...buildRequest(validBidRequests, bidderRequest, bannerImps, BANNER_ENDPOINT_VERSION));
+      allImps.push(bannerImps);
     }
     if (Object.keys(videoImps).length > 0) {
-      reqs.push(...buildRequest(validBidRequests, bidderRequest, videoImps, VIDEO_ENDPOINT_VERSION));
+      allImps.push(videoImps);
     }
     if (Object.keys(nativeImps).length > 0) {
-      reqs.push(...buildRequest(validBidRequests, bidderRequest, nativeImps));
+      allImps.push(nativeImps);
+    }
+
+    if (FEATURE_TOGGLES.isFeatureEnabled('pbjs_enable_multiformat')) {
+      reqs.push(...buildRequest(validBidRequests, bidderRequest, combineImps(allImps)));
+    } else {
+      if (Object.keys(bannerImps).length > 0) {
+        reqs.push(...buildRequest(validBidRequests, bidderRequest, bannerImps, BANNER_ENDPOINT_VERSION));
+      }
+      if (Object.keys(videoImps).length > 0) {
+        reqs.push(...buildRequest(validBidRequests, bidderRequest, videoImps, VIDEO_ENDPOINT_VERSION));
+      }
+      if (Object.keys(nativeImps).length > 0) {
+        reqs.push(...buildRequest(validBidRequests, bidderRequest, nativeImps));
+      }
     }
 
     return reqs;
@@ -1789,4 +1878,147 @@ function buildImgSyncUrl(syncsPerBidder, index) {
   return IMG_USER_SYNC_URL + '&site_id=' + siteID.toString() + '&p=' + syncsPerBidder.toString() + '&i=' + index.toString() + '&gdpr=' + gdprApplies + '&gdpr_consent=' + consentString + '&us_privacy=' + (usPrivacy || '');
 }
 
+/**
+ * Combines all imps into a single object
+ * @param {array} imps array of imps
+ * @returns object
+ */
+export function combineImps(imps) {
+  const result = {}
+  imps.forEach((imp) => {
+    Object.keys(imp).forEach((key) => {
+      if (Object.keys(result).includes(key)) {
+        if (result[key].hasOwnProperty('ixImps') && imp[key].hasOwnProperty('ixImps')) {
+          result[key].ixImps = [...result[key].ixImps, ...imp[key].ixImps];
+        } else if (result[key].hasOwnProperty('missingImps') && imp[key].hasOwnProperty('missingImps')) {
+          result[key].missingImps = [...result[key].missingImps, ...imp[key].missingImps];
+        } else if (imp[key].hasOwnProperty('ixImps')) {
+          result[key].ixImps = imp[key].ixImps;
+        } else if (imp[key].hasOwnProperty('missingImps')) {
+          result[key].missingImps = imp[key].missingImps
+        }
+      } else {
+        result[key] = imp[key];
+      }
+    });
+  });
+  return result;
+}
+
+/**
+ * Deduplicates ext fields. For example if imp.ext.tid exists, removes imp.banner.ext.tid
+ *
+ * @param {object} r request object
+ * @returns object
+ */
+export function deduplicateImpExtFields(r) {
+  r.imp.forEach((imp, index) => {
+    const impExt = imp.ext;
+    if (impExt == undefined) {
+      return r;
+    }
+    if (getFormatCount(imp) < 2) {
+      return;
+    }
+    Object.keys(impExt).forEach((key) => {
+      if (BANNER in imp) {
+        const bannerExt = imp.banner.ext;
+        if (bannerExt !== undefined && bannerExt[key] !== undefined && bannerExt[key] == impExt[key]) {
+          delete r.imp[index].banner.ext[key];
+        }
+        if (imp.banner.format !== undefined) {
+          for (let i = 0; i < imp.banner.format.length; i++) {
+            if (imp.banner.format[i].ext != undefined && imp.banner.format[i].ext[key] != undefined && imp.banner.format[i].ext[key] == impExt[key]) {
+              delete r.imp[index].banner.format[i].ext[key];
+            }
+          }
+        }
+      }
+      if (VIDEO in imp) {
+        const videoExt = imp.video.ext;
+        if (videoExt !== undefined && videoExt[key] !== undefined && videoExt[key] == impExt[key]) {
+          delete r.imp[index].video.ext[key];
+        }
+      }
+
+      if (NATIVE in imp) {
+        const nativeExt = imp.native.ext;
+        if (nativeExt !== undefined && nativeExt[key] !== undefined && nativeExt[key] == impExt[key]) {
+          delete r.imp[index].native.ext[key];
+        }
+      }
+    });
+  });
+  return r;
+}
+
+/**
+ * Removes ext.siteids in multiformat scenario
+ * Site id will be set only at imp.ext.siteId
+ *
+ * @param {object} r request object
+ * @returns object
+ */
+export function removeSiteIDs(r) {
+  r.imp.forEach((imp, index) => {
+    const impExt = imp.ext;
+    if (impExt == undefined) {
+      return r;
+    }
+    if (getFormatCount(imp) < 2) {
+      return;
+    }
+
+    if (BANNER in imp) {
+      const bannerExt = imp.banner.ext;
+      if (bannerExt !== undefined && bannerExt.siteID !== undefined) {
+        delete r.imp[index].banner.ext.siteID;
+      }
+      if (imp.banner.format !== undefined) {
+        for (let i = 0; i < imp.banner.format.length; i++) {
+          if (imp.banner.format[i].ext !== undefined && imp.banner.format[i].ext.siteID !== undefined) {
+            deepSetValue(r.imp[index], 'ext.siteID', imp.banner.format[i].ext.siteID);
+            deepSetValue(r, 'ext.ixdiag.usid', true);
+            delete r.imp[index].banner.format[i].ext.siteID;
+          }
+        }
+      }
+    }
+
+    if (VIDEO in imp) {
+      const videoExt = imp.video.ext;
+      if (videoExt !== undefined && videoExt.siteID !== undefined) {
+        delete r.imp[index].video.ext.siteID;
+      }
+    }
+
+    if (NATIVE in imp) {
+      const nativeExt = imp.native.ext;
+      if (nativeExt !== undefined && nativeExt.siteID !== undefined) {
+        delete r.imp[index].native.ext.siteID;
+      }
+    }
+  });
+  return r;
+}
+
+/**
+ * Gets count of banner/video/native formats in imp
+ * @param {object} imp
+ * @returns int
+ */
+function getFormatCount(imp) {
+  let formatCount = 0;
+  if (imp.banner !== undefined) {
+    formatCount += 1;
+  }
+  if (imp.video !== undefined) {
+    formatCount += 1;
+  }
+  if (imp.native !== undefined) {
+    formatCount += 1;
+  }
+  return formatCount;
+}
+
 registerBidder(spec);

package/modules/kargoBidAdapter.js

@@ -97,6 +97,10 @@ function buildRequests(validBidRequests, bidderRequest) {
     user: getUserIds(tdidAdapter, bidderRequest.uspConsent, bidderRequest.gdprConsent, firstBidRequest.userIdAsEids, bidderRequest.gppConsent),
   });
 
+  if (firstBidRequest.schain && firstBidRequest.schain.nodes) {
+    krakenParams.schain = firstBidRequest.schain
+  }
+
   const reqCount = getRequestCount()
   if (reqCount != null) {
     krakenParams.requestCount = reqCount;

package/modules/mediasquareBidAdapter.js

@@ -119,23 +119,17 @@ export const spec = {
           netRevenue: value['net_revenue'],
           ttl: value['ttl'],
           ad: value['ad'],
-          mediasquare: {
-            'bidder': value['bidder'],
-            'code': value['code']
-          },
+          mediasquare: {},
           meta: {
             'advertiserDomains': value['adomain']
           }
         };
-        if ('context' in value) {
-          bidResponse['mediasquare']['context'] = value['context'];
-        }
-        if ('match' in value) {
-          bidResponse['mediasquare']['match'] = value['match'];
-        }
-        if ('hasConsent' in value) {
-          bidResponse['mediasquare']['hasConsent'] = value['hasConsent'];
-        }
+        let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context', 'increment'];
+        paramsToSearchFor.forEach(param => {
+          if (param in value) {
+            bidResponse['mediasquare'][param] = value[param];
+          }
+        });
         if ('native' in value) {
           bidResponse['native'] = value['native'];
           bidResponse['mediaType'] = 'native';
@@ -179,21 +173,23 @@ export const spec = {
     }
     let params = { pbjs: '$prebid.version$', referer: encodeURIComponent(getRefererInfo().page || getRefererInfo().topmostLocation) };
     let endpoint = document.location.search.match(/msq_test=true/) ? BIDDER_URL_TEST : BIDDER_URL_PROD;
-    let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context'];
+    let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context', 'increment'];
     if (bid.hasOwnProperty('mediasquare')) {
-      for (let i = 0; i < paramsToSearchFor.length; i++) {
-        if (bid['mediasquare'].hasOwnProperty(paramsToSearchFor[i])) {
-          params[paramsToSearchFor[i]] = bid['mediasquare'][paramsToSearchFor[i]];
+      paramsToSearchFor.forEach(param => {
+        if (bid['mediasquare'].hasOwnProperty(param)) {
+          params[param] = bid['mediasquare'][param];
         }
-      }
+      });
     };
     paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId', 'originalCpm', 'originalCurrency'];
-    for (let i = 0; i < paramsToSearchFor.length; i++) {
-      if (bid.hasOwnProperty(paramsToSearchFor[i])) {
-        params[paramsToSearchFor[i]] = bid[paramsToSearchFor[i]];
-        if (typeof params[paramsToSearchFor[i]] == 'number') { params[paramsToSearchFor[i]] = params[paramsToSearchFor[i]].toString() }
+    paramsToSearchFor.forEach(param => {
+      if (bid.hasOwnProperty(param)) {
+        params[param] = bid[param];
+        if (typeof params[param] == 'number') {
+          params[param] = params[param].toString();
+        }
       }
-    }
+    });
     ajax(endpoint + BIDDER_ENDPOINT_WINNING, null, JSON.stringify(params), {method: 'POST', withCredentials: true});
     return true;
   }