Multibid Module: add new module to handle multiple bids from single bidder & update rubicon adapter #6404
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| /** | ||
| * This module adds Multibid support to prebid.js | ||
| * @module modules/multibid | ||
| */ | ||
|
|
||
| import {config} from '../../src/config.js'; | ||
| import {setupBeforeHookFnOnce, getHook} from '../../src/hook.js'; | ||
| import * as utils from '../../src/utils.js'; | ||
| import events from '../../src/events.js'; | ||
| import CONSTANTS from '../../src/constants.json'; | ||
| import {addBidderRequests} from '../../src/auction.js'; | ||
| import {getHighestCpmBidsFromBidPool, sortByDealAndPriceBucketOrCpm} from '../../src/targeting.js'; | ||
|
|
||
| const MODULE_NAME = 'multibid'; | ||
| let hasMultibid = false; | ||
| let multiConfig = {}; | ||
| let multibidUnits = {}; | ||
|
|
||
| // Storing this globally on init for easy reference to configuration | ||
| config.getConfig(MODULE_NAME, conf => { | ||
| if (!Array.isArray(conf.multibid) || !conf.multibid.length || !validateMultibid(conf.multibid)) return; | ||
|
|
||
| resetMultiConfig(); | ||
| hasMultibid = true; | ||
|
|
||
| conf.multibid.forEach(entry => { | ||
| multiConfig[entry.bidder] = { | ||
| maxbids: entry.maxbids, | ||
| prefix: entry.targetbiddercodeprefix | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| /** | ||
| * @summary validates multibid configuration entries | ||
| * @param {Object[]} multibid - example [{bidder: 'bidderA', maxbids: 2, prefix: 'bidA'}, {bidder: 'bidderB', maxbids: 2}] | ||
| * @return {Boolean} | ||
| */ | ||
| export function validateMultibid(conf) { | ||
| let check = true; | ||
| let duplicate = conf.filter(entry => { | ||
| // Check if entry.bidder is not defined or typeof string, filter entry and reset configuration | ||
| if (!entry.bidder || typeof entry.bidder !== 'string') { | ||
| utils.logWarn('Filtering multibid entry due to missing required bidder property.'); | ||
| check = false; | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| }).map(entry => { | ||
| // Check if entry.maxbids is not defined, not typeof number, or less than 1, set maxbids to 1 and reset configuration | ||
| // Check if entry.maxbids is greater than 9, set maxbids to 9 and reset configuration | ||
| if (typeof entry.maxbids !== 'number' || entry.maxbids < 1 || entry.maxbids > 9) { | ||
| entry.maxbids = (typeof entry.maxbids !== 'number' || entry.maxbids < 1) ? 1 : 9; | ||
| check = false; | ||
| } | ||
|
|
||
| return entry; | ||
| }); | ||
|
|
||
| if (!check) config.setConfig({multibid: duplicate}); | ||
|
|
||
| return check; | ||
| } | ||
|
|
||
| /** | ||
| * @summary addBidderRequests before hook | ||
| * @param {Function} fn reference to original function (used by hook logic) | ||
| * @param {Object[]} array containing copy of each bidderRequest object | ||
| */ | ||
| export function adjustBidderRequestsHook(fn, bidderRequests) { | ||
| bidderRequests.map(bidRequest => { | ||
| // Loop through bidderRequests and check if bidderCode exists in multiconfig | ||
| // If true, add bidderRequest.bidLimit to bidder request | ||
| if (multiConfig[bidRequest.bidderCode]) { | ||
| bidRequest.bidLimit = multiConfig[bidRequest.bidderCode].maxbids | ||
| } | ||
| return bidRequest; | ||
| }) | ||
|
|
||
| fn.call(this, bidderRequests); | ||
| } | ||
|
|
||
| /** | ||
| * @summary addBidResponse before hook | ||
| * @param {Function} fn reference to original function (used by hook logic) | ||
| * @param {String} ad unit code for bid | ||
| * @param {Object} bid object | ||
| */ | ||
| export function addBidResponseHook(fn, adUnitCode, bid) { | ||
| let floor = utils.deepAccess(bid, 'floorData.floorValue'); | ||
|
|
||
| if (!config.getConfig('multibid')) resetMultiConfig(); | ||
| // Checks if multiconfig exists and bid bidderCode exists within config | ||
| if (hasMultibid && multiConfig[bid.bidderCode]) { | ||
| // Set property multibidPrefix on 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 (utils.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)) { | ||
| bid.originalRequestId = bid.requestId; | ||
|
|
||
| bid.requestId = utils.getUniqueIdentifierStr(); | ||
| multibidUnits[adUnitCode][bid.bidderCode].ads.push(bid); | ||
|
|
||
| let length = multibidUnits[adUnitCode][bid.bidderCode].ads.length; | ||
|
|
||
| if (multiConfig[bid.bidderCode].prefix) bid.targetingBidder = multiConfig[bid.bidderCode].prefix + length; | ||
| if (length === multiConfig[bid.bidderCode].maxbids) multibidUnits[adUnitCode][bid.bidderCode].maxReached = true; | ||
|
|
||
| fn.call(this, adUnitCode, bid); | ||
| } else { | ||
| utils.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 (utils.deepAccess(bid, 'floorData.floorValue')) utils.deepSetValue(multibidUnits, `${adUnitCode}.${bid.bidderCode}`, {floor: utils.deepAccess(bid, 'floorData.floorValue')}); | ||
|
|
||
| utils.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); | ||
| } | ||
| } else { | ||
| fn.call(this, adUnitCode, bid); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A descending sort function that will sort the list of objects based on the following: | ||
| * - bids without dynamic aliases are sorted before bids with dynamic aliases | ||
| */ | ||
| export function sortByMultibid(a, b) { | ||
| if (a.bidder !== a.bidderCode && b.bidder === b.bidderCode) { | ||
| return 1; | ||
| } | ||
|
|
||
| if (a.bidder === a.bidderCode && b.bidder !== b.bidderCode) { | ||
| return -1; | ||
| } | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| /** | ||
| * @summary getHighestCpmBidsFromBidPool before hook | ||
| * @param {Function} fn reference to original function (used by hook logic) | ||
| * @param {Object[]} array of objects containing all bids from bid pool | ||
| * @param {Function} function to reduce to only highest cpm value for each bidderCode | ||
| * @param {Number} adUnit bidder targeting limit, default set to 0 | ||
| * @param {Boolean} default set to false, this hook modifies targeting and sets to true | ||
| */ | ||
| export function targetBidPoolHook(fn, bidsReceived, highestCpmCallback, adUnitBidLimit = 0, hasModified = false) { | ||
| if (!config.getConfig('multibid')) resetMultiConfig(); | ||
| if (hasMultibid) { | ||
| const dealPrioritization = config.getConfig('sendBidsControl.dealPrioritization'); | ||
| let modifiedBids = []; | ||
| let buckets = utils.groupBy(bidsReceived, 'adUnitCode'); | ||
| let bids = [].concat.apply([], Object.keys(buckets).reduce((result, slotId) => { | ||
| let bucketBids = []; | ||
| // Get bids and group by property originalBidder | ||
| let bidsByBidderName = utils.groupBy(buckets[slotId], 'originalBidder'); | ||
| let adjustedBids = [].concat.apply([], Object.keys(bidsByBidderName).map(key => { | ||
| // Reset all bidderCodes to original bidder values and sort by CPM | ||
| return bidsByBidderName[key].sort((bidA, bidB) => { | ||
| if (bidA.originalBidder && bidA.originalBidder !== bidA.bidderCode) bidA.bidderCode = bidA.originalBidder; | ||
| if (bidA.originalBidder && bidB.originalBidder !== bidB.bidderCode) bidB.bidderCode = bidB.originalBidder; | ||
| return bidA.cpm > bidB.cpm ? -1 : (bidA.cpm < bidB.cpm ? 1 : 0); | ||
| }).map((bid, index) => { | ||
| // For each bid (post CPM sort), set dynamic bidderCode using prefix and index if less than maxbid amount | ||
| if (utils.deepAccess(multiConfig, `${bid.bidderCode}.prefix`) && index !== 0 && index < multiConfig[bid.bidderCode].maxbids) { | ||
| bid.bidderCode = multiConfig[bid.bidderCode].prefix + (index + 1); | ||
| } | ||
|
|
||
| return bid | ||
| }) | ||
| })); | ||
| // Get adjustedBids by bidderCode and reduce using highestCpmCallback | ||
| let bidsByBidderCode = utils.groupBy(adjustedBids, 'bidderCode'); | ||
| Object.keys(bidsByBidderCode).forEach(key => bucketBids.push(bidsByBidderCode[key].reduce(highestCpmCallback))); | ||
| // if adUnitBidLimit is set, pass top N number bids | ||
| if (adUnitBidLimit > 0) { | ||
| bucketBids = dealPrioritization ? bucketBids.sort(sortByDealAndPriceBucketOrCpm(true)) : bucketBids.sort((a, b) => b.cpm - a.cpm); | ||
| bucketBids.sort(sortByMultibid); | ||
| modifiedBids.push(...bucketBids.slice(0, adUnitBidLimit)); | ||
| } else { | ||
| modifiedBids.push(...bucketBids); | ||
| } | ||
|
|
||
| return [].concat.apply([], modifiedBids); | ||
| }, [])); | ||
|
|
||
| fn.call(this, bids, highestCpmCallback, adUnitBidLimit, true); | ||
| } else { | ||
| fn.call(this, bidsReceived, highestCpmCallback, adUnitBidLimit); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Resets globally stored multibid configuration | ||
| */ | ||
| export const resetMultiConfig = () => { hasMultibid = false; multiConfig = {}; }; | ||
|
|
||
| /** | ||
| * Resets globally stored multibid ad unit bids | ||
| */ | ||
| export const resetMultibidUnits = () => multibidUnits = {}; | ||
|
|
||
| /** | ||
| * Set up hooks on init | ||
| */ | ||
| function init() { | ||
| events.on(CONSTANTS.EVENTS.AUCTION_INIT, resetMultibidUnits); | ||
| setupBeforeHookFnOnce(addBidderRequests, adjustBidderRequestsHook); | ||
| getHook('addBidResponse').before(addBidResponseHook, 3); | ||
| setupBeforeHookFnOnce(getHighestCpmBidsFromBidPool, targetBidPoolHook); | ||
| } | ||
|
|
||
| init(); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Overview | ||
|
|
||
| Module Name: multibid | ||
|
|
||
| Purpose: To expand the number of key value pairs going to the ad server in the normal Prebid way by establishing the concept of a "dynamic alias" -- a bidder code that exists only on the response, not in the adunit. | ||
|
|
||
|
|
||
| # Description | ||
| Allowing a single bidder to multi-bid into an auction has several use cases: | ||
|
|
||
| 1. allows a bidder to provide both outstream and banner | ||
| 2. supports the video VAST fallback scenario | ||
| 3. allows one bid to be blocked in the ad server and the second one still considered | ||
| 4. add extra high-value bids to the cache for future refreshes | ||
|
|
||
|
|
||
| # Example of using config | ||
| ``` | ||
| pbjs.setConfig({ | ||
| multibid: [{ | ||
| bidder: "bidderA", | ||
| maxbids: 3, | ||
| targetbiddercodeprefix: "bidA" | ||
|
There was a problem hiding this comment. Please ensure correct formatting is listed here (in case anyone tries to use these examples); it seems the code uses There was a problem hiding this comment. I'll fix this. I originally coded it all lowercased, and then updated to camelCase. Must have missed this one! |
||
| },{ | ||
| bidder: "bidderB", | ||
| maxbids: 3, | ||
| targetbiddercodeprefix: "bidB" | ||
| },{ | ||
| bidder: "bidderC", | ||
| maxbids: 3 | ||
| }] | ||
| }); | ||
| ``` | ||
|
|
||
| # Please Note: | ||
| - | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't the
floor < bid.cpmbe a<=, so that a bid can equal the floor and pass?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep I'll modify this