Quantcast adaptor

adapters.json

@@ -32,6 +32,7 @@
     "pubmatic",
     "pulsepoint",
     "pulsepointLite",
+    "quantcast",
     "rhythmone",
     "rubicon",
     "smartyads",

integrationExamples/gpt/pbjs_example_gpt.html

@@ -250,6 +250,13 @@
                             zone: '2eb6bd58-865c-47ce-af7f-a918108c3fd2' // REQUIRED zone oid
                         }
                     },
+                    {
+                        bidder: 'quantcast',
+                        params: {
+                            publisherId: 'test-publisher', // REQUIRED Publisher Id provided by Quantcast
+                            battr : [1,2] // OPTIONAL - Array of Blocked creative attributes as per OpenRTB Spec List 5.3
+                        }
+                    },
                     {
                         bidder: 'atomx',
                         params: {
@@ -363,6 +370,13 @@
                             pId: 123456 // REQUIRED Placement Id
                         }
                     },
+                    {
+                        bidder: 'quantcast',
+                        params: {
+                            publisherId: 'test-publisher', // REQUIRED Publisher Id provided by Quantcast
+                            battr : [1,2] // OPTIONAL - Array of Blocked creative attributes as per OpenRTB Spec List 5.3
+                        }
+                    },
                     {
                         bidder: 'huddledmasses',
                         params: {

src/adapters/quantcast.js

@@ -0,0 +1,135 @@
+const utils = require('../utils.js');
+const bidfactory = require('../bidfactory.js');
+const bidmanager = require('../bidmanager.js');
+const ajax = require('../ajax.js');
+const CONSTANTS = require('../constants.json');
+const QUANTCAST_CALLBACK_URL = 'http://global.qc.rtb.quantserve.com:8080/qchb';
+
+var QuantcastAdapter = function QuantcastAdapter() {
+
+  const BIDDER_CODE = 'quantcast';
+
+  const DEFAULT_BID_FLOOR = 0.0000000001;
+  let bidRequests = {};
+
+  let returnEmptyBid = function(bidId) {
+      var bidRequested = utils.getBidRequest(bidId);
+      if (!utils.isEmpty(bidRequested)) {
+        let bid = bidfactory.createBid(CONSTANTS.STATUS.NO_BID, bidRequested);
+        bid.bidderCode = BIDDER_CODE;
+        bidmanager.addBidResponse(bidRequested.placementCode, bid);
+      }
+      return;
+    };
+
+
+  //expose the callback to the global object:
+  $$PREBID_GLOBAL$$.handleQuantcastCB = function (responseText) {
+    if(utils.isEmpty(responseText)) {
+      return;
+    }
+    let response = null;
+    try {
+      response = JSON.parse(responseText);
+    } catch(e) {
+      // Malformed JSON
+      utils.logError("Malformed JSON received from server - can't do anything here");
+      return;
+    }
+
+    if(response === null || !response.hasOwnProperty('bids') || utils.isEmpty(response.bids)) {
+      utils.logError("Sub-optimal JSON received from server - can't do anything here");
+      return;
+    }
+
+    for(let i = 0; i < response.bids.length; i++) {
+      let seatbid = response.bids[i];
+      let key = seatbid.placementCode;
+      var request = bidRequests[key];
+      if(request === null || request === undefined) {
+        return returnEmptyBid(seatbid.placementCode);
+      }
+      // This line is required since this is the field
+      // that bidfactory.createBid looks for
+      request.bidId = request.imp[0].placementCode;
+      let responseBid = bidfactory.createBid(CONSTANTS.STATUS.GOOD, request);
+
+      responseBid.cpm = seatbid.cpm;
+      responseBid.ad = seatbid.ad;
+      responseBid.height = seatbid.height;
+      responseBid.width = seatbid.width;
+      responseBid.bidderCode = response.bidderCode;
+      responseBid.requestId = request.requestId;
+      responseBid.bidderCode = BIDDER_CODE;
+
+      bidmanager.addBidResponse(request.bidId, responseBid);
+    }
+
+  };
+
+  function callBids(params) {
+    let bids = params.bids || [];
+    if (bids.length === 0) {
+      return;
+    }
+
+    let referrer = utils.getTopWindowUrl();
+    let loc = utils.getTopWindowLocation();
+    let domain = loc.hostname;
+    let publisherId = 0;
+
+    publisherId = '' + bids[0].params.publisherId;
+    utils._each(bids, function(bid) {
+      let key = bid.placementCode;
+      var bidSizes = [];
+      utils._each(bid.sizes, function (size) {
+        bidSizes.push({
+          'width' : size[0],
+          'height' : size[1]
+        });
+      });
+
+      bidRequests[key] = bidRequests[key] || {
+        'publisherId' : publisherId,
+        'requestId' : bid.bidId,
+        'bidId' : bid.bidId,
+        'site' : {
+          'page' : loc.href,
+          'referrer' : referrer,
+          'domain' : domain,
+        },
+        'imp' : [{
+
+          'banner' : {
+            'battr' : bid.params.battr,
+            'sizes' : bidSizes,
+          },
+          'placementCode' : bid.placementCode,
+          'bidFloor' : bid.params.bidFloor || DEFAULT_BID_FLOOR,
+        }]
+      };
+
+      utils._each(bidRequests, function (bidRequest) {
+        ajax.ajax(QUANTCAST_CALLBACK_URL, $$PREBID_GLOBAL$$.handleQuantcastCB, JSON.stringify(bidRequest), {
+          method : 'POST',
+          withCredentials: true
+        });
+      });
+    });
+  }
+
+
+  // Export the `callBids` function, so that Prebid.js can execute
+  // this function when the page asks to send out bid requests.
+  return {
+    callBids: callBids,
+    QUANTCAST_CALLBACK_URL: QUANTCAST_CALLBACK_URL
+  };
+};
+
+exports.createNew = function() {
+  return new QuantcastAdapter();
+};
+
+
+module.exports = QuantcastAdapter;

test/spec/adapters/quantcast_spec.js

@@ -0,0 +1,194 @@
+import {expect} from 'chai';
+import Adapter from '../../../src/adapters/quantcast';
+import * as ajax from 'src/ajax';
+import bidManager from '../../../src/bidmanager';
+import adLoader from '../../../src/adloader';
+
+describe('quantcast adapter', () => {
+
+  let bidsRequestedOriginal;
+  let adapter;
+  let sandbox;
+  let ajaxStub;
+
+  const bidderRequest = {
+    bidderCode: 'quantcast',
+    requestId : "595ffa73-d78a-46c9-b18e-f99548a5be6b",
+    bidderRequestId:"1cc026909c24c8",
+    bids: [
+      {
+        bidId: '2f7b179d443f14',
+        bidder: 'quantcast',
+        placementCode: 'div-gpt-ad-1438287399331-0',
+        sizes: [[300,250],[300,600]],
+        params: {
+          publisherId: 'test-publisher',
+          battr : [1,2],
+        }
+      }
+    ]
+  };
+
+  beforeEach(() => {
+    bidsRequestedOriginal = $$PREBID_GLOBAL$$._bidsRequested;
+    $$PREBID_GLOBAL$$._bidsRequested = [];
+
+    adapter = new Adapter();
+    sandbox = sinon.sandbox.create();
+    ajaxStub = sandbox.stub(ajax, 'ajax');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+
+    $$PREBID_GLOBAL$$._bidsRequested = bidsRequestedOriginal;
+  });
+
+  describe('sizes', () => {
+    let bidderRequest = {
+      bidderCode: 'quantcast',
+      requestId : "595ffa73-d78a-46c9-b18e-f99548a5be6b",
+      bidderRequestId:"1cc026909c24c8",
+      bids: [
+        {
+          bidId: '2f7b179d443f14',
+          bidder: 'quantcast',
+          placementCode: 'div-gpt-ad-1438287399331-0',
+          sizes: [[300,250],[300,600]],
+          params: {
+            publisherId: 'test-publisher',
+            battr : [1,2],
+          }
+        }
+      ]
+    };
+
+    it('should not call server when empty input is provided', () => {
+      adapter.callBids({});
+      sinon.assert.notCalled(ajaxStub);
+    });
+
+    it('should call server once even when multiple sizes are passed', () => {
+      adapter.callBids(bidderRequest);
+      sinon.assert.calledOnce(ajaxStub);
+
+      expect(ajaxStub.firstCall.args[0]).to.eql(adapter.QUANTCAST_CALLBACK_URL);
+      expect(ajaxStub.firstCall.args[1]).to.exist.and.to.be.a('function');
+      expect(ajaxStub.firstCall.args[2]).to.include('div-gpt-ad-1438287399331-0');
+      expect(ajaxStub.firstCall.args[2]).to.include('test-publisher');
+      expect(ajaxStub.firstCall.args[2]).to.include('2f7b179d443f14');
+      expect(ajaxStub.firstCall.args[3]).to.eql({method : 'POST', withCredentials: true});
+    });
+
+    it('should call server once when one size is passed', () => {
+      bidderRequest.bids[0].sizes = [728, 90];
+      adapter.callBids(bidderRequest);
+      sinon.assert.calledOnce(ajaxStub);
+
+      expect(ajaxStub.firstCall.args[0]).to.eql(adapter.QUANTCAST_CALLBACK_URL);
+      expect(ajaxStub.firstCall.args[1]).to.exist.and.to.be.a('function');
+      expect(ajaxStub.firstCall.args[3]).to.eql({method : 'POST', withCredentials: true});
+    });
+
+    it('should call server once when size is passed as string', () => {
+      bidderRequest.bids[0].sizes = "728x90";
+      adapter.callBids(bidderRequest);
+      sinon.assert.calledOnce(ajaxStub);
+
+      expect(ajaxStub.firstCall.args[0]).to.eql(adapter.QUANTCAST_CALLBACK_URL);
+      expect(ajaxStub.firstCall.args[1]).to.exist.and.to.be.a('function');
+      expect(ajaxStub.firstCall.args[3]).to.eql({method : 'POST', withCredentials: true});
+    });
+
+    it('should call server once when sizes are passed as a comma-separated string', () => {
+      bidderRequest.bids[0].sizes = "728x90,360x240";
+      adapter.callBids(bidderRequest);
+      sinon.assert.calledOnce(ajaxStub);
+
+      expect(ajaxStub.firstCall.args[0]).to.eql(adapter.QUANTCAST_CALLBACK_URL);
+      expect(ajaxStub.firstCall.args[1]).to.exist.and.to.be.a('function');
+      expect(ajaxStub.firstCall.args[3]).to.eql({method : 'POST', withCredentials: true});
+    });
+
+
+  });
+
+  describe('handleQuantcastCB add bids to the manager', () => {
+
+    let firstBid;
+    let addBidReponseStub;
+    let bidsRequestedOriginal;
+    // respond
+    let bidderReponse = {
+      "bidderCode": "quantcast",
+      "requestId" : bidderRequest.requestId,
+      "bids" : [
+          {
+            "statusCode" : 1,
+            "placementCode" : bidderRequest.bids[0].bidId,
+            "cpm": 4.5,
+            "ad": "<!DOCTYPE html>\n\n\n<div style=\"height: 250; width: 300; display: table-cell; vertical-align: middle;\">\n<div style=\"width: 300px; margin-left: auto; margin-right: auto;\">  \n\n  <script src=\"https://adserver.adtechus.com/addyn/3.0/5399.1/2394397/0/-1/QUANTCAST;size=300x250;target=_blank;alias=;kvp36=;sub1=;kvl=;kvc=;kvs=300x250;kvi=;kva=;sub2=;rdclick=http://exch.quantserve.com/r?a=;labels=_qc.clk,_click.adserver.rtb,_click.rand.;rtbip=;rtbdata2=;redirecturl2=\" type=\"text/javascript\"></script>\n\n<img src=\"https://exch.quantserve.com/pixel/p_12345.gif?media=ad&p=&r=&rand=&labels=_qc.imp,_imp.adserver.rtb&rtbip=&rtbdata2=\" style=\"display: none;\" border=\"0\" height=\"1\" width=\"1\" alt=\"Quantcast\"/>\n\n</div>\n</div>",
+            "width": 300,
+            "height": 250
+          }
+       ]
+    };
+
+    beforeEach(() => {
+      bidsRequestedOriginal = $$PREBID_GLOBAL$$._bidsRequested;
+      addBidReponseStub = sandbox.stub(bidManager, 'addBidResponse');
+      $$PREBID_GLOBAL$$._bidsRequested.push(bidderRequest);
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+      $$PREBID_GLOBAL$$._bidsRequested = bidsRequestedOriginal;
+    });
+
+    it('should exist and be a function', () => {
+      expect($$PREBID_GLOBAL$$.handleQuantcastCB).to.exist.and.to.be.a('function');
+    });
+
+    it('should not add bid when empty text response comes', () => {
+      $$PREBID_GLOBAL$$.handleQuantcastCB();
+      sinon.assert.notCalled(addBidReponseStub);
+    });
+
+    it('should not add bid when empty json response comes', () => {
+      $$PREBID_GLOBAL$$.handleQuantcastCB(JSON.stringify({}));
+      sinon.assert.notCalled(addBidReponseStub);
+    });
+
+    it('should not add bid when malformed json response comes', () => {
+      $$PREBID_GLOBAL$$.handleQuantcastCB('non json text');
+      sinon.assert.notCalled(addBidReponseStub);
+    });
+
+    it('should add a bid object for each bid', () => {
+      // You need the following call so that the in-memory storage of the bidRequest is carried out. Without this the callback won't work correctly.
+      adapter.callBids(bidderRequest);
+      $$PREBID_GLOBAL$$.handleQuantcastCB(JSON.stringify(bidderReponse));
+      sinon.assert.calledOnce(addBidReponseStub);
+      expect(addBidReponseStub.firstCall.args[0]).to.eql("div-gpt-ad-1438287399331-0");
+    });
+
+    it('should return no bid even when requestId and sizes are missing', () =>{
+      let bidderReponse = {
+          "bidderCode": "quantcast",
+          "bids" : [
+              {
+                "statusCode" : 0,
+                "placementCode" : bidderRequest.bids[0].bidId,
+              }
+           ]
+        };
+
+      // You need the following call so that the in-memory storage of the bidRequest is carried out. Without this the callback won't work correctly.
+      adapter.callBids(bidderRequest);
+      $$PREBID_GLOBAL$$.handleQuantcastCB(JSON.stringify(bidderReponse));
+      //sinon.assert.calledOnce(addBidReponseStub);
+      //expect(addBidReponseStub.firstCall.args[0]).to.eql("div-gpt-ad-1438287399331-0");
+    });
+  });
+
+});