prebid.js 5.19.0 → 5.20.3

package/modules/ventesBidAdapter.js

@@ -0,0 +1,370 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
+import {convertCamelToUnderscore, isStr, isArray, isNumber, isPlainObject, replaceAuctionPrice} from '../src/utils.js';
+import find from 'core-js-pure/features/array/find.js';
+import includes from 'core-js-pure/features/array/includes.js';
+
+const BID_METHOD = 'POST';
+const BIDDER_URL = 'http://13.234.201.146:8088/va/ad';
+const FIRST_PRICE = 1;
+const NET_REVENUE = true;
+const TTL = 10;
+const USER_PARAMS = ['age', 'externalUid', 'segments', 'gender', 'dnt', 'language'];
+const DEVICE_PARAMS = ['ua', 'geo', 'dnt', 'lmt', 'ip', 'ipv6', 'devicetype'];
+const APP_DEVICE_PARAMS = ['geo', 'device_id']; // appid is collected separately
+const DOMAIN_REGEX = new RegExp('//([^/]*)');
+
+function groupBy(values, key) {
+  const groups = values.reduce((acc, value) => {
+    const groupId = value[key];
+
+    if (!acc[groupId]) acc[groupId] = [];
+    acc[groupId].push(value);
+
+    return acc;
+  }, {});
+
+  return Object
+    .keys(groups)
+    .map(id => ({id, key, values: groups[id]}));
+}
+
+function validateMediaTypes(mediaTypes, allowedMediaTypes) {
+  if (!isPlainObject(mediaTypes)) return false;
+  if (!allowedMediaTypes.some(mediaType => mediaType in mediaTypes)) return false;
+
+  if (isBanner(mediaTypes)) {
+    if (!validateBanner(mediaTypes.banner)) return false;
+  }
+  return true;
+}
+
+function isBanner(mediaTypes) {
+  return isPlainObject(mediaTypes) && isPlainObject(mediaTypes.banner);
+}
+
+function validateBanner(banner) {
+  return isPlainObject(banner) &&
+    isArray(banner.sizes) &&
+    (banner.sizes.length > 0) &&
+    banner.sizes.every(validateMediaSizes);
+}
+
+function validateMediaSizes(mediaSize) {
+  return isArray(mediaSize) &&
+    (mediaSize.length === 2) &&
+    mediaSize.every(size => (isNumber(size) && size >= 0));
+}
+
+function hasUserInfo(bid) {
+  return !!bid.params.user;
+}
+
+function validateParameters(parameters, adUnit) {
+  if (!(parameters.placementId)) {
+    return false;
+  }
+  if (!(parameters.publisherId)) {
+    return false;
+  }
+
+  return true;
+}
+
+function extractSiteDomainFromURL(url) {
+  if (!url || !isStr(url)) return null;
+
+  const domain = url.match(DOMAIN_REGEX);
+
+  if (isArray(domain) && domain.length === 2) return domain[1];
+
+  return null;
+}
+
+function generateSiteFromAdUnitContext(bidRequests, adUnitContext) {
+  if (!adUnitContext || !adUnitContext.refererInfo) return null;
+
+  const domain = extractSiteDomainFromURL(adUnitContext.refererInfo.referer);
+  const publisherId = bidRequests[0].params.publisherId;
+
+  if (!domain) return null;
+
+  return {
+    page: adUnitContext.refererInfo.referer,
+    domain: domain,
+    name: domain,
+    publisher: {
+      id: publisherId
+    }
+  };
+}
+
+function validateServerRequest(serverRequest) {
+  return isPlainObject(serverRequest) &&
+    isPlainObject(serverRequest.data) &&
+    isArray(serverRequest.data.imp)
+}
+
+function createServerRequestFromAdUnits(adUnits, bidRequestId, adUnitContext) {
+  return {
+    method: BID_METHOD,
+    url: BIDDER_URL,
+    data: generateBidRequestsFromAdUnits(adUnits, bidRequestId, adUnitContext),
+    options: {
+      contentType: 'application/json',
+      withCredentials: false,
+    }
+  }
+}
+
+function generateBidRequestsFromAdUnits(bidRequests, bidRequestId, adUnitContext) {
+  const userObjBid = find(bidRequests, hasUserInfo);
+  let userObj = {};
+  if (userObjBid) {
+    Object.keys(userObjBid.params.user)
+      .filter(param => includes(USER_PARAMS, param))
+      .forEach((param) => {
+        let uparam = convertCamelToUnderscore(param);
+        if (param === 'segments' && isArray(userObjBid.params.user[param])) {
+          let segs = [];
+          userObjBid.params.user[param].forEach(val => {
+            if (isNumber(val)) {
+              segs.push({'id': val});
+            } else if (isPlainObject(val)) {
+              segs.push(val);
+            }
+          });
+          userObj[uparam] = segs;
+        } else if (param !== 'segments') {
+          userObj[uparam] = userObjBid.params.user[param];
+        }
+      });
+  }
+
+  const deviceObjBid = find(bidRequests, hasDeviceInfo);
+  let deviceObj;
+  if (deviceObjBid && deviceObjBid.params && deviceObjBid.params.device) {
+    deviceObj = {};
+    Object.keys(deviceObjBid.params.device)
+      .filter(param => includes(DEVICE_PARAMS, param))
+      .forEach(param => deviceObj[param] = deviceObjBid.params.device[param]);
+    if (!deviceObjBid.hasOwnProperty('ua')) {
+      deviceObj.ua = navigator.userAgent;
+    }
+    if (!deviceObjBid.hasOwnProperty('language')) {
+      deviceObj.language = navigator.language;
+    }
+  } else {
+    deviceObj = {};
+    deviceObj.ua = navigator.userAgent;
+    deviceObj.language = navigator.language;
+  }
+  const appDeviceObjBid = find(bidRequests, hasAppInfo);
+  let appIdObj;
+  if (appDeviceObjBid && appDeviceObjBid.params && appDeviceObjBid.params.app && appDeviceObjBid.params.app.id) {
+    Object.keys(appDeviceObjBid.params.app)
+      .filter(param => includes(APP_DEVICE_PARAMS, param))
+      .forEach(param => appDeviceObjBid[param] = appDeviceObjBid.params.app[param]);
+  }
+
+  const payload = {}
+  payload.id = bidRequestId
+  payload.at = FIRST_PRICE
+  payload.cur = ['USD']
+  payload.imp = bidRequests.reduce(generateImpressionsFromAdUnit, [])
+  payload.site = generateSiteFromAdUnitContext(bidRequests, adUnitContext)
+  payload.device = deviceObj
+  if (appDeviceObjBid && payload.site != null) {
+    payload.app = appIdObj;
+  }
+  payload.user = userObj
+  // payload.regs = getRegulationFromAdUnitContext(adUnitContext)
+  // payload.ext = generateBidRequestExtension()
+
+  return payload
+}
+
+function generateImpressionsFromAdUnit(acc, adUnit) {
+  const {bidId, mediaTypes, params} = adUnit;
+  const {placementId} = params;
+  const pmp = {};
+
+  if (placementId) pmp.deals = [{id: placementId}]
+
+  const imps = Object
+    .keys(mediaTypes)
+    .reduce((acc, mediaType) => {
+      const data = mediaTypes[mediaType];
+      const impId = `${bidId}`;
+
+      if (mediaType === 'banner') return acc.concat(generateBannerFromAdUnit(impId, data, params));
+    }, []);
+
+  return acc.concat(imps);
+}
+
+function generateBannerFromAdUnit(impId, data, params) {
+  const {position, placementId} = params;
+  const pos = position || 0;
+  const pmp = {};
+  const ext = {placementId};
+
+  if (placementId) pmp.deals = [{id: placementId}]
+
+  return data.sizes.map(([w, h]) => ({id: `${impId}`, banner: {format: [{w, h}], w, h, pos}, pmp, ext, tagid: placementId}));
+}
+
+function validateServerResponse(serverResponse) {
+  return isPlainObject(serverResponse) &&
+    isPlainObject(serverResponse.body) &&
+    isStr(serverResponse.body.cur) &&
+    isArray(serverResponse.body.seatbid);
+}
+
+function seatBidsToAds(seatBid, bidResponse, serverRequest) {
+  return seatBid.bid
+    .filter(bid => validateBids(bid))
+    .map(bid => generateAdFromBid(bid, bidResponse));
+}
+
+function validateBids(bid) {
+  if (!isPlainObject(bid)) return false;
+  if (!isStr(bid.impid)) return false;
+  if (!isStr(bid.crid)) return false;
+  if (!isNumber(bid.price)) return false;
+  if (!isNumber(bid.w)) return false;
+  if (!isNumber(bid.h)) return false;
+  if (!bid.adm) return false;
+  if (bid.adm) {
+    if (!isStr(bid.adm)) return false;
+  }
+  return true;
+}
+
+const VAST_REGEXP = /VAST\s+version/;
+
+function getMediaType(adm) {
+  const videoRegex = new RegExp(VAST_REGEXP);
+
+  if (videoRegex.test(adm)) {
+    return VIDEO;
+  }
+
+  const markup = safeJSONparse(adm.replace(/\\/g, ''));
+
+  if (markup && isPlainObject(markup.native)) {
+    return NATIVE;
+  }
+
+  return BANNER;
+}
+
+function safeJSONparse(...args) {
+  try {
+    return JSON.parse(...args);
+  } catch (_) {
+    return undefined;
+  }
+}
+
+function generateAdFromBid(bid, bidResponse) {
+  const mediaType = getMediaType(bid.adm);
+  const base = {
+    requestId: bid.impid,
+    cpm: bid.price,
+    currency: bidResponse.cur,
+    ttl: TTL,
+    creativeId: bid.crid,
+    mediaType: mediaType,
+    netRevenue: NET_REVENUE
+  };
+
+  if (bid.adomain) {
+    base.meta = { advertiserDomains: bid.adomain };
+  }
+
+  const size = getSizeFromBid(bid);
+  const creative = getCreativeFromBid(bid);
+
+  return {
+    ...base,
+    height: size.height,
+    width: size.width,
+    ad: creative.markup,
+    adUrl: creative.markupUrl,
+    // vastXml: isVideo && !isStr(creative.markupUrl) ? creative.markup : null,
+    // vastUrl: isVideo && isStr(creative.markupUrl) ? creative.markupUrl : null,
+    renderer: creative.renderer
+  };
+}
+
+function getSizeFromBid(bid) {
+  if (isNumber(bid.w) && isNumber(bid.h)) {
+    return { width: bid.w, height: bid.h };
+  }
+  return { width: null, height: null };
+}
+
+function getCreativeFromBid(bid) {
+  const shouldUseAdMarkup = !!bid.adm;
+  const price = bid.price;
+  return {
+    markup: shouldUseAdMarkup ? replaceAuctionPrice(bid.adm, price) : null,
+    markupUrl: !shouldUseAdMarkup ? replaceAuctionPrice(bid.nurl, price) : null
+  };
+}
+
+function hasDeviceInfo(bid) {
+  if (bid.params) {
+    return !!bid.params.device
+  }
+}
+
+function hasAppInfo(bid) {
+  if (bid.params) {
+    return !!bid.params.app
+  }
+}
+
+const venavenBidderSpec = {
+  code: 'ventes',
+  supportedMediaTypes: [BANNER],
+  isBidRequestValid(adUnit) {
+    const allowedBidderCodes = [this.code];
+
+    return isPlainObject(adUnit) &&
+      allowedBidderCodes.indexOf(adUnit.bidder) !== -1 &&
+      isStr(adUnit.adUnitCode) &&
+      isStr(adUnit.bidderRequestId) &&
+      isStr(adUnit.bidId) &&
+      validateMediaTypes(adUnit.mediaTypes, this.supportedMediaTypes) &&
+      validateParameters(adUnit.params, adUnit);
+  },
+  buildRequests(bidRequests, bidderRequest) {
+    if (!bidRequests) return null;
+
+    return groupBy(bidRequests, 'bidderRequestId').map(group => {
+      const bidRequestId = group.id;
+      const adUnits = groupBy(group.values, 'bidId').map((group) => {
+        const length = group.values.length;
+        return length > 0 && group.values[length - 1]
+      });
+
+      return createServerRequestFromAdUnits(adUnits, bidRequestId, bidderRequest)
+    });
+  },
+  interpretResponse(serverResponse, serverRequest) {
+    if (!validateServerRequest(serverRequest)) return [];
+    if (!validateServerResponse(serverResponse)) return [];
+
+    const bidResponse = serverResponse.body;
+
+    return bidResponse.seatbid
+      .filter(seatBid => isPlainObject(seatBid) && isArray(seatBid.bid))
+      .reduce((acc, seatBid) => acc.concat(seatBidsToAds(seatBid, bidResponse, serverRequest)), []);
+  }
+};
+
+registerBidder(venavenBidderSpec);
+
+export {venavenBidderSpec as spec};

package/modules/ventesBidAdapter.md

@@ -0,0 +1,94 @@
+---
+layout: bidder
+title: ventes
+description: Prebid ventes Bidder Adapter
+pbjs: false
+biddercode: ventes
+gdpr_supported: false
+usp_supported: false
+media_types: banner
+coppa_supported: false
+schain_supported: false
+dchain_supported: false
+prebid_member: false
+---
+
+### BidParams
+{: .table .table-bordered .table-striped }
+| Name            | Scope    | Description                                		 | Example                      		| Type          |
+|-----------------|----------|-----------------------------------------------------------|----------------------------------------------|---------------|
+| `placementId`   | required | Placement ID from Ventes Avenues 			 | `'VA-062-0013-0183'` 			| `string`	|
+| `publisherId`   | required | Publisher ID from Ventes Avenues 			 | `'VA-062'` 					| `string`	|
+| `user`          | optional | Object that specifies information about an external user. | `user: { age: 25, gender: 0, dnt: true}` 	| `object`	|
+| `app`           | required | Object containing mobile app parameters.  		 | `app : { id: 'app-id'}`			| `object`	|
+| `device`        | required | Object containing device info mandatory for mobile devices| `device : { ifa: 'device-id'}`	        | `object`	|
+
+#### User Object
+
+{: .table .table-bordered .table-striped }
+| Name              | Description 										| Example		| Type             	|
+|-------------------|-------------------------------------------------------------------------------------------|-----------------------|-----------------------|
+| `age`             | The age of the user.									| `35`			| `integer`		|
+| `externalUid`     | Specifies a string that corresponds to an external user ID for this user. 		| `'1234567890abcdefg'`	| `string` 		|
+| `segments`        | Specifies the segments to which the user belongs.						| `[1, 2]` 		| `Array<integer>`	|
+| `gender`          | Specifies the gender of the user.  Allowed values: Unknown: `0`; Male: `1`; Female: `2`	| `1` 			| `integer`		|
+| `dnt`             | Do not track flag.  Indicates if tracking cookies should be disabled for this auction	| `true`  	 	| `boolean`		|
+| `language`        | Two-letter ANSI code for this user's language.						| `EN`			| `string`		|
+
+
+### Ad Unit Setup for Banner through mobile devices
+```javascript
+var adUnits = [
+{
+  code: 'test-hb-ad-11111-1',
+  mediaTypes: {
+    banner: {  
+      sizes: [
+          [300, 250]
+      ]
+    }   
+  }, 
+  bids: [{
+    bidder: 'ventes',
+    params: {
+        placementId: 'VA-062-0013-0183',
+        publisherId: '5cebea3c9eea646c7b623d5e',
+        IABCategories: "['IAB1', 'IAB5']",
+        device:{
+          ip: '123.145.167.189',
+          ifa:"AEBE52E7-03EE-455A-B3C4-E57283966239",
+        },
+        app: {
+          id: "agltb3B1Yi1pbmNyDAsSA0FwcBiJkfIUDA",
+          name: "Yahoo Weather",
+          bundle: 'com.kiloo.subwaysurf',
+          storeurl: 'https://play.google.com/store/apps/details?id=com.kiloo.subwaysurf&hl=en',
+          domain: 'somoaudience.com',
+        } 
+    }
+  }]
+ }
+]
+```
+
+### Ad Unit Setup for Banner through Websites
+```javascript
+var adUnits = [
+{
+  code: 'test-hb-ad-11111-1',
+  mediaTypes: {
+    banner: {  
+      sizes: [
+          [300, 250]
+      ]
+    }   
+  }, 
+  bids: [{
+    bidder: 'ventes',
+    params: {
+        placementId: 'VA-002-0007-0799',
+        publisherId: '5cebea3c9eea646c7b623d5e',
+    }
+  }]
+ }
+]

package/modules/yahoosspBidAdapter.js

@@ -144,9 +144,9 @@ function getAdapterMode() {
 
 function getResponseFormat(bid) {
   const adm = bid.adm;
-  if (adm.includes('o2playerSettings') || adm.includes('YAHOO.VideoPlatform.VideoPlayer') || adm.includes('AdPlacement')) {
+  if (adm.indexOf('o2playerSettings') !== -1 || adm.indexOf('YAHOO.VideoPlatform.VideoPlayer') !== -1 || adm.indexOf('AdPlacement') !== -1) {
     return BANNER;
-  } else if (adm.includes('VAST')) {
+  } else if (adm.indexOf('VAST') !== -1) {
     return VIDEO;
   }
 };
@@ -188,23 +188,23 @@ function validateAppendObject(validationType, allowedKeys, inputObject, appendTo
   for (const objectKey in inputObject) {
     switch (validationType) {
       case 'string':
-        if (allowedKeys.includes(objectKey) && isStr(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isStr(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
       case 'number':
-        if (allowedKeys.includes(objectKey) && isNumber(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isNumber(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
 
       case 'array':
-        if (allowedKeys.includes(objectKey) && isArray(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isArray(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;
       case 'object':
-        if (allowedKeys.includes(objectKey) && isPlainObject(inputObject[objectKey])) {
+        if (allowedKeys.indexOf(objectKey) !== -1 && isPlainObject(inputObject[objectKey])) {
           outputObject[objectKey] = inputObject[objectKey];
         };
         break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "5.19.0",
+  "version": "5.20.3",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/auction.js

@@ -613,7 +613,8 @@ export const getPriceGranularity = (mediaType, bidReq) => {
  * @returns {function}
  */
 export const getPriceByGranularity = (granularity) => {
-  return (bid) => {
+  return (bid, bidReq) => {
+    granularity = granularity || getPriceGranularity(bid.mediaType, bidReq);
     if (granularity === CONSTANTS.GRANULARITY_OPTIONS.AUTO) {
       return bid.pbAg;
     } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.DENSE) {
@@ -646,14 +647,14 @@ export const getAdvertiserDomain = () => {
  * @param {BidRequest} bidReq
  * @returns {*}
  */
-export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
+export function getStandardBidderSettings(mediaType, bidderCode) {
   // factory for key value objs
   function createKeyVal(key, value) {
     return {
       key,
       val: (typeof value === 'function')
-        ? function (bidResponse) {
-          return value(bidResponse);
+        ? function (bidResponse, bidReq) {
+          return value(bidResponse, bidReq);
         }
         : function (bidResponse) {
           return getValue(bidResponse, value);
@@ -661,7 +662,6 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     };
   }
   const TARGETING_KEYS = CONSTANTS.TARGETING_KEYS;
-  const granularity = getPriceGranularity(mediaType, bidReq);
 
   let bidderSettings = $$PREBID_GLOBAL$$.bidderSettings;
   if (!bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD]) {
@@ -671,7 +671,7 @@ export function getStandardBidderSettings(mediaType, bidderCode, bidReq) {
     bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] = [
       createKeyVal(TARGETING_KEYS.BIDDER, 'bidderCode'),
       createKeyVal(TARGETING_KEYS.AD_ID, 'adId'),
-      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity(granularity)),
+      createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity()),
       createKeyVal(TARGETING_KEYS.SIZE, 'size'),
       createKeyVal(TARGETING_KEYS.DEAL, 'dealId'),
       createKeyVal(TARGETING_KEYS.SOURCE, 'source'),
@@ -716,12 +716,12 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   // 1) set the keys from "standard" setting or from prebid defaults
   if (bidderSettings) {
     // initialize default if not set
-    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode, bidReq);
-    setKeys(keyValues, standardSettings, custBidObj);
+    const standardSettings = getStandardBidderSettings(custBidObj.mediaType, bidderCode);
+    setKeys(keyValues, standardSettings, custBidObj, bidReq);
 
     // 2) set keys from specific bidder setting override if they exist
     if (bidderCode && bidderSettings[bidderCode] && bidderSettings[bidderCode][CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING]) {
-      setKeys(keyValues, bidderSettings[bidderCode], custBidObj);
+      setKeys(keyValues, bidderSettings[bidderCode], custBidObj, bidReq);
       custBidObj.sendStandardTargeting = bidderSettings[bidderCode].sendStandardTargeting;
     }
   }
@@ -734,7 +734,7 @@ export function getKeyValueTargetingPairs(bidderCode, custBidObj, bidReq) {
   return keyValues;
 }
 
-function setKeys(keyValues, bidderSettings, custBidObj) {
+function setKeys(keyValues, bidderSettings, custBidObj, bidReq) {
   var targeting = bidderSettings[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING];
   custBidObj.size = custBidObj.getSize();
 
@@ -748,7 +748,7 @@ function setKeys(keyValues, bidderSettings, custBidObj) {
 
     if (isFn(value)) {
       try {
-        value = value(custBidObj);
+        value = value(custBidObj, bidReq);
       } catch (e) {
         logError('bidmanager', 'ERROR', e);
       }

package/src/prebid.js

@@ -403,10 +403,23 @@ function emitAdRenderSucceeded({ doc, bid, id }) {
   events.emit(AD_RENDER_SUCCEEDED, data);
 }
 
+/**
+ * This function will check for presence of given node in given parent. If not present - will inject it.
+ * @param {Node} node node, whose existance is in question
+ * @param {Document} doc document element do look in
+ * @param {string} tagName tag name to look in
+ */
+function reinjectNodeIfRemoved(node, doc, tagName) {
+  const injectionNode = doc.querySelector(tagName);
+  if (!node.parentNode || node.parentNode !== injectionNode) {
+    insertElement(node, doc, tagName);
+  }
+}
+
 /**
  * This function will render the ad (based on params) in the given iframe document passed through.
  * Note that doc SHOULD NOT be the parent document page as we can't doc.write() asynchronously
- * @param  {HTMLDocument} doc document
+ * @param  {Document} doc document
  * @param  {string} id bid id to locate the ad
  * @alias module:pbjs.renderAd
  */
@@ -450,10 +463,13 @@ $$PREBID_GLOBAL$$.renderAd = hook('async', function (doc, id, options) {
           const {height, width, ad, mediaType, adUrl, renderer} = bid;
 
           const creativeComment = document.createComment(`Creative ${bid.creativeId} served by ${bid.bidder} Prebid.js Header Bidding`);
+          // It is important that the comment with metadata is injected before the ad is actually rendered,
+          // so the creativeId can be used by e.g. ad quality scanners to check against blocking rules
+          insertElement(creativeComment, doc, 'html');
 
           if (isRendererRequired(renderer)) {
             executeRenderer(renderer, bid);
-            insertElement(creativeComment, doc, 'html');
+            reinjectNodeIfRemoved(creativeComment, doc, 'html');
             emitAdRenderSucceeded({ doc, bid, id });
           } else if ((doc === document && !inIframe()) || mediaType === 'video') {
             const message = `Error trying to write ad. Ad render call ad id ${id} was prevented from writing to the main document.`;
@@ -472,7 +488,7 @@ $$PREBID_GLOBAL$$.renderAd = hook('async', function (doc, id, options) {
             doc.write(ad);
             doc.close();
             setRenderSize(doc, width, height);
-            insertElement(creativeComment, doc, 'html');
+            reinjectNodeIfRemoved(creativeComment, doc, 'html');
             callBurl(bid);
             emitAdRenderSucceeded({ doc, bid, id });
           } else if (adUrl) {
@@ -485,7 +501,7 @@ $$PREBID_GLOBAL$$.renderAd = hook('async', function (doc, id, options) {
 
             insertElement(iframe, doc, 'body');
             setRenderSize(doc, width, height);
-            insertElement(creativeComment, doc, 'html');
+            reinjectNodeIfRemoved(creativeComment, doc, 'html');
             callBurl(bid);
             emitAdRenderSucceeded({ doc, bid, id });
           } else {

package/src/targeting.js

@@ -416,7 +416,15 @@ export function newTargeting(auctionManager) {
     let bidsReceived = auctionManager.getBidsReceived();
 
     if (!config.getConfig('useBidCache')) {
+      // don't use bid cache (i.e. filter out bids not in the latest auction)
       bidsReceived = bidsReceived.filter(bid => latestAuctionForAdUnit[bid.adUnitCode] === bid.auctionId)
+    } else {
+      // if custom bid cache filter function exists, run for each bid from
+      // previous auctions. If it returns true, include bid in bid pool
+      const filterFunction = config.getConfig('bidCacheFilterFunction');
+      if (typeof filterFunction === 'function') {
+        bidsReceived = bidsReceived.filter(bid => latestAuctionForAdUnit[bid.adUnitCode] === bid.auctionId || !!filterFunction(bid))
+      }
     }
 
     bidsReceived = bidsReceived

package/test/fixtures/fixtures.js

@@ -1231,7 +1231,7 @@ export function getCurrencyRates() {
   };
 }
 
-export function createBidReceived({bidder, cpm, auctionId, responseTimestamp, adUnitCode, adId, status, ttl, requestId}) {
+export function createBidReceived({bidder, cpm, auctionId, responseTimestamp, adUnitCode, adId, status, ttl, requestId, mediaType}) {
   let bid = {
     'bidderCode': bidder,
     'width': '300',
@@ -1259,6 +1259,7 @@ export function createBidReceived({bidder, cpm, auctionId, responseTimestamp, ad
       'hb_pb': cpm,
       'foobar': '300x250'
     }),
+    'mediaType': mediaType,
     'netRevenue': true,
     'currency': 'USD',
     'ttl': (!ttl) ? 300 : ttl