prebid.js 6.7.0 → 6.11.0

package/modules/sizeMappingV2.js

@@ -5,7 +5,6 @@
  */
 
 import { isArray, logError, isArrayOfNums, deepClone, logWarn, getWindowTop, deepEqual, logInfo, isValidMediaTypes, deepAccess, getDefinedParams, getUniqueIdentifierStr, flatten } from '../src/utils.js';
-import { processNativeAdUnitParams } from '../src/native.js';
 import { adunitCounter } from '../src/adUnits.js';
 import includes from 'core-js-pure/features/array/includes.js';
 import { getHook } from '../src/hook.js';
@@ -536,14 +535,8 @@ export function getBids({ bidderCode, auctionId, bidderRequestId, adUnits, label
             .reduce((bids, bid) => {
               if (internal.isLabelActivated(bid, labels, adUnit.code, adUnitInstance)) {
                 // handle native params
-                const nativeParams = adUnit.nativeParams || deepAccess(adUnit, 'mediaTypes.native');
-                if (nativeParams) {
-                  bid = Object.assign({}, bid, {
-                    nativeParams: processNativeAdUnitParams(nativeParams)
-                  });
-                }
 
-                bid = Object.assign({}, bid, getDefinedParams(adUnit, ['mediaType', 'renderer']));
+                bid = Object.assign({}, bid, getDefinedParams(adUnit, ['mediaType', 'renderer', 'nativeParams']));
 
                 if (bid.sizeConfig) {
                   const relevantMediaTypes = internal.getRelevantMediaTypesForBidder(bid.sizeConfig, activeViewport);

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/sovrnBidAdapter.js

@@ -1,12 +1,38 @@
-import { _each, getBidIdParameter, isArray, deepClone, parseUrl, getUniqueIdentifierStr, deepSetValue, logError, deepAccess } from '../src/utils.js';
+import { _each, getBidIdParameter, isArray, deepClone, parseUrl, getUniqueIdentifierStr, deepSetValue, logError, deepAccess, isInteger, logWarn } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js'
-import { BANNER } from '../src/mediaTypes.js'
+import { ADPOD, BANNER, VIDEO } from '../src/mediaTypes.js'
 import { createEidsArray } from './userId/eids.js';
 import {config} from '../src/config.js';
 
+const ORTB_VIDEO_PARAMS = {
+  'mimes': (value) => Array.isArray(value) && value.length > 0 && value.every(v => typeof v === 'string'),
+  'minduration': (value) => isInteger(value),
+  'maxduration': (value) => isInteger(value),
+  'protocols': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 10),
+  'w': (value) => isInteger(value),
+  'h': (value) => isInteger(value),
+  'startdelay': (value) => isInteger(value),
+  'placement': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 5),
+  'linearity': (value) => [1, 2].indexOf(value) !== -1,
+  'skip': (value) => [0, 1].indexOf(value) !== -1,
+  'skipmin': (value) => isInteger(value),
+  'skipafter': (value) => isInteger(value),
+  'sequence': (value) => isInteger(value),
+  'battr': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 17),
+  'maxextended': (value) => isInteger(value),
+  'minbitrate': (value) => isInteger(value),
+  'maxbitrate': (value) => isInteger(value),
+  'boxingallowed': (value) => [0, 1].indexOf(value) !== -1,
+  'playbackmethod': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 6),
+  'playbackend': (value) => [1, 2, 3].indexOf(value) !== -1,
+  'delivery': (value) => [1, 2, 3].indexOf(value) !== -1,
+  'pos': (value) => Array.isArray(value) && value.every(v => v >= 0 && v <= 7),
+  'api': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 6)
+}
+
 export const spec = {
   code: 'sovrn',
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
   gvlid: 13,
 
   /**
@@ -15,7 +41,12 @@ export const spec = {
    * @return boolean for whether or not a bid is valid
    */
   isBidRequestValid: function(bid) {
-    return !!(bid.params.tagid && !isNaN(parseFloat(bid.params.tagid)) && isFinite(bid.params.tagid))
+    return !!(
+      bid.params.tagid &&
+      !isNaN(parseFloat(bid.params.tagid)) &&
+      isFinite(bid.params.tagid) &&
+      deepAccess(bid, 'mediaTypes.video.context') !== ADPOD
+    )
   },
 
   /**
@@ -50,13 +81,9 @@ export const spec = {
         }
         iv = iv || getBidIdParameter('iv', bid.params)
 
-        let bidSizes = (bid.mediaTypes && bid.mediaTypes.banner && bid.mediaTypes.banner.sizes) || bid.sizes
-        bidSizes = ((isArray(bidSizes) && isArray(bidSizes[0])) ? bidSizes : [bidSizes])
-        bidSizes = bidSizes.filter(size => isArray(size))
-        const processedSizes = bidSizes.map(size => ({w: parseInt(size[0], 10), h: parseInt(size[1], 10)}))
         const floorInfo = (bid.getFloor && typeof bid.getFloor === 'function') ? bid.getFloor({
           currency: 'USD',
-          mediaType: 'banner',
+          mediaType: bid.mediaTypes && bid.mediaTypes.banner ? 'banner' : 'video',
           size: '*'
         }) : {}
         floorInfo.floor = floorInfo.floor || getBidIdParameter('bidfloor', bid.params)
@@ -64,13 +91,24 @@ export const spec = {
         const imp = {
           adunitcode: bid.adUnitCode,
           id: bid.bidId,
-          banner: {
+          tagid: String(getBidIdParameter('tagid', bid.params)),
+          bidfloor: floorInfo.floor
+        }
+
+        if (deepAccess(bid, 'mediaTypes.banner')) {
+          let bidSizes = deepAccess(bid, 'mediaTypes.banner.sizes') || bid.sizes
+          bidSizes = (isArray(bidSizes) && isArray(bidSizes[0])) ? bidSizes : [bidSizes]
+          bidSizes = bidSizes.filter(size => isArray(size))
+          const processedSizes = bidSizes.map(size => ({w: parseInt(size[0], 10), h: parseInt(size[1], 10)}))
+
+          imp.banner = {
             format: processedSizes,
             w: 1,
             h: 1,
-          },
-          tagid: String(getBidIdParameter('tagid', bid.params)),
-          bidfloor: floorInfo.floor
+          };
+        }
+        if (deepAccess(bid, 'mediaTypes.video')) {
+          imp.video = _buildVideoRequestObj(bid);
         }
 
         imp.ext = getBidIdParameter('ext', bid.ortb2Imp) || undefined
@@ -149,7 +187,7 @@ export const spec = {
         seatbid[0].bid &&
         seatbid[0].bid.length > 0) {
         seatbid[0].bid.map(sovrnBid => {
-          sovrnBidResponses.push({
+          const bid = {
             requestId: sovrnBid.impid,
             cpm: parseFloat(sovrnBid.price),
             width: parseInt(sovrnBid.w),
@@ -158,11 +196,18 @@ export const spec = {
             dealId: sovrnBid.dealid || null,
             currency: 'USD',
             netRevenue: true,
-            mediaType: BANNER,
-            ad: decodeURIComponent(`${sovrnBid.adm}<img src="${sovrnBid.nurl}">`),
             ttl: sovrnBid.ext ? (sovrnBid.ext.ttl || 90) : 90,
             meta: { advertiserDomains: sovrnBid && sovrnBid.adomain ? sovrnBid.adomain : [] }
-          });
+          }
+
+          if (!sovrnBid.nurl) {
+            bid.mediaType = VIDEO
+            bid.vastXml = decodeURIComponent(sovrnBid.adm)
+          } else {
+            bid.mediaType = BANNER
+            bid.ad = decodeURIComponent(`${sovrnBid.adm}<img src="${sovrnBid.nurl}">`)
+          }
+          sovrnBidResponses.push(bid);
         });
       }
       return sovrnBidResponses
@@ -209,4 +254,34 @@ export const spec = {
   },
 }
 
-registerBidder(spec);
+function _buildVideoRequestObj(bid) {
+  const videoObj = {}
+  const videoAdUnitParams = deepAccess(bid, 'mediaTypes.video', {})
+  const videoBidderParams = deepAccess(bid, 'params.video', {})
+  const computedParams = {}
+
+  if (Array.isArray(videoAdUnitParams.playerSize)) {
+    const sizes = (Array.isArray(videoAdUnitParams.playerSize[0])) ? videoAdUnitParams.playerSize[0] : videoAdUnitParams.playerSize
+    computedParams.w = sizes[0]
+    computedParams.h = sizes[1]
+  }
+
+  const videoParams = {
+    ...computedParams,
+    ...videoAdUnitParams,
+    ...videoBidderParams
+  };
+
+  Object.keys(ORTB_VIDEO_PARAMS).forEach(paramName => {
+    if (videoParams.hasOwnProperty(paramName)) {
+      if (ORTB_VIDEO_PARAMS[paramName](videoParams[paramName])) {
+        videoObj[paramName] = videoParams[paramName]
+      } else {
+        logWarn(`The OpenRTB video param ${paramName} has been skipped due to misformating. Please refer to OpenRTB 2.5 spec.`);
+      }
+    }
+  })
+  return videoObj
+}
+
+registerBidder(spec)

package/modules/sovrnBidAdapter.md

@@ -10,9 +10,9 @@ Maintainer: jrosendahl@sovrn.com
 
 Sovrn's adapter integration to the Prebid library. Posts plain-text JSON to the /rtb/bid endpoint.
 
-# Test Parameters
+# Banner Test Parameters
 
-```
+```js
 var adUnits = [
   {
     code: 'test-leaderboard',
@@ -45,3 +45,81 @@ var adUnits = [
   }
 ]
 ```
+
+# Video Test Parameters
+### Instream
+```js
+var videoAdUnit = {
+  code: 'video1',
+  sizes: [640, 480],
+  mediaTypes: {
+    video: {
+      context: 'instream',
+      playerSize: [640, 480],
+      mimes: ['video/mp4'],
+      protocols: [1, 2, 3, 4, 5, 6, 7, 8],
+      playbackmethod: [2],
+      skip: 1,
+    },
+  },
+  bids: [
+    {
+      bidder: 'sovrn',
+      // Prebid Server Bidder Params https://docs.prebid.org/dev-docs/pbs-bidders.html#sovrn
+      params: {
+        tagid: '315045',
+        bidfloor: '0.04',
+      },
+    },
+  ],
+}
+```
+### Outstream
+```js
+var adUnits = [
+  {
+    code: videoId,
+    mediaTypes: {
+      video: {
+        context: 'outstream',
+        playerSize: [640, 360],
+        mimes: ['video/mp4'],
+        protocols: [1, 2, 3, 4, 5, 6, 7, 8],
+        playbackmethod: [2],
+        skip: 1,
+      },
+    },
+    bids: [
+      {
+        bidder: 'sovrn',
+        // Prebid Server Bidder Params https://docs.prebid.org/dev-docs/pbs-bidders.html#sovrn
+        params: {
+          tagid: '315045',
+          bidfloor: '0.04',
+        },
+      },
+    ],
+    renderer: {
+      url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js',
+      render: function (bid) {
+        adResponse = {
+          ad: {
+            video: {
+              content: bid.vastXml,
+              player_height: bid.height,
+              player_width: bid.width,
+            },
+          },
+        }
+        // push to render queue because ANOutstreamVideo may not be loaded yet.
+        bid.renderer.push(() => {
+          ANOutstreamVideo.renderAd({
+            targetId: bid.adUnitCode,
+            adResponse: adResponse,
+          })
+        })
+      },
+    },
+  },
+]
+```

package/modules/sspBCBidAdapter.js

@@ -8,8 +8,10 @@ const BIDDER_CODE = 'sspBC';
 const BIDDER_URL = 'https://ssp.wp.pl/bidder/';
 const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
+const TRACKER_URL = 'https://bdr.wpcdn.pl/tag/jstracker.js';
+const GVLID = 676;
 const TMAX = 450;
-const BIDDER_VERSION = '5.3';
+const BIDDER_VERSION = '5.41';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
@@ -29,8 +31,8 @@ const getNotificationPayload = bidData => {
       const result = {
         requestId: undefined,
         siteId: [],
-        adUnit: [],
         slotId: [],
+        tagid: [],
       }
       bids.forEach(bid => {
         let params = isArray(bid.params) ? bid.params[0] : bid.params;
@@ -55,7 +57,7 @@ const getNotificationPayload = bidData => {
           result.adomain = meta.advertiserDomains && meta.advertiserDomains[0];
           result.networkName = meta.networkName;
         }
-        result.adUnit.push(bid.adUnitCode)
+        result.tagid.push(bid.adUnitCode);
         result.requestId = bid.auctionId || result.requestId;
         result.timeout = bid.timeout || result.timeout;
       })
@@ -123,7 +125,16 @@ const applyClientHints = ortbRequest => {
       ]
     }];
 
-  ortbRequest.user = Object.assign(ortbRequest.user, { data });
+  const ch = { data };
+  ortbRequest.user = { ...ortbRequest.user, ...ch };
+};
+
+const applyUserIds = (validBidRequest, ortbRequest) => {
+  const eids = validBidRequest.userIdAsEids
+  if (eids && eids.length) {
+    const ids = { eids };
+    ortbRequest.user = { ...ortbRequest.user, ...ids };
+  }
 };
 
 /**
@@ -135,8 +146,8 @@ const applyGdpr = (bidderRequest, ortbRequest) => {
   if (gdprConsent) {
     const { apiVersion, gdprApplies, consentString } = gdprConsent;
     consentApiVersion = apiVersion;
-    ortbRequest.regs = Object.assign(ortbRequest.regs, { '[ortb_extensions.gdpr]': gdprApplies ? 1 : 0 });
-    ortbRequest.user = Object.assign(ortbRequest.user, { '[ortb_extensions.consent]': consentString });
+    ortbRequest.regs = Object.assign(ortbRequest.regs, { 'gdpr': gdprApplies ? 1 : 0 });
+    ortbRequest.user = Object.assign(ortbRequest.user, { 'consent': consentString });
   }
 }
 
@@ -299,7 +310,7 @@ const mapImpression = slot => {
   ext.data = Object.assign({ pbsize: adUnitsCalled[adUnitCode] }, ext.data);
 
   const imp = {
-    id: id && siteId ? id : 'bidid-' + bidId,
+    id: id && siteId ? id.padStart(3, '0') : 'bidid-' + bidId,
     banner: mapBanner(slot),
     native: mapNative(slot),
     video: mapVideo(slot),
@@ -342,7 +353,7 @@ const isVideoAd = bid => {
 const isNativeAd = bid => {
   const xmlTester = new RegExp(/^{['"]native['"]/);
 
-  return bid.adm && bid.adm.match(xmlTester);
+  return bid.admNative || (bid.adm && bid.adm.match(xmlTester));
 }
 
 const parseNative = nativeData => {
@@ -450,12 +461,10 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
   window.gdpr = ${JSON.stringify(request.gdprConsent)};
   window.page = "${site.page}";
   window.ref = "${site.ref}";
+  window.adlabel = "${site.adLabel ? site.adLabel : ''}";
+  window.pubid = "${site.publisherId ? site.publisherId : ''}";
   `;
 
-  if (gam) {
-    adcode += `window.gam = ${JSON.stringify(gam)};`;
-  }
-
   adcode += `</script>
     </head>
     <body>
@@ -469,6 +478,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
 
 const spec = {
   code: BIDDER_CODE,
+  gvlid: GVLID,
   aliases: [],
   supportedMediaTypes: [BANNER, NATIVE, VIDEO],
   isBidRequestValid(bid) {
@@ -513,6 +523,7 @@ const spec = {
 
     applyGdpr(bidderRequest, payload);
     applyClientHints(payload);
+    applyUserIds(validBidRequests[0], payload);
 
     return {
       method: 'POST',
@@ -558,10 +569,14 @@ const spec = {
             /*
               bid response might include ext object containing siteId / slotId, as detected by OneCode
               update site / slot data in this case
+
+              ext also might contain publisherId and custom ad label
             */
-            const { siteid, slotid } = ext;
+            const { siteid, slotid, pubid, adlabel } = ext;
             site.id = siteid || site.id;
             site.slot = slotid || site.slot;
+            site.publisherId = pubid;
+            site.adLabel = adlabel;
           }
 
           if (bidRequest && site.id && !strIncludes(site.id, 'bidid')) {
@@ -598,10 +613,28 @@ const spec = {
               bid.mediaType = 'native';
               // check native object
               try {
-                const nativeData = JSON.parse(serverBid.adm).native;
+                const nativeData = serverBid.admNative || JSON.parse(serverBid.adm).native;
                 bid.native = parseNative(nativeData);
                 bid.width = 1;
                 bid.height = 1;
+
+                // append viewability tracker
+                const jsData = {
+                  rid: bidRequest.auctionId,
+                  crid: bid.creativeId,
+                  adunit: bidRequest.adUnitCode,
+                  url: bid.native.clickUrl,
+                  vendor: seat,
+                  site: site.id,
+                  slot: site.slot,
+                  cpm: bid.cpm.toPrecision(4),
+                }
+                const jsTracker = '<script type="text/javascript" async="true" src="' + TRACKER_URL + '" ' + Object.keys(jsData).reduce((acc, current) => { return acc + ` data-wpar-${current}="${jsData[current]}"` }, '') + '><\/script>';
+                if (bid.native.javascriptTrackers) {
+                  bid.native.javascriptTrackers.push(jsTracker);
+                } else {
+                  bid.native.javascriptTrackers = [jsTracker];
+                }
               } catch (err) {
                 logWarn('Could not parse native data', serverBid.adm);
                 bid.cpm = 0;
@@ -624,15 +657,15 @@ const spec = {
 
     return bids;
   },
-  getUserSyncs(syncOptions) {
+  getUserSyncs(syncOptions, serverResponses, gdprConsent) {
+    let mySyncs = [];
     if (syncOptions.iframeEnabled && consentApiVersion != 1) {
-      return [{
+      mySyncs.push({
         type: 'iframe',
         url: `${SYNC_URL}?tcf=${consentApiVersion}`,
-      }];
-    } else {
-      logWarn('sspBC adapter requires iframe based user sync.');
-    }
+      });
+    };
+    return mySyncs;
   },
 
   onTimeout(timeoutData) {

package/modules/telariaBidAdapter.js

@@ -1,8 +1,6 @@
 import { logError, isEmpty, deepAccess, triggerPixel, logWarn, isArray } from '../src/utils.js';
-import {createBid as createBidFactory} from '../src/bidfactory.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {VIDEO} from '../src/mediaTypes.js';
-import CONSTANTS from '../src/constants.json';
 
 const BIDDER_CODE = 'telaria';
 const DOMAIN = 'tremorhub.com';
@@ -86,7 +84,9 @@ export const spec = {
       logError(errorMessage);
     } else if (!isEmpty(bidResult.seatbid)) {
       bidResult.seatbid[0].bid.forEach(tag => {
-        bids.push(createBid(CONSTANTS.STATUS.GOOD, bidderRequest, tag, width, height, BIDDER_CODE));
+        if (tag) {
+          bids.push(createBid(bidderRequest, tag, width, height));
+        }
       });
     }
 
@@ -253,38 +253,31 @@ function generateUrl(bid, bidderRequest) {
 }
 
 /**
- * Create and return a bid object based on status and tag
- * @param status
+ * Create and return a bid response
  * @param reqBid
  * @param response
  * @param width
  * @param height
- * @param bidderCode
  */
-function createBid(status, reqBid, response, width, height, bidderCode) {
-  let bid = createBidFactory(status, reqBid);
-
+function createBid(reqBid, response, width, height) {
   // TTL 5 mins by default, future support for extended imp wait time
-  if (response) {
-    Object.assign(bid, {
-      requestId: reqBid.bidId,
-      cpm: response.price,
-      creativeId: response.crid || '-1',
-      vastXml: response.adm,
-      vastUrl: reqBid.vastUrl,
-      mediaType: 'video',
-      width: width,
-      height: height,
-      bidderCode: bidderCode,
-      currency: 'USD',
-      netRevenue: true,
-      ttl: 300,
-      ad: response.adm
-    });
-  }
-
-  bid.meta = bid.meta || {};
-  if (response && response.adomain && response.adomain.length > 0) {
+  const bid = {
+    requestId: reqBid.bidId,
+    cpm: response.price,
+    creativeId: response.crid || '-1',
+    vastXml: response.adm,
+    vastUrl: reqBid.vastUrl,
+    mediaType: 'video',
+    width: width,
+    height: height,
+    currency: 'USD',
+    netRevenue: true,
+    ttl: 300,
+    ad: response.adm,
+    meta: {}
+  };
+
+  if (response.adomain && response.adomain.length > 0) {
     bid.meta.advertiserDomains = response.adomain;
   }