Add Native ad capability to AdYouLike adapter

modules/adyoulikeBidAdapter.js

@@ -2,13 +2,15 @@ import * as utils from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import find from 'core-js-pure/features/array/find.js';
+import {BANNER, NATIVE} from '../src/mediaTypes.js';
 
 const VERSION = '1.0';
 const BIDDER_CODE = 'adyoulike';
 const DEFAULT_DC = 'hb-api';
 
 export const spec = {
   code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, NATIVE],
   aliases: ['ayl'], // short code
   /**
    * Determines whether or not the given bid request is valid.
@@ -18,10 +20,11 @@ export const spec = {
    */
   isBidRequestValid: function (bid) {
     const sizes = getSize(getSizeArray(bid));
-    if (!bid.params || !bid.params.placement || !sizes.width || !sizes.height) {
-      return false;
-    }
-    return true;
+    const sizeValid = sizes.width > 0 && sizes.height > 0;
+
+    // allows no size fornative only
+    return (bid.params && bid.params.placement &&
+            (sizeValid || (bid.mediaTypes && bid.mediaTypes.native)));
   },
   /**
    * Make a server request from the list of BidRequests.
@@ -41,6 +44,7 @@ export const spec = {
         accumulator[bid.bidId].Width = size.width;
         accumulator[bid.bidId].Height = size.height;
         accumulator[bid.bidId].AvailableSizes = sizesArray.join(',');
+        if (bid.mediaTypes && bid.mediaTypes.native) accumulator[bid.bidId].Native = bid.mediaTypes.native;
         return accumulator;
       }, {}),
       PageRefreshed: getPageRefreshed()
@@ -171,9 +175,9 @@ function createEndpointQS(bidderRequest) {
 }
 
 function getSizeArray(bid) {
-  let inputSize = bid.sizes;
+  let inputSize = bid.sizes || [];
   if (bid.mediaTypes && bid.mediaTypes.banner) {
-    inputSize = bid.mediaTypes.banner.sizes;
+    inputSize = bid.mediaTypes.banner.sizes || [];
   }
 
   return utils.parseSizesInput(inputSize);
@@ -203,34 +207,179 @@ function getSize(sizesArray) {
   return parsed;
 }
 
+function getInternalImgUrl(uid) {
+  if (!uid) return '';
+  return 'https://blobs.omnitagjs.com/blobs/' + uid.substr(16, 2) + '/' + uid.substr(16) + '/' + uid;
+}
+
+function getImageUrl(config, resource, width, height) {
+  let url = '';
+
+  switch (resource.Kind) {
+    case 'INTERNAL':
+      url = getInternalImgUrl(resource.Data.Internal.BlobReference.Uid);
+
+      break;
+
+    case 'EXTERNAL':
+      const dynPrefix = config.DynamicPrefix;
+      let extUrl = resource.Data.External.Url;
+      extUrl = extUrl.replace(/\[height\]/i, '' + height);
+      extUrl = extUrl.replace(/\[width\]/i, '' + width);
+
+      if (extUrl.indexOf(dynPrefix) >= 0) {
+        const urlmatch = (/.*url=([^&]*)/gm).exec(extUrl);
+        url = urlmatch ? urlmatch[1] : '';
+        if (!url) {
+          url = getInternalImgUrl((/.*key=([^&]*)/gm).exec(extUrl)[1]);
+        }
+      } else {
+        url = extUrl;
+      }
+
+      break;
+  }
+
+  return url;
+}
+
+function getTrackers(eventsArray, jsTrackers) {
+  const result = [];
+
+  if (!eventsArray) return result;
+
+  eventsArray.map((item, index) => {
+    if ((jsTrackers && item.Kind === 'JAVASCRIPT_URL') ||
+        (!jsTrackers && item.Kind === 'PIXEL_URL')) {
+      result.push(item.Url);
+    }
+  });
+  return result;
+}
+
+function getNativeAssets(response, nativeConfig) {
+  const native = {};
+
+  var adJson = {};
+  var textsJson = {};
+  if (typeof response.Ad === 'string') {
+    adJson = JSON.parse(response.Ad.match(/\/\*PREBID\*\/(.*)\/\*PREBID\*\//)[1]);
+    textsJson = adJson.Content.Preview.Text;
+
+    var impressionUrl = adJson.TrackingPrefix +
+            '/pixel?event_kind=IMPRESSION&attempt=' + adJson.Attempt;
+
+    if (adJson.Campaign) {
+      impressionUrl += '&campaign=' + adJson.Campaign;
+    }
+
+    native.clickUrl = adJson.TrackingPrefix + '/ar?event_kind=CLICK&attempt=' + adJson.Attempt +
+      '&campaign=' + adJson.Campaign + '&url=' + encodeURIComponent(adJson.Content.Landing.Url);
+
+    native.clickTrackers = getTrackers(adJson.OnEvents['CLICK']);
+    native.impressionTrackers = getTrackers(adJson.OnEvents['IMPRESSION']);
+    native.impressionTrackers.push(impressionUrl);
+    native.javascriptTrackers = getTrackers(adJson.OnEvents['IMPRESSION'], true);
+  }
+
+  Object.keys(nativeConfig).map(function(key, index) {
+    if (typeof response.Native === 'object') {
+      native[key] = response.Native[key];
+    } else {
+      switch (key) {
+        case 'title':
+          native[key] = textsJson.TITLE;
+          break;
+        case 'body':
+          native[key] = textsJson.DESCRIPTION;
+          break;
+        case 'cta':
+          native[key] = textsJson.CALLTOACTION;
+          break;
+        case 'sponsoredBy':
+          native[key] = adJson.Content.Preview.Sponsor.Name;
+          break;
+        case 'image':
+          // main image requested size
+          const imgSize = nativeConfig.image.sizes || [];
+          if (!imgSize.length) {
+            imgSize[0] = response.Width || 300;
+            imgSize[1] = response.Height || 250;
+          }
+
+          native[key] = {
+            url: getImageUrl(adJson, adJson.Content.Preview.Thumbnail.Image, imgSize[0], imgSize[1]),
+            width: imgSize[0],
+            height: imgSize[1]
+          };
+          break;
+        case 'icon':
+          if (adJson.HasSponsorImage) {
+            // icon requested size
+            const iconSize = nativeConfig.icon.sizes || [];
+            if (!iconSize.length) {
+              iconSize[0] = 50;
+              iconSize[1] = 50;
+            }
+
+            native[key] = {
+              url: getImageUrl(adJson, adJson.Content.Preview.Sponsor.Logo.Resource, iconSize[0], iconSize[1]),
+              width: iconSize[0],
+              height: iconSize[1]
+            };
+          }
+          break;
+        case 'privacyIcon':
+          native[key] = getImageUrl(adJson, adJson.Content.Preview.Credit.Logo.Resource, 25, 25);
+          break;
+        case 'privacyLink':
+          native[key] = adJson.Content.Preview.Credit.Url;
+          break;
+      }
+    }
+  });
+
+  return native;
+}
+
 /* Create bid from response */
 function createBid(response, bidRequests) {
-  if (!response || !response.Ad) {
+  if (!response || (!response.Ad && !response.Native)) {
     return
   }
 
+  const request = bidRequests && bidRequests[response.BidID];
+
   // In case we don't retreive the size from the adserver, use the given one.
-  if (bidRequests && bidRequests[response.BidID]) {
+  if (request) {
     if (!response.Width || response.Width === '0') {
-      response.Width = bidRequests[response.BidID].Width;
+      response.Width = request.Width;
     }
 
     if (!response.Height || response.Height === '0') {
-      response.Height = bidRequests[response.BidID].Height;
+      response.Height = request.Height;
     }
   }
 
-  return {
+  const bid = {
     requestId: response.BidID,
-    width: response.Width,
-    height: response.Height,
-    ad: response.Ad,
     ttl: 3600,
     creativeId: response.CreativeID,
     cpm: response.Price,
     netRevenue: true,
     currency: 'USD'
   };
+
+  if (request && request.Native) {
+    bid.native = getNativeAssets(response, request.Native);
+    bid.mediaType = 'native';
+  } else {
+    bid.width = response.Width;
+    bid.height = response.Height;
+    bid.ad = response.Ad;
+  }
+
+  return bid;
 }
 
 registerBidder(spec);

modules/adyoulikeBidAdapter.md

@@ -11,19 +11,49 @@ Banner formats are supported.
 
 # Test Parameters
 ```
-    var adUnits = [
-           {
-               code: 'test-div',
-               sizes: [[300, 250]],
-               bids: [
-                   {
-                       bidder: "adyoulike",
-                       params: {
-                           placement: 194f787b85c829fb8822cdaf1ae64435,
-                           DC: 'fra01', // Optional for set the data center name
-                       }
-                   }
-               ]
-           }
-       ];
+    var adUnits = {
+    "code": "test-div",
+    "mediaTypes": {
+      "banner": {
+        "sizes": ["300x250"]
+      },
+      "native": {
+        "image": {
+          "required": true,
+        },
+        "title": {
+          "required": true,
+          "len": 80
+        },
+        "cta": {
+          "required": false
+        },
+        "sponsoredBy": {
+          "required": true
+        },
+        "clickUrl": {
+          "required": true
+        },
+        "privacyIcon": {
+          "required": false
+        },
+        "privacyLink": {
+          "required": false
+        },
+        "body": {
+          "required": true
+        },
+        "icon": {
+          "required": true,
+          "sizes": []
+        }
+      }
+      bids: [{
+        bidder: "adyoulike",
+        params: {
+          placement: 194 f787b85c829fb8822cdaf1ae64435,
+          DC: "fra01", // Optional for set the data center name
+        }
+      }]
+    };
 ```