prebid.js 5.14.0 → 5.18.0

package/modules/sspBCBidAdapter.js

@@ -1,7 +1,7 @@
-import * as utils from '../src/utils.js';
+import { isArray, deepAccess, logWarn, parseUrl } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER } from '../src/mediaTypes.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import strIncludes from 'core-js-pure/features/string/includes.js';
 
 const BIDDER_CODE = 'sspBC';
@@ -9,7 +9,7 @@ const BIDDER_URL = 'https://ssp.wp.pl/bidder/';
 const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
 const TMAX = 450;
-const BIDDER_VERSION = '5.0';
+const BIDDER_VERSION = '5.2';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
@@ -22,7 +22,7 @@ var consentApiVersion;
  */
 const getNotificationPayload = bidData => {
   if (bidData) {
-    const bids = utils.isArray(bidData) ? bidData : [bidData];
+    const bids = isArray(bidData) ? bidData : [bidData];
     if (bids.length > 0) {
       const result = {
         requestId: undefined,
@@ -31,7 +31,7 @@ const getNotificationPayload = bidData => {
         slotId: [],
       }
       bids.forEach(bid => {
-        let params = utils.isArray(bid.params) ? bid.params[0] : bid.params;
+        let params = isArray(bid.params) ? bid.params[0] : bid.params;
         params = params || {};
 
         // check for stored detection
@@ -122,7 +122,7 @@ const applyGdpr = (bidderRequest, ortbRequest) => {
 /**
  * Get value for first occurence of key within the collection
  */
-const setOnAny = (collection, key) => collection.reduce((prev, next) => prev || utils.deepAccess(next, key), false);
+const setOnAny = (collection, key) => collection.reduce((prev, next) => prev || deepAccess(next, key), false);
 
 /**
  * Send payload to notification endpoint
@@ -141,7 +141,7 @@ const sendNotification = payload => {
  */
 const mapBanner = slot => {
   if (slot.mediaType === 'banner' ||
-    utils.deepAccess(slot, 'mediaTypes.banner') ||
+    deepAccess(slot, 'mediaTypes.banner') ||
     (!slot.mediaType && !slot.mediaTypes)) {
     const format = slot.sizes.map(size => ({
       w: size[0],
@@ -155,6 +155,108 @@ const mapBanner = slot => {
   }
 }
 
+/**
+ * @param {string} paramName Native parameter name
+ * @param {object} paramValue Native parameter value
+ * @returns {object} native asset object that conforms to ortb native ads spec
+ */
+const mapAsset = (paramName, paramValue) => {
+  let asset;
+  switch (paramName) {
+    case 'title':
+      asset = {
+        id: 0,
+        required: paramValue.required,
+        title: { len: paramValue.len }
+      }
+      break;
+    case 'cta':
+      asset = {
+        id: 1,
+        required: paramValue.required,
+        data: { type: 12 }
+      }
+      break;
+    case 'icon':
+      asset = {
+        id: 2,
+        required: paramValue.required,
+        img: { type: 1, w: paramValue.sizes[0], h: paramValue.sizes[1] }
+      }
+      break;
+    case 'image':
+      asset = {
+        id: 3,
+        required: paramValue.required,
+        img: { type: 3, w: paramValue.sizes[0], h: paramValue.sizes[1] }
+      }
+      break;
+    case 'body':
+      asset = {
+        id: 4,
+        required: paramValue.required,
+        data: { type: 2 }
+      }
+      break;
+    case 'sponsoredBy':
+      asset = {
+        id: 5,
+        required: paramValue.required,
+        data: { type: 1 }
+      }
+      break;
+  }
+  return asset;
+}
+
+/**
+ * @param {object} slot Ad Unit Params by Prebid
+ * @returns {object} native object that conforms to ortb native ads spec
+ */
+const mapNative = slot => {
+  const native = deepAccess(slot, 'mediaTypes.native');
+  let assets;
+  if (native) {
+    const nativeParams = Object.keys(native);
+    assets = [];
+    nativeParams.forEach(par => {
+      const newAsset = mapAsset(par, native[par]);
+      if (newAsset) { assets.push(newAsset) };
+    });
+  }
+  return assets ? { request: JSON.stringify({ native: { assets } }) } : undefined;
+}
+
+var mapVideo = slot => {
+  var video = deepAccess(slot, 'mediaTypes.video');
+  var videoParamsUsed = ['api', 'context', 'linearity', 'maxduration', 'mimes', 'protocols'];
+  var videoAssets;
+
+  if (video) {
+    var videoParams = Object.keys(video);
+    var playerSize = video.playerSize;
+    videoAssets = {}; // player width / height
+
+    if (playerSize) {
+      var maxSize = playerSize.reduce(function (prev, next) {
+        return next[0] >= prev[0] && next[1] >= prev[1] ? next : prev;
+      }, [1, 1]);
+      videoAssets.w = maxSize[0];
+      videoAssets.h = maxSize[1];
+    } // remaining supported params
+
+    videoParams.forEach(function (par) {
+      if (videoParamsUsed.indexOf(par) >= 0) {
+        videoAssets[par] = video[par];
+      }
+
+      ;
+    });
+  }
+
+  return videoAssets;
+};
+
 const mapImpression = slot => {
   const { adUnitCode, bidId, params = {}, ortb2Imp = {} } = slot;
   const { id, siteId } = params;
@@ -165,32 +267,100 @@ const mapImpression = slot => {
      send this info as ext.pbsize
   */
   const slotSize = slot.sizes.length ? slot.sizes.reduce((prev, next) => prev[0] * prev[1] <= next[0] * next[1] ? next : prev).join('x') : '1x1';
-  adSizesCalled[slotSize] = adSizesCalled[slotSize] ? adSizesCalled[slotSize] + 1 : 1;
+  adSizesCalled[slotSize] = adSizesCalled[slotSize] ? adSizesCalled[slotSize] += 1 : 1;
   ext.data = Object.assign({ pbsize: `${slotSize}_${adSizesCalled[slotSize]}` }, ext.data);
 
   const imp = {
     id: id && siteId ? id : 'bidid-' + bidId,
     banner: mapBanner(slot),
-    // native: mapNative(slot),
+    native: mapNative(slot),
+    video: mapVideo(slot),
     tagid: adUnitCode,
     ext,
   };
 
   // Check floorprices for this imp
   if (typeof slot.getFloor === 'function') {
-    let bannerFloor = 0;
-    // sspBC adapter accepts only floor per imp - check for maximum value for requested ad types and sizes
+    var bannerFloor = 0;
+    var nativeFloor = 0;
+    var videoFloor = 0; // sspBC adapter accepts only floor per imp - check for maximum value for requested ad types and sizes
+
     if (slot.sizes.length) {
-      bannerFloor = slot.sizes.reduce((prev, next) => {
-        const currentFloor = slot.getFloor({ mediaType: 'banner', size: next }).floor;
+      bannerFloor = slot.sizes.reduce(function (prev, next) {
+        var currentFloor = slot.getFloor({
+          mediaType: 'banner',
+          size: next
+        }).floor;
         return prev > currentFloor ? prev : currentFloor;
       }, 0);
     }
-    imp.bidfloor = bannerFloor;
+
+    nativeFloor = slot.getFloor({
+      mediaType: 'native'
+    });
+    videoFloor = slot.getFloor({
+      mediaType: 'video'
+    });
+    imp.bidfloor = Math.max(bannerFloor, nativeFloor, videoFloor);
   }
   return imp;
 }
 
+const isVideoAd = bid => {
+  const xmlTester = new RegExp(/^<\?xml/);
+  return bid.adm && bid.adm.match(xmlTester);
+}
+
+const isNativeAd = bid => {
+  const xmlTester = new RegExp(/^{['"]native['"]/);
+
+  return bid.adm && bid.adm.match(xmlTester);
+}
+
+const parseNative = nativeData => {
+  const result = {};
+  nativeData.assets.forEach(asset => {
+    const id = parseInt(asset.id);
+    switch (id) {
+      case 0:
+        result.title = asset.title.text;
+        break;
+      case 2:
+        result.icon = {
+          url: asset.img.url,
+          width: asset.img.w,
+          height: asset.img.h,
+        };
+        break;
+      case 3:
+        result.image = {
+          url: asset.img.url,
+          width: asset.img.w,
+          height: asset.img.h,
+        };
+        break;
+      case 4:
+        result.body = asset.data.value;
+        break;
+      case 5:
+        result.sponsoredBy = asset.data.value;
+        break;
+
+      default:
+        logWarn('Unrecognized native asset', asset);
+    }
+  });
+  result.clickUrl = nativeData.link.url;
+  result.impressionTrackers = nativeData.imptrackers;
+
+  if (isArray(nativeData.jstracker)) {
+    result.javascriptTrackers = nativeData.jstracker;
+  } else if (nativeData.jstracker) {
+    result.javascriptTrackers = [nativeData.jstracker];
+  }
+  return result;
+}
+
 const renderCreative = (site, auctionId, bid, seat, request) => {
   let gam;
 
@@ -225,7 +395,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
         gam.targeting = {};
       }
     } catch (err) {
-      utils.logWarn('Could not parse adm data', bid.adm);
+      logWarn('Could not parse adm data', bid.adm);
     }
   }
 
@@ -243,6 +413,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
   <script>
   window.rekid = ${site.id};
   window.slot = ${parseInt(site.slot, 10)};
+  window.responseTimestamp = ${Date.now()};
   window.wp_sn = "${site.sn}";
   window.mcad = JSON.parse(decodeURI(atob("${mcbase}")));
   window.gdpr = ${JSON.stringify(request.gdprConsent)};
@@ -268,7 +439,7 @@ const renderCreative = (site, auctionId, bid, seat, request) => {
 const spec = {
   code: BIDDER_CODE,
   aliases: [],
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, NATIVE, VIDEO],
   isBidRequestValid(bid) {
     // as per OneCode integration, bids without params are valid
     return true;
@@ -281,7 +452,7 @@ const spec = {
     const siteId = setOnAny(validBidRequests, 'params.siteId');
     const publisherId = setOnAny(validBidRequests, 'params.publisherId');
     const page = setOnAny(validBidRequests, 'params.page') || bidderRequest.refererInfo.referer;
-    const domain = setOnAny(validBidRequests, 'params.domain') || utils.parseUrl(page).hostname;
+    const domain = setOnAny(validBidRequests, 'params.domain') || parseUrl(page).hostname;
     const tmax = setOnAny(validBidRequests, 'params.tmax') ? parseInt(setOnAny(validBidRequests, 'params.tmax'), 10) : TMAX;
     const pbver = '$prebid.version$';
     const testMode = setOnAny(validBidRequests, 'params.test') ? 1 : undefined;
@@ -377,20 +548,44 @@ const spec = {
               width: w,
               height: h,
               bidderCode: BIDDER_CODE,
-              mediaType: 'banner',
               meta: {
                 advertiserDomains: adomain,
                 networkName: seat,
               },
               netRevenue: true,
-              ad: renderCreative(site, response.id, serverBid, seat, bidderRequest),
             };
 
+            // mediaType and ad data for instream / native / banner
+            if (isVideoAd(serverBid)) {
+              // video
+              bid.adType = 'instream';
+              bid.mediaType = 'video';
+              bid.vastXml = serverBid.adm;
+              bid.vastContent = serverBid.adm;
+            } else if (isNativeAd(serverBid)) {
+              // native
+              bid.mediaType = 'native';
+              // check native object
+              try {
+                const nativeData = JSON.parse(serverBid.adm).native;
+                bid.native = parseNative(nativeData);
+                bid.width = 1;
+                bid.height = 1;
+              } catch (err) {
+                logWarn('Could not parse native data', serverBid.adm);
+                bid.cpm = 0;
+              }
+            } else {
+              // banner ad (default)
+              bid.mediaType = 'banner';
+              bid.ad = renderCreative(site, response.id, serverBid, seat, bidderRequest);
+            }
+
             if (bid.cpm > 0) {
               bids.push(bid);
             }
           } else {
-            utils.logWarn('Discarding response - no matching request / site id', serverBid.impid);
+            logWarn('Discarding response - no matching request / site id', serverBid.impid);
           }
         });
       });
@@ -405,7 +600,7 @@ const spec = {
         url: `${SYNC_URL}?tcf=${consentApiVersion}`,
       }];
     } else {
-      utils.logWarn('sspBC adapter requires iframe based user sync.');
+      logWarn('sspBC adapter requires iframe based user sync.');
     }
   },
 

package/modules/sspBCBidAdapter.md

@@ -7,7 +7,7 @@ Maintainer: wojciech.bialy@grupawp.pl
 # Description
 
 Module that connects to Wirtualna Polska Media header bidding endpoint to fetch bids.
-Only banner format is supported.
+Supports Banner, Video (instream) and Native formats 
 Supported currencies: USD, EUR, PLN
 
 Required parameters:

package/modules/staqAnalyticsAdapter.js

@@ -1,8 +1,8 @@
+import { logInfo, logError, parseUrl, _each } from '../src/utils.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { getRefererInfo } from '../src/refererDetection.js';
-import * as utils from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { getStorageManager } from '../src/storageManager.js';
 
@@ -94,14 +94,14 @@ analyticsAdapter.context = {};
 analyticsAdapter.originEnableAnalytics = analyticsAdapter.enableAnalytics;
 
 analyticsAdapter.enableAnalytics = (config) => {
-  utils.logInfo('Enabling STAQ Adapter');
+  logInfo('Enabling STAQ Adapter');
   staqAdapterRefWin = getRefererInfo(window);
   if (!config.options.connId) {
-    utils.logError('ConnId is not defined. STAQ Analytics won\'t work');
+    logError('ConnId is not defined. STAQ Analytics won\'t work');
     return;
   }
   if (!config.options.url) {
-    utils.logError('URL is not defined. STAQ Analytics won\'t work');
+    logError('URL is not defined. STAQ Analytics won\'t work');
     return;
   }
   analyticsAdapter.context = {
@@ -133,7 +133,7 @@ function sendAll() {
 }
 
 analyticsAdapter.ajaxCall = function ajaxCall(data) {
-  utils.logInfo('SENDING DATA: ' + data);
+  logInfo('SENDING DATA: ' + data);
   ajax(`https://${analyticsAdapter.context.url}/prebid/${analyticsAdapter.context.connectionId}`, () => {}, data, { contentType: 'text/plain' });
 };
 
@@ -248,7 +248,7 @@ export function getUmtSource(pageUrl, referrer) {
       if (se) {
         return asUtm(se, ORGANIC, ORGANIC);
       }
-      let parsedUrl = utils.parseUrl(pageUrl);
+      let parsedUrl = parseUrl(pageUrl);
       let [refHost, refPath] = getReferrer(referrer);
       if (refHost && refHost !== parsedUrl.hostname) {
         return asUtm(refHost, REFERRAL, REFERRAL, '', refPath);
@@ -275,17 +275,17 @@ export function getUmtSource(pageUrl, referrer) {
   }
 
   function getReferrer(referrer) {
-    let ref = utils.parseUrl(referrer);
+    let ref = parseUrl(referrer);
     return [ref.hostname, ref.pathname];
   }
 
   function getUTM(pageUrl) {
-    let urlParameters = utils.parseUrl(pageUrl).search;
+    let urlParameters = parseUrl(pageUrl).search;
     if (!urlParameters['utm_campaign'] || !urlParameters['utm_source']) {
       return;
     }
     let utmArgs = [];
-    utils._each(UTM_TAGS, (utmTagName) => {
+    _each(UTM_TAGS, (utmTagName) => {
       let utmValue = urlParameters[utmTagName] || '';
       utmArgs.push(utmValue);
     });

package/modules/stroeerCoreBidAdapter.js

@@ -1,6 +1,6 @@
+import { getWindowSelf, getWindowTop, buildUrl, logError, isStr, isEmpty, deepAccess } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
-import * as utils from '../src/utils.js';
 
 const GVL_ID = 136;
 const BIDDER_CODE = 'stroeerCore';
@@ -10,22 +10,22 @@ const DEFAULT_PORT = '';
 const FIVE_MINUTES_IN_SECONDS = 300;
 const USER_SYNC_IFRAME_URL = 'https://js.adscale.de/pbsync.html';
 
-const isSecureWindow = () => utils.getWindowSelf().location.protocol === 'https:';
-const isMainPageAccessible = () => getMostAccessibleTopWindow() === utils.getWindowTop();
+const isSecureWindow = () => getWindowSelf().location.protocol === 'https:';
+const isMainPageAccessible = () => getMostAccessibleTopWindow() === getWindowTop();
 
 function getTopWindowReferrer() {
   try {
-    return utils.getWindowTop().document.referrer;
+    return getWindowTop().document.referrer;
   } catch (e) {
-    return utils.getWindowSelf().referrer;
+    return getWindowSelf().referrer;
   }
 }
 
 function getMostAccessibleTopWindow() {
-  let res = utils.getWindowSelf();
+  let res = getWindowSelf();
 
   try {
-    while (utils.getWindowTop().top !== res && res.parent.location.href.length) {
+    while (getWindowTop().top !== res && res.parent.location.href.length) {
       res = res.parent;
     }
   } catch (ignore) {
@@ -36,7 +36,7 @@ function getMostAccessibleTopWindow() {
 
 function elementInView(elementId) {
   const resolveElement = (elId) => {
-    const win = utils.getWindowSelf();
+    const win = getWindowSelf();
 
     return win.document.getElementById(elId);
   };
@@ -53,19 +53,19 @@ function elementInView(elementId) {
   };
 
   try {
-    return visibleInWindow(resolveElement(elementId), utils.getWindowSelf());
+    return visibleInWindow(resolveElement(elementId), getWindowSelf());
   } catch (e) {
     // old browser, element not found, cross-origin etc.
   }
   return undefined;
 }
 
-function buildUrl({host: hostname = DEFAULT_HOST, port = DEFAULT_PORT, securePort, path: pathname = DEFAULT_PATH}) {
+function _buildUrl({host: hostname = DEFAULT_HOST, port = DEFAULT_PORT, securePort, path: pathname = DEFAULT_PATH}) {
   if (securePort) {
     port = securePort;
   }
 
-  return utils.buildUrl({protocol: 'https', hostname, port, pathname});
+  return buildUrl({protocol: 'https', hostname, port, pathname});
 }
 
 function getGdprParams(gdprConsent) {
@@ -92,7 +92,7 @@ export const spec = {
         if (checkFn(bidRequest)) {
           return true;
         } else {
-          utils.logError(`invalid bid: ${errorMsgFn(bidRequest)}`, 'ERROR');
+          logError(`invalid bid: ${errorMsgFn(bidRequest)}`, 'ERROR');
           return false;
         }
       }
@@ -108,7 +108,7 @@ export const spec = {
       bidReq => `bid request ${bidReq.bidId} is not a banner`));
     validators.push(createValidator((bidReq) => typeof bidReq.params === 'object',
       bidReq => `bid request ${bidReq.bidId} does not have custom params`));
-    validators.push(createValidator((bidReq) => utils.isStr(bidReq.params.sid),
+    validators.push(createValidator((bidReq) => isStr(bidReq.params.sid),
       bidReq => `bid request ${bidReq.bidId} does not have a sid string field`));
 
     return function (bidRequest) {
@@ -130,7 +130,7 @@ export const spec = {
 
     const userIds = anyBid.userId;
 
-    if (!utils.isEmpty(userIds)) {
+    if (!isEmpty(userIds)) {
       payload.user = {
         euids: userIds
       };
@@ -145,7 +145,7 @@ export const spec = {
     }
 
     function bidSizes(bid) {
-      return utils.deepAccess(bid, 'mediaTypes.banner.sizes') || bid.sizes /* for prebid < 3 */ || [];
+      return deepAccess(bid, 'mediaTypes.banner.sizes') || bid.sizes /* for prebid < 3 */ || [];
     }
 
     validBidRequests.forEach(bid => {
@@ -155,7 +155,7 @@ export const spec = {
     });
 
     return {
-      method: 'POST', url: buildUrl(anyBid.params), data: payload
+      method: 'POST', url: _buildUrl(anyBid.params), data: payload
     }
   },
 

package/modules/sublimeBidAdapter.js

@@ -1,6 +1,6 @@
+import { logInfo, generateUUID, formatQS, triggerPixel, deepAccess } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
-import * as utils from '../src/utils.js';
 
 const BIDDER_CODE = 'sublime';
 const BIDDER_GVLID = 114;
@@ -43,7 +43,7 @@ function isValidNotifyId(value) {
  * @param {Object=} obj
  */
 export function log(msg, obj) {
-  utils.logInfo('SublimeBidAdapter - ' + msg, obj);
+  logInfo('SublimeBidAdapter - ' + msg, obj);
 }
 
 // Default state
@@ -73,7 +73,7 @@ function getNotifyId(params) {
 
   let notifyId = params.notifyId || sublime.notifyId;
   if (!notifyId) {
-    notifyId = utils.generateUUID();
+    notifyId = generateUUID();
     log('generating a notifyId', notifyId);
   }
   if (!sublime.notifyId) {
@@ -110,8 +110,8 @@ export function sendEvent(eventName, sspName) {
 
   log('Sending pixel for event: ' + eventName, eventObject);
 
-  const queryString = utils.formatQS(eventObject);
-  utils.triggerPixel('https://' + SUBLIME_ANTENNA + '/?' + queryString);
+  const queryString = formatQS(eventObject);
+  triggerPixel('https://' + SUBLIME_ANTENNA + '/?' + queryString);
 }
 
 /**
@@ -280,7 +280,7 @@ function onBidWon(bid) {
 function onTimeout(timeoutData) {
   log('Timeout from adapter', timeoutData);
 
-  const timeout = utils.deepAccess(timeoutData, '0.timeout');
+  const timeout = deepAccess(timeoutData, '0.timeout');
   if (timeout) {
     // Set timeout to the one we got from the bid
     setState({ timeout });