prebid.js 7.14.0 → 7.16.0

package/modules/nextMillenniumBidAdapter.js

@@ -1,7 +1,21 @@
-import { isStr, _each, parseUrl, getWindowTop, getBidIdParameter } from '../src/utils.js';
-import { getRefererInfo } from '../src/refererDetection.js';
+import {
+  _each,
+  createTrackPixelHtml,
+  deepAccess,
+  isStr,
+  getWindowTop,
+  getBidIdParameter,
+  logMessage,
+  parseUrl,
+  triggerPixel,
+} from '../src/utils.js';
+
+import CONSTANTS from '../src/constants.json';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import * as events from '../src/events.js';
+
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { getRefererInfo } from '../src/refererDetection.js';
 
 const BIDDER_CODE = 'nextMillennium';
 const ENDPOINT = 'https://pbs.nextmillmedia.com/openrtb2/auction';
@@ -9,9 +23,15 @@ const TEST_ENDPOINT = 'https://test.pbs.nextmillmedia.com/openrtb2/auction';
 const SYNC_ENDPOINT = 'https://statics.nextmillmedia.com/load-cookie.html?v=4';
 const TIME_TO_LIVE = 360;
 
+const EXPIRENCE_WURL = 20 * 60000;
+const wurlMap = {};
+
+events.on(CONSTANTS.EVENTS.BID_WON, bidWonHandler);
+cleanWurl();
+
 export const spec = {
   code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   isBidRequestValid: function(bid) {
     return !!(
@@ -25,12 +45,14 @@ export const spec = {
 
     _each(validBidRequests, function(bid) {
       window.nmmRefreshCounts[bid.adUnitCode] = window.nmmRefreshCounts[bid.adUnitCode] || 0;
-      const id = getPlacementId(bid)
-      let sizes = bid.sizes
-      if (sizes && !Array.isArray(sizes[0])) sizes = [sizes]
+      const id = getPlacementId(bid);
+      const auctionId = bid.auctionId;
+      const bidId = bid.bidId;
+      let sizes = bid.sizes;
+      if (sizes && !Array.isArray(sizes[0])) sizes = [sizes];
 
-      const site = getSiteObj()
-      const device = getDeviceObj()
+      const site = getSiteObj();
+      const device = getDeviceObj();
 
       const postBody = {
         'id': bid.auctionId,
@@ -47,12 +69,14 @@ export const spec = {
             'scrollTop': window.pageYOffset || document.documentElement.scrollTop
           }
         },
+
         device,
         site,
         'imp': [{
           'banner': {
             'format': (sizes || []).map(s => { return {w: s[0], h: s[1]} })
           },
+
           'ext': {
             'prebid': {
               'storedrequest': {
@@ -61,30 +85,30 @@ export const spec = {
             }
           }
         }]
-      }
+      };
 
       const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
-      const uspConsent = bidderRequest && bidderRequest.uspConsent
+      const uspConsent = bidderRequest && bidderRequest.uspConsent;
 
       if (gdprConsent || uspConsent) {
-        postBody.regs = { ext: {} }
+        postBody.regs = { ext: {} };
 
         if (uspConsent) {
           postBody.regs.ext.us_privacy = uspConsent;
-        }
+        };
 
         if (gdprConsent) {
           if (typeof gdprConsent.gdprApplies !== 'undefined') {
             postBody.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
-          }
+          };
 
           if (typeof gdprConsent.consentString !== 'undefined') {
             postBody.user = {
               ext: { consent: gdprConsent.consentString }
-            }
-          }
-        }
-      }
+            };
+          };
+        };
+      };
 
       const urlParameters = parseUrl(getWindowTop().location.href).search;
       const isTest = urlParameters['pbs'] && urlParameters['pbs'] === 'test';
@@ -97,7 +121,9 @@ export const spec = {
           contentType: 'application/json',
           withCredentials: true
         },
-        bidId: bid.bidId
+
+        bidId,
+        auctionId,
       });
     });
 
@@ -110,8 +136,15 @@ export const spec = {
 
     _each(response.seatbid, (resp) => {
       _each(resp.bid, (bid) => {
-        bidResponses.push({
-          requestId: bidRequest.bidId,
+        const requestId = bidRequest.bidId;
+        const auctionId = bidRequest.auctionId;
+        const wurl = deepAccess(bid, 'ext.prebid.events.win');
+        addWurl({auctionId, requestId, wurl});
+
+        const {ad, adUrl, vastUrl, vastXml} = getAd(bid);
+
+        const bidResponse = {
+          requestId,
           cpm: bid.price,
           width: bid.w,
           height: bid.h,
@@ -121,10 +154,20 @@ export const spec = {
           ttl: TIME_TO_LIVE,
           meta: {
             advertiserDomains: bid.adomain || []
-          },
+          }
+        };
+
+        if (vastUrl || vastXml) {
+          bidResponse.mediaType = VIDEO;
 
-          ad: bid.adm
-        });
+          if (vastUrl) bidResponse.vastUrl = vastUrl;
+          if (vastXml) bidResponse.vastXml = vastXml;
+        } else {
+          bidResponse.ad = ad;
+          bidResponse.adUrl = adUrl;
+        };
+
+        bidResponses.push(bidResponse);
       });
     });
 
@@ -133,22 +176,22 @@ export const spec = {
 
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
     if (!syncOptions.iframeEnabled) {
-      return
-    }
+      return;
+    };
 
-    let syncurl = gdprConsent && gdprConsent.gdprApplies ? `${SYNC_ENDPOINT}&gdpr=1&gdpr_consent=${gdprConsent.consentString}` : SYNC_ENDPOINT
+    let syncurl = gdprConsent && gdprConsent.gdprApplies ? `${SYNC_ENDPOINT}&gdpr=1&gdpr_consent=${gdprConsent.consentString}` : SYNC_ENDPOINT;
 
-    let bidders = []
+    let bidders = [];
     if (responses) {
       _each(responses, (response) => {
-        if (!(response && response.body && response.body.ext && response.body.ext.responsetimemillis)) return
-        _each(Object.keys(response.body.ext.responsetimemillis), b => bidders.push(b))
-      })
-    }
+        if (!(response && response.body && response.body.ext && response.body.ext.responsetimemillis)) return;
+        _each(Object.keys(response.body.ext.responsetimemillis), b => bidders.push(b));
+      });
+    };
 
     if (bidders.length) {
-      syncurl += `&bidders=${bidders.join(',')}`
-    }
+      syncurl += `&bidders=${bidders.join(',')}`;
+    };
 
     return [{
       type: 'iframe',
@@ -156,6 +199,7 @@ export const spec = {
     }];
   },
 };
+
 function getAdEl(bid) {
   // best way I could think of to get El, is by matching adUnitCode to google slots...
   const slot = window.googletag && window.googletag.pubads && window.googletag.pubads().getSlots().find(slot => slot.getAdUnitPath() === bid.adUnitCode);
@@ -163,58 +207,127 @@ function getAdEl(bid) {
   if (!slotElementId) return null;
   return document.querySelector('#' + slotElementId);
 }
+
 function getBoundingClient(bid) {
-  // console.log(bid)
-  const el = getAdEl(bid)
-  if (!el) return {}
+  const el = getAdEl(bid);
+  if (!el) return {};
   return el.getBoundingClientRect();
 }
 
 function getPlacementId(bid) {
-  const groupId = getBidIdParameter('group_id', bid.params)
-  const placementId = getBidIdParameter('placement_id', bid.params)
-  if (!groupId) return placementId
+  const groupId = getBidIdParameter('group_id', bid.params);
+  const placementId = getBidIdParameter('placement_id', bid.params);
+  if (!groupId) return placementId;
 
-  let windowTop = getTopWindow(window)
-  let size = []
+  let windowTop = getTopWindow(window);
+  let sizes = [];
   if (bid.mediaTypes) {
-    if (bid.mediaTypes.banner) size = bid.mediaTypes.banner.sizes && bid.mediaTypes.banner.sizes[0]
-    if (bid.mediaTypes.video) size = bid.mediaTypes.video.playerSize
-  }
+    if (bid.mediaTypes.banner) sizes = bid.mediaTypes.banner.sizes;
+    if (bid.mediaTypes.video) sizes = [bid.mediaTypes.video.playerSize];
+  };
 
-  const host = (windowTop && windowTop.location && windowTop.location.host) || ''
-  return `g${groupId};${size.join('x')};${host}`
+  const host = (windowTop && windowTop.location && windowTop.location.host) || '';
+  return `g${groupId};${sizes.map(size => size.join('x')).join('|')};${host}`;
 }
 
 function getTopWindow(curWindow, nesting = 0) {
   if (nesting > 10) {
-    return curWindow
-  }
+    return curWindow;
+  };
 
   try {
     if (curWindow.parent.document) {
-      return getTopWindow(curWindow.parent.window, ++nesting)
-    }
+      return getTopWindow(curWindow.parent.window, ++nesting);
+    };
   } catch (err) {
-    return curWindow
+    return curWindow;
+  };
+}
+
+function getAd(bid) {
+  let ad, adUrl, vastXml, vastUrl;
+
+  switch (deepAccess(bid, 'ext.prebid.type')) {
+    case VIDEO:
+      if (bid.adm.substr(0, 4) === 'http') {
+        vastUrl = bid.adm;
+      } else {
+        vastXml = bid.adm;
+      };
+
+      break;
+    default:
+      if (bid.adm && bid.nurl) {
+        ad = bid.adm;
+        ad += createTrackPixelHtml(decodeURIComponent(bid.nurl));
+      } else if (bid.adm) {
+        ad = bid.adm;
+      } else if (bid.nurl) {
+        adUrl = bid.nurl;
+      };
   }
+
+  return {ad, adUrl, vastXml, vastUrl};
 }
 
 function getSiteObj() {
-  const refInfo = (getRefererInfo && getRefererInfo()) || {}
+  const refInfo = (getRefererInfo && getRefererInfo()) || {};
 
   return {
     page: refInfo.page,
     ref: refInfo.ref,
     domain: refInfo.domain
-  }
+  };
 }
 
 function getDeviceObj() {
   return {
     w: window.innerWidth || window.document.documentElement.clientWidth || window.document.body.clientWidth || 0,
     h: window.innerHeight || window.document.documentElement.clientHeight || window.document.body.clientHeight || 0,
-  }
+  };
+}
+
+function getKeyWurl({auctionId, requestId}) {
+  return `${auctionId}-${requestId}`;
+}
+
+function addWurl({wurl, requestId, auctionId}) {
+  if (!wurl) return;
+
+  const expirence = Date.now() + EXPIRENCE_WURL;
+  const key = getKeyWurl({auctionId, requestId});
+  wurlMap[key] = {wurl, expirence};
+}
+
+function removeWurl({auctionId, requestId}) {
+  const key = getKeyWurl({auctionId, requestId});
+  delete wurlMap[key];
+}
+
+function getWurl({auctionId, requestId}) {
+  const key = getKeyWurl({auctionId, requestId});
+  return wurlMap[key] && wurlMap[key].wurl;
+}
+
+function bidWonHandler(bid) {
+  const {auctionId, requestId} = bid;
+  const wurl = getWurl({auctionId, requestId});
+  if (wurl) {
+    logMessage(`(nextmillennium) Invoking image pixel for wurl on BID_WIN: "${wurl}"`);
+    triggerPixel(wurl);
+    removeWurl({auctionId, requestId});
+  };
+}
+
+function cleanWurl() {
+  const dateNow = Date.now();
+  Object.keys(wurlMap).forEach(key => {
+    if (dateNow >= wurlMap[key].expirence) {
+      delete wurlMap[key];
+    };
+  });
+
+  setTimeout(cleanWurl, 60000);
 }
 
 registerBidder(spec);

package/modules/openxOrtbBidAdapter.js

@@ -275,7 +275,7 @@ function interpretOrtbResponse(resp, req) {
   }
 
   const respBody = resp.body;
-  if (!respBody || 'nbr' in respBody) {
+  if (!respBody || 'nbr' in respBody || !Array.isArray(respBody.seatbid)) {
     return [];
   }
 

package/modules/prebidServerBidAdapter/index.js

@@ -39,6 +39,7 @@ import {ajax} from '../../src/ajax.js';
 import {hook} from '../../src/hook.js';
 import {getGlobal} from '../../src/prebidGlobal.js';
 import {hasPurpose1Consent} from '../../src/utils/gpdr.js';
+import {useMetrics} from '../../src/utils/perfMetrics.js';
 
 const getConfig = config.getConfig;
 
@@ -1097,6 +1098,12 @@ export function PrebidServer() {
 
   /* Prebid executes this function when the page asks to send out bid requests */
   baseAdapter.callBids = function(s2sBidRequest, bidRequests, addBidResponse, done, ajax) {
+    const adapterMetrics = s2sBidRequest.metrics = useMetrics(deepAccess(bidRequests, '0.metrics'))
+      .newMetrics()
+      .renameWith((n) => [`adapter.s2s.${n}`, `adapters.s2s.${s2sBidRequest.s2sConfig.defaultVendor}.${n}`])
+    done = adapterMetrics.startTiming('total').stopBefore(done);
+    bidRequests.forEach(req => useMetrics(req.metrics).join(adapterMetrics, {continuePropagation: false}));
+
     let { gdprConsent, uspConsent } = getConsentData(bidRequests);
 
     if (Array.isArray(_s2sConfigs)) {
@@ -1118,7 +1125,9 @@ export function PrebidServer() {
         },
         onError: done,
         onBid: function ({adUnit, bid}) {
-          if (isValid(adUnit, bid)) {
+          const metrics = bid.metrics = s2sBidRequest.metrics.fork().renameWith();
+          metrics.checkpoint('addBidResponse');
+          if (metrics.measureTime('addBidResponse.validate', () => isValid(adUnit, bid))) {
             addBidResponse(adUnit, bid);
           }
         }
@@ -1157,19 +1166,21 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
     .filter(uniques);
 
   const ortb2 = new ORTB2(s2sBidRequest, bidRequests, adUnits, requestedBidders);
-  const request = ortb2.buildRequest();
+  const request = s2sBidRequest.metrics.measureTime('buildRequests', () => ortb2.buildRequest());
   const requestJson = request && JSON.stringify(request);
   logInfo('BidRequest: ' + requestJson);
   const endpointUrl = getMatchingConsentUrl(s2sBidRequest.s2sConfig.endpoint, gdprConsent);
   if (request && requestJson && endpointUrl) {
+    const networkDone = s2sBidRequest.metrics.startTiming('net');
     ajax(
       endpointUrl,
       {
         success: function (response) {
+          networkDone();
           let result;
           try {
             result = JSON.parse(response);
-            const bids = ortb2.interpretResponse(result);
+            const bids = s2sBidRequest.metrics.measureTime('interpretResponse', () => ortb2.interpretResponse(result));
             bids.forEach(onBid);
           } catch (error) {
             logError(error);
@@ -1181,7 +1192,10 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
             onResponse(true, requestedBidders);
           }
         },
-        error: onError
+        error: function () {
+          networkDone();
+          onError.apply(this, arguments);
+        }
       },
       requestJson,
       {contentType: 'text/plain', withCredentials: true}

package/modules/priceFloors.js

@@ -25,6 +25,7 @@ import {find} from '../src/polyfill.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {bidderSettings} from '../src/bidderSettings.js';
 import {auctionManager} from '../src/auctionManager.js';
+import {timedAuctionHook, timedBidResponseHook} from '../src/utils/perfMetrics.js';
 
 /**
  * @summary This Module is intended to provide users with the ability to dynamically set and enforce price floors on a per auction basis.
@@ -501,7 +502,7 @@ export function parseFloorData(floorsData, location) {
  * @param {Object} reqBidsConfigObj required; This is the same param that's used in pbjs.requestBids.
  * @param {function} fn required; The next function in the chain, used by hook.js
  */
-export function requestBidsHook(fn, reqBidsConfigObj) {
+export const requestBidsHook = timedAuctionHook('priceFloors', function requestBidsHook(fn, reqBidsConfigObj) {
   // preserves all module related variables for the current auction instance (used primiarily for concurrent auctions)
   const hookConfig = {
     reqBidsConfigObj,
@@ -522,7 +523,7 @@ export function requestBidsHook(fn, reqBidsConfigObj) {
   } else {
     continueAuction(hookConfig);
   }
-}
+});
 
 /**
  * @summary If an auction was queued to be delayed (waiting for a fetch) then this function will resume
@@ -693,7 +694,7 @@ function shouldFloorBid(floorData, floorInfo, bid) {
  * @summary The main driving force of floors. On bidResponse we hook in and intercept bidResponses.
  * And if the rule we find determines a bid should be floored we will do so.
  */
-export function addBidResponseHook(fn, adUnitCode, bid) {
+export const addBidResponseHook = timedBidResponseHook('priceFloors', function addBidResponseHook(fn, adUnitCode, bid) {
   let floorData = _floorDataForAuction[bid.auctionId];
   // if no floor data then bail
   if (!floorData || !bid || floorData.skipped) {
@@ -755,6 +756,6 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     return fn.call(this, adUnitCode, flooredBid);
   }
   return fn.call(this, adUnitCode, bid);
-}
+});
 
 config.getConfig('floors', config => handleSetFloorsConfig(config.floors));

package/modules/pubCommonId.js

@@ -8,6 +8,7 @@ import { config } from '../src/config.js';
 import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager } from '../src/storageManager.js';
+import {timedAuctionHook} from '../src/utils/perfMetrics.js';
 
 const storage = getStorageManager({moduleName: 'pubCommonId'});
 
@@ -165,7 +166,7 @@ export function getPubcidConfig() { return pubcidConfig; }
  * @param {function} next The next function in the chain
  */
 
-export function requestBidHook(next, config) {
+export const requestBidHook = timedAuctionHook('pubCommonId', function requestBidHook(next, config) {
   let adUnits = config.adUnits || $$PREBID_GLOBAL$$.adUnits;
   let pubcid = null;
 
@@ -221,7 +222,7 @@ export function requestBidHook(next, config) {
   }
 
   return next.call(this, config);
-}
+});
 
 // Helper to set a cookie
 export function setCookie(name, value, expires, sameSite) {

package/modules/rtdModule/index.js

@@ -158,6 +158,7 @@ import * as events from '../../src/events.js';
 import CONSTANTS from '../../src/constants.json';
 import {gdprDataHandler, uspDataHandler} from '../../src/adapterManager.js';
 import {find} from '../../src/polyfill.js';
+import {timedAuctionHook} from '../../src/utils/perfMetrics.js';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
@@ -266,7 +267,7 @@ function initSubModules() {
  * @param {Object} reqBidsConfigObj required; This is the same param that's used in pbjs.requestBids.
  * @param {function} fn required; The next function in the chain, used by hook.js
  */
-export function setBidRequestsData(fn, reqBidsConfigObj) {
+export const setBidRequestsData = timedAuctionHook('rtd', function setBidRequestsData(fn, reqBidsConfigObj) {
   _userConsent = getConsentData();
 
   const relevantSubModules = [];
@@ -317,7 +318,7 @@ export function setBidRequestsData(fn, reqBidsConfigObj) {
     clearTimeout(waitTimeout);
     fn.call(this, reqBidsConfigObj);
   }
-}
+});
 
 /**
  * loop through configured data providers If the data provider has registered getTargetingData,

package/modules/sharethroughBidAdapter.js

@@ -4,7 +4,7 @@ import { config } from '../src/config.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { createEidsArray } from './userId/eids.js';
 
-const VERSION = '4.2.0';
+const VERSION = '4.3.0';
 const BIDDER_CODE = 'sharethrough';
 const SUPPLY_ID = 'WYu2BXv1';
 
@@ -52,6 +52,7 @@ export const sharethroughAdapterSpec = {
         ext: {},
       },
       source: {
+        tid: bidRequests[0].transactionId,
         ext: {
           version: '$prebid.version$',
           str: VERSION,
@@ -80,12 +81,13 @@ export const sharethroughAdapterSpec = {
     }
 
     const imps = bidRequests.map(bidReq => {
-      const impression = {};
+      const impression = { ext: {} };
 
-      const gpid = deepAccess(bidReq, 'ortb2Imp.ext.data.pbadslot');
-      if (gpid) {
-        impression.ext = { gpid: gpid };
-      }
+      // mergeDeep(impression, bidReq.ortb2Imp); // leaving this out for now as we may want to leave stuff out on purpose
+      const tid = deepAccess(bidReq, 'ortb2Imp.ext.tid');
+      if (tid) impression.ext.tid = tid;
+      const gpid = deepAccess(bidReq, 'ortb2Imp.ext.gpid', deepAccess(bidReq, 'ortb2Imp.ext.data.pbadslot'));
+      if (gpid) impression.ext.gpid = gpid;
 
       const videoRequest = deepAccess(bidReq, 'mediaTypes.video');
 

package/modules/spotxBidAdapter.js

@@ -365,6 +365,7 @@ export const spec = {
             const renderer = Renderer.install({
               id: 0,
               renderNow: true,
+              url: '/',
               config: {
                 adText: 'SpotX Outstream Video Ad via Prebid.js',
                 player_width: playersize[0][0],