OpenXOutstream Bid Adapter (prebid#3153)

* adds openxoutstreamadapter files * cleans up url, adds bidder config and version, removes unused code * updates template ad response * remove final unused custom param code * add openrtb to list of params again. * add payload back so we can read bidId * extra checks for cpm (pub_rev) * adds unit tests * adds unit tests * update md page * undo openx adapter space changes from autosave * undo openx adapter space changes from autosave * test cleanup * test cleanup * update md file * update example page params * remove sneaky console.log * return false * adds yieldmo to the md. remove useless docEl assignment * remove useless docEl assignments * move crid and adid to constants * fix test * remove another useless variable assignment caught by LGTM * changes CR_ID. moves tdoc to within if scope * updates crid on test * use more constants and use crid for lfid * remove superfluous trailing argument * adds viewport meta tag to header. removes unnecessary string interpolation. * move ad_id to a string * undo changes for pacakge-lock * fixes lfid to lfId, pID to pId * fixes lfid to lfId, pID to pId * remove rti:1 * adds openx maintainer email
Marfeel · Mar 18, 2019 · 4c049c7 · 4c049c7
1 parent 468f0b8
commit 4c049c7
Show file tree

Hide file tree

Showing 4 changed files with 503 additions and 0 deletions.
diff --git a/integrationExamples/gpt/pbjs_example_gpt.html b/integrationExamples/gpt/pbjs_example_gpt.html
@@ -302,6 +302,16 @@
                             channelCode: 2264002816,   //REQUIRED
                             dimId: 9 //REQUIRED
                         }
+                    },
+                    {
+                      bidder: 'openxoutstream',
+                      params: {
+                          unit: '53943996499',
+                          delDomain: 'se-demo-d.openx.net',
+                          publisher_page_url: 'yieldmo.com',
+                          width:  '300',
+                          height: '250',
+                      }
                     }
 
                 ]

diff --git a/modules/openxoutstreamBidAdapter.js b/modules/openxoutstreamBidAdapter.js
@@ -0,0 +1,214 @@
+import { config } from 'src/config';
+import { registerBidder } from 'src/adapters/bidderFactory';
+import * as utils from 'src/utils';
+import { BANNER } from 'src/mediaTypes';
+
+const SUPPORTED_AD_TYPES = [BANNER];
+const BIDDER_CODE = 'openxoutstream';
+const BIDDER_CONFIG = 'hb_pb_ym';
+const BIDDER_VERSION = '1.0.0';
+const CURRENCY = 'USD';
+const NET_REVENUE = true;
+const TIME_TO_LIVE = 300;
+const YM_SCRIPT = `!function(e,t){if(void 0===t._ym){var a=Math.round(5*Math.random()/3)+'';t._ym='';var m=e.createElement('script');m.type='text/javascript',m.async=!0,m.src='//static.yieldmo.com/ym.'+a+'.js',(e.getElementsByTagName('head')[0]||e.getElementsByTagName('body')[0]).appendChild(m)}else t._ym instanceof String||void 0===t._ym.chkPls||t._ym.chkPls()}(document,window);`;
+const PLACEMENT_ID = '1986307928000988495';
+const PUBLISHER_ID = '1986307525700126029';
+const CR_ID = '2052941939925262540';
+const AD_ID = '1991358644725162800';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: SUPPORTED_AD_TYPES,
+  isBidRequestValid: function(bidRequest) {
+    if (bidRequest.params.delDomain) {
+      return !!bidRequest.params.unit || utils.deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
+    }
+    return false;
+  },
+  buildRequests: function(bidRequests, bidderRequest) {
+    if (bidRequests.length === 0) {
+      return [];
+    }
+    let requests = [];
+    requests.push(buildOXBannerRequest(bidRequests, bidderRequest));
+    return requests;
+  },
+  interpretResponse: function(serverResponse, serverRequest) {
+    return handleVastResponse(serverResponse, serverRequest.payload)
+  },
+
+  transformBidParams: function(params, isOpenRtb) {
+    return utils.convertTypes({
+      'unit': 'string',
+    }, params);
+  }
+};
+
+function getViewportDimensions(isIfr) {
+  let width;
+  let height;
+  let tWin = window;
+  let body;
+
+  if (isIfr) {
+    let tDoc;
+    try {
+      tWin = window.top;
+      tDoc = window.top.document;
+    } catch (e) {
+      return;
+    }
+    body = tDoc.body;
+
+    width = tWin.innerWidth || docEl.clientWidth || body.clientWidth;
+    height = tWin.innerHeight || docEl.clientHeight || body.clientHeight;
+  } else {
+    width = tWin.innerWidth || docEl.clientWidth;
+    height = tWin.innerHeight || docEl.clientHeight;
+  }
+
+  return `${width}x${height}`;
+}
+
+function buildCommonQueryParamsFromBids(bids, bidderRequest) {
+  const isInIframe = utils.inIframe();
+  let defaultParams;
+  defaultParams = {
+    ju: config.getConfig('pageUrl') || utils.getTopWindowUrl(),
+    jr: utils.getTopWindowReferrer(),
+    ch: document.charSet || document.characterSet,
+    res: `${screen.width}x${screen.height}x${screen.colorDepth}`,
+    ifr: isInIframe,
+    tz: new Date().getTimezoneOffset(),
+    tws: getViewportDimensions(isInIframe),
+    be: 1,
+    bc: bids[0].params.bc || `${BIDDER_CONFIG}_${BIDDER_VERSION}`,
+    auid: '540141567',
+    dddid: utils._map(bids, bid => bid.transactionId).join(','),
+    openrtb: '%7B%22mimes%22%3A%5B%22video%2Fmp4%22%5D%7D',
+    nocache: new Date().getTime()
+  };
+
+  if (utils.deepAccess(bidderRequest, 'gdprConsent')) {
+    let gdprConsentConfig = bidderRequest.gdprConsent;
+
+    if (gdprConsentConfig.consentString !== undefined) {
+      defaultParams.gdpr_consent = gdprConsentConfig.consentString;
+    }
+
+    if (gdprConsentConfig.gdprApplies !== undefined) {
+      defaultParams.gdpr = gdprConsentConfig.gdprApplies ? 1 : 0;
+    }
+
+    if (config.getConfig('consentManagement.cmpApi') === 'iab') {
+      defaultParams.x_gdpr_f = 1;
+    }
+  }
+
+  return defaultParams;
+}
+
+function buildOXBannerRequest(bids, bidderRequest) {
+  let queryParams = buildCommonQueryParamsFromBids(bids, bidderRequest);
+  queryParams.aus = utils._map(bids, bid => utils.parseSizesInput(bid.sizes).join(',')).join('|');
+
+  if (bids.some(bid => bid.params.doNotTrack)) {
+    queryParams.ns = 1;
+  }
+
+  if (bids.some(bid => bid.params.coppa)) {
+    queryParams.tfcd = 1;
+  }
+
+  let url = `https://${bids[0].params.delDomain}/v/1.0/avjp`
+  return {
+    method: 'GET',
+    url: url,
+    data: queryParams,
+    payload: {'bids': bids}
+  };
+}
+
+function handleVastResponse(response, serverResponse) {
+  const body = response.body
+  let bidResponses = [];
+  if (response !== undefined && body.vastUrl !== '' && body.pub_rev && body.pub_rev > 0) {
+    const openHtmlTag = '<html><head><meta name="viewport" content="width=device-width, initial-scale=1.0"></head><body>';
+    const closeHtmlTag = '</body></html>';
+    const sdkScript = createSdkScript().outerHTML;
+    const placementDiv = createPlacementDiv();
+    placementDiv.dataset.pId = PUBLISHER_ID;
+    const placementDivString = placementDiv.outerHTML;
+    const adResponse = getTemplateAdResponse(body.vastUrl);
+    const adResponseString = JSON.stringify(adResponse);
+    const ymAdsScript = '<script type="text/javascript"> window.__ymAds =' + adResponseString + '</script>';
+
+    let bidResponse = {};
+    bidResponse.requestId = serverResponse.bids[0].bidId;
+    bidResponse.bidderCode = BIDDER_CODE;
+    bidResponse.netRevenue = NET_REVENUE;
+    bidResponse.currency = CURRENCY;
+    bidResponse.cpm = Number(body.pub_rev) / 1000;
+    bidResponse.creativeId = body.adid;
+    bidResponse.height = body.height;
+    bidResponse.width = body.width;
+    bidResponse.vastUrl = body.vastUrl;
+    bidResponse.ttl = TIME_TO_LIVE;
+    bidResponse.mediaType = BANNER;
+    bidResponse.ad = openHtmlTag + placementDivString + ymAdsScript + sdkScript + closeHtmlTag;
+
+    bidResponses.push(bidResponse);
+  }
+  return bidResponses;
+}
+registerBidder(spec);
+
+// HELPER FUNCTIONS
+function createSdkScript() {
+  const script = document.createElement('script');
+  script.innerHTML = YM_SCRIPT;
+  return script;
+}
+function createPlacementDiv() {
+  const div = document.createElement('div');
+  div.id = `ym_${PLACEMENT_ID}`;
+  div.classList.add('ym');
+  div.dataset.lfId = CR_ID;
+  return div
+}
+
+/**
+ * Create a nativeplay template with the placement id and vastURL.
+ * @param vastUrl
+ */
+const getTemplateAdResponse = (vastUrl) => {
+  return {
+    availability_zone: 'us-east-1a',
+    data: [
+      {
+        ads: [
+          {
+            actions: {},
+            adv_id: AD_ID,
+            configurables: {
+              cta_button_copy: 'Learn More',
+              vast_click_tracking: 'true',
+              vast_url: vastUrl,
+            },
+            cr_id: CR_ID,
+          }
+        ],
+        column_count: 1,
+        configs: {
+          allowable_height: '248',
+          header_copy: 'You May Like',
+          ping: 'true',
+        },
+        creative_format_id: 40,
+        css: '',
+        placement_id: PLACEMENT_ID,
+      }
+    ],
+    nc: 0,
+  };
+};
diff --git a/modules/openxoutstreamBidAdapter.md b/modules/openxoutstreamBidAdapter.md
@@ -0,0 +1,41 @@
+# Overview
+
+```
+Module Name: OpenX Outstream Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: opensource@yieldmo.com, jimmy.tu@openx.com
+Note: Ads will only render in mobile
+```
+
+# Description
+
+Module that connects to OpenX's demand sources for outstream to Yieldmo.
+
+This bid adapter supports Banner.
+
+# Example
+```javascript
+var adUnits = [
+  {
+    code: 'test-div',
+    sizes: [[300, 250]],  // a display size
+    mediaTypes: {'banner': {}},
+    bids: [
+      {
+        bidder: 'openxoutstream',
+        params: {
+          unit: '53943996499',
+          delDomain: 'se-demo-d.openx.net',
+          publisher_page_url: 'yieldmo.com',
+          width:  '300',
+          height: '250',
+        }
+      }
+    ]
+  }
+];
+```
+
+# Additional Details
+[Banner Ads](https://docs.openx.com/Content/developers/containers/prebid-adapter.html)
+