prebid.js 5.16.0 → 5.20.0

package/modules/mediakeysBidAdapter.js

@@ -1,4 +1,6 @@
-import { getWindowTop, isFn, logWarn, getDNT, deepAccess, isArray, inIframe, mergeDeep, isStr, isEmpty, deepSetValue, deepClone, parseUrl, cleanObj, logError, triggerPixel } from '../src/utils.js';
+import find from 'core-js-pure/features/array/find.js';
+import arrayFrom from 'core-js-pure/features/array/from';
+import { getWindowTop, isFn, logWarn, getDNT, deepAccess, isArray, inIframe, mergeDeep, isStr, isEmpty, deepSetValue, deepClone, parseUrl, cleanObj, logError, triggerPixel, isInteger, isNumber } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
@@ -8,10 +10,63 @@ const AUCTION_TYPE = 1;
 const BIDDER_CODE = 'mediakeys';
 const ENDPOINT = 'https://prebid.eu-central-1.bidder.mediakeys.io/bids';
 const GVLID = 498;
-const SUPPORTED_MEDIA_TYPES = [BANNER];
+const SUPPORTED_MEDIA_TYPES = [BANNER, NATIVE, VIDEO];
 const DEFAULT_CURRENCY = 'USD';
 const NET_REVENUE = true;
 
+const NATIVE_ASSETS_MAPPING = [
+  { name: 'title', id: 1, type: 0 },
+  { name: 'image', id: 2, type: 3 },
+  { name: 'icon', id: 3, type: 1 },
+  { name: 'sponsoredBy', id: 5, type: 1 },
+  { name: 'body', id: 6, type: 2 },
+  { name: 'rating', id: 7, type: 3 },
+  { name: 'likes', id: 8, type: 4 },
+  { name: 'downloads', id: 9, type: 5 },
+  { name: 'price', id: 10, type: 6 },
+  { name: 'salePrice', id: 11, type: 7 },
+  { name: 'phone', id: 12, type: 8 },
+  { name: 'address', id: 13, type: 9 },
+  { name: 'body2', id: 14, type: 10 },
+  { name: 'displayUrl', id: 15, type: 11 },
+  { name: 'cta', id: 16, type: 12 },
+];
+
+// This provide a whitelist and a basic validation of OpenRTB native 1.2 options.
+// https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf
+const ORTB_NATIVE_PARAMS = {
+  context: value => [1, 2, 3].indexOf(value) !== -1,
+  plcmttype: value => [1, 2, 3, 4].indexOf(value) !== -1
+};
+
+// This provide a whitelist and a basic validation of OpenRTB 2.5 video options.
+// https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
+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 => [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].indexOf(v) !== -1),
+  w: value => isInteger(value),
+  h: value => isInteger(value),
+  startdelay: value => isInteger(value),
+  placement: value => [1, 2, 3, 4, 5].indexOf(value) !== -1,
+  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 => arrayFrom({length: 17}, (_, i) => i + 1).indexOf(v) !== -1),
+  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 => [1, 2, 3, 4, 5, 6].indexOf(v) !== -1),
+  playbackend: value => [1, 2, 3].indexOf(value) !== -1,
+  delivery: value => [1, 2, 3].indexOf(value) !== -1,
+  pos: value => [0, 1, 2, 3, 4, 5, 6, 7].indexOf(value) !== -1,
+  api: value => Array.isArray(value) && value.every(v => [1, 2, 3, 4, 5, 6].indexOf(v) !== -1),
+};
+
 /**
  * Detects the capability to reach window.top.
  *
@@ -83,6 +138,33 @@ function getFloor(bid, mediaType, size = '*') {
   return (!isNaN(floor.floor) && floor.currency === DEFAULT_CURRENCY) ? floor.floor : false
 }
 
+/**
+ * Returns the highest floor price found when a bid have
+ * several mediaTypes.
+ *
+ * @param {*} bid a Prebid.js bid (request) object
+ * @returns {number|boolean}
+ */
+function getHighestFloor(bid) {
+  const floors = [];
+
+  for (let mediaType in bid.mediaTypes) {
+    const floor = getFloor(bid, mediaType);
+
+    if (isNumber(floor)) {
+      floors.push(floor);
+    }
+  }
+
+  if (!floors.length) {
+    return false;
+  }
+
+  return floors.reduce((a, b) => {
+    return Math.max(a, b);
+  });
+}
+
 /**
  * Returns an openRTB 2.5 object.
  * This one will be populated at each step of the buildRequest process.
@@ -153,6 +235,190 @@ function createBannerImp(bid) {
   }
 }
 
+/**
+ * Returns an openRtb 2.5 native object with a native 1.2 request.
+ *
+ * @param {object} bid Prebid bid object from request
+ * @returns {object}
+ */
+function createNativeImp(bid) {
+  if (!bid.nativeParams) {
+    logWarn(`${BIDDER_CODE}: bid.nativeParams object has not been found.`);
+    return
+  }
+
+  const nativeParams = deepClone(bid.nativeParams);
+
+  const nativeAdUnitParams = deepAccess(bid, 'mediaTypes.native', {});
+  const nativeBidderParams = deepAccess(bid, 'params.native', {});
+
+  const extraParams = {
+    ...nativeAdUnitParams,
+    ...nativeBidderParams
+  };
+
+  const nativeObject = {
+    ver: '1.2',
+    context: 1, // overwrited later if needed
+    plcmttype: 1, // overwrited later if needed
+    assets: []
+  }
+
+  Object.keys(ORTB_NATIVE_PARAMS).forEach(name => {
+    if (extraParams.hasOwnProperty(name)) {
+      if (ORTB_NATIVE_PARAMS[name](extraParams[name])) {
+        nativeObject[name] = extraParams[name];
+      } else {
+        logWarn(`${BIDDER_CODE}: the OpenRTB native param ${name} has been skipped due to misformating. Please refer to OpenRTB Native spec.`);
+      }
+    }
+  });
+
+  // just a helper function
+  const setImageAssetSizes = function(asset, param) {
+    if (param.sizes && param.sizes.length) {
+      asset.img.w = param.sizes ? param.sizes[0] : undefined;
+      asset.img.h = param.sizes ? param.sizes[1] : undefined;
+    }
+
+    if (!asset.img.w) {
+      asset.img.wmin = 0;
+    }
+
+    if (!asset.img.h) {
+      asset.img.hmin = 0;
+    }
+  }
+
+  // Prebid.js "image" type support.
+  // Add some defaults to support special type provided by Prebid.js `mediaTypes.native.type: "image"`
+  const nativeImageType = deepAccess(bid, 'mediaTypes.native.type');
+  if (nativeImageType === 'image') {
+    // Default value is ones of the recommended by the spec: https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf
+    nativeParams.title.len = 90;
+  }
+
+  for (let key in nativeParams) {
+    if (nativeParams.hasOwnProperty(key)) {
+      const internalNativeAsset = find(NATIVE_ASSETS_MAPPING, ref => ref.name === key);
+      if (!internalNativeAsset) {
+        logWarn(`${BIDDER_CODE}: the asset "${key}" has not been found in Prebid assets map. Skipped for request.`);
+        continue;
+      }
+
+      const param = nativeParams[key];
+
+      const asset = {
+        id: internalNativeAsset.id,
+        required: param.required ? 1 : 0
+      }
+
+      switch (key) {
+        case 'title':
+          if (param.len || param.length) {
+            asset.title = {
+              len: param.len || param.length,
+              ext: param.ext
+            }
+          } else {
+            logWarn(`${BIDDER_CODE}: "title.length" property for native asset is required. Skipped for request.`)
+            continue;
+          }
+          break;
+
+        case 'image':
+          asset.img = {
+            type: internalNativeAsset.type,
+            mimes: param.mimes,
+            ext: param.ext,
+          }
+
+          setImageAssetSizes(asset, param);
+
+          break;
+        case 'icon':
+          asset.img = {
+            type: internalNativeAsset.type,
+            mimes: param.mimes,
+            ext: param.ext,
+          }
+
+          setImageAssetSizes(asset, param);
+          break;
+
+        case 'sponsoredBy': // sponsored
+        case 'body': // desc
+        case 'rating':
+        case 'likes':
+        case 'downloads':
+        case 'price':
+        case 'salePrice':
+        case 'phone':
+        case 'address':
+        case 'body2': // desc2
+        case 'displayUrl':
+        case 'cta':
+          // generic asset.data
+          asset.data = {
+            type: internalNativeAsset.type,
+            len: param.len,
+            ext: param.ext
+          }
+          break;
+      }
+
+      nativeObject.assets.push(asset);
+    }
+  }
+
+  if (nativeObject.assets.length) {
+    return {
+      request: nativeObject
+    }
+  }
+}
+
+/**
+ * Returns an openRtb 2.5 video object.
+ *
+ * @param {object} bid Prebid bid object from request
+ * @returns {object}
+ */
+function createVideoImp(bid) {
+  const videoAdUnitParams = deepAccess(bid, 'mediaTypes.video', {});
+  const videoBidderParams = deepAccess(bid, 'params.video', {});
+  const computedParams = {};
+
+  // Special case for playerSize.
+  // Eeach props will be overrided if they are defined in config.
+  if (Array.isArray(videoAdUnitParams.playerSize)) {
+    const tempSize = (Array.isArray(videoAdUnitParams.playerSize[0])) ? videoAdUnitParams.playerSize[0] : videoAdUnitParams.playerSize;
+    computedParams.w = tempSize[0];
+    computedParams.h = tempSize[1];
+  }
+
+  const videoParams = {
+    ...computedParams,
+    ...videoAdUnitParams,
+    ...videoBidderParams
+  };
+
+  const video = {};
+
+  // Only whitelisted OpenRTB options need to be validated.
+  Object.keys(ORTB_VIDEO_PARAMS).forEach(name => {
+    if (videoParams.hasOwnProperty(name)) {
+      if (ORTB_VIDEO_PARAMS[name](videoParams[name])) {
+        video[name] = videoParams[name];
+      } else {
+        logWarn(`${BIDDER_CODE}: the OpenRTB video param ${name} has been skipped due to misformating. Please refer to OpenRTB 2.5 spec.`);
+      }
+    }
+  });
+
+  return video
+}
+
 /**
  * Create the OpenRTB 2.5 imp object.
  *
@@ -167,20 +433,34 @@ function createImp(bid) {
     secure: 1,
   };
 
+  // There is no default floor. bidfloor is set only
+  // if the priceFloors module is activated and returns a valid floor.
+  const floor = getHighestFloor(bid);
+  if (isNumber(floor)) {
+    imp.bidfloor = floor;
+  }
+
   // Only supports proper mediaTypes definition…
   for (let mediaType in bid.mediaTypes) {
-    // There is no default floor. bidfloor is set only
-    // if the priceFloors module is activated and returns a valid floor.
-    const floor = getFloor(bid, mediaType);
-    if (floor) {
-      imp.bidfloor = floor;
-    }
-
-    if (mediaType === BANNER) {
-      const banner = createBannerImp(bid);
-      if (banner) {
-        imp.banner = banner;
-      }
+    switch (mediaType) {
+      case BANNER:
+        const banner = createBannerImp(bid);
+        if (banner) {
+          imp.banner = banner;
+        }
+        break;
+      case NATIVE:
+        const native = createNativeImp(bid);
+        if (native) {
+          imp.native = native;
+        }
+        break;
+      case VIDEO:
+        const video = createVideoImp(bid);
+        if (video) {
+          imp.video = video;
+        }
+        break;
     }
   }
 
@@ -213,6 +493,94 @@ function getPrimaryCatFromResponse(cat) {
   }
 }
 
+/**
+ * Create the Prebid.js native object from response.
+ *
+ * @param {*} bid bid object from response
+ * @returns {object} Prebid.js native object used in response
+ */
+function nativeBidResponseHandler(bid) {
+  const nativeAdm = JSON.parse(bid.adm);
+  if (!nativeAdm || !nativeAdm.assets.length) {
+    logError(`${BIDDER_CODE}: invalid native response.`);
+    return;
+  }
+
+  const native = {}
+
+  nativeAdm.assets.forEach(asset => {
+    if (asset.title) {
+      native.title = asset.title.text;
+      return;
+    }
+
+    if (asset.img) {
+      switch (asset.img.type) {
+        case 1:
+          native.icon = {
+            url: asset.img.url,
+            width: asset.img.w,
+            height: asset.img.h
+          };
+          break;
+        default:
+          native.image = {
+            url: asset.img.url,
+            width: asset.img.w,
+            height: asset.img.h
+          };
+          break;
+      }
+      return;
+    }
+
+    if (asset.data) {
+      const internalNativeAsset = find(NATIVE_ASSETS_MAPPING, ref => ref.id === asset.id);
+      if (internalNativeAsset) {
+        native[internalNativeAsset.name] = asset.data.value;
+      }
+    }
+  });
+
+  if (nativeAdm.link) {
+    if (nativeAdm.link.url) {
+      native.clickUrl = nativeAdm.link.url;
+    }
+    if (Array.isArray(nativeAdm.link.clicktrackers)) {
+      native.clickTrackers = nativeAdm.link.clicktrackers
+    }
+  }
+
+  if (Array.isArray(nativeAdm.eventtrackers)) {
+    native.impressionTrackers = [];
+    nativeAdm.eventtrackers.forEach(tracker => {
+      // Only Impression events are supported. Prebid does not support Viewability events yet.
+      if (tracker.event !== 1) {
+        return;
+      }
+
+      // methods:
+      // 1: image
+      // 2: js
+      // note: javascriptTrackers is a string. If there's more than one JS tracker in bid response, the last script will be used.
+      switch (tracker.method) {
+        case 1:
+          native.impressionTrackers.push(tracker.url);
+          break;
+        case 2:
+          native.javascriptTrackers = `<script src=\"${tracker.url}\"></script>`;
+          break;
+      }
+    });
+  }
+
+  if (nativeAdm.privacy) {
+    native.privacyLink = nativeAdm.privacy;
+  }
+
+  return native;
+}
+
 export const spec = {
   code: BIDDER_CODE,
 
@@ -355,6 +723,29 @@ export const spec = {
               meta: cleanObj(meta)
             };
 
+            if (mediaType === NATIVE) {
+              const native = nativeBidResponseHandler(bid);
+              if (native) {
+                newBid.native = native;
+              }
+            }
+
+            if (mediaType === VIDEO) {
+              // Note:
+              // Mediakeys bid adapter expects a publisher has set his own video player
+              // in the `mediaTypes.video` configuration object.
+
+              // Mediakeys bidder does not provide inline XML in the bid response
+              // newBid.vastXml = bid.ext.vast_url;
+
+              // For instream video, disable server cache as vast is generated per bid request
+              newBid.videoCacheKey = 'no_cache';
+
+              // The vast URL is server independently and must be fetched before video rendering in the renderer
+              // appending '&no_cache' is safe and fast as the vast url always have parameters
+              newBid.vastUrl = bid.ext.vast_url + '&no_cache';
+            }
+
             bidResponses.push(newBid);
           });
         });

package/modules/mediakeysBidAdapter.md

@@ -29,3 +29,111 @@ var adUnits = [
     }]
 },
 ```
+
+## Native only Ad Unit
+
+The Mediakeys adapter accepts two optional params for native requests. Please see the [OpenRTB Native Ads Specification](https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) for valid values.
+
+```
+var adUnits = [
+{
+    code: 'test',
+    mediaTypes: {
+        native: {
+            type: 'image',
+        }
+    },
+    bids: [{
+        bidder: 'mediakeys',
+        params: {
+            native: {
+                context: 1, // ORTB Native Context Type IDs. Default `1`.
+                plcmttype: 1, // ORTB Native Placement Type IDs. Default `1`.
+            }
+        }
+    }]
+},
+```
+
+## Video only Ad Unit
+
+The Mediakeys adapter accepts any valid openRTB 2.5 video property. Properties can be defined at the adUnit `mediaTypes.video` or `bid[].params` level.
+
+### Outstream context
+
+```
+var adUnits = [
+{
+    code: 'test',
+    mediaTypes: {
+        video: {
+            context: 'outstream',
+            playerSize: [300, 250],
+            // additional OpenRTB video params
+            // placement: 2,
+            // api: [1],
+            // …
+        }
+    },
+    renderer: {
+        url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js',
+        render: function (bid) {
+            var bidReqConfig = pbjs.adUnits.find(bidReq => bidReq.bidId === bid.impid);
+
+            if (bidReqConfig && bidReqConfig.mediaTypes && bidReqConfig.mediaTypes.video && bidReqConfig.mediaTypes.video.context === 'outstream') {
+                var adResponse = fetch(bid.vastUrl).then(resp => resp.text()).then(text => ({
+                    ad: {
+                        video: {
+                            content: text,
+                            player_width: bid.width || bidReqConfig.mediaTypes.video.playerSize[0],
+                            player_height: bid.height || bidReqConfig.mediaTypes.video.playerSize[1],
+                        }
+                    }
+                }))
+
+                adResponse.then((ad) => {
+                    bid.renderer.push(() => {
+                        ANOutstreamVideo.renderAd({
+                            targetId: bid.adUnitCode,
+                            adResponse: ad
+                        });
+                    });
+                })
+            }
+        }
+    },
+    bids: [{
+        bidder: 'mediakeys',
+        params: {
+            video: {
+                // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+            }
+        }
+    }]
+},
+```
+
+### Instream context
+
+```
+var adUnits = [
+{
+    code: 'test',
+    mediaTypes: {
+        video: {
+            context: 'instream',
+            playerSize: [300, 250],
+            // additional OpenRTB video params
+            // placement: 2,
+            // api: [1],
+            // …
+        }
+    },
+    bids: [{
+        bidder: 'mediakeys',
+        params: {
+            // additional OpenRTB video params. Will be merged with params defined at mediaTypes level
+        }
+    }]
+},
+```

package/modules/multibid/index.js

@@ -112,7 +112,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     if (multiConfig[bid.bidderCode].prefix) bid.multibidPrefix = multiConfig[bid.bidderCode].prefix;
     bid.originalBidder = bid.bidderCode;
     // Check if stored bids for auction include adUnitCode.bidder and max limit not reach for ad unit
-    if (deepAccess(multibidUnits, `${adUnitCode}.${bid.bidderCode}`)) {
+    if (deepAccess(multibidUnits, [adUnitCode, bid.bidderCode])) {
       // Store request id under new property originalRequestId, create new unique bidId,
       // and push bid into multibid stored bids for auction if max not reached and bid cpm above floor
       if (!multibidUnits[adUnitCode][bid.bidderCode].maxReached && (!floor || floor <= bid.cpm)) {
@@ -131,9 +131,9 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
         logWarn(`Filtering multibid received from bidder ${bid.bidderCode}: ` + ((multibidUnits[adUnitCode][bid.bidderCode].maxReached) ? `Maximum bid limit reached for ad unit code ${adUnitCode}` : 'Bid cpm under floors value.'));
       }
     } else {
-      if (deepAccess(bid, 'floorData.floorValue')) deepSetValue(multibidUnits, `${adUnitCode}.${bid.bidderCode}`, {floor: deepAccess(bid, 'floorData.floorValue')});
+      if (deepAccess(bid, 'floorData.floorValue')) deepSetValue(multibidUnits, [adUnitCode, bid.bidderCode], {floor: deepAccess(bid, 'floorData.floorValue')});
 
-      deepSetValue(multibidUnits, `${adUnitCode}.${bid.bidderCode}`, {ads: [bid]});
+      deepSetValue(multibidUnits, [adUnitCode, bid.bidderCode], {ads: [bid]});
       if (multibidUnits[adUnitCode][bid.bidderCode].ads.length === multiConfig[bid.bidderCode].maxbids) multibidUnits[adUnitCode][bid.bidderCode].maxReached = true;
 
       fn.call(this, adUnitCode, bid);

package/modules/mytargetBidAdapter.js

@@ -0,0 +1,112 @@
+import { _map } from '../src/utils.js';
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+
+const BIDDER_CODE = 'mytarget';
+const BIDDER_URL = '//ad.mail.ru/hbid_prebid/';
+const DEFAULT_CURRENCY = 'RUB';
+const DEFAULT_TTL = 180;
+
+function buildPlacement(bidRequest) {
+  let { bidId, params } = bidRequest;
+  let { placementId, position, response, bidfloor } = params;
+  let placement = {
+    placementId,
+    id: bidId,
+    position: position || 0,
+    response: response || 0
+  };
+
+  if (typeof bidfloor !== 'undefined') {
+    placement.bidfloor = bidfloor;
+  }
+
+  return placement;
+}
+
+function getSiteName(referrer) {
+  let sitename = config.getConfig('mytarget.sitename');
+
+  if (!sitename) {
+    const parsed = document.createElement('a');
+    parsed.href = decodeURIComponent(referrer);
+    sitename = parsed.hostname;
+  }
+
+  return sitename;
+}
+
+function generateRandomId() {
+  return Math.random().toString(16).substring(2);
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+
+  isBidRequestValid: function(bid) {
+    return !!bid.params.placementId;
+  },
+
+  buildRequests: function(validBidRequests, bidderRequest) {
+    let referrer = '';
+
+    if (bidderRequest && bidderRequest.refererInfo) {
+      referrer = bidderRequest.refererInfo.referer;
+    }
+
+    const payload = {
+      places: _map(validBidRequests, buildPlacement),
+      site: {
+        sitename: getSiteName(referrer),
+        page: referrer
+      },
+      settings: {
+        currency: DEFAULT_CURRENCY,
+        windowSize: {
+          width: window.screen.width,
+          height: window.screen.height
+        }
+      }
+    };
+
+    return {
+      method: 'POST',
+      url: BIDDER_URL,
+      data: payload,
+    };
+  },
+
+  interpretResponse: function(serverResponse, bidRequest) {
+    let { body } = serverResponse;
+
+    if (body.bids) {
+      return _map(body.bids, (bid) => {
+        let bidResponse = {
+          requestId: bid.id,
+          cpm: bid.price,
+          width: bid.size.width,
+          height: bid.size.height,
+          ttl: bid.ttl || DEFAULT_TTL,
+          currency: bid.currency || DEFAULT_CURRENCY,
+          creativeId: bid.creativeId || generateRandomId(),
+          netRevenue: true,
+          meta: {
+            advertiserDomains: bid.adomain && bid.adomain.length > 0 ? bid.adomain : [],
+          }
+        }
+
+        if (bid.adm) {
+          bidResponse.ad = bid.adm;
+        } else {
+          bidResponse.adUrl = bid.displayUrl;
+        }
+
+        return bidResponse;
+      });
+    }
+
+    return [];
+  }
+}
+
+registerBidder(spec);