diff --git a/modules/adpod.js b/modules/adpod.js index c678c854dc1..875809b8df5 100644 --- a/modules/adpod.js +++ b/modules/adpod.js @@ -13,7 +13,7 @@ */ import * as utils from '../src/utils'; -import { addBidToAuction, doCallbacksIfTimedout, AUCTION_IN_PROGRESS, callPrebidCache } from '../src/auction'; +import { addBidToAuction, doCallbacksIfTimedout, AUCTION_IN_PROGRESS, callPrebidCache, getPriceByGranularity, getPriceGranularity } from '../src/auction'; import { checkAdUnitSetup } from '../src/prebid'; import { checkVideoBidSetup } from '../src/video'; import { setupBeforeHookFnOnce, module } from '../src/hook'; @@ -23,6 +23,7 @@ import { ADPOD } from '../src/mediaTypes'; import Set from 'core-js/library/fn/set'; import find from 'core-js/library/fn/array/find'; import { auctionManager } from '../src/auctionManager'; +import CONSTANTS from '../src/constants.json'; const from = require('core-js/library/fn/array/from'); @@ -119,7 +120,9 @@ function createDispatcher(timeoutDuration) { function attachPriceIndustryDurationKeyToBid(bid, brandCategoryExclusion) { let initialCacheKey = bidCacheRegistry.getInitialCacheKey(bid); let duration = utils.deepAccess(bid, 'video.durationBucket'); - let cpmFixed = bid.cpm.toFixed(2); + const granularity = getPriceGranularity(bid.mediaType); + let cpmFixed = getPriceByGranularity(granularity)(bid); + let pcd; if (brandCategoryExclusion) { @@ -424,10 +427,10 @@ export function callPrebidCacheAfterAuction(bids, callback) { * @param {Object} bid */ export function sortByPricePerSecond(a, b) { - if (a.cpm / a.video.durationBucket < b.cpm / b.video.durationBucket) { + if (a.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket < b.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) { return 1; } - if (a.cpm / a.video.durationBucket > b.cpm / b.video.durationBucket) { + if (a.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket > b.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) { return -1; } return 0; diff --git a/src/auction.js b/src/auction.js index a1e8c33adfb..fd29aec4b16 100644 --- a/src/auction.js +++ b/src/auction.js @@ -510,6 +510,41 @@ function setupBidTargeting(bidObject, bidderRequest) { bidObject.adserverTargeting = Object.assign(bidObject.adserverTargeting || {}, keyValues); } +/** + * This function returns the price granularity defined. It can be either publisher defined or default value + * @param {string} mediaType + * @returns {string} granularity + */ +export const getPriceGranularity = (mediaType) => { + // Use the config value 'mediaTypeGranularity' if it has been set for mediaType, else use 'priceGranularity' + const mediaTypeGranularity = config.getConfig(`mediaTypePriceGranularity.${mediaType}`); + const granularity = (typeof mediaType === 'string' && mediaTypeGranularity) ? ((typeof mediaTypeGranularity === 'string') ? mediaTypeGranularity : 'custom') : config.getConfig('priceGranularity'); + return granularity; +} + +/** + * This function returns a function to get bid price by price granularity + * @param {string} granularity + * @returns {function} + */ +export const getPriceByGranularity = (granularity) => { + return (bid) => { + if (granularity === CONSTANTS.GRANULARITY_OPTIONS.AUTO) { + return bid.pbAg; + } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.DENSE) { + return bid.pbDg; + } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.LOW) { + return bid.pbLg; + } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.MEDIUM) { + return bid.pbMg; + } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.HIGH) { + return bid.pbHg; + } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.CUSTOM) { + return bid.pbCg; + } + } +} + /** * @param {string} mediaType * @param {string} bidderCode @@ -530,9 +565,7 @@ export function getStandardBidderSettings(mediaType, bidderCode) { }; } const TARGETING_KEYS = CONSTANTS.TARGETING_KEYS; - // Use the config value 'mediaTypeGranularity' if it has been set for mediaType, else use 'priceGranularity' - const mediaTypeGranularity = config.getConfig(`mediaTypePriceGranularity.${mediaType}`); - const granularity = (typeof mediaType === 'string' && mediaTypeGranularity) ? ((typeof mediaTypeGranularity === 'string') ? mediaTypeGranularity : 'custom') : config.getConfig('priceGranularity'); + const granularity = getPriceGranularity(mediaType); let bidderSettings = $$PREBID_GLOBAL$$.bidderSettings; if (!bidderSettings[CONSTANTS.JSON_MAPPING.BD_SETTING_STANDARD]) { @@ -542,21 +575,7 @@ export function getStandardBidderSettings(mediaType, bidderCode) { 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, function(bidResponse) { - if (granularity === CONSTANTS.GRANULARITY_OPTIONS.AUTO) { - return bidResponse.pbAg; - } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.DENSE) { - return bidResponse.pbDg; - } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.LOW) { - return bidResponse.pbLg; - } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.MEDIUM) { - return bidResponse.pbMg; - } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.HIGH) { - return bidResponse.pbHg; - } else if (granularity === CONSTANTS.GRANULARITY_OPTIONS.CUSTOM) { - return bidResponse.pbCg; - } - }), + createKeyVal(TARGETING_KEYS.PRICE_BUCKET, getPriceByGranularity(granularity)), createKeyVal(TARGETING_KEYS.SIZE, 'size'), createKeyVal(TARGETING_KEYS.DEAL, 'dealId'), createKeyVal(TARGETING_KEYS.SOURCE, 'source'), diff --git a/test/spec/modules/adpod_spec.js b/test/spec/modules/adpod_spec.js index 507a3be9f14..8b7701c5631 100644 --- a/test/spec/modules/adpod_spec.js +++ b/test/spec/modules/adpod_spec.js @@ -99,6 +99,10 @@ describe('adpod.js', function () { auctionId: 'no_defer_123', mediaType: 'video', cpm: 5, + pbMg: '5.00', + adserverTargeting: { + hb_pb: '5.00' + }, meta: { adServerCatId: 'test' }, @@ -114,6 +118,10 @@ describe('adpod.js', function () { auctionId: 'no_defer_123', mediaType: 'video', cpm: 12, + pbMg: '12.00', + adserverTargeting: { + hb_pb: '12.00' + }, meta: { adServerCatId: 'value' }, @@ -175,6 +183,10 @@ describe('adpod.js', function () { auctionId: 'full_abc123', mediaType: 'video', cpm: 10, + pbMg: '10.00', + adserverTargeting: { + hb_pb: '10.00' + }, meta: { adServerCatId: 'airline' }, @@ -189,6 +201,10 @@ describe('adpod.js', function () { auctionId: 'full_abc123', mediaType: 'video', cpm: 15, + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00' + }, meta: { adServerCatId: 'airline' }, @@ -247,6 +263,10 @@ describe('adpod.js', function () { auctionId: 'timer_abc234', mediaType: 'video', cpm: 15, + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00' + }, meta: { adServerCatId: 'airline' }, @@ -300,6 +320,10 @@ describe('adpod.js', function () { auctionId: 'multi_call_abc345', mediaType: 'video', cpm: 15, + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00' + }, meta: { adServerCatId: 'airline' }, @@ -314,6 +338,10 @@ describe('adpod.js', function () { auctionId: 'multi_call_abc345', mediaType: 'video', cpm: 15, + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00' + }, meta: { adServerCatId: 'news' }, @@ -328,6 +356,10 @@ describe('adpod.js', function () { auctionId: 'multi_call_abc345', mediaType: 'video', cpm: 10, + pbMg: '10.00', + adserverTargeting: { + hb_pb: '10.00' + }, meta: { adServerCatId: 'sports' }, @@ -395,6 +427,10 @@ describe('adpod.js', function () { auctionId: 'no_category_abc345', mediaType: 'video', cpm: 10, + pbMg: '10.00', + adserverTargeting: { + hb_pb: '10.00' + }, meta: { adServerCatId: undefined }, @@ -409,6 +445,10 @@ describe('adpod.js', function () { auctionId: 'no_category_abc345', mediaType: 'video', cpm: 15, + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00' + }, meta: { adServerCatId: undefined }, @@ -525,6 +565,10 @@ describe('adpod.js', function () { auctionId: 'duplicate_def123', mediaType: 'video', cpm: 5, + pbMg: '5.00', + adserverTargeting: { + hb_pb: '5.00' + }, meta: { adServerCatId: 'tech' }, @@ -539,6 +583,10 @@ describe('adpod.js', function () { auctionId: 'duplicate_def123', mediaType: 'video', cpm: 5, + pbMg: '5.00', + adserverTargeting: { + hb_pb: '5.00' + }, meta: { adServerCatId: 'tech' }, @@ -642,6 +690,82 @@ describe('adpod.js', function () { expect(logWarnStub.calledOnce).to.equal(true); expect(auctionBids.length).to.equal(0); }); + + it('should use bid.adserverTargeting.hb_pb when custom price granularity is configured', function() { + storeStub.callsFake(fakeStoreFn); + + const customConfigObject = { + 'buckets': [{ + 'precision': 2, // default is 2 if omitted - means 2.1234 rounded to 2 decimal places = 2.12 + 'min': 0, + 'max': 5, + 'increment': 0.01 // from $0 to $5, 1-cent increments + }, + { + 'precision': 2, + 'min': 5, + 'max': 8, + 'increment': 0.05 // from $5 to $8, round down to the previous 5-cent increment + }, + { + 'precision': 2, + 'min': 8, + 'max': 40, + 'increment': 0.5 // from $8 to $40, round down to the previous 50-cent increment + }] + }; + config.setConfig({ + priceGranularity: customConfigObject, + adpod: { + brandCategoryExclusion: true + } + }); + + let bidResponse1 = { + adId: 'cat_ad1', + auctionId: 'test_category_abc345', + mediaType: 'video', + cpm: 15, + pbAg: '15.00', + pbCg: '15.00', + pbDg: '15.00', + pbHg: '15.00', + pbLg: '5.00', + pbMg: '15.00', + adserverTargeting: { + hb_pb: '15.00', + }, + meta: { + adServerCatId: 'test' + }, + video: { + context: ADPOD, + durationSeconds: 15, + durationBucket: 15 + } + }; + + let bidderRequest = { + adUnitCode: 'adpod_5', + auctionId: 'test_category_abc345', + mediaTypes: { + video: { + context: ADPOD, + playerSize: [300, 300], + adPodDurationSec: 45, + durationRangeSec: [15, 30], + requireExactDuration: false + } + } + }; + + callPrebidCacheHook(callbackFn, auctionInstance, bidResponse1, afterBidAddedSpy, bidderRequest); + + expect(callbackResult).to.be.null; + expect(afterBidAddedSpy.calledOnce).to.equal(true); + expect(storeStub.called).to.equal(false); + expect(auctionBids.length).to.equal(1); + }); }); describe('checkAdUnitSetupHook', function () { @@ -1021,53 +1145,83 @@ describe('adpod.js', function () { it('should sort bids array', function() { let bids = [{ cpm: 10.12345, + adserverTargeting: { + hb_pb: '10.00', + }, video: { durationBucket: 15 } }, { cpm: 15, + adserverTargeting: { + hb_pb: '15.00', + }, video: { durationBucket: 15 } }, { cpm: 15.00, + adserverTargeting: { + hb_pb: '15.00', + }, video: { durationBucket: 30 } }, { cpm: 5.45, + adserverTargeting: { + hb_pb: '5.00', + }, video: { durationBucket: 5 } }, { cpm: 20.1234567, + adserverTargeting: { + hb_pb: '20.10', + }, video: { durationBucket: 60 } }] bids.sort(sortByPricePerSecond); let sortedBids = [{ - cpm: 5.45, + cpm: 15, + adserverTargeting: { + hb_pb: '15.00', + }, video: { - durationBucket: 5 + durationBucket: 15 } }, { - cpm: 15, + cpm: 5.45, + adserverTargeting: { + hb_pb: '5.00', + }, video: { - durationBucket: 15 + durationBucket: 5 } }, { cpm: 10.12345, + adserverTargeting: { + hb_pb: '10.00', + }, video: { durationBucket: 15 } }, { cpm: 15.00, + adserverTargeting: { + hb_pb: '15.00', + }, video: { durationBucket: 30 } }, { cpm: 20.1234567, + adserverTargeting: { + hb_pb: '20.10', + }, video: { durationBucket: 60 } diff --git a/test/spec/modules/dfpAdServerVideo_spec.js b/test/spec/modules/dfpAdServerVideo_spec.js index 62b0a752f50..bd417189aef 100644 --- a/test/spec/modules/dfpAdServerVideo_spec.js +++ b/test/spec/modules/dfpAdServerVideo_spec.js @@ -402,9 +402,9 @@ describe('The DFP video support module', function () { }); function getBids() { let bids = [ - createBid(10, 'adUnitCode-1', 15, '10.00_15s', '123', '395'), - createBid(15, 'adUnitCode-1', 15, '15.00_15s', '123', '395'), - createBid(25, 'adUnitCode-1', 30, '15.00_30s', '123', '406'), + createBid(10, 'adUnitCode-1', 15, '10.00_15s', '123', '395', '10.00'), + createBid(15, 'adUnitCode-1', 15, '15.00_15s', '123', '395', '15.00'), + createBid(25, 'adUnitCode-1', 30, '15.00_30s', '123', '406', '25.00'), ]; bids.forEach((bid) => { delete bid.meta; @@ -480,13 +480,13 @@ describe('The DFP video support module', function () { function getBidsReceived() { return [ - createBid(10, 'adUnitCode-1', 15, '10.00_395_15s', '123', '395'), - createBid(15, 'adUnitCode-1', 15, '15.00_395_15s', '123', '395'), - createBid(25, 'adUnitCode-1', 30, '15.00_406_30s', '123', '406'), + createBid(10, 'adUnitCode-1', 15, '10.00_395_15s', '123', '395', '10.00'), + createBid(15, 'adUnitCode-1', 15, '15.00_395_15s', '123', '395', '15.00'), + createBid(25, 'adUnitCode-1', 30, '15.00_406_30s', '123', '406', '25.00'), ] } -function createBid(cpm, adUnitCode, durationBucket, priceIndustryDuration, uuid, label) { +function createBid(cpm, adUnitCode, durationBucket, priceIndustryDuration, uuid, label, hbpb) { return { 'bidderCode': 'appnexus', 'width': 640, @@ -526,7 +526,7 @@ function createBid(cpm, adUnitCode, durationBucket, priceIndustryDuration, uuid, 'adserverTargeting': { 'hb_bidder': 'appnexus', 'hb_adid': '28f24ced14586c', - 'hb_pb': '5.00', + 'hb_pb': hbpb, 'hb_size': '640x360', 'hb_source': 'client', 'hb_format': 'video',