Somo prebid 3.0 updates (prebid#4595)

* Re-add Somo bid adapter with v3 compliance * Somo: fixed malformed url in test * Use an alternative method of getting the domain from a url when the URL API isn't supported (IE11) * Somo: fixed indent error
33Across · Dec 19, 2019 · 271d634 · 271d634
1 parent 927d36e
commit 271d634
Show file tree

Hide file tree

Showing 3 changed files with 845 additions and 3 deletions.
diff --git a/modules/somoBidAdapter.js b/modules/somoBidAdapter.js
@@ -0,0 +1,289 @@
+import * as utils from '../src/utils';
+import { registerBidder } from '../src/adapters/bidderFactory';
+import includes from 'core-js/library/fn/array/includes';
+import {BANNER, VIDEO} from '../src/mediaTypes';
+
+const VIDEO_TARGETING = ['mimes', 'minduration', 'maxduration', 'protocols',
+  'startdelay', 'linearity', 'skip', 'delivery',
+  'pos', 'api', 'ext', 'battr'];
+const BANNER_TARGETING = ['battr', 'btype', 'pos', 'mimes', 'ext'];
+
+const SITE_TARGETING = ['name', 'domain', 'cat', 'keywords', 'content']
+const APP_TARGETING = ['name', 'bundle', 'domain', 'storeUrl', 'cat', 'ver', 'keywords', 'content']
+
+export const spec = {
+
+  code: 'somo',
+
+  supportedMediaTypes: [BANNER, VIDEO],
+  aliases: ['somoaudience'],
+
+  isBidRequestValid: bid => (
+    !!(bid && bid.params && bid.params.placementId)
+  ),
+
+  buildRequests: function(bidRequests, bidderRequest) {
+    return bidRequests.map(bidRequest => {
+      let da = openRtbRequest(bidRequest, bidderRequest);
+
+      return {
+        method: 'POST',
+        url: 'https://publisher-east.mobileadtrading.com/rtb/bid?s=' + bidRequest.params.placementId.toString(),
+        data: da,
+        bidRequest: bidRequest
+      };
+    });
+  },
+
+  interpretResponse(response, request) {
+    return bidResponseAvailable(request, response);
+  },
+
+  getUserSyncs: (syncOptions, serverResponses, gdprConsent) => {
+    const syncs = [];
+    var url = 'https://publisher-east.mobileadtrading.com/usersync';
+
+    if (syncOptions.pixelEnabled) {
+      if (gdprConsent && typeof gdprConsent.consentString === 'string') {
+        // add 'gdpr' only if 'gdprApplies' is defined
+        if (typeof gdprConsent.gdprApplies === 'boolean') {
+          url += `?gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+        }
+      }
+      syncs.push({
+        type: 'image',
+        url: url
+      });
+    }
+    return syncs;
+  }
+};
+
+function bidResponseAvailable(bidRequest, bidResponse) {
+  let bidResponses = [];
+
+  if (bidResponse.body) {
+    let bidData = bidResponse.body.seatbid[0].bid[0];
+    const bid = {
+      requestId: bidResponse.body.id,
+      cpm: bidData.price,
+      width: bidData.w,
+      height: bidData.h,
+      ad: bidData.adm,
+      ttl: 360,
+      creativeId: bidData.crid,
+      adId: bidData.impid,
+      netRevenue: false,
+      currency: 'USD',
+      adUnitCode: bidRequest.bidRequest.adUnitCode
+    };
+    if (isVideo(bidRequest.bidRequest)) {
+      bid.vastXml = bidData.adm;
+      bid.mediaType = 'video';
+    } else {
+      bid.ad = bidData.adm;
+      bid.mediaType = 'banner';
+    }
+    bidResponses.push(bid);
+  }
+  return bidResponses;
+}
+
+function openRtbRequest(bidRequest, bidderRequest) {
+  var openRtbRequest = {
+    id: bidRequest.bidId,
+    imp: [openRtbImpression(bidRequest)],
+    at: 1,
+    tmax: 400,
+    site: openRtbSite(bidRequest, bidderRequest),
+    app: openRtbApp(bidRequest),
+    device: openRtbDevice(),
+    bcat: openRtbBCat(bidRequest),
+    badv: openRtbBAdv(bidRequest),
+    ext: {
+      prebid: '$prebid.version$',
+    },
+  };
+  if (typeof bidderRequest !== 'undefined') {
+    openRtbRequest = populateOpenRtbGdpr(bidderRequest.gdprConsent, openRtbRequest);
+  }
+
+  return openRtbRequest;
+}
+
+function populateOpenRtbGdpr(gdpr, bidRequest) {
+  if (gdpr && bidRequest && 'gdprApplies' in gdpr) {
+    if (!('reqs' in bidRequest)) {
+      bidRequest.reqs = {};
+    }
+    if (!('ext' in bidRequest.reqs)) {
+      bidRequest.reqs.ext = {};
+    }
+    bidRequest.reqs.ext.gdpr = gdpr.gdprApplies;
+
+    if ('consentString' in gdpr) {
+      if (!('user' in bidRequest)) {
+        bidRequest.user = {};
+      }
+      if (!('ext' in bidRequest.user)) {
+        bidRequest.user.ext = {};
+      }
+      bidRequest.user.ext.consent = gdpr.consentString;
+    }
+  }
+
+  return bidRequest;
+}
+
+function openRtbImpression(bidRequest) {
+  const imp = {
+    'id': bidRequest.bidId,
+    bidfloor: bidRequest.params.bidfloor || 0,
+  };
+  if (isVideo(bidRequest)) {
+    imp.video = {};
+    if (bidRequest.mediaTypes &&
+            bidRequest.mediaTypes.video &&
+            bidRequest.mediaTypes.video.sizes) {
+      const sizes = getSizes(bidRequest.mediaTypes.video.sizes);
+      imp.video.w = sizes[0];
+      imp.video.h = sizes[1];
+    }
+    if (bidRequest.params.video) {
+      Object.keys(bidRequest.params.video)
+        .filter(param => includes(VIDEO_TARGETING, param))
+        .forEach(param => imp.video[param] = bidRequest.params.video[param]);
+    }
+  } else {
+    imp.banner = {
+      topframe: 0
+    };
+    if (bidRequest.mediaTypes &&
+            bidRequest.mediaTypes.banner &&
+            bidRequest.mediaTypes.banner.sizes) {
+      const sizes = getSizes(bidRequest.mediaTypes.banner.sizes);
+      imp.banner.w = sizes[0];
+      imp.banner.h = sizes[1];
+    }
+    if (bidRequest.params.banner) {
+      Object.keys(bidRequest.params.banner)
+        .filter(param => includes(BANNER_TARGETING, param))
+        .forEach(param => imp.banner[param] = bidRequest.params.banner[param]);
+    }
+  }
+  return imp;
+}
+
+function isApp(bidRequest) {
+  if (bidRequest.params.app) {
+    return true;
+  } else {
+    return false;
+  }
+}
+
+function openRtbSite(bidRequest, bidderRequest) {
+  if (!isApp(bidRequest)) {
+    const site = {};
+
+    if (bidderRequest && bidderRequest.refererInfo) {
+      site.ref = bidderRequest.refererInfo.referer;
+      site.page = bidderRequest.refererInfo.canonicalUrl;
+    }
+
+    if (bidRequest.params.site) {
+      Object.keys(bidRequest.params.site)
+        .filter(param => includes(SITE_TARGETING, param))
+        .forEach(param => site[param] = bidRequest.params.site[param]);
+    }
+    if (typeof site.domain === 'undefined' &&
+            typeof site.page !== 'undefined') {
+      if (typeof window.URL === 'function') {
+        site.domain = (new window.URL(site.page)).hostname;
+      } else {
+        site.domain = getDomainFromUrl(site.page);
+      }
+    }
+
+    return site;
+  } else {
+    return null;
+  }
+}
+
+function getDomainFromUrl(url) {
+  var domain = url;
+
+  if (url.indexOf('//') > -1) {
+    domain = url.split('/')[2];
+  } else {
+    domain = url.split('/')[0];
+  }
+
+  domain = domain.split(':')[0];
+  domain = domain.split('?')[0];
+
+  return domain;
+}
+
+function openRtbApp(bidRequest) {
+  if (isApp(bidRequest)) {
+    const app = {
+
+    }
+    Object.keys(bidRequest.params.app)
+      .filter(param => includes(APP_TARGETING, param))
+      .forEach(param => app[param] = bidRequest.params.app[param]);
+
+    return app;
+  } else {
+    return null;
+  }
+}
+
+function openRtbDevice() {
+  return {
+    ip: 'check',
+    ua: navigator.userAgent,
+    language: (navigator.language || navigator.browserLanguage || navigator.userLanguage || navigator.systemLanguage),
+  };
+}
+
+function openRtbBCat(bidRequest) {
+  if (utils.isArray(bidRequest.params.bcat)) {
+    return bidRequest.params.bcat;
+  }
+  return [];
+}
+
+function openRtbBAdv(bidRequest) {
+  if (utils.isArray(bidRequest.params.badv)) {
+    return bidRequest.params.badv;
+  }
+  return [];
+}
+
+function isVideo(format) {
+  return utils.deepAccess(format, 'mediaTypes.video') || format.mediaType == 'video';
+}
+
+/* Turn bid request sizes into compatible format */
+function getSizes(requestSizes) {
+  let width = 0;
+  let height = 0;
+  if (utils.isArray(requestSizes) && requestSizes.length === 2 &&
+    !utils.isArray(requestSizes[0])) {
+    width = parseInt(requestSizes[0], 10);
+    height = parseInt(requestSizes[1], 10);
+  } else if (typeof requestSizes === 'object') {
+    for (let i = 0; i < requestSizes.length; i++) {
+      let size = requestSizes[i];
+      width = parseInt(size[0], 10);
+      height = parseInt(size[1], 10);
+      break;
+    }
+  }
+  return [width, height];
+}
+
+registerBidder(spec);
diff --git a/modules/somoBidAdapter.md b/modules/somoBidAdapter.md
@@ -7,12 +7,16 @@
 Connects to Somo Audience demand source.  
 Please use ```somo``` as the bidder code.  
 
-For video integration, somoAudience returns content as vastXML and requires the publisher to define the cache url in config passed to Prebid for it to be valid in the auction
+For video integration, Somo Audience returns content as vastXML and requires the publisher to define the cache url in config passed to Prebid for it to be valid in the auction
 # Test Site Parameters
 ```
     var adUnits = [{
       code: 'banner-ad-div',
-      sizes: [[300, 250]],
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250]]
+        }
+      },
       bids: [{
           bidder: 'somo',
           params: {
@@ -25,7 +29,11 @@ For video integration, somoAudience returns content as vastXML and requires the
 ```
 var adUnits = [{
   code: 'banner-ad-div',
-  sizes: [[300, 250]],
+  mediaTypes: {
+    banner: {
+      sizes: [[300, 250]]
+    }
+  },
   bids: [{
       bidder: 'somo',
       params: {