Added VOX Bidder Adapter (#6030)

* Added voxBidAdapter.js to get a bid from partners.hybrid.ai * Added placements ids for testing Co-authored-by: s-shevtsov <s.shevtsov@targetix.net>
prebid · Dec 19, 2020 · 2c1e535 · 2c1e535
1 parent 78917f5
commit 2c1e535
Show file tree

Hide file tree

Showing 3 changed files with 804 additions and 0 deletions.
diff --git a/modules/voxBidAdapter.js b/modules/voxBidAdapter.js
@@ -0,0 +1,247 @@
+import * as utils from '../src/utils.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js'
+import {BANNER, VIDEO} from '../src/mediaTypes.js'
+import find from 'core-js-pure/features/array/find.js';
+import {auctionManager} from '../src/auctionManager.js';
+import {Renderer} from '../src/Renderer.js';
+
+const BIDDER_CODE = 'vox';
+const SSP_ENDPOINT = 'https://ssp.hybrid.ai/auction/prebid';
+const VIDEO_RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
+const TTL = 60;
+
+function buildBidRequests(validBidRequests) {
+  return utils._map(validBidRequests, function(validBidRequest) {
+    const params = validBidRequest.params;
+    const bidRequest = {
+      bidId: validBidRequest.bidId,
+      transactionId: validBidRequest.transactionId,
+      sizes: validBidRequest.sizes,
+      placement: params.placement,
+      placeId: params.placementId,
+      imageUrl: params.imageUrl
+    };
+
+    return bidRequest;
+  })
+}
+
+const outstreamRender = bid => {
+  bid.renderer.push(() => {
+    window.ANOutstreamVideo.renderAd({
+      sizes: [bid.width, bid.height],
+      targetId: bid.adUnitCode,
+      rendererOptions: {
+        showBigPlayButton: false,
+        showProgressBar: 'bar',
+        showVolume: false,
+        allowFullscreen: true,
+        skippable: false,
+        content: bid.vastXml
+      }
+    });
+  });
+}
+
+const createRenderer = (bid) => {
+  const renderer = Renderer.install({
+    targetId: bid.adUnitCode,
+    url: VIDEO_RENDERER_URL,
+    loaded: false
+  });
+
+  try {
+    renderer.setRender(outstreamRender);
+  } catch (err) {
+    utils.logWarn('Prebid Error calling setRender on renderer', err);
+  }
+
+  return renderer;
+}
+
+function buildBid(bidData) {
+  const bid = {
+    requestId: bidData.bidId,
+    cpm: bidData.price,
+    width: bidData.content.width,
+    height: bidData.content.height,
+    creativeId: bidData.content.seanceId || bidData.bidId,
+    currency: bidData.currency,
+    netRevenue: true,
+    mediaType: BANNER,
+    ttl: TTL,
+    content: bidData.content
+  };
+
+  if (bidData.placement === 'video') {
+    bid.vastXml = bidData.content;
+    bid.mediaType = VIDEO;
+
+    let adUnit = find(auctionManager.getAdUnits(), function (unit) {
+      return unit.transactionId === bidData.transactionId;
+    });
+
+    if (adUnit) {
+      bid.width = adUnit.mediaTypes.video.playerSize[0][0];
+      bid.height = adUnit.mediaTypes.video.playerSize[0][1];
+
+      if (adUnit.mediaTypes.video.context === 'outstream') {
+        bid.renderer = createRenderer(bid);
+      }
+    }
+  } else if (bidData.placement === 'inImage') {
+    bid.mediaType = BANNER;
+    bid.ad = wrapInImageBanner(bid, bidData);
+  } else {
+    bid.mediaType = BANNER;
+    bid.ad = wrapBanner(bid, bidData);
+  }
+
+  return bid;
+}
+
+function getMediaTypeFromBid(bid) {
+  return bid.mediaTypes && Object.keys(bid.mediaTypes)[0];
+}
+
+function hasVideoMandatoryParams(mediaTypes) {
+  const isHasVideoContext = !!mediaTypes.video && (mediaTypes.video.context === 'instream' || mediaTypes.video.context === 'outstream');
+
+  const isPlayerSize =
+    !!utils.deepAccess(mediaTypes, 'video.playerSize') &&
+    utils.isArray(utils.deepAccess(mediaTypes, 'video.playerSize'));
+
+  return isHasVideoContext && isPlayerSize;
+}
+
+function wrapInImageBanner(bid, bidData) {
+  return `<!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <title></title>
+        <script id="prebidrenderer"></script>
+        <style>html, body {width: 100%; height: 100%; margin: 0;}</style>
+    </head>
+    <body>
+      <div data-hyb-ssp-in-image-overlay="${bidData.content.placeId}" style="width: 100%; height: 100%;"></div>
+      <script>
+        var s = document.getElementById("prebidrenderer");
+        s.onload = function () {
+          var _html = "${encodeURIComponent(JSON.stringify(bid))}";
+          window._ao_ssp.registerInImage(JSON.parse(decodeURIComponent(_html)));
+        }
+        s.src = "https://st.hybrid.ai/prebidrenderer.js?t=" + Date.now();
+        if (parent.window.frames[window.name]) {
+            var parentDocument = window.parent.document.getElementById(parent.window.frames[window.name].name);
+            parentDocument.style.height = "100%";
+            parentDocument.style.width = "100%";
+        }
+      </script>
+    </body>
+  </html>`;
+}
+
+function wrapBanner(bid, bidData) {
+  return `<!DOCTYPE html>
+    <html lang="en">
+    <head>
+      <meta charset="UTF-8">
+      <title></title>
+      <script id="prebidrenderer"></script>
+      <style>html, body {width: 100%; height: 100%; margin: 0;}</style>
+    </head>
+    <body>
+      <div data-hyb-ssp-ad-place="${bidData.content.placeId}"></div>
+      <script>
+        var s = document.getElementById("prebidrenderer");
+        s.onload = function () {
+            var _html = "${encodeURIComponent(JSON.stringify(bid))}";
+            window._ao_ssp.registerAds(JSON.parse(decodeURIComponent(_html)));
+        }
+        s.src = "https://st.hybrid.ai/prebidrenderer.js?t=" + Date.now();
+      </script>
+    </body>
+  </html>`;
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
+
+  /**
+   * 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(bid) {
+    return (
+      !!bid.params.placementId &&
+      !!bid.params.placement &&
+      (
+        (getMediaTypeFromBid(bid) === BANNER && bid.params.placement === 'banner') ||
+        (getMediaTypeFromBid(bid) === BANNER && bid.params.placement === 'inImage' && !!bid.params.imageUrl) ||
+        (getMediaTypeFromBid(bid) === VIDEO && bid.params.placement === 'video' && hasVideoMandatoryParams(bid.mediaTypes))
+      )
+    );
+  },
+
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {validBidRequests[]} - an array of bids
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests(validBidRequests, bidderRequest) {
+    const payload = {
+      url: bidderRequest.refererInfo.referer,
+      cmp: !!bidderRequest.gdprConsent,
+      bidRequests: buildBidRequests(validBidRequests)
+    };
+
+    if (payload.cmp) {
+      const gdprApplies = bidderRequest.gdprConsent.gdprApplies;
+      if (gdprApplies !== undefined) payload['ga'] = gdprApplies;
+      payload['cs'] = bidderRequest.gdprConsent.consentString;
+    }
+
+    const payloadString = JSON.stringify(payload);
+
+    return {
+      method: 'POST',
+      url: SSP_ENDPOINT,
+      data: payloadString,
+      options: {
+        contentType: 'application/json'
+      }
+    }
+  },
+
+  /**
+   * 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.
+   */
+  interpretResponse: function(serverResponse, bidRequest) {
+    let bidRequests = JSON.parse(bidRequest.data).bidRequests;
+    const serverBody = serverResponse.body;
+
+    if (serverBody && serverBody.bids && utils.isArray(serverBody.bids)) {
+      return utils._map(serverBody.bids, function(bid) {
+        let rawBid = find(bidRequests, function (item) {
+          return item.bidId === bid.bidId;
+        });
+        bid.placement = rawBid.placement;
+        bid.transactionId = rawBid.transactionId;
+        bid.placeId = rawBid.placeId;
+        return buildBid(bid);
+      });
+    } else {
+      return [];
+    }
+  }
+
+}
+registerBidder(spec);