Stv Bid Adapter : initial adapter release (prebid#9533)

theo-stv · theo_ · jorgeluisrocha · commit e9991ef2387c · 2023-05-18T15:44:08.000-04:00
* initial commit

* adapted buildRequests function

* refinement pfilter and bcat

* refinement

* adapted tests for isBidRequestValid,buildRequests

* adaptations for test

* finished building stvBidAdapter.js

* finished: ran tests, coverage 99%

* update: rename w-&gt;srw, h-&gt;srh

* adapt stvBidAdapter.md

* remove dspx from stv adapters

* some changes (missing: getUserSyncs, but is the same as in
radsBidAdapter)

* added checks in getUserSyncs; ran tests

---------

Co-authored-by: theo_ &lt;theo_@IDEA3&gt;
diff --git a/modules/stvBidAdapter.js b/modules/stvBidAdapter.js
@@ -0,0 +1,330 @@
+import { deepAccess } from '../src/utils.js';
+import { config } from '../src/config.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import {includes} from '../src/polyfill.js';
+
+const BIDDER_CODE = 'stv';
+const ENDPOINT_URL = 'https://ads.smartstream.tv/r/';
+const ENDPOINT_URL_DEV = 'https://ads.smartstream.tv/r/';
+const GVLID = 134;
+const VIDEO_ORTB_PARAMS = {
+  'minduration': 'min_duration',
+  'maxduration': 'max_duration',
+  'maxbitrate': 'max_bitrate',
+  'api': 'api',
+};
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  aliases: [],
+  supportedMediaTypes: [BANNER, VIDEO],
+  isBidRequestValid: function(bid) {
+    return !!(bid.params.placement);
+  },
+  buildRequests: function(validBidRequests, bidderRequest) {
+    return validBidRequests.map(bidRequest => {
+      const params = bidRequest.params;
+
+      const placementId = params.placement;
+      const rnd = Math.floor(Math.random() * 99999999999);
+      const referrer = bidderRequest.refererInfo.page;
+      const bidId = bidRequest.bidId;
+      const isDev = params.devMode || false;
+      const pbcode = bidRequest.adUnitCode || false; // div id
+
+      let endpoint = isDev ? ENDPOINT_URL_DEV : ENDPOINT_URL;
+
+      let mediaTypesInfo = getMediaTypesInfo(bidRequest);
+      let type = isBannerRequest(bidRequest) ? BANNER : VIDEO;
+      let sizes = mediaTypesInfo[type];
+
+      let payload = {
+        _f: 'vast2',
+        alternative: 'prebid_js',
+        _ps: placementId,
+        srw: sizes ? sizes[0].width : 0,
+        srh: sizes ? sizes[0].height : 0,
+        idt: 100,
+        rnd: rnd,
+        ref: referrer,
+        bid_id: bidId,
+        pbver: '$prebid.version$',
+      };
+      if (!isVideoRequest(bidRequest)) {
+        payload._f = 'html';
+      }
+
+      payload.pfilter = { ...params };
+      delete payload.pfilter.placement;
+      if (params.bcat !== undefined) { delete payload.pfilter.bcat; }
+      if (params.dvt !== undefined) { delete payload.pfilter.dvt; }
+      if (params.devMode !== undefined) { delete payload.pfilter.devMode; }
+
+      if (payload.pfilter === undefined || !payload.pfilter.floorprice) {
+        let bidFloor = getBidFloor(bidRequest);
+        if (bidFloor > 0) {
+          if (payload.pfilter !== undefined) {
+            payload.pfilter.floorprice = bidFloor;
+          } else {
+            payload.pfilter = { 'floorprice': bidFloor };
+          }
+          // payload.bidFloor = bidFloor;
+        }
+      }
+
+      if (mediaTypesInfo[VIDEO] !== undefined) {
+        let videoParams = deepAccess(bidRequest, 'mediaTypes.video');
+        Object.keys(videoParams)
+          .filter(key => includes(Object.keys(VIDEO_ORTB_PARAMS), key) && params[VIDEO_ORTB_PARAMS[key]] === undefined)
+          .forEach(key => payload.pfilter[VIDEO_ORTB_PARAMS[key]] = videoParams[key]);
+      }
+      if (Object.keys(payload.pfilter).length == 0) { delete payload.pfilter }
+
+      if (bidderRequest && bidderRequest.gdprConsent) {
+        payload.gdpr_consent = bidderRequest.gdprConsent.consentString;
+        payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
+      }
+
+      if (params.bcat !== undefined) {
+        payload.bcat = deepAccess(bidderRequest.ortb2Imp, 'bcat') || params.bcat;
+      }
+      if (params.dvt !== undefined) {
+        payload.dvt = params.dvt;
+      }
+      if (isDev) {
+        payload.prebidDevMode = 1;
+      }
+
+      if (pbcode) {
+        payload.pbcode = pbcode;
+      }
+
+      payload.media_types = convertMediaInfoForRequest(mediaTypesInfo);
+
+      return {
+        method: 'GET',
+        url: endpoint,
+        data: objectToQueryString(payload),
+      };
+    });
+  },
+  interpretResponse: function(serverResponse, bidRequest) {
+    const bidResponses = [];
+    const response = serverResponse.body;
+    const crid = response.crid || 0;
+    const cpm = response.cpm / 1000000 || 0;
+    if (cpm !== 0 && crid !== 0) {
+      const dealId = response.dealid || '';
+      const currency = response.currency || 'EUR';
+      const netRevenue = (response.netRevenue === undefined) ? true : response.netRevenue;
+      const bidResponse = {
+        requestId: response.bid_id,
+        cpm: cpm,
+        width: response.width,
+        height: response.height,
+        creativeId: crid,
+        dealId: dealId,
+        currency: currency,
+        netRevenue: netRevenue,
+        ttl: config.getConfig('_bidderTimeout'),
+        meta: {
+          advertiserDomains: response.adomain || []
+        }
+      };
+      if (response.vastXml) {
+        bidResponse.vastXml = response.vastXml;
+        bidResponse.mediaType = 'video';
+      } else {
+        bidResponse.ad = response.adTag;
+      }
+
+      bidResponses.push(bidResponse);
+    }
+    return bidResponses;
+  },
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
+    if (!serverResponses || serverResponses.length === 0) {
+      return [];
+    }
+
+    const syncs = []
+
+    let gdprParams = '';
+    if (gdprConsent) {
+      if ('gdprApplies' in gdprConsent && typeof gdprConsent.gdprApplies === 'boolean') {
+        gdprParams = `gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
+      } else {
+        gdprParams = `gdpr_consent=${gdprConsent.consentString}`;
+      }
+    }
+
+    if (serverResponses.length > 0 && serverResponses[0].body !== undefined &&
+        serverResponses[0].body.userSync !== undefined && serverResponses[0].body.userSync.iframeUrl !== undefined &&
+        serverResponses[0].body.userSync.iframeUrl.length > 0) {
+      if (syncOptions.iframeEnabled) {
+        serverResponses[0].body.userSync.iframeUrl.forEach((url) => syncs.push({
+          type: 'iframe',
+          url: appendToUrl(url, gdprParams)
+        }));
+      }
+      if (syncOptions.pixelEnabled) {
+        serverResponses[0].body.userSync.imageUrl.forEach((url) => syncs.push({
+          type: 'image',
+          url: appendToUrl(url, gdprParams)
+        }));
+      }
+    }
+    return syncs;
+  }
+}
+
+function appendToUrl(url, what) {
+  if (!what) {
+    return url;
+  }
+  return url + (url.indexOf('?') !== -1 ? '&' : '?') + what;
+}
+
+function objectToQueryString(obj, prefix) {
+  let str = [];
+  let p;
+  for (p in obj) {
+    if (obj.hasOwnProperty(p)) {
+      let k = prefix ? prefix + '[' + p + ']' : p;
+      let v = obj[p];
+      str.push((v !== null && typeof v === 'object')
+        ? objectToQueryString(v, k)
+        : encodeURIComponent(k) + '=' + encodeURIComponent(v));
+    }
+  }
+  return str.join('&');
+}
+
+/**
+ * Check if it's a banner bid request
+ *
+ * @param {BidRequest} bid - Bid request generated from ad slots
+ * @returns {boolean} True if it's a banner bid
+ */
+function isBannerRequest(bid) {
+  return bid.mediaType === 'banner' || !!deepAccess(bid, 'mediaTypes.banner') || !isVideoRequest(bid);
+}
+
+/**
+ * Check if it's a video bid request
+ *
+ * @param {BidRequest} bid - Bid request generated from ad slots
+ * @returns {boolean} True if it's a video bid
+ */
+function isVideoRequest(bid) {
+  return bid.mediaType === 'video' || !!deepAccess(bid, 'mediaTypes.video');
+}
+
+/**
+ * Get video sizes
+ *
+ * @param {BidRequest} bid - Bid request generated from ad slots
+ * @returns {object} True if it's a video bid
+ */
+function getVideoSizes(bid) {
+  return parseSizes(deepAccess(bid, 'mediaTypes.video.playerSize') || bid.sizes);
+}
+
+/**
+ * Get banner sizes
+ *
+ * @param {BidRequest} bid - Bid request generated from ad slots
+ * @returns {object} True if it's a video bid
+ */
+function getBannerSizes(bid) {
+  return parseSizes(deepAccess(bid, 'mediaTypes.banner.sizes') || bid.sizes);
+}
+
+/**
+ * Parse size
+ * @param sizes
+ * @returns {width: number, h: height}
+ */
+function parseSize(size) {
+  let sizeObj = {}
+  sizeObj.width = parseInt(size[0], 10);
+  sizeObj.height = parseInt(size[1], 10);
+  return sizeObj;
+}
+
+/**
+ * Parse sizes
+ * @param sizes
+ * @returns {{width: number , height: number }[]}
+ */
+function parseSizes(sizes) {
+  if (Array.isArray(sizes[0])) { // is there several sizes ? (ie. [[728,90],[200,300]])
+    return sizes.map(size => parseSize(size));
+  }
+  return [parseSize(sizes)]; // or a single one ? (ie. [728,90])
+}
+
+/**
+ * Get MediaInfo object for server request
+ *
+ * @param mediaTypesInfo
+ * @returns {*}
+ */
+function convertMediaInfoForRequest(mediaTypesInfo) {
+  let requestData = {};
+  Object.keys(mediaTypesInfo).forEach(mediaType => {
+    requestData[mediaType] = mediaTypesInfo[mediaType].map(size => {
+      return size.width + 'x' + size.height;
+    }).join(',');
+  });
+  return requestData;
+}
+
+/**
+ * Get Bid Floor
+ * @param bid
+ * @returns {number|*}
+ */
+function getBidFloor(bid) {
+  if (typeof bid.getFloor !== 'function') {
+    return deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'EUR',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0
+  }
+}
+
+/**
+ * Get media types info
+ *
+ * @param bid
+ */
+function getMediaTypesInfo(bid) {
+  let mediaTypesInfo = {};
+
+  if (bid.mediaTypes) {
+    Object.keys(bid.mediaTypes).forEach(mediaType => {
+      if (mediaType === BANNER) {
+        mediaTypesInfo[mediaType] = getBannerSizes(bid);
+      }
+      if (mediaType === VIDEO) {
+        mediaTypesInfo[mediaType] = getVideoSizes(bid);
+      }
+    });
+  } else {
+    mediaTypesInfo[BANNER] = getBannerSizes(bid);
+  }
+  return mediaTypesInfo;
+}
+
+registerBidder(spec);
diff --git a/modules/stvBidAdapter.md b/modules/stvBidAdapter.md
@@ -0,0 +1,62 @@
+# Overview
+
+```
+Module Name: STV/Smartstream Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: prebid@smartstream.tv
+```
+
+# Description
+
+STV/Smartstream adapter for Prebid.
+
+# Test Parameters
+```
+    var adUnits = [
+        {
+            code: 'test-div',
+            mediaTypes: {
+                banner: {
+                    sizes: [
+                      [300, 250],
+                      [300, 600],
+                    ]
+                }
+            },
+            bids: [
+                {
+                    bidder: "stv",
+                    params: {
+                        placement: '101',   // [required] info available from your contact with Smartstream team
+                        /* // [optional params]
+                            bcat:  "IAB2,IAB4",  // [optional] list of blocked advertiser categories (IAB), comma separated 
+                        */
+                    }
+                }
+            ]
+        },
+        {
+            code: 'video1',
+            mediaTypes: {
+                video: {
+                    playerSize: [640, 480],
+                    context: 'instream'
+                }
+            },
+            bids: [{
+                bidder: 'stv',
+                params: {
+                    placement: '106',
+                    /* // [optional params]
+                        bcat:  "IAB2,IAB4",  // [optional] list of blocked advertiser categories (IAB), comma separated 
+                        floorprice: 1000000, // input min_cpm_micros, CPM in EUR * 1000000
+                        max_duration: 60,    // in seconds
+                        min_duration: 5,     // in seconds
+                        max_bitrate: 600,   
+                        api: [1,2],          // https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-
+                    */
+                }
+            }]
+        }
+    ];
+```
diff --git a/test/spec/modules/stvBidAdapter_spec.js b/test/spec/modules/stvBidAdapter_spec.js
