Added native support for Mediaforce Bid Adapter (#5528)

* add mediaforce bid adapter

* make use of unused variable language

* Added native support for Mediaforce Bid Adapter

* Fix test endpoint url for Mediaforce Bid Adapter

* cleanup

Co-authored-by: ksanksana <little.grey.goblin@gmail.com>

modules/mediaforceBidAdapter.js

@@ -1,42 +1,126 @@
 import * as utils from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {BANNER} from '../src/mediaTypes.js';
+import {BANNER, NATIVE} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'mediaforce';
 const ENDPOINT_URL = 'https://rtb.mfadsrvr.com/header_bid';
+const TEST_ENDPOINT_URL = 'https://rtb.mfadsrvr.com/header_bid?debug_key=abcdefghijklmnop';
+const NATIVE_ID_MAP = {};
+const NATIVE_PARAMS = {
+  title: {
+    id: 1,
+    name: 'title'
+  },
+  icon: {
+    id: 2,
+    type: 1,
+    name: 'img'
+  },
+  image: {
+    id: 3,
+    type: 3,
+    name: 'img'
+  },
+  body: {
+    id: 4,
+    name: 'data',
+    type: 2
+  },
+  sponsoredBy: {
+    id: 5,
+    name: 'data',
+    type: 1
+  },
+  cta: {
+    id: 6,
+    type: 12,
+    name: 'data'
+  },
+  body2: {
+    id: 7,
+    name: 'data',
+    type: 10
+  },
+  rating: {
+    id: 8,
+    name: 'data',
+    type: 3
+  },
+  likes: {
+    id: 9,
+    name: 'data',
+    type: 4
+  },
+  downloads: {
+    id: 10,
+    name: 'data',
+    type: 5
+  },
+  displayUrl: {
+    id: 11,
+    name: 'data',
+    type: 11
+  },
+  price: {
+    id: 12,
+    name: 'data',
+    type: 6
+  },
+  salePrice: {
+    id: 13,
+    name: 'data',
+    type: 7
+  },
+  address: {
+    id: 14,
+    name: 'data',
+    type: 9
+  },
+  phone: {
+    id: 15,
+    name: 'data',
+    type: 8
+  }
+};
+
+Object.keys(NATIVE_PARAMS).forEach((key) => {
+  NATIVE_ID_MAP[NATIVE_PARAMS[key].id] = key;
+});
 
 export const spec = {
   code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, NATIVE],
 
   /**
-     * Determines whether or not the given bid request is valid.
-     *
-     * @param {BidRequest} bid The bid params to validate.
-     * @return boolean True if this is a valid bid, and false otherwise.
-     */
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {BidRequest} bid The bid params to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
   isBidRequestValid: function(bid) {
     return !!((typeof bid.params === 'object') && bid.params.placement_id && bid.params.publisher_id);
   },
 
   /**
-     * Make a server request from the list of BidRequests.
-     *
-     * @param {validBidRequests[]} - an array of bids
-     * @return ServerRequest Info describing the request to the server.
-     */
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} validBidRequests - an array of bids
+   * @param {bidderRequest} bidderRequest bidder request object
+   * @return ServerRequest Info describing the request to the server.
+   */
   buildRequests: function(validBidRequests, bidderRequest) {
     if (validBidRequests.length === 0) {
       return;
     }
 
     const referer = bidderRequest && bidderRequest.refererInfo ? encodeURIComponent(bidderRequest.refererInfo.referer) : '';
     const dnt = utils.getDNT() ? 1 : 0;
-    let imp = [];
-    let requests = []
+    let requests = [];
     validBidRequests.forEach(bid => {
       let tagid = bid.params.placement_id;
       let bidfloor = bid.params.bidfloor ? parseFloat(bid.params.bidfloor) : 0;
+      let imp = [];
+      let validImp = false;
       let impObj = {
         id: bid.bidId,
         tagid: tagid,
@@ -47,11 +131,16 @@ export const spec = {
         switch (mediaTypes) {
           case BANNER:
             impObj.banner = createBannerRequest(bid);
-            imp.push(impObj);
+            validImp = true;
+            break;
+          case NATIVE:
+            impObj.native = createNativeRequest(bid);
+            validImp = true;
             break;
           default: return;
         }
       }
+      validImp && imp.push(impObj);
 
       let request = {
         id: bid.transactionId,
@@ -73,19 +162,20 @@ export const spec = {
       };
       requests.push({
         method: 'POST',
-        url: ENDPOINT_URL,
+        url: bid.params.is_test ? TEST_ENDPOINT_URL : ENDPOINT_URL,
         data: JSON.stringify(request)
       });
     });
     return requests;
   },
 
   /**
-     * Unpack the response from the server into a list of bids.
-     *
-     * @param {ServerResponse} serverResponse A successful response from the server.
-     * @return {Bid[]} An array of bids which were nested inside the server.
-     */
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {ServerResponse} serverResponse A successful response from the server.
+   * @param {BidRequest} bidRequest
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
   interpretResponse: function(serverResponse, bidRequest) {
     if (!serverResponse || !serverResponse.body) {
       return [];
@@ -99,15 +189,35 @@ export const spec = {
         const bid = {
           requestId: serverBid.impid,
           cpm: parseFloat(serverBid.price),
-          width: serverBid.w,
-          height: serverBid.h,
           creativeId: serverBid.adid,
           currency: cur,
           netRevenue: true,
           ttl: serverBid.ttl || 300,
-          ad: serverBid.adm,
           burl: serverBid.burl,
         };
+        if (serverBid.dealid) {
+          bid.dealId = serverBid.dealid;
+        }
+        let jsonAdm;
+        let adm = serverBid.adm;
+        let ext = serverBid.ext;
+        try {
+          jsonAdm = JSON.parse(adm);
+        } catch (err) {}
+        if (jsonAdm && jsonAdm.native) {
+          ext = ext || {};
+          ext.native = jsonAdm.native;
+          adm = null;
+        }
+        if (adm) {
+          bid.width = serverBid.w;
+          bid.height = serverBid.h;
+          bid.ad = adm;
+          bid.mediaType = BANNER;
+        } else if (ext && ext.native) {
+          bid.native = parseNative(ext.native);
+          bid.mediaType = NATIVE;
+        }
 
         bidResponses.push(bid);
       })
@@ -117,17 +227,18 @@ export const spec = {
   },
 
   /**
-     * Register bidder specific code, which will execute if a bid from this bidder won the auction
-     * @param {Bid} The bid that won the auction
-     */
+   * Register bidder specific code, which will execute if a bid from this bidder won the auction
+   * @param {Bid} The bid that won the auction
+   */
   onBidWon: function(bid) {
     const cpm = utils.deepAccess(bid, 'adserverTargeting.hb_pb') || '';
     if (utils.isStr(bid.burl) && bid.burl !== '') {
       bid.burl = utils.replaceAuctionPrice(bid.burl, cpm);
       utils.triggerPixel(bid.burl);
     }
   },
-}
+};
+
 registerBidder(spec);
 
 function getLanguage() {
@@ -149,3 +260,73 @@ function createBannerRequest(bid) {
   }
   return r
 }
+
+function parseNative(native) {
+  const {assets, link, imptrackers, jstracker} = native;
+  const result = {
+    clickUrl: link.url,
+    clickTrackers: link.clicktrackers || [],
+    impressionTrackers: imptrackers || [],
+    javascriptTrackers: jstracker ? [jstracker] : []
+  };
+
+  (assets || []).forEach((asset) => {
+    const {id, img, data, title} = asset;
+    const key = NATIVE_ID_MAP[id];
+    if (key) {
+      if (!utils.isEmpty(title)) {
+        result.title = title.text
+      } else if (!utils.isEmpty(img)) {
+        result[key] = {
+          url: img.url,
+          height: img.h,
+          width: img.w
+        }
+      } else if (!utils.isEmpty(data)) {
+        result[key] = data.value;
+      }
+    }
+  });
+
+  return result;
+}
+
+function createNativeRequest(bid) {
+  const assets = [];
+  if (bid.nativeParams) {
+    Object.keys(bid.nativeParams).forEach((key) => {
+      if (NATIVE_PARAMS[key]) {
+        const {name, type, id} = NATIVE_PARAMS[key];
+        const assetObj = type ? {type} : {};
+        let {len, sizes, required, aspect_ratios: aRatios} = bid.nativeParams[key];
+        if (len) {
+          assetObj.len = len;
+        }
+        if (aRatios && aRatios[0]) {
+          aRatios = aRatios[0];
+          let wmin = aRatios.min_width || 0;
+          let hmin = aRatios.ratio_height * wmin / aRatios.ratio_width | 0;
+          assetObj.wmin = wmin;
+          assetObj.hmin = hmin;
+        }
+        if (sizes && sizes.length) {
+          sizes = [].concat(...sizes);
+          assetObj.w = sizes[0];
+          assetObj.h = sizes[1];
+        }
+        const asset = {required: required ? 1 : 0, id};
+        asset[name] = assetObj;
+        assets.push(asset);
+      }
+    });
+  }
+  return {
+    ver: '1.2',
+    request: {
+      assets: assets,
+      context: 1,
+      plcmttype: 1,
+      ver: '1.2'
+    }
+  }
+}

modules/mediaforceBidAdapter.md

@@ -33,3 +33,36 @@ Module that connects to mediaforce's demand sources
         }
     ];
 ```
+
+```
+    var adUnits = [
+        {
+            code: 'test-div',
+            mediaTypes: {
+                native: {
+                    title: {
+                        required: true,
+                        len: 800
+                    },
+                    image: {
+                        required: true,
+                        sizes: [420, 315],
+                    },
+                    sponsoredBy: {
+                        required: false
+                    }
+                }
+            },
+            bids: [
+                {
+                    bidder: "mediaforce",
+                    params: {
+                        placement_id: 'pl12345',  // required
+                        publisher_id: 'pub111', // required
+                        is_test: true
+                    }
+                }
+            ]
+        }
+    ];
+```