prebid.js 7.18.0 → 7.20.0

package/modules/debugging/bidInterceptor.js

@@ -126,7 +126,7 @@ Object.assign(BidInterceptor.prototype, {
         Object.entries(ref).forEach(([key, val]) => {
           if (typeof val === 'function') {
             result[key] = val(...args);
-          } else if (typeof val === 'object') {
+          } else if (val != null && typeof val === 'object') {
             result[key] = replFn({args, ref: val})
           } else {
             result[key] = val;
@@ -138,7 +138,7 @@ Object.assign(BidInterceptor.prototype, {
     return (bid, ...args) => {
       const response = this.responseDefaults(bid);
       mergeDeep(response, replFn({args: [bid, ...args]}));
-      if (!response.ad) {
+      if (!response.hasOwnProperty('ad') && !response.hasOwnProperty('adUrl')) {
         response.ad = this.defaultAd(bid, response);
       }
       response.isDebug = true;

package/modules/debugging/debugging.js

@@ -49,9 +49,17 @@ function saveDebuggingConfig(debugConfig, {sessionStorage = window.sessionStorag
   }
 }
 
-export function getConfig(debugging, {sessionStorage = window.sessionStorage, DEBUG_KEY, config, hook, logger} = {}) {
+export function getConfig(debugging, {getStorage = () => window.sessionStorage, DEBUG_KEY, config, hook, logger} = {}) {
   if (debugging == null) return;
-  saveDebuggingConfig(debugging, {sessionStorage, DEBUG_KEY});
+  let sessionStorage;
+  try {
+    sessionStorage = getStorage();
+  } catch (e) {
+    logger.logError(`sessionStorage is not available: debugging configuration will not persist on page reload`, e);
+  }
+  if (sessionStorage != null) {
+    saveDebuggingConfig(debugging, {sessionStorage, DEBUG_KEY});
+  }
   if (!debugging.enabled) {
     disableDebugging({hook, logger});
   } else {

package/modules/debugging/legacy.js

@@ -54,7 +54,7 @@ export function applyBidOverrides(overrideObj, bidObj, bidType, logger) {
   }, bidObj);
 }
 
-export function addBidResponseHook(next, adUnitCode, bid) {
+export function addBidResponseHook(next, adUnitCode, bid, reject) {
   const {overrides, logger} = this;
 
   if (bidderExcluded(overrides.bidders, bid.bidderCode)) {
@@ -70,7 +70,7 @@ export function addBidResponseHook(next, adUnitCode, bid) {
     });
   }
 
-  next(adUnitCode, bid);
+  next(adUnitCode, bid, reject);
 }
 
 export function addBidderRequestsHook(next, bidderRequests) {

package/modules/dgkeywordRtdProvider.js

@@ -20,10 +20,8 @@ import { getGlobal } from '../src/prebidGlobal.js';
  * @param {Object} userConsent
  */
 export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, userConsent) {
-  const URL = 'https://mediaconsortium.profiles.tagger.opecloud.com/api/v1?url=';
   const PROFILE_TIMEOUT_MS = 1000;
   const timeout = (moduleConfig && moduleConfig.params && moduleConfig.params.timeout && Number(moduleConfig.params.timeout) > 0) ? Number(moduleConfig.params.timeout) : PROFILE_TIMEOUT_MS;
-  const url = (moduleConfig && moduleConfig.params && moduleConfig.params.url) ? moduleConfig.params.url : URL + encodeURIComponent(window.location.href);
   const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
   callback = (function(cb) {
     let done = false;
@@ -43,7 +41,7 @@ export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, us
   } else {
     logMessage('[dgkeyword sub module] dgkeyword targets:', setKeywordTargetBidders);
     logMessage('[dgkeyword sub module] get targets from profile api start.');
-    ajax(url, {
+    ajax(getProfileApiUrl(moduleConfig?.params?.url, moduleConfig?.params?.disableReadFpid), {
       success: function(response) {
         const res = JSON.parse(response);
         if (!isFinish) {
@@ -98,6 +96,26 @@ export function getDgKeywordsAndSet(reqBidsConfigObj, callback, moduleConfig, us
   }
 }
 
+export function getProfileApiUrl(customeUrl, disableReadFpid) {
+  const URL = 'https://mediaconsortium.profiles.tagger.opecloud.com/api/v1';
+  const fpid = (disableReadFpid) ? '' : readFpidFromLocalStrage();
+  let url = customeUrl || URL;
+  url = url + '?url=' + encodeURIComponent(window.location.href) + ((fpid) ? `&fpid=${fpid}` : '');
+  return url;
+}
+
+export function readFpidFromLocalStrage() {
+  try {
+    const fpid = window.localStorage.getItem('ope_fpid');
+    if (fpid) {
+      return fpid;
+    }
+    return null;
+  } catch (error) {
+    return null;
+  }
+}
+
 /**
  * get all bidder which hava {dgkeyword: true} in params
  * @param {Object} adUnits

package/modules/dianomiBidAdapter.js

@@ -112,7 +112,7 @@ export const spec = {
       setOnAny(validBidRequests, 'params.pt') ||
       setOnAny(validBidRequests, 'params.priceType') ||
       'net';
-    const tid = validBidRequests[0].transactionId;
+    const tid = bidderRequest.auctionId;
     const currency = getConfig('currency.adServerCurrency');
     const cur = currency && [currency];
     const eids = setOnAny(validBidRequests, 'userIdAsEids');

package/modules/enrichmentFpdModule.js

@@ -7,11 +7,15 @@ import { timestamp, mergeDeep } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
 import {getRefererInfo, parseDomain} from '../src/refererDetection.js';
 import { getCoreStorageManager } from '../src/storageManager.js';
+import {GreedyPromise} from '../src/utils/promise.js';
+import {getHighEntropySUA, getLowEntropySUA} from '../libraries/fpd/sua.js';
 
-let ortb2 = {};
+let ortb2;
 let win = (window === window.top) ? window : window.top;
 export const coreStorage = getCoreStorageManager('enrichmentFpd');
 
+export const sua = {he: getHighEntropySUA, le: getLowEntropySUA};
+
 /**
   * Find the root domain
   * @param {string|undefined} fullDomain
@@ -124,6 +128,17 @@ function setKeywords() {
   if (keywords && keywords.content) mergeDeep(ortb2, { site: { keywords: keywords.content.replace(/\s/g, '') } });
 }
 
+function setDeviceSua(hints) {
+  let data = Array.isArray(hints) && hints.length === 0
+    ? GreedyPromise.resolve(sua.le())
+    : sua.he(hints);
+  return data.then((sua) => {
+    if (sua != null) {
+      mergeDeep(ortb2, {device: {sua}});
+    }
+  })
+}
+
 /**
  * Checks the Global Privacy Control status, and if exists and is true, merges into regs.ext.gpc
  */
@@ -137,30 +152,34 @@ function setGpc() {
 /**
  * Resets modules global ortb2 data
  */
-const resetOrtb2 = () => { ortb2 = {} };
+export const resetEnrichments = () => { ortb2 = null };
 
-function runEnrichments() {
+function runEnrichments(fpdConf) {
   setReferer();
   setPage();
   setDomain();
   setDimensions();
   setKeywords();
   setGpc();
-
-  return ortb2;
+  return setDeviceSua(fpdConf.uaHints).then(() => ortb2);
 }
 
-/**
- * Sets default values to ortb2 if exists and adds currency and ortb2 setConfig callbacks on init
- */
 export function processFpd(fpdConf, {global}) {
-  resetOrtb2();
-
-  return {
-    global: (!fpdConf.skipEnrichments) ? mergeDeep(runEnrichments(), global) : global
-  };
+  if (fpdConf.skipEnrichments) {
+    return {global};
+  } else {
+    let ready;
+    if (ortb2 == null) {
+      ortb2 = {};
+      ready = runEnrichments(fpdConf);
+    } else {
+      ready = GreedyPromise.resolve();
+    }
+    return ready.then(() => ({
+      global: mergeDeep({}, ortb2, global)
+    }))
+  }
 }
-
 /** @type {firstPartyDataSubmodule} */
 export const enrichmentsSubmodule = {
   name: 'enrichments',

package/modules/eplanningBidAdapter.js

@@ -2,6 +2,7 @@ import {getWindowSelf, isEmpty, parseSizesInput, isGptPubadsDefined, isSlotMatch
 import {getGlobal} from '../src/prebidGlobal.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'eplanning';
 export const storage = getStorageManager({bidderCode: BIDDER_CODE});
@@ -19,9 +20,14 @@ const STORAGE_VIEW_PREFIX = 'pbvi_';
 const mobileUserAgent = isMobileUserAgent();
 const PRIORITY_ORDER_FOR_MOBILE_SIZES_ASC = ['1x1', '300x50', '320x50', '300x250'];
 const PRIORITY_ORDER_FOR_DESKTOP_SIZES_ASC = ['1x1', '970x90', '970x250', '160x600', '300x600', '728x90', '300x250'];
+const VAST_INSTREAM = 1;
+const VAST_OUTSTREAM = 2;
+const VAST_VERSION_DEFAULT = 3;
+const DEFAULT_SIZE_VAST = '640x480';
 
 export const spec = {
   code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
 
   isBidRequestValid: function(bid) {
     return Boolean(bid.params.ci) || Boolean(bid.params.t);
@@ -86,6 +92,10 @@ export const spec = {
           params['e_' + id] = (typeof userIds[id] === 'object') ? encodeURIComponent(JSON.stringify(userIds[id])) : encodeURIComponent(userIds[id]);
         }
       }
+      if (spaces.impType) {
+        params.vctx = spaces.impType & VAST_INSTREAM ? VAST_INSTREAM : VAST_OUTSTREAM;
+        params.vv = VAST_VERSION_DEFAULT;
+      }
     }
 
     return {
@@ -108,7 +118,6 @@ export const spec = {
               cpm: ad.pr,
               width: ad.w,
               height: ad.h,
-              ad: ad.adm,
               ttl: TTL,
               creativeId: ad.crid,
               netRevenue: NET_REVENUE,
@@ -119,6 +128,13 @@ export const spec = {
                 advertiserDomains: ad.adom
               };
             }
+            if (isVastResponse(ad)) {
+              bidResponse.vastXml = ad.adm;
+              bidResponse.mediaTypes = VIDEO;
+            } else {
+              bidResponse.ad = ad.adm;
+            }
+
             bidResponses.push(bidResponse);
           });
         }
@@ -236,17 +252,42 @@ function getSpacesStruct(bids) {
   return e;
 }
 
+function getFirstSizeVast(sizes) {
+  if (sizes == undefined || !Array.isArray(sizes)) {
+    return undefined;
+  }
+
+  let size = Array.isArray(sizes[0]) ? sizes[0] : sizes;
+
+  return (Array.isArray(size) && size.length == 2) ? size : undefined;
+}
+
 function cleanName(name) {
   return name.replace(/_|\.|-|\//g, '').replace(/\)\(|\(|\)|:/g, '_').replace(/^_+|_+$/g, '');
 }
 
 function getSpaces(bidRequests, ml) {
+  let impType = bidRequests.reduce((previousBits, bid) => (bid.mediaTypes && bid.mediaTypes[VIDEO]) ? (bid.mediaTypes[VIDEO].context == 'outstream' ? (previousBits | 2) : (previousBits | 1)) : previousBits, 0);
+  // Only one type of auction is supported at a time
+  if (impType) {
+    bidRequests = bidRequests.filter((bid) => bid.mediaTypes && bid.mediaTypes[VIDEO] && (impType & VAST_INSTREAM ? (!bid.mediaTypes[VIDEO].context || bid.mediaTypes[VIDEO].context == 'instream') : (bid.mediaTypes[VIDEO].context == 'outstream')));
+  }
+
   let spacesStruct = getSpacesStruct(bidRequests);
-  let es = {str: '', vs: '', map: {}};
+  let es = {str: '', vs: '', map: {}, impType: impType};
   es.str = Object.keys(spacesStruct).map(size => spacesStruct[size].map((bid, i) => {
     es.vs += getVs(bid);
 
     let name;
+
+    if (impType) {
+      let firstSize = getFirstSizeVast(bid.mediaTypes[VIDEO].playerSize);
+      let sizeVast = firstSize ? firstSize.join('x') : DEFAULT_SIZE_VAST;
+      name = 'video_' + sizeVast + '_' + i;
+      es.map[name] = bid.bidId;
+      return name + ':' + sizeVast + ';1';
+    }
+
     if (ml) {
       name = cleanName(bid.adUnitCode);
     } else {
@@ -462,4 +503,9 @@ function registerAuction(storageID) {
 
   return true;
 }
+
+function isVastResponse(bid) {
+  return bid.adm.match(/^(<VAST)|(<VideoAdServingTemplate)/gmi);
+}
+
 registerBidder(spec);

package/modules/finativeBidAdapter.js

@@ -63,7 +63,7 @@ export const spec = {
     // convert Native ORTB definition to old-style prebid native definition
     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.referer;