IndexExchange Display Bid Adapter

modules/ixBidAdapter.js

@@ -0,0 +1,252 @@
+import * as utils from 'src/utils';
+import { BANNER } from 'src/mediaTypes';
+import { config } from 'src/config';
+import isArray from 'core-js/library/fn/array/is-array';
+import isInteger from 'core-js/library/fn/number/is-integer';
+import { registerBidder } from 'src/adapters/bidderFactory';
+
+const BIDDER_CODE = 'ix';
+const BANNER_SECURE_BID_URL = 'https://as-sec.casalemedia.com/cygnus';
+const BANNER_INSECURE_BID_URL = 'http://as.casalemedia.com/cygnus';
+const SUPPORTED_AD_TYPES = [BANNER];
+const ENDPOINT_VERSION = 7.2;
+const CENT_TO_DOLLAR_FACTOR = 100;
+const TIME_TO_LIVE = 60;
+const NET_REVENUE = true;
+const isSecureWeb = utils.getTopWindowLocation().protocol === 'https:';
+const baseUrl = isSecureWeb ? BANNER_SECURE_BID_URL : BANNER_INSECURE_BID_URL;
+const PRICE_TO_DOLLAR_FACTOR = {
+  JPY: 1
+};
+
+/**
+ * Transform valid bid request config object to impression object that will be sent to ad server.
+ *
+ * @param {object} bid A valid bid request config object.
+ * @return {object} A impression object that will be sent to ad server.
+ */
+function bidToBannerImp(bid) {
+  const imp = {};
+
+  imp.id = bid.bidId;
+
+  imp.banner = {};
+  imp.banner.w = bid.params.size[0];
+  imp.banner.h = bid.params.size[1];
+  imp.banner.topframe = utils.inIframe() ? 0 : 1;
+
+  imp.ext = {};
+  imp.ext.sid = `${bid.params.size[0]}x${bid.params.size[1]}`;
+  imp.ext.siteID = bid.params.siteId;
+
+  if (bid.params.hasOwnProperty('bidFloor') && bid.params.hasOwnProperty('bidFloorCur')) {
+    imp.bidfloor = bid.params.bidFloor;
+    imp.bidfloorcur = bid.params.bidFloorCur;
+  }
+
+  return imp;
+}
+
+/**
+ * Parses a raw bid for the relevant information.
+ *
+ * @param {object} rawBid The bid to be parsed.
+ * @param {string} currency Global currency in bid response.
+ * @return {object} bid The parsed bid.
+ */
+function parseBid(rawBid, currency) {
+  const bid = {};
+
+  if (PRICE_TO_DOLLAR_FACTOR.hasOwnProperty(currency)) {
+    bid.cpm = rawBid.price / PRICE_TO_DOLLAR_FACTOR[currency];
+  } else {
+    bid.cpm = rawBid.price / CENT_TO_DOLLAR_FACTOR;
+  }
+
+  bid.requestId = rawBid.impid;
+  bid.width = rawBid.w;
+  bid.height = rawBid.h;
+  bid.ad = rawBid.adm;
+  bid.dealId = utils.deepAccess(rawBid, 'ext.dealid');
+  bid.ttl = TIME_TO_LIVE;
+  bid.netRevenue = NET_REVENUE;
+  bid.currency = currency;
+  bid.creativeId = rawBid.hasOwnProperty('crid') ? rawBid.crid : '-';
+
+  return bid;
+}
+
+/**
+ * Determines whether or not the given object is valid size format.
+ *
+ * @param {*} size The object to de validated.
+ * @return {boolean} True if this is a valid size format, and false otherwise.
+ */
+function isValidSize(size) {
+  return isArray(size) && size.length === 2 && isInteger(size[0]) && isInteger(size[1]);
+}
+
+/**
+ * Determines whether or not the given size object is an element of the size array.
+ *
+ * @param {array} sizeArray The size array.
+ * @param {object} size The size object.
+ * @return {boolean} True if the size object is an element of the size array, and false otherwise.
+ */
+function includesSize(sizeArray, size) {
+  if (isValidSize(sizeArray)) {
+    return sizeArray[0] === size[0] && sizeArray[1] === size[1];
+  }
+
+  for (let i = 0; i < sizeArray.length; i++) {
+    if (sizeArray[i][0] === size[0] && sizeArray[i][1] === size[1]) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+/**
+ * Determines whether or not the given bidFloor parameters are valid.
+ *
+ * @param {*} bidFloor The bidFloor parameter inside bid request config.
+ * @param {*} bidFloorCur The bidFloorCur parameter inside bid request config.
+ * @return {boolean} True if this is a valid biFfloor parameters format, and false otherwise.
+ */
+function isValidBidFloorParams(bidFloor, bidFloorCur) {
+  const curRegex = /^[A-Z]{3}$/;
+
+  return Boolean(typeof bidFloor === 'number' && typeof bidFloorCur === 'string' && bidFloorCur.match(curRegex));
+}
+
+export const spec = {
+
+  code: BIDDER_CODE,
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {object} bid The bid to validate.
+   * @return {boolean} True if this is a valid bid, and false otherwise.
+   */
+  isBidRequestValid: function (bid) {
+    if (!isValidSize(bid.params.size)) {
+      return false;
+    }
+
+    if (!includesSize(bid.sizes, bid.params.size)) {
+      return false;
+    }
+
+    if (typeof bid.params.siteId !== 'string') {
+      return false;
+    }
+
+    const hasBidFloor = bid.params.hasOwnProperty('bidFloor');
+    const hasBidFloorCur = bid.params.hasOwnProperty('bidFloorCur');
+
+    if (hasBidFloor || hasBidFloorCur) {
+      return hasBidFloor && hasBidFloorCur && isValidBidFloorParams(bid.params.bidFloor, bid.params.bidFloorCur);
+    }
+
+    return true;
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {array} validBidRequests A list of valid bid request config objects.
+   * @return {object} Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests) {
+    const bannerImps = [];
+    let validBidRequest = null;
+    let bannerImp = null;
+
+    for (let i = 0; i < validBidRequests.length; i++) {
+      validBidRequest = validBidRequests[i];
+
+      // If the bid request is for banner, then transform the bid request based on banner format
+      if (utils.deepAccess(validBidRequest, 'mediaTypes.banner') || validBidRequest.mediaType === 'banner') {
+        bannerImp = bidToBannerImp(validBidRequest);
+        bannerImps.push(bannerImp);
+      }
+    }
+
+    // Since bidderRequestId are the same for diffrent bid request, just use the first one
+    const r = {};
+    r.id = validBidRequests[0].bidderRequestId;
+    r.imp = bannerImps;
+    r.site = {};
+    r.site.page = utils.getTopWindowUrl();
+    r.site.ref = utils.getTopWindowReferrer();
+    r.ext = {};
+    r.ext.source = 'prebid';
+
+    // Append firstPartyData to r.site.page if firstPartyData exists
+    const otherIxConfig = config.getConfig('ix');
+
+    if (otherIxConfig && otherIxConfig.firstPartyData) {
+      const firstPartyData = otherIxConfig.firstPartyData;
+      let firstPartyString = '?';
+      for (const key in firstPartyData) {
+        if (firstPartyData.hasOwnProperty(key)) {
+          firstPartyString += `${encodeURIComponent(key)}=${encodeURIComponent(firstPartyData[key])}&`;
+        }
+      }
+      firstPartyString = firstPartyString.slice(0, -1);
+
+      r.site.page += firstPartyString;
+    }
+
+    // Use the siteId in the first bid request as the main siteId
+    const payload = {};
+    payload.s = validBidRequests[0].params.siteId;
+    payload.v = ENDPOINT_VERSION;
+    payload.r = JSON.stringify(r);
+    payload.ac = 'j';
+    payload.sd = 1;
+
+    return {
+      method: 'GET',
+      url: baseUrl,
+      data: payload
+    };
+  },
+
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {object} serverResponse A successful response from the server.
+   * @return {array} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function (serverResponse) {
+    const bids = [];
+    let bid = null;
+
+    if (!serverResponse.hasOwnProperty('body') || !serverResponse.body.hasOwnProperty('seatbid')) {
+      return bids;
+    }
+
+    const responseBody = serverResponse.body;
+    const seatbid = responseBody.seatbid;
+    for (let i = 0; i < seatbid.length; i++) {
+      if (!seatbid[i].hasOwnProperty('bid')) {
+        continue;
+      }
+
+      // Transform rawBid in bid response to the format that will be accepted by prebid
+      const innerBids = seatbid[i].bid;
+      for (let j = 0; j < innerBids.length; j++) {
+        bid = parseBid(innerBids[j], responseBody.cur);
+        bids.push(bid);
+      }
+    }
+
+    return bids;
+  }
+};
+
+registerBidder(spec);