prebid.js 6.22.0 → 6.23.0

package/modules/jwplayerRtdProvider.md

@@ -95,9 +95,10 @@ Example:
             content: {
                 id: 'jw_abc123',
                 data: [{
-                    name: 'jwplayer',
+                    name: 'jwplayer.com',
                     ext: {
-                        segtax: 502
+                        segtax: 502,
+                        cids: ['abc123']
                     },
                     segment: [{ 
                         id: '123'
@@ -117,8 +118,9 @@ where:
     - `content` is an object containing metadata for the media. It may contain the following information: 
       - `id` is a unique identifier for the specific media asset
       - `data` is an array containing segment taxonomy objects that have the following parameters:
-        - `name` is the `jwplayer` string indicating the provider name
+        - `name` is the `jwplayer.com` string indicating the provider name
         - `ext.segtax` whose `502` value is the unique identifier for JW Player's proprietary taxonomy
+        - `ext.cids` is an array containing the list of extended content ids as defined in [oRTB's community extensions](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/community_extensions/extended-content-ids.md#example---content-id-and-seller-defined-context). 
         - `segment` is an array containing the segment taxonomy values as an object where:
           - `id` is the string representation of the data segment value. 
   

package/modules/livewrappedBidAdapter.js

@@ -67,7 +67,7 @@ export const spec = {
     var adRequests = bidRequests.map(bidToAdRequest);
 
     if (eids) {
-      ortb2 = mergeDeep(ortb2 || {}, eids);
+      ortb2 = mergeDeep(mergeDeep({}, ortb2 || {}), eids);
     }
 
     const payload = {

package/modules/minutemediaBidAdapter.js

@@ -1,17 +1,17 @@
-import { logWarn, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter } from '../src/utils.js';
+import { logWarn, logInfo, isArray, isFn, deepAccess, isEmpty, contains, timestamp, getBidIdParameter, triggerPixel, isInteger } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {VIDEO} from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
 
-const SUPPORTED_AD_TYPES = [VIDEO];
+const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
 const BIDDER_CODE = 'minutemedia';
-const ADAPTER_VERSION = '5.0.1';
+const ADAPTER_VERSION = '6.0.0';
 const TTL = 360;
 const CURRENCY = 'USD';
 const SELLER_ENDPOINT = 'https://hb.minutemedia-prebid.com/';
 const MODES = {
-  PRODUCTION: 'hb-mm',
-  TEST: 'hb-mm-test'
+  PRODUCTION: 'hb-mm-multi',
+  TEST: 'hb-multi-mm-test'
 }
 const SUPPORTED_SYNC_METHODS = {
   IFRAME: 'iframe',
@@ -23,7 +23,7 @@ export const spec = {
   gvlid: 918,
   version: ADAPTER_VERSION,
   supportedMediaTypes: SUPPORTED_AD_TYPES,
-  isBidRequestValid: function(bidRequest) {
+  isBidRequestValid: function (bidRequest) {
     if (!bidRequest.params) {
       logWarn('no params have been set to MinuteMedia adapter');
       return false;
@@ -36,54 +36,70 @@ export const spec = {
 
     return true;
   },
-  buildRequests: function (bidRequests, bidderRequest) {
-    if (bidRequests.length === 0) {
-      return [];
-    }
+  buildRequests: function (validBidRequests, bidderRequest) {
+    const combinedRequestsObject = {};
 
-    const requests = [];
+    // use data from the first bid, to create the general params for all bids
+    const generalObject = validBidRequests[0];
+    const testMode = generalObject.params.testMode;
 
-    bidRequests.forEach(bid => {
-      requests.push(buildVideoRequest(bid, bidderRequest));
-    });
+    combinedRequestsObject.params = generateGeneralParams(generalObject, bidderRequest);
+    combinedRequestsObject.bids = generateBidsParams(validBidRequests, bidderRequest);
 
-    return requests;
+    return {
+      method: 'POST',
+      url: getEndpoint(testMode),
+      data: combinedRequestsObject
+    }
   },
-  interpretResponse: function({body}) {
+  interpretResponse: function ({body}) {
     const bidResponses = [];
 
-    const bidResponse = {
-      requestId: body.requestId,
-      cpm: body.cpm,
-      width: body.width,
-      height: body.height,
-      creativeId: body.requestId,
-      currency: body.currency,
-      netRevenue: body.netRevenue,
-      ttl: body.ttl || TTL,
-      vastXml: body.vastXml,
-      mediaType: VIDEO
-    };
-
-    if (body.adomain && body.adomain.length) {
-      bidResponse.meta = {};
-      bidResponse.meta.advertiserDomains = body.adomain
+    if (body.bids) {
+      body.bids.forEach(adUnit => {
+        const bidResponse = {
+          requestId: adUnit.requestId,
+          cpm: adUnit.cpm,
+          currency: adUnit.currency || CURRENCY,
+          width: adUnit.width,
+          height: adUnit.height,
+          ttl: adUnit.ttl || TTL,
+          creativeId: adUnit.requestId,
+          netRevenue: adUnit.netRevenue || true,
+          nurl: adUnit.nurl,
+          mediaType: adUnit.mediaType,
+          meta: {
+            mediaType: adUnit.mediaType
+          }
+        };
+
+        if (adUnit.mediaType === VIDEO) {
+          bidResponse.vastXml = adUnit.vastXml;
+        } else if (adUnit.mediaType === BANNER) {
+          bidResponse.ad = adUnit.ad;
+        }
+
+        if (adUnit.adomain && adUnit.adomain.length) {
+          bidResponse.meta.advertiserDomains = adUnit.adomain;
+        }
+
+        bidResponses.push(bidResponse);
+      });
     }
-    bidResponses.push(bidResponse);
 
     return bidResponses;
   },
-  getUserSyncs: function(syncOptions, serverResponses) {
+  getUserSyncs: function (syncOptions, serverResponses) {
     const syncs = [];
     for (const response of serverResponses) {
-      if (syncOptions.iframeEnabled && response.body.userSyncURL) {
+      if (syncOptions.iframeEnabled && response.body.params.userSyncURL) {
         syncs.push({
           type: 'iframe',
-          url: response.body.userSyncURL
+          url: response.body.params.userSyncURL
         });
       }
-      if (syncOptions.pixelEnabled && isArray(response.body.userSyncPixels)) {
-        const pixels = response.body.userSyncPixels.map(pixel => {
+      if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) {
+        const pixels = response.body.params.userSyncPixels.map(pixel => {
           return {
             type: 'image',
             url: pixel
@@ -93,6 +109,16 @@ 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);
+    }
   }
 };
 
@@ -103,46 +129,33 @@ registerBidder(spec);
  * @param bid {bid}
  * @returns {Number}
  */
-function getFloor(bid) {
+function getFloor(bid, mediaType) {
   if (!isFn(bid.getFloor)) {
     return 0;
   }
   let floorResult = bid.getFloor({
     currency: CURRENCY,
-    mediaType: VIDEO,
+    mediaType: mediaType,
     size: '*'
   });
   return floorResult.currency === CURRENCY && floorResult.floor ? floorResult.floor : 0;
 }
 
 /**
- * Build the video request
- * @param bid {bid}
- * @param bidderRequest {bidderRequest}
- * @returns {Object}
- */
-function buildVideoRequest(bid, bidderRequest) {
-  const sellerParams = generateParameters(bid, bidderRequest);
-  const {params} = bid;
-  return {
-    method: 'GET',
-    url: getEndpoint(params.testMode),
-    data: sellerParams
-  };
-}
-
-/**
- * Get the the ad size from the bid
+ * Get the the ad sizes array from the bid
  * @param bid {bid}
  * @returns {Array}
  */
-function getSizes(bid) {
-  if (deepAccess(bid, 'mediaTypes.video.sizes')) {
-    return bid.mediaTypes.video.sizes[0];
+function getSizesArray(bid, mediaType) {
+  let sizesArray = []
+
+  if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) {
+    sizesArray = bid.mediaTypes[mediaType].sizes;
   } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
-    return bid.sizes[0];
+    sizesArray = bid.sizes;
   }
-  return [];
+
+  return sizesArray;
 }
 
 /**
@@ -239,122 +252,180 @@ function getDeviceType(ua) {
   return '1';
 }
 
+function generateBidsParams(validBidRequests, bidderRequest) {
+  const bidsArray = [];
+
+  if (validBidRequests.length) {
+    validBidRequests.forEach(bid => {
+      bidsArray.push(generateBidParameters(bid, bidderRequest));
+    });
+  }
+
+  return bidsArray;
+}
+
 /**
- * Generate query parameters for the request
- * @param bid {bid}
- * @param bidderRequest {bidderRequest}
- * @returns {Object}
+ * Generate bid specific parameters
+ * @param {bid} bid
+ * @param {bidderRequest} bidderRequest
+ * @returns {Object} bid specific params object
  */
-function generateParameters(bid, bidderRequest) {
+function generateBidParameters(bid, bidderRequest) {
   const {params} = bid;
-  const timeout = config.getConfig('bidderTimeout');
-  const {syncEnabled, filterSettings} = config.getConfig('userSync') || {};
-  const [width, height] = getSizes(bid);
-  const {bidderCode} = bidderRequest;
-  const domain = window.location.hostname;
+  const mediaType = isBanner(bid) ? BANNER : VIDEO;
+  const sizesArray = getSizesArray(bid, mediaType);
 
   // fix floor price in case of NAN
   if (isNaN(params.floorPrice)) {
     params.floorPrice = 0;
   }
 
-  const requestParams = {
+  const bidObject = {
+    mediaType,
+    adUnitCode: getBidIdParameter('adUnitCode', bid),
+    sizes: sizesArray,
+    floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
+    bidId: getBidIdParameter('bidId', bid),
+    bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+    transactionId: getBidIdParameter('transactionId', bid),
+  };
+
+  const pos = deepAccess(bid, `mediaTypes.${mediaType}.pos`);
+  if (pos) {
+    bidObject.pos = pos;
+  }
+
+  const gpid = deepAccess(bid, `ortb2Imp.ext.gpid`);
+  if (gpid) {
+    bidObject.gpid = gpid;
+  }
+
+  const placementId = params.placementId || deepAccess(bid, `mediaTypes.${mediaType}.name`);
+  if (placementId) {
+    bidObject.placementId = placementId;
+  }
+
+  if (mediaType === VIDEO) {
+    const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`);
+    let playbackMethodValue;
+
+    // verify playbackMethod is of type integer array, or integer only.
+    if (Array.isArray(playbackMethod) && isInteger(playbackMethod[0])) {
+      // only the first playbackMethod in the array will be used, according to OpenRTB 2.5 recommendation
+      playbackMethodValue = playbackMethod[0];
+    } else if (isInteger(playbackMethod)) {
+      playbackMethodValue = playbackMethod;
+    }
+
+    if (playbackMethodValue) {
+      bidObject.playbackMethod = playbackMethodValue;
+    }
+
+    const placement = deepAccess(bid, `mediaTypes.video.placement`);
+    if (placement) {
+      bidObject.placement = placement;
+    }
+
+    const minDuration = deepAccess(bid, `mediaTypes.video.minduration`);
+    if (minDuration) {
+      bidObject.minDuration = minDuration;
+    }
+
+    const maxDuration = deepAccess(bid, `mediaTypes.video.maxduration`);
+    if (maxDuration) {
+      bidObject.maxDuration = maxDuration;
+    }
+
+    const skip = deepAccess(bid, `mediaTypes.video.skip`);
+    if (skip) {
+      bidObject.skip = skip;
+    }
+
+    const linearity = deepAccess(bid, `mediaTypes.video.linearity`);
+    if (linearity) {
+      bidObject.linearity = linearity;
+    }
+  }
+
+  return bidObject;
+}
+
+function isBanner(bid) {
+  return bid.mediaTypes && bid.mediaTypes.banner;
+}
+
+/**
+ * Generate params that are common between all bids
+ * @param {single bid object} generalObject
+ * @param {bidderRequest} bidderRequest
+ * @returns {object} the common params object
+ */
+function generateGeneralParams(generalObject, bidderRequest) {
+  const domain = window.location.hostname;
+  const {syncEnabled, filterSettings} = config.getConfig('userSync') || {};
+  const {bidderCode} = bidderRequest;
+  const generalBidParams = generalObject.params;
+  const timeout = config.getConfig('bidderTimeout');
+
+  // these params are snake_case instead of camelCase to allow backwards compatability on the server.
+  // in the future, these will be converted to camelCase to match our convention.
+  const generalParams = {
     wrapper_type: 'prebidjs',
     wrapper_vendor: '$$PREBID_GLOBAL$$',
     wrapper_version: '$prebid.version$',
     adapter_version: ADAPTER_VERSION,
     auction_start: timestamp(),
-    ad_unit_code: getBidIdParameter('adUnitCode', bid),
-    tmax: timeout,
-    width: width,
-    height: height,
-    publisher_id: params.org,
-    floor_price: Math.max(getFloor(bid), params.floorPrice),
-    ua: navigator.userAgent,
-    bid_id: getBidIdParameter('bidId', bid),
-    bidder_request_id: getBidIdParameter('bidderRequestId', bid),
-    transaction_id: getBidIdParameter('transactionId', bid),
-    session_id: getBidIdParameter('auctionId', bid),
+    publisher_id: generalBidParams.org,
     publisher_name: domain,
     site_domain: domain,
     dnt: (navigator.doNotTrack == 'yes' || navigator.doNotTrack == '1' || navigator.msDoNotTrack == '1') ? 1 : 0,
-    device_type: getDeviceType(navigator.userAgent)
-  };
+    device_type: getDeviceType(navigator.userAgent),
+    ua: navigator.userAgent,
+    session_id: getBidIdParameter('auctionId', generalObject),
+    tmax: timeout
+  }
 
-  const userIdsParam = getBidIdParameter('userId', bid);
+  const userIdsParam = getBidIdParameter('userId', generalObject);
   if (userIdsParam) {
-    requestParams.userIds = JSON.stringify(userIdsParam);
+    generalParams.userIds = JSON.stringify(userIdsParam);
   }
 
   const ortb2Metadata = config.getConfig('ortb2') || {};
   if (ortb2Metadata.site) {
-    requestParams.site_metadata = JSON.stringify(ortb2Metadata.site);
+    generalParams.site_metadata = JSON.stringify(ortb2Metadata.site);
   }
   if (ortb2Metadata.user) {
-    requestParams.user_metadata = JSON.stringify(ortb2Metadata.user);
-  }
-
-  const playbackMethod = deepAccess(bid, 'mediaTypes.video.playbackmethod');
-  if (playbackMethod) {
-    requestParams.playback_method = playbackMethod;
-  }
-  const placement = deepAccess(bid, 'mediaTypes.video.placement');
-  if (placement) {
-    requestParams.placement = placement;
-  }
-  const pos = deepAccess(bid, 'mediaTypes.video.pos');
-  if (pos) {
-    requestParams.pos = pos;
-  }
-  const minduration = deepAccess(bid, 'mediaTypes.video.minduration');
-  if (minduration) {
-    requestParams.min_duration = minduration;
-  }
-  const maxduration = deepAccess(bid, 'mediaTypes.video.maxduration');
-  if (maxduration) {
-    requestParams.max_duration = maxduration;
-  }
-  const skip = deepAccess(bid, 'mediaTypes.video.skip');
-  if (skip) {
-    requestParams.skip = skip;
-  }
-  const linearity = deepAccess(bid, 'mediaTypes.video.linearity');
-  if (linearity) {
-    requestParams.linearity = linearity;
-  }
-
-  if (params.placementId) {
-    requestParams.placement_id = params.placementId;
+    generalParams.user_metadata = JSON.stringify(ortb2Metadata.user);
   }
 
   if (syncEnabled) {
     const allowedSyncMethod = getAllowedSyncMethod(filterSettings, bidderCode);
     if (allowedSyncMethod) {
-      requestParams.cs_method = allowedSyncMethod;
+      generalParams.cs_method = allowedSyncMethod;
     }
   }
 
   if (bidderRequest.uspConsent) {
-    requestParams.us_privacy = bidderRequest.uspConsent;
+    generalParams.us_privacy = bidderRequest.uspConsent;
   }
 
   if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
-    requestParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
-    requestParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
+    generalParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
+    generalParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
   }
 
-  if (params.ifa) {
-    requestParams.ifa = params.ifa;
+  if (generalBidParams.ifa) {
+    generalParams.ifa = generalBidParams.ifa;
   }
 
-  if (bid.schain) {
-    requestParams.schain = getSupplyChain(bid.schain);
+  if (generalObject.schain) {
+    generalParams.schain = getSupplyChain(generalObject.schain);
   }
 
   if (bidderRequest && bidderRequest.refererInfo) {
-    requestParams.referrer = deepAccess(bidderRequest, 'refererInfo.referer');
-    requestParams.page_url = config.getConfig('pageUrl') || deepAccess(window, 'location.href');
+    generalParams.referrer = deepAccess(bidderRequest, 'refererInfo.referer');
+    generalParams.page_url = config.getConfig('pageUrl') || deepAccess(window, 'location.href');
   }
 
-  return requestParams;
+  return generalParams
 }

package/modules/minutemediaBidAdapter.md

@@ -13,7 +13,7 @@ Module that connects to MinuteMedia's demand sources.
 
 The MinuteMedia adapter requires setup and approval from the MinuteMedia. Please reach out to hb@minutemedia.com to create an MinuteMedia account.
 
-The adapter supports Video(instream).
+The adapter supports Video(instream) & Banner.
 
 # Bid Parameters
 ## Video
@@ -27,25 +27,50 @@ The adapter supports Video(instream).
 
 # Test Parameters
 ```javascript
-var adUnits = [
-       {
+var adUnits = [{
         code: 'dfp-video-div',
-        sizes: [[640, 480]],
+        sizes: [
+            [640, 480]
+        ],
         mediaTypes: {
-          video: {
-            playerSize: [[640, 480]],
-            context: 'instream'
-          }
+            video: {
+                playerSize: [
+                    [640, 480]
+                ],
+                context: 'instream'
+            }
         },
         bids: [{
-          bidder: 'minutemedia',
-          params: {
-            org: '56f91cd4d3e3660002000033', // Required
-            floorPrice: 2.00, // Optional
-            placementId: '12345678', // Optional
-            testMode: false // Optional
-          }
+            bidder: 'minutemedia',
+            params: {
+                org: '56f91cd4d3e3660002000033', // Required
+                floorPrice: 2.00, // Optional
+                placementId: 'video-test', // Optional
+                testMode: false // Optional
+            }
         }]
-      }
-   ];
+    },
+    {
+        code: 'dfp-banner-div',
+        sizes: [
+            [640, 480]
+        ],
+        mediaTypes: {
+            banner: {
+                sizes: [
+                    [640, 480]
+                ]
+            }
+        },
+        bids: [{
+            bidder: 'minutemedia',
+            params: {
+                org: '56f91cd4d3e3660002000033', // Required
+                floorPrice: 2.00, // Optional
+                placementId: 'banner-test', // Optional
+                testMode: false // Optional
+            }
+        }]
+    }
+];
 ```

package/modules/prebidServerBidAdapter/index.js

@@ -563,13 +563,16 @@ Object.assign(ORTB2.prototype, {
       const nativeParams = adUnit.nativeParams;
       let nativeAssets;
       if (nativeParams) {
+        let idCounter = -1;
         try {
           nativeAssets = nativeAssetCache[impressionId] = Object.keys(nativeParams).reduce((assets, type) => {
             let params = nativeParams[type];
 
             function newAsset(obj) {
+              idCounter++;
               return Object.assign({
-                required: params.required ? 1 : 0
+                required: params.required ? 1 : 0,
+                id: (isNumber(params.id)) ? idCounter = params.id : idCounter
               }, obj ? cleanObj(obj) : {});
             }
 

package/modules/sovrnBidAdapter.js

@@ -30,6 +30,14 @@ const ORTB_VIDEO_PARAMS = {
   'api': (value) => Array.isArray(value) && value.every(v => v >= 1 && v <= 6)
 }
 
+const REQUIRED_VIDEO_PARAMS = {
+  context: (value) => value !== ADPOD,
+  mimes: ORTB_VIDEO_PARAMS.mimes,
+  minduration: ORTB_VIDEO_PARAMS.minduration,
+  maxduration: ORTB_VIDEO_PARAMS.maxduration,
+  protocols: ORTB_VIDEO_PARAMS.protocols
+}
+
 export const spec = {
   code: 'sovrn',
   supportedMediaTypes: [BANNER, VIDEO],
@@ -40,12 +48,17 @@ export const spec = {
    * @param {object} bid the Sovrn bid to validate
    * @return boolean for whether or not a bid is valid
    */
-  isBidRequestValid: function(bid) {
+  isBidRequestValid: function (bid) {
+    const video = bid?.mediaTypes?.video
     return !!(
       bid.params.tagid &&
       !isNaN(parseFloat(bid.params.tagid)) &&
-      isFinite(bid.params.tagid) &&
-      deepAccess(bid, 'mediaTypes.video.context') !== ADPOD
+      isFinite(bid.params.tagid) && (
+        !video || (
+          Object.keys(REQUIRED_VIDEO_PARAMS)
+            .every(key => REQUIRED_VIDEO_PARAMS[key](video[key]))
+        )
+      )
     )
   },
 

package/modules/tripleliftBidAdapter.js

@@ -1,4 +1,4 @@
-import { tryAppendQueryString, logMessage, isEmpty, isStr, isPlainObject, isArray, logWarn } from '../src/utils.js';
+import { tryAppendQueryString, logMessage, logError, isEmpty, isStr, isPlainObject, isArray, logWarn } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
@@ -175,14 +175,18 @@ function _getORTBVideo(bidRequest) {
 function _getFloor (bid) {
   let floor = null;
   if (typeof bid.getFloor === 'function') {
-    const floorInfo = bid.getFloor({
-      currency: 'USD',
-      mediaType: _isInstreamBidRequest(bid) ? 'video' : 'banner',
-      size: '*'
-    });
-    if (typeof floorInfo === 'object' &&
-    floorInfo.currency === 'USD' && !isNaN(parseFloat(floorInfo.floor))) {
-      floor = parseFloat(floorInfo.floor);
+    try {
+      const floorInfo = bid.getFloor({
+        currency: 'USD',
+        mediaType: _isInstreamBidRequest(bid) ? 'video' : 'banner',
+        size: '*'
+      });
+      if (typeof floorInfo === 'object' &&
+      floorInfo.currency === 'USD' && !isNaN(parseFloat(floorInfo.floor))) {
+        floor = parseFloat(floorInfo.floor);
+      }
+    } catch (err) {
+      logError('Triplelift: getFloor threw an error: ', err);
     }
   }
   return floor !== null ? floor : bid.params.floor;

package/modules/userId/eids.js

@@ -305,6 +305,15 @@ export const USER_IDS_CONFIG = {
     source: 'impact-ad.jp',
     atype: 1
   },
+
+  // 33across ID
+  '33acrossId': {
+    source: '33across.com',
+    atype: 1,
+    getValue: function(data) {
+      return data.envelope;
+    }
+  },
 };
 
 // this function will create an eid object for the given UserId sub-module