Adding adKernel adapter

adapters.json

@@ -4,6 +4,7 @@
     "adbutler",
     "adequant",
     "adform",
+    "adkernel",
     "admedia",
     "aol",
     "appnexus",

integrationExamples/gpt/pbjs_example_gpt.html

@@ -217,6 +217,13 @@
                         params:{
                             placementId:'VZH123'        //REQUIRED AD unit id
                         }
+                    },
+                    {
+                        bidder: 'adkernel',
+                        params: {
+                            zoneId : '30164',
+                            host : 'cpm.metaadserving.com'
+                        }
                     }
                 ]
             }, {

src/adapters/adkernel.js

@@ -0,0 +1,207 @@
+import bidmanager from 'src/bidmanager';
+import bidfactory from 'src/bidfactory';
+import * as utils from 'src/utils';
+import {ajax} from 'src/ajax';
+
+/**
+ * Adapter for requesting bids from AdKernel white-label platform
+ * @class
+ */
+const AdkernelAdapter = function AdkernelAdapter() {
+  const ADKERNEL = 'adkernel';
+  const AJAX_REQ_PARAMS = {
+    contentType: 'text/plain',
+    withCredentials: true,
+    method: 'GET'
+  };
+  const EMPTY_BID_RESPONSE = {'seatbid': [{'bid': []}]};
+
+  /**
+   * Helper object to build multiple bid requests in case of multiple zones/ad-networks
+   * @constructor
+   */
+  function RtbRequestDispatcher() {
+    const _dispatch = {};
+    const originalBids = {};
+    const site = createSite();
+
+    //translate adunit info into rtb impression dispatched by host/zone
+    this.addImp = function (bid) {
+      let host = bid.params.host;
+      let zone = bid.params.zoneId;
+      let size = bid.sizes[0];
+      let bidId = bid.bidId;
+
+      if (!(host in _dispatch)) {
+        _dispatch[host] = {};
+      }
+      /* istanbul ignore else  */
+      if (!(zone in _dispatch[host])) {
+        _dispatch[host][zone] = [];
+      }
+      let imp = {'id': bidId, 'banner': {'w': size[0], 'h': size[1]}};
+      if (utils.getTopWindowLocation().protocol === 'https:') {
+        imp.secure = 1;
+      }
+      //save rtb impression for specified ad-network host and zone
+      _dispatch[host][zone].push(imp);
+      originalBids[bidId] = bid;
+    };
+
+    /**
+     *  Main function to get bid requests
+     */
+    this.dispatch = function (callback) {
+      utils._each(_dispatch, (zones, host) => {
+        utils.logMessage('processing network ' + host);
+        utils._each(zones, (impressions, zone) => {
+          utils.logMessage('processing zone ' + zone);
+          dispatchRtbRequest(host, zone, impressions, callback);
+        });
+      });
+    };
+
+    function dispatchRtbRequest(host, zone, impressions, callback) {
+      let url = buildEndpointUrl(host);
+      let rtbRequest = buildRtbRequest(impressions);
+      let params = buildRequestParams(zone, rtbRequest);
+      ajax(url, (bidResp) => {
+        bidResp = bidResp === '' ? EMPTY_BID_RESPONSE : JSON.parse(bidResp);
+        utils._each(rtbRequest.imp, (imp) => {
+          let bidFound = false;
+          utils._each(bidResp.seatbid[0].bid, (bid) => {
+            /* istanbul ignore else */
+            if (!bidFound && bid.impid === imp.id) {
+              bidFound = true;
+              callback(originalBids[imp.id], imp, bid);
+            }
+          });
+          if (!bidFound) {
+            callback(originalBids[imp.id], imp);
+          }
+        });
+      }, params, AJAX_REQ_PARAMS);
+    }
+
+    /**
+     * Builds complete rtb bid request
+     * @param imps collection of impressions
+     */
+    function buildRtbRequest(imps) {
+      return {
+        'id': utils.getUniqueIdentifierStr(),
+        'imp': imps,
+        'site': site,
+        'at': 1,
+        'device': {
+          'ip': 'caller',
+          'ua': 'caller'
+        }
+      };
+    }
+
+    /**
+     * Build ad-network specific endpoint url
+     */
+    function buildEndpointUrl(host) {
+      return window.location.protocol + '//' + host + '/rtbg';
+    }
+
+    function buildRequestParams(zone, rtbReq) {
+      return {
+        'zone': encodeURIComponent(zone),
+        'ad_type': 'rtb',
+        'r': encodeURIComponent(JSON.stringify(rtbReq))
+      };
+    }
+  }
+
+  /**
+   *  Main module export function implementation
+   */
+  function _callBids(params) {
+    var bids = params.bids || [];
+    processBids(bids);
+  }
+
+  /**
+   *  Process all bids grouped by network/zone
+   */
+  function processBids(bids) {
+    const dispatcher = new RtbRequestDispatcher();
+    //process individual bids
+    utils._each(bids, (bid) => {
+      if (!validateBidParams(bid.params)) {
+        utils.logError('Incorrect configuration for adkernel bidder:', bid.params);
+        bidmanager.addBidResponse(bid.placementCode, createEmptyBidObject(bid));
+      } else {
+        dispatcher.addImp(bid);
+      }
+    });
+    //process bids grouped into bidrequests
+    dispatcher.dispatch((bid, imp, bidResp) => {
+      let adUnitId = bid.placementCode;
+      if (bidResp) {
+        utils.logMessage('got response for ' + adUnitId);
+        bidmanager.addBidResponse(adUnitId, createBidObject(bidResp, bid, imp.banner.w, imp.banner.h));
+      } else {
+        utils.logMessage('got empty response for ' + adUnitId);
+        bidmanager.addBidResponse(adUnitId, createEmptyBidObject(bid));
+      }
+    });
+  }
+
+  /**
+   *  Create bid object for the bid manager
+   */
+  function createBidObject(resp, bid, width, height) {
+    return utils.extend(bidfactory.createBid(1, bid), {
+      bidderCode: ADKERNEL,
+      ad: formatAdmarkup(resp),
+      width: width,
+      height: height,
+      cpm: parseFloat(resp.price)
+    });
+  }
+
+  /**
+   * Create empty bid object for the bid manager
+   */
+  function createEmptyBidObject(bid) {
+    return utils.extend(bidfactory.createBid(2, bid), {
+      bidderCode: ADKERNEL
+    });
+  }
+
+  /**
+   *  Format creative with optional nurl call
+   */
+  function formatAdmarkup(bid) {
+    var adm = bid.adm;
+    if ('nurl' in bid) {
+      adm += utils.createTrackPixelHtml(bid.nurl);
+    }
+    return adm;
+  }
+
+  function validateBidParams(params) {
+    return typeof params.host !== 'undefined' && typeof params.zoneId !== 'undefined';
+  }
+
+  /**
+   * Creates site description object
+   */
+  function createSite() {
+    var location = utils.getTopWindowLocation();
+    return {
+      'domain': location.hostname,
+      'page': location.pathname
+    };
+  }
+
+  return {
+    callBids: _callBids
+  };
+};
+
+module.exports = AdkernelAdapter;