Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding AdButler Adapter #707

Merged
merged 4 commits into from
Oct 24, 2016
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions adapters.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[
"aardvark",
"adblade",
"adbutler",
"adequant",
"adform",
"admedia",
Expand Down
148 changes: 148 additions & 0 deletions src/adapters/adbutler.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
/**
* @overview AdButler Prebid.js adapter.
* @author dkharton
*/

'use strict';

var utils = require('../utils.js');
var adloader = require('../adloader.js');
var bidmanager = require('../bidmanager.js');
var bidfactory = require('../bidfactory.js');

var AdButlerAdapter = function AdButlerAdapter() {

function _callBids(params) {

var bids = params.bids || [],
callbackData = {},
zoneCount = {},
pageID = Math.floor(Math.random() * 10e6);

//Build and send bid requests
for (var i = 0; i < bids.length; i++) {
var bid = bids[i],
zoneID = utils.getBidIdParamater('zoneID', bid.params),
callbackID;

if(!(zoneID in zoneCount)){
zoneCount[zoneID] = 0;
}

//build callbackID to get placementCode later
callbackID = zoneID + '_' +zoneCount[zoneID];

callbackData[callbackID] = {};
callbackData[callbackID].bidId = bid.bidId;

var adRequest = buildRequest(bid,zoneCount[zoneID],pageID);
zoneCount[zoneID]++;

adloader.loadScript(adRequest);
}

//Define callback function for bid responses
$$PREBID_GLOBAL$$.adbutlerCB = function(aBResponseObject){

var bidResponse = {},
callbackID = aBResponseObject.zone_id+'_'+aBResponseObject.place,
width = parseInt(aBResponseObject.width),
height = parseInt(aBResponseObject.height),
isCorrectSize = false,
isCorrectCPM = true,
CPM,minCPM,maxCPM,
bidObj = utils.getBidRequest(callbackData[callbackID].bidId);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can cause another TypeError which occasionally fails unit tests. Checking callbackData[callbackID] before accessing bidId will fix this. Something like bidObj = callbackData[callbackID] ? utils.getBidRequest(callbackData[callbackID].bidId) : null; will work as a one-liner but feel free to do the check however you prefer


if (bidObj) {

if(aBResponseObject.status === 'SUCCESS'){
CPM = aBResponseObject.cpm;
minCPM = utils.getBidIdParamater('minCPM',bidObj.params);
maxCPM = utils.getBidIdParamater('maxCPM',bidObj.params);

//Ensure response CPM is within the given bounds
if(minCPM !== '' && CPM < parseFloat(minCPM)){
isCorrectCPM = false;
}
if(maxCPM !== '' && CPM > parseFloat(maxCPM)){
isCorrectCPM = false;
}

//Ensure that response ad matches one of the placement sizes.
utils._each(bidObj.sizes,function(size){
if(width === size[0] && height === size[1]){
isCorrectSize = true;
}
});

if(isCorrectCPM && isCorrectSize){

bidResponse = bidfactory.createBid(1);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

createBid can take bidObj as a second parameter here to set the response ID to the request ID. See #509 for background info

bidResponse.bidderCode = 'adbutler';
bidResponse.cpm = CPM;
bidResponse.width = width;
bidResponse.height = height;
bidResponse.ad = aBResponseObject.ad_code;
bidResponse.ad += addTrackingPixels(aBResponseObject.tracking_pixels);

} else {

bidResponse = bidfactory.createBid(2);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pass bidObj as second param to createBid

bidResponse.bidderCode = 'adbutler';

}
} else {

bidResponse = bidfactory.createBid(2);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pass bidObj as second param to createBid

bidResponse.bidderCode = 'adbutler';

}

bidmanager.addBidResponse(bidObj.placementCode, bidResponse);

}
};
}

function buildRequest(bid,adIndex,pageID){
var accountID = utils.getBidIdParamater('accountID', bid.params);
var zoneID = utils.getBidIdParamater('zoneID', bid.params);
var keyword = utils.getBidIdParamater('keyword', bid.params);

var requestURI = location.protocol + '//servedbyadbutler.com/adserve/;type=hbr;';
requestURI += 'ID='+encodeURIComponent(accountID)+';';
requestURI += 'setID='+encodeURIComponent(zoneID)+';';
requestURI += 'pid='+encodeURIComponent(pageID)+';';
requestURI += 'place='+encodeURIComponent(adIndex)+';';

//append the keyword for targeting if one was passed in
if(keyword !== ''){
requestURI +='kw='+encodeURIComponent(keyword)+';';
}
requestURI += 'jsonpfunc=$$PREBID_GLOBAL$$.adbutlerCB;';
requestURI += 'click=CLICK_MACRO_PLACEHOLDER';

return requestURI;
}

function addTrackingPixels(trackingPixels){
var trackingPixelMarkup = '';
utils._each(trackingPixels,function(pixelURL){

var trackingPixel = '<img height="0" width="0" border="0" style="display:none;" src="';
trackingPixel += pixelURL;
trackingPixel += '">';

trackingPixelMarkup += trackingPixel;
});
return trackingPixelMarkup;
}

// Export the callBids function, so that prebid.js can execute this function
// when the page asks to send out bid requests.
return {
callBids: _callBids
};
};

module.exports = AdButlerAdapter;
Loading