prebid.js 6.8.0 → 6.9.0

package/modules/priceFloors.js

@@ -8,6 +8,7 @@ import { getHook } from '../src/hook.js';
 import { createBid } from '../src/bidfactory.js';
 import find from 'core-js-pure/features/array/find.js';
 import { getRefererInfo } from '../src/refererDetection.js';
+import {bidderSettings} from '../src/bidderSettings.js';
 
 /**
  * @summary This Module is intended to provide users with the ability to dynamically set and enforce price floors on a per auction basis.
@@ -147,7 +148,7 @@ function generatePossibleEnumerations(arrayOfFields, delimiter) {
  * @summary If a the input bidder has a registered cpmadjustment it returns the input CPM after being adjusted
  */
 export function getBiddersCpmAdjustment(bidderName, inputCpm, bid = {}) {
-  const adjustmentFunction = deepAccess(getGlobal(), `bidderSettings.${bidderName}.bidCpmAdjustment`) || deepAccess(getGlobal(), 'bidderSettings.standard.bidCpmAdjustment');
+  const adjustmentFunction = bidderSettings.get(bidderName, 'bidCpmAdjustment');
   if (adjustmentFunction) {
     return parseFloat(adjustmentFunction(inputCpm, {...bid, cpm: inputCpm}));
   }

package/modules/richaudienceBidAdapter.js

@@ -59,10 +59,15 @@ export const spec = {
       REFERER = (typeof bidderRequest.refererInfo.referer != 'undefined' ? encodeURIComponent(bidderRequest.refererInfo.referer) : null)
 
       payload.gdpr_consent = '';
-      payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
+      payload.gdpr = false;
 
       if (bidderRequest && bidderRequest.gdprConsent) {
-        payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+        if (typeof bidderRequest.gdprConsent.gdprApplies != 'undefined') {
+          payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
+        }
+        if (typeof bidderRequest.gdprConsent.consentString != 'undefined') {
+          payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+        }
       }
 
       var payloadString = JSON.stringify(payload);

package/modules/riseBidAdapter.js

@@ -1,4 +1,4 @@
-import { logWarn, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter } from '../src/utils.js';
+import { logWarn, logInfo, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter, triggerPixel } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {VIDEO} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
@@ -23,7 +23,7 @@ export const spec = {
   gvlid: 1043,
   version: ADAPTER_VERSION,
   supportedMediaTypes: SUPPORTED_AD_TYPES,
-  isBidRequestValid: function(bidRequest) {
+  isBidRequestValid: function (bidRequest) {
     if (!bidRequest.params) {
       logWarn('no params have been set to Rise adapter');
       return false;
@@ -49,7 +49,7 @@ export const spec = {
 
     return requests;
   },
-  interpretResponse: function({body}) {
+  interpretResponse: function ({body}) {
     const bidResponses = [];
 
     const bidResponse = {
@@ -62,6 +62,7 @@ export const spec = {
       netRevenue: body.netRevenue,
       ttl: body.ttl || TTL,
       vastXml: body.vastXml,
+      nurl: body.nurl,
       mediaType: VIDEO
     };
 
@@ -73,7 +74,7 @@ export const spec = {
 
     return bidResponses;
   },
-  getUserSyncs: function(syncOptions, serverResponses) {
+  getUserSyncs: function (syncOptions, serverResponses) {
     const syncs = [];
     for (const response of serverResponses) {
       if (syncOptions.iframeEnabled && response.body.userSyncURL) {
@@ -93,8 +94,18 @@ export const spec = {
       }
     }
     return syncs;
-  }
-};
+  },
+  onBidWon: function (bid) {
+    if (bid == null) {
+      return;
+    }
+
+    logInfo('onBidWon:', bid);
+    if (bid.hasOwnProperty('nurl') && bid.nurl.length > 0) {
+      triggerPixel(bid.nurl);
+    }
+  },
+}
 
 registerBidder(spec);
 

package/modules/rubiconAnalyticsAdapter.js

@@ -234,6 +234,9 @@ function sendMessage(auctionId, bidWonId, trigger) {
 
     let auction = {
       clientTimeoutMillis: auctionCache.timeout,
+      auctionStart: auctionCache.timestamp,
+      auctionEnd: auctionCache.endTs,
+      bidderOrder: auctionCache.bidderOrder,
       samplingFactor,
       accountId,
       adUnits: Object.keys(adUnitMap).map(i => adUnitMap[i]),
@@ -583,6 +586,7 @@ let rubiconAdapter = Object.assign({}, baseAdapter, {
         cacheEntry.bids = {};
         cacheEntry.bidsWon = {};
         cacheEntry.gamHasRendered = {};
+        cacheEntry.bidderOrder = [];
         cacheEntry.referrer = deepAccess(args, 'bidderRequests.0.refererInfo.referer');
         const floorData = deepAccess(args, 'bidderRequests.0.bids.0.floorData');
         if (floorData) {
@@ -608,6 +612,7 @@ let rubiconAdapter = Object.assign({}, baseAdapter, {
         }
         break;
       case BID_REQUESTED:
+        cache.auctions[args.auctionId].bidderOrder.push(args.bidderCode);
         Object.assign(cache.auctions[args.auctionId].bids, args.bids.reduce((memo, bid) => {
           // mark adUnits we expect bidWon events for
           cache.auctions[args.auctionId].bidsWon[bid.adUnitCode] = false;

package/modules/sortableAnalyticsAdapter.js

@@ -5,6 +5,7 @@ import adapterManager from '../src/adapterManager.js';
 import {ajax} from '../src/ajax.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 import { config } from '../src/config.js';
+import {bidderSettings} from '../src/bidderSettings.js';
 
 const DEFAULT_PROTOCOL = 'https';
 const DEFAULT_HOST = 'pa.deployads.com';
@@ -182,11 +183,11 @@ function getFactor(bidder) {
 }
 
 function getBiddersFactors() {
-  const pb = getGlobal();
   const result = {};
-  if (pb && pb.bidderSettings) {
-    Object.keys(pb.bidderSettings).forEach(bidderKey => {
-      const bidder = pb.bidderSettings[bidderKey];
+  const settings = bidderSettings.getSettings();
+  if (settings) {
+    Object.keys(settings).forEach(bidderKey => {
+      const bidder = settings[bidderKey];
       const factor = getFactor(bidder);
       if (factor !== null) {
         result[bidderKey] = factor;

package/modules/weboramaRtdProvider.js

@@ -7,27 +7,42 @@
  * @requires module:modules/realTimeData
  */
 
+/** onData callback type
+ * @callback dataCallback
+ * @param {Object} data profile data
+ * @param {Boolean} site true if site, else it is user
+ * @returns {void}
+ */
+
 /**
  * @typedef {Object} ModuleParams
- * @property {WeboCtxConf} weboCtxConf
- * @property {WeboUserDataConf} weboUserDataConf
+ * @property {?Boolean} setPrebidTargeting if true, will set the GAM targeting (default undefined)
+ * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default undefined)
+ * @property {?dataCallback} onData callback
+ * @property {?WeboCtxConf} weboCtxConf
+ * @property {?WeboUserDataConf} weboUserDataConf
  */
 
 /**
  * @typedef {Object} WeboCtxConf
  * @property {string} token required token to be used on bigsea contextual API requests
  * @property {?string} targetURL specify the target url instead use the referer
- * @property {?Boolean} setPrebidTargeting if true will set the GAM targeting (default true)
- * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default true)
+ * @property {?Boolean} setPrebidTargeting if true, will set the GAM targeting (default params.setPrebidTargeting or true)
+ * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default params.sendToBidders or true)
+ * @property {?dataCallback} onData callback
  * @property {?object} defaultProfile to be used if the profile is not found
+ * @property {?Boolean} enabled if false, will ignore this configuration
  */
 
 /**
  * @typedef {Object} WeboUserDataConf
- * @property {?string} localStorageProfileKey can be used to customize the local storage key (default is 'webo_wam2gam_entry')
- * @property {?Boolean} setPrebidTargeting if true will set the GAM targeting (default true)
- * @property {?Boolean} sendToBidders if true, will send the contextual profile to all bidders (default true)
+ * @property {?number} accountId wam account id
+ * @property {?Boolean} setPrebidTargeting if true, will set the GAM targeting (default params.setPrebidTargeting or true)
+ * @property {?Boolean} sendToBidders if true, will send the user-centric profile to all bidders (default params.sendToBidders or true)
  * @property {?object} defaultProfile to be used if the profile is not found
+ * @property {?dataCallback} onData callback
+ * @property {?string} localStorageProfileKey can be used to customize the local storage key (default is 'webo_wam2gam_entry')
+ * @property {?Boolean} enabled if false, will ignore this configuration
  */
 
 import {
@@ -39,8 +54,10 @@ import {
   isEmpty,
   mergeDeep,
   logError,
+  logWarn,
   tryAppendQueryString,
-  logMessage
+  logMessage,
+  isFn
 } from '../src/utils.js';
 import {
   submodule
@@ -86,40 +103,88 @@ let _weboUserDataInitialized = false;
 function init(moduleConfig) {
   moduleConfig = moduleConfig || {};
   const moduleParams = moduleConfig.params || {};
-  const weboCtxConf = moduleParams.weboCtxConf || {};
+  const weboCtxConf = moduleParams.weboCtxConf;
   const weboUserDataConf = moduleParams.weboUserDataConf;
 
-  _weboCtxInitialized = initWeboCtx(weboCtxConf);
-  _weboUserDataInitialized = initWeboUserData(weboUserDataConf);
+  _weboCtxInitialized = initWeboCtx(moduleParams, weboCtxConf);
+  _weboUserDataInitialized = initWeboUserData(moduleParams, weboUserDataConf);
 
   return _weboCtxInitialized || _weboUserDataInitialized;
 }
 
 /** Initialize contextual sub module
+ * @param {ModuleParams} moduleParams
  * @param {WeboCtxConf} weboCtxConf
  * @return {Boolean} true if sub module was initialized with success
  */
-function initWeboCtx(weboCtxConf) {
+function initWeboCtx(moduleParams, weboCtxConf) {
+  if (!weboCtxConf || weboCtxConf.enabled === false) {
+    moduleParams.weboCtxConf = null;
+
+    return false
+  }
+
+  normalizeConf(moduleParams, weboCtxConf);
+
   _weboCtxInitialized = false;
   _weboContextualProfile = null;
 
   if (!weboCtxConf.token) {
-    logError('missing param "token" for weborama contextual sub module initialization');
+    logWarn('missing param "token" for weborama contextual sub module initialization');
     return false;
   }
 
+  logMessage('weborama contextual intialized with success');
+
   return true;
 }
 
 /** Initialize weboUserData sub module
+ * @param {ModuleParams} moduleParams
  * @param {WeboUserDataConf} weboUserDataConf
  * @return {Boolean} true if sub module was initialized with success
  */
-function initWeboUserData(weboUserDataConf) {
+function initWeboUserData(moduleParams, weboUserDataConf) {
+  if (!weboUserDataConf || weboUserDataConf.enabled === false) {
+    moduleParams.weboUserDataConf = null;
+
+    return false;
+  }
+
+  normalizeConf(moduleParams, weboUserDataConf);
+
   _weboUserDataInitialized = false;
   _weboUserDataUserProfile = null;
 
-  return !!weboUserDataConf;
+  let message = 'weborama user-centric intialized with success';
+  if (weboUserDataConf.hasOwnProperty('accountId')) {
+    message = `weborama user-centric intialized with success for account: ${weboUserDataConf.accountId}`;
+  }
+
+  logMessage(message);
+
+  return true;
+}
+
+/** @type {Object} */
+const globalDefaults = {
+  setPrebidTargeting: true,
+  sendToBidders: true,
+  onData: (data, kind, def) => logMessage('onData(data,kind,default)', data, kind, def),
+}
+
+/** normalize submodule configuration
+ * @param {ModuleParams} moduleParams
+ * @param {WeboCtxConf|WeboUserDataConf} submoduleParams
+ * @return {void}
+ */
+function normalizeConf(moduleParams, submoduleParams) {
+  Object.entries(globalDefaults).forEach(([propertyName, globalDefaultValue]) => {
+    if (!submoduleParams.hasOwnProperty(propertyName)) {
+      const hasModuleParam = moduleParams.hasOwnProperty(propertyName);
+      submoduleParams[propertyName] = (hasModuleParam) ? moduleParams[propertyName] : globalDefaultValue;
+    }
+  })
 }
 
 /** function that provides ad server targeting data to RTD-core
@@ -132,8 +197,8 @@ function getTargetingData(adUnitsCodes, moduleConfig) {
   const moduleParams = moduleConfig.params || {};
   const weboCtxConf = moduleParams.weboCtxConf || {};
   const weboUserDataConf = moduleParams.weboUserDataConf || {};
-  const weboCtxConfTargeting = weboCtxConf.setPrebidTargeting !== false;
-  const weboUserDataConfTargeting = weboUserDataConf.setPrebidTargeting !== false;
+  const weboCtxConfTargeting = weboCtxConf.setPrebidTargeting;
+  const weboUserDataConfTargeting = weboUserDataConf.setPrebidTargeting;
 
   try {
     const profile = getCompleteProfile(moduleParams, weboCtxConfTargeting, weboUserDataConfTargeting);
@@ -250,21 +315,79 @@ export function getBidRequestData(reqBidsConfigObj, onDone, moduleConfig) {
 function handleBidRequestData(adUnits, moduleParams) {
   const weboCtxConf = moduleParams.weboCtxConf || {};
   const weboUserDataConf = moduleParams.weboUserDataConf || {};
-  const weboCtxConfTargeting = weboCtxConf.sendToBidders !== false;
-  const weboUserDataConfTargeting = weboUserDataConf.sendToBidders !== false;
-  const profile = getCompleteProfile(moduleParams, weboCtxConfTargeting, weboUserDataConfTargeting);
+  const weboCtxConfTargeting = weboCtxConf.sendToBidders;
+  const weboUserDataConfTargeting = weboUserDataConf.sendToBidders;
 
-  if (isEmpty(profile)) {
-    return;
+  if (weboCtxConfTargeting) {
+    const contextualProfile = getContextualProfile(weboCtxConf);
+    if (!isEmpty(contextualProfile)) {
+      setBidRequestProfile(adUnits, contextualProfile, true);
+    }
+  }
+
+  if (weboUserDataConfTargeting) {
+    const weboUserDataProfile = getWeboUserDataProfile(weboUserDataConf);
+    if (!isEmpty(weboUserDataProfile)) {
+      setBidRequestProfile(adUnits, weboUserDataProfile, false);
+    }
   }
 
+  handleOnData(weboCtxConf, weboUserDataConf);
+}
+
+/** function that handle with onData callbacks
+ * @param {WeboCtxConf} weboCtxConf
+ * @param {WeboUserDataConf} weboUserDataConf
+ */
+
+function handleOnData(weboCtxConf, weboUserDataConf) {
+  const callbacks = [{
+    onData: weboCtxConf.onData,
+    fetchData: () => getContextualProfile(weboCtxConf),
+    site: true,
+  }, {
+    onData: weboUserDataConf.onData,
+    fetchData: () => getWeboUserDataProfile(weboUserDataConf),
+    site: false,
+  }];
+
+  callbacks.filter(obj => isFn(obj.onData)).forEach(obj => {
+    try {
+      const data = obj.fetchData();
+      obj.onData(data, obj.site);
+    } catch (e) {
+      const kind = (obj.site) ? 'site' : 'user';
+      logError(`error while executure onData callback with ${kind}-based data:`, e);
+    }
+  });
+}
+
+/** function that set bid request data on each segment (site or user centric)
+ * @param {Object[]} adUnits
+ * @param {Object} profile
+ * @param {Boolean} site true if site centric, else it is user centric
+ * @returns {void}
+ */
+function setBidRequestProfile(adUnits, profile, site) {
+  setGlobalOrtb2(profile, site);
+
   adUnits.forEach(adUnit => {
     if (adUnit.hasOwnProperty('bids')) {
-      adUnit.bids.forEach(bid => handleBid(adUnit, profile, bid));
+      const adUnitCode = adUnit.code || 'no code';
+      adUnit.bids.forEach(bid => handleBid(adUnitCode, profile, site, bid));
     }
   });
 }
 
+/** @type {string} */
+const APPNEXUS = 'appnexus';
+
+/** @type {string} */
+const PUBMATIC = 'pubmatic';
+
+/** @type {string} */
+const RUBICON = 'rubicon';
+
 /** @type {string} */
 const SMARTADSERVER = 'smartadserver';
 
@@ -272,35 +395,143 @@ const SMARTADSERVER = 'smartadserver';
 const bidderAliasRegistry = adapterManager.aliasRegistry || {};
 
 /** handle individual bid
- * @param {Object} adUnit
+ * @param {string} adUnitCode
  * @param {Object} profile
+ * @param {Boolean} site true if site centric, else it is user centric
  * @param {Object} bid
  * @returns {void}
  */
-function handleBid(adUnit, profile, bid) {
+function handleBid(adUnitCode, profile, site, bid) {
   const bidder = bidderAliasRegistry[bid.bidder] || bid.bidder;
 
-  logMessage('handle bidder', bidder, bid);
+  logMessage(`handling on adunit '${adUnitCode}', bidder '${bidder}' and bid`, bid);
 
   switch (bidder) {
+    case APPNEXUS:
+      handleAppnexusBid(profile, bid);
+
+      break;
+
+    case PUBMATIC:
+      handlePubmaticBid(profile, bid);
+
+      break;
+
     case SMARTADSERVER:
-      handleSmartadserverBid(adUnit, profile, bid);
+      handleSmartadserverBid(profile, bid);
 
       break;
+    case RUBICON:
+      handleRubiconBid(profile, site, bid);
+
+      break;
+    default:
+      logMessage(`unsupported bidder '${bidder}', trying via bidder ortb2 fpd`);
+      const section = ((site) ? 'site' : 'user');
+      const base = `ortb2.${section}.ext.data`;
+
+      assignProfileToObject(bid, base, profile);
+  }
+}
+
+/**
+ * set ortb2 global data
+ * @param {Object} profile
+ * @param {Boolean} site
+ * @returns {void}
+ */
+function setGlobalOrtb2(profile, site) {
+  const section = ((site) ? 'site' : 'user');
+  const base = `${section}.ext.data`;
+  const addOrtb2 = {};
+
+  assignProfileToObject(addOrtb2, base, profile);
+
+  if (!isEmpty(addOrtb2)) {
+    const testGlobal = getGlobal().getConfig('ortb2') || {};
+    const ortb2 = {
+      ortb2: mergeDeep({}, testGlobal, addOrtb2)
+    };
+    getGlobal().setConfig(ortb2);
+  }
+}
+
+/**
+ * assign profile to object
+ * @param {Object} destination
+ * @param {string} base
+ * @param {Object} profile
+ * @returns {void}
+ */
+function assignProfileToObject(destination, base, profile) {
+  Object.keys(profile).forEach(key => {
+    const path = `${base}.${key}`;
+    deepSetValue(destination, path, profile[key])
+  })
+}
+
+/** handle rubicon bid
+ * @param {Object} profile
+ * @param {Boolean} site
+ * @param {Object} bid
+ * @returns {void}
+ */
+function handleRubiconBid(profile, site, bid) {
+  const section = (site) ? 'inventory' : 'visitor';
+  const base = `params.${section}`;
+  assignProfileToObject(bid, base, profile);
+}
+
+/** handle appnexus/xandr bid
+ * @param {Object} profile
+ * @param {Object} bid
+ * @returns {void}
+ */
+function handleAppnexusBid(profile, bid) {
+  const base = 'params.keywords';
+  assignProfileToObject(bid, base, profile);
+}
+
+/** handle pubmatic bid
+ * @param {Object} profile
+ * @param {Object} bid
+ * @returns {void}
+ */
+function handlePubmaticBid(profile, bid) {
+  const sep = '|';
+  const subsep = ',';
+  const bidKey = 'params.dctr';
+  const target = [];
+
+  const data = deepAccess(bid, bidKey);
+  if (data) {
+    data.split(sep).forEach(t => target.push(t));
   }
+
+  Object.keys(profile).forEach(key => {
+    const value = profile[key].join(subsep);
+    const keyword = `${key}=${value}`;
+    if (target.indexOf(keyword) === -1) {
+      target.push(keyword);
+    }
+  });
+
+  deepSetValue(bid, bidKey, target.join(sep));
 }
 
 /** handle smartadserver bid
- * @param {Object} adUnit
  * @param {Object} profile
  * @param {Object} bid
  * @returns {void}
  */
-function handleSmartadserverBid(adUnit, profile, bid) {
+function handleSmartadserverBid(profile, bid) {
+  const sep = ';';
+  const bidKey = 'params.target';
   const target = [];
 
-  if (deepAccess(bid, 'params.target')) {
-    target.push(bid.params.target.split(';'));
+  const data = deepAccess(bid, bidKey);
+  if (data) {
+    data.split(sep).forEach(t => target.push(t));
   }
 
   Object.keys(profile).forEach(key => {
@@ -311,8 +542,7 @@ function handleSmartadserverBid(adUnit, profile, bid) {
       }
     });
   });
-
-  deepSetValue(bid, 'params.target', target.join(';'));
+  deepSetValue(bid, bidKey, target.join(sep));
 }
 
 /** set bigsea contextual profile on module state
@@ -350,7 +580,7 @@ function fetchContextualProfile(weboCtxConf, onSuccess, onDone) {
   queryString = tryAppendQueryString(queryString, 'token', token);
   queryString = tryAppendQueryString(queryString, 'url', targetURL);
 
-  const url = 'https://ctx.weborama.com/api/profile?' + queryString;
+  const url = `https://ctx.weborama.com/api/profile?${queryString}`;
 
   ajax(url, {
     success: function(response, req) {