Back to Publisher API Reference
pbjs.onEvent(eventType, handler, id)
This routine allows the page (or module) to create a callback function that’s invoked when heading bidding events are fired.
Kind: static method of pbjs
Args: eventType, callbackFunction, id
Returns: none
See the getEvents function for the full list of eventTypes supported.
The optional id
parameter provides more finely-grained event
callback registration. This makes it possible to register callback
events for a specific item in the event context.
For example, bidWon
events will accept an id
for ad unit code.
bidWon
callbacks registered with an ad unit code id will be called
when a bid for that ad unit code wins the auction. Without an id
this method registers the callback for every bidWon
event.
Currently, bidWon
is the only event that accepts the id
parameter.
Example 1: Basic event logging
/* Log when ad units are added to Prebid */
pbjs.onEvent('addAdUnits', function() {
console.log('Ad units were added to Prebid.')
console.log(pbjs.adUnits);
});
/* Log when Prebid wins the ad server auction */
pbjs.onEvent('bidWon', function(data) {
console.log(data.bidderCode+ ' won the ad server auction for ad unit ' +data.adUnitCode+ ' at ' +data.cpm+ ' CPM');
});
Example 2: Dynamically modify the auction
var bidderFilter = function bidderFilter(adunits) {
// pub-specific logic to optimize bidders
// e.g. "remove any that haven't bid in the last 4 refreshes"
};
pbjs.onEvent('beforeRequestBids', bidderFilter);
Example 3: Log errors and render fails to your own endpoint
pbjs.onEvent('adRenderFailed', function () {
// pub-specific logic to call their own endpoint
});
pbjs.onEvent('auctionDebug', function () {
// pub-specific logic to call their own endpoint
});