prebid.js 5.17.0 → 6.0.0

package/modules/atsAnalyticsAdapter.js

@@ -20,7 +20,7 @@ export const analyticsUrl = 'https://analytics.rlcdn.com';
 let handlerRequest = [];
 let handlerResponse = [];
 
-let atsAnalyticsAdapterVersion = 2;
+let atsAnalyticsAdapterVersion = 3;
 
 let browsersList = [
   /* Googlebot */
@@ -222,7 +222,8 @@ function bidRequestedHandler(args) {
       auction_start: new Date(args.auctionStart).toJSON(),
       domain: window.location.hostname,
       pid: atsAnalyticsAdapter.context.pid,
-      adapter_version: atsAnalyticsAdapterVersion
+      adapter_version: atsAnalyticsAdapterVersion,
+      bid_won: false
     };
   });
   return requests;
@@ -251,13 +252,14 @@ export function parseBrowser() {
   }
 }
 
-function sendDataToAnalytic () {
+function sendDataToAnalytic (events) {
   // send data to ats analytic endpoint
   try {
-    let dataToSend = {'Data': atsAnalyticsAdapter.context.events};
+    let dataToSend = {'Data': events};
     let strJSON = JSON.stringify(dataToSend);
     logInfo('ATS Analytics - tried to send analytics data!');
     ajax(analyticsUrl, function () {
+      logInfo('ATS Analytics - events sent successfully!');
     }, strJSON, {method: 'POST', contentType: 'application/json'});
   } catch (err) {
     logError('ATS Analytics - request encounter an error: ', err);
@@ -265,7 +267,7 @@ function sendDataToAnalytic () {
 }
 
 // preflight request, to check did publisher have permission to send data to analytics endpoint
-function preflightRequest (envelopeSourceCookieValue) {
+function preflightRequest (envelopeSourceCookieValue, events) {
   logInfo('ATS Analytics - preflight request!');
   ajax(preflightUrl + atsAnalyticsAdapter.context.pid,
     {
@@ -276,7 +278,8 @@ function preflightRequest (envelopeSourceCookieValue) {
         atsAnalyticsAdapter.setSamplingCookie(samplingRate);
         let samplingRateNumber = Number(samplingRate);
         if (data && samplingRate && atsAnalyticsAdapter.shouldFireRequest(samplingRateNumber) && envelopeSourceCookieValue != null) {
-          sendDataToAnalytic();
+          logInfo('ATS Analytics - events to send: ', events);
+          sendDataToAnalytic(events);
         }
       },
       error: function () {
@@ -286,29 +289,6 @@ function preflightRequest (envelopeSourceCookieValue) {
     }, undefined, {method: 'GET', crossOrigin: true});
 }
 
-function callHandler(evtype, args) {
-  if (evtype === CONSTANTS.EVENTS.BID_REQUESTED) {
-    handlerRequest = handlerRequest.concat(bidRequestedHandler(args));
-  } else if (evtype === CONSTANTS.EVENTS.BID_RESPONSE) {
-    handlerResponse.push(bidResponseHandler(args));
-  }
-  if (evtype === CONSTANTS.EVENTS.AUCTION_END) {
-    if (handlerRequest.length) {
-      let events = [];
-      if (handlerResponse.length) {
-        events = handlerRequest.filter(request => handlerResponse.filter(function(response) {
-          if (request.bid_id === response.bid_id) {
-            Object.assign(request, response);
-          }
-        }));
-      } else {
-        events = handlerRequest;
-      }
-      atsAnalyticsAdapter.context.events = events;
-    }
-  }
-}
-
 let atsAnalyticsAdapter = Object.assign(adapter(
   {
     analyticsType
@@ -316,22 +296,7 @@ let atsAnalyticsAdapter = Object.assign(adapter(
 {
   track({eventType, args}) {
     if (typeof args !== 'undefined') {
-      callHandler(eventType, args);
-    }
-    if (eventType === CONSTANTS.EVENTS.AUCTION_END) {
-      let envelopeSourceCookieValue = storage.getCookie('_lr_env_src_ats');
-      try {
-        let samplingRateCookie = storage.getCookie('_lr_sampling_rate');
-        if (!samplingRateCookie) {
-          preflightRequest(envelopeSourceCookieValue);
-        } else {
-          if (atsAnalyticsAdapter.shouldFireRequest(parseInt(samplingRateCookie)) && envelopeSourceCookieValue != null) {
-            sendDataToAnalytic();
-          }
-        }
-      } catch (err) {
-        logError('ATS Analytics - preflight request encounter an error: ', err);
-      }
+      atsAnalyticsAdapter.callHandler(eventType, args);
     }
   }
 });
@@ -369,13 +334,69 @@ atsAnalyticsAdapter.enableAnalytics = function (config) {
   }
   atsAnalyticsAdapter.context = {
     events: [],
-    pid: config.options.pid
+    pid: config.options.pid,
+    bidWonTimeout: config.options.bidWonTimeout
   };
   let initOptions = config.options;
   logInfo('ATS Analytics - adapter enabled! ');
   atsAnalyticsAdapter.originEnableAnalytics(initOptions); // call the base class function
 };
 
+atsAnalyticsAdapter.callHandler = function (evtype, args) {
+  if (evtype === CONSTANTS.EVENTS.BID_REQUESTED) {
+    handlerRequest = handlerRequest.concat(bidRequestedHandler(args));
+  } else if (evtype === CONSTANTS.EVENTS.BID_RESPONSE) {
+    handlerResponse.push(bidResponseHandler(args));
+  }
+  if (evtype === CONSTANTS.EVENTS.AUCTION_END) {
+    let bidWonTimeout = atsAnalyticsAdapter.context.bidWonTimeout ? atsAnalyticsAdapter.context.bidWonTimeout : 2000;
+    let events = [];
+    setTimeout(() => {
+      let winningBids = $$PREBID_GLOBAL$$.getAllWinningBids();
+      logInfo('ATS Analytics - winning bids: ', winningBids)
+      // prepare format data for sending to analytics endpoint
+      if (handlerRequest.length) {
+        let wonEvent = {};
+        if (handlerResponse.length) {
+          events = handlerRequest.filter(request => handlerResponse.filter(function (response) {
+            if (request.bid_id === response.bid_id) {
+              Object.assign(request, response);
+            }
+          }));
+          if (winningBids.length) {
+            events = events.filter(event => winningBids.filter(function (won) {
+              wonEvent.bid_id = won.requestId;
+              wonEvent.bid_won = true;
+              if (event.bid_id === wonEvent.bid_id) {
+                Object.assign(event, wonEvent);
+              }
+            }))
+          }
+        } else {
+          events = handlerRequest;
+        }
+        // check should we send data to analytics or not, check first cookie value _lr_sampling_rate
+        try {
+          let envelopeSourceCookieValue = storage.getCookie('_lr_env_src_ats');
+          let samplingRateCookie = storage.getCookie('_lr_sampling_rate');
+          if (!samplingRateCookie) {
+            preflightRequest(envelopeSourceCookieValue, events);
+          } else {
+            if (atsAnalyticsAdapter.shouldFireRequest(parseInt(samplingRateCookie)) && envelopeSourceCookieValue != null) {
+              logInfo('ATS Analytics - events to send: ', events);
+              sendDataToAnalytic(events);
+            }
+          }
+          // empty events array to not send duplicate events
+          events = [];
+        } catch (err) {
+          logError('ATS Analytics - preflight request encounter an error: ', err);
+        }
+      }
+    }, bidWonTimeout);
+  }
+}
+
 adaptermanager.registerAnalyticsAdapter({
   adapter: atsAnalyticsAdapter,
   code: 'atsAnalytics',

package/modules/atsAnalyticsAdapter.md

@@ -17,6 +17,7 @@ Analytics adapter for Authenticated Traffic Solution(ATS), provided by LiveRamp.
   provider: 'atsAnalytics',
   options: {
      pid: '999', // publisher ID
+     bidWonTimeout: 2000 // on auction end for how long to wait for bid_won events, by default it's 2000 miliseconds, if it's not set it will be 2000 miliseconds.  
   }
 }
 ```

package/modules/betweenBidAdapter.js

@@ -3,12 +3,14 @@ import { getAdUnitSizes, parseSizesInput } from '../src/utils.js';
 import { getRefererInfo } from '../src/refererDetection.js';
 
 const BIDDER_CODE = 'between';
-const ENDPOINT = 'https://ads.betweendigital.com/adjson?t=prebid';
+let ENDPOINT = 'https://ads.betweendigital.com/adjson?t=prebid';
+const CODE_TYPES = ['inpage', 'preroll', 'midroll', 'postroll'];
 
+const includes = require('core-js-pure/features/array/includes.js');
 export const spec = {
   code: BIDDER_CODE,
   aliases: ['btw'],
-  supportedMediaTypes: ['banner'],
+  supportedMediaTypes: ['banner', 'video'],
   /**
    * Determines whether or not the given bid request is valid.
    *
@@ -30,6 +32,8 @@ export const spec = {
     const refInfo = getRefererInfo();
 
     validBidRequests.forEach((i) => {
+      const video = i.mediaTypes && i.mediaTypes.video;
+
       let params = {
         eids: getUsersIds(i),
         sizes: parseSizesInput(getAdUnitSizes(i)),
@@ -38,12 +42,21 @@ export const spec = {
         tz: getTz(),
         fl: getFl(),
         rr: getRr(),
-        s: i.params.s,
+        s: i.params && i.params.s,
         bidid: i.bidId,
         transactionid: i.transactionId,
         auctionid: i.auctionId
       };
 
+      if (video) {
+        params.mediaType = 2;
+        params.maxd = video.maxd;
+        params.mind = video.mind;
+        params.pos = 'atf';
+        ENDPOINT += '&jst=pvc';
+        params.codeType = includes(CODE_TYPES, video.codeType) ? video.codeType : 'inpage';
+      }
+
       if (i.params.itu !== undefined) {
         params.itu = i.params.itu;
       }
@@ -94,12 +107,15 @@ export const spec = {
    */
   interpretResponse: function(serverResponse, bidRequest) {
     const bidResponses = [];
+
     for (var i = 0; i < serverResponse.body.length; i++) {
       let bidResponse = {
         requestId: serverResponse.body[i].bidid,
         cpm: serverResponse.body[i].cpm || 0,
         width: serverResponse.body[i].w,
         height: serverResponse.body[i].h,
+        vastXml: serverResponse.body[i].vastXml,
+        mediaType: serverResponse.body[i].mediaType,
         ttl: serverResponse.body[i].ttl,
         creativeId: serverResponse.body[i].creativeid,
         currency: serverResponse.body[i].currency || 'RUB',
@@ -109,6 +125,7 @@ export const spec = {
           advertiserDomains: serverResponse.body[i].adomain ? serverResponse.body[i].adomain : []
         }
       };
+
       bidResponses.push(bidResponse);
     }
     return bidResponses;

package/modules/bliinkBidAdapter.js

@@ -10,10 +10,9 @@ export const META_KEYWORDS = 'keywords'
 export const META_DESCRIPTION = 'description'
 
 const VIDEO = 'video'
-const NATIVE = 'native'
 const BANNER = 'banner'
 
-const supportedMediaTypes = [BANNER, VIDEO, NATIVE]
+const supportedMediaTypes = [BANNER, VIDEO]
 const aliasBidderCode = ['bk']
 
 export function getMetaList(name) {
@@ -90,7 +89,11 @@ export const parseXML = (content) => {
   if (typeof content !== 'string' || content.length === 0) return null
 
   const parser = new DOMParser()
-  const xml = parser.parseFromString(content, 'text/xml')
+  let xml;
+
+  try {
+    xml = parser.parseFromString(content, 'text/xml')
+  } catch (e) {}
 
   if (xml &&
     xml.getElementsByTagName('VAST')[0] &&
@@ -104,19 +107,19 @@ export const parseXML = (content) => {
 /**
  * @param bidRequest
  * @param bliinkCreative
- * @return {{cpm, netRevenue: boolean, ad: string, requestId, width: number, currency: string, mediaType: string, vastXml, ttl: number, height: number}|null}
+ * @return {{cpm, netRevenue: boolean, requestId, width: (*|number), currency, ttl: number, creativeId, height: (*|number)} & {mediaType: string, vastXml}}
  */
 export const buildBid = (bidRequest, bliinkCreative) => {
   if (!bidRequest && !bliinkCreative) return null
 
   const body = {
     requestId: bidRequest.bidId,
+    currency: bliinkCreative.currency,
     cpm: bliinkCreative.price,
     creativeId: bliinkCreative.creativeId,
-    currency: 'EUR',
+    width: (bidRequest.sizes && bidRequest.sizes[0][0]) || 1,
+    height: (bidRequest.sizes && bidRequest.sizes[0][1]) || 1,
     netRevenue: false,
-    width: 1,
-    height: 1,
     ttl: 3600,
   }
 
@@ -131,14 +134,20 @@ export const buildBid = (bidRequest, bliinkCreative) => {
 
   delete bidRequest['bids']
 
-  return Object.assign(body, {
-    currency: bliinkCreative.currency,
-    width: 1,
-    height: 1,
-    mediaType: VIDEO,
-    ad: '<html lang="en"></html>',
-    vastXml: bliinkCreative.content,
-  })
+  switch (bliinkCreative.media_type) {
+    case VIDEO:
+      return Object.assign(body, {
+        mediaType: VIDEO,
+        vastXml: bliinkCreative.content,
+      })
+    case BANNER:
+      return Object.assign(body, {
+        mediaType: BANNER,
+        ad: (bliinkCreative && bliinkCreative.content && bliinkCreative.content.creative && bliinkCreative.content.creative.adm) || '',
+      })
+    default:
+      break;
+  }
 }
 
 /**
@@ -209,7 +218,7 @@ export const buildRequests = (_, bidderRequest) => {
  * @return
  */
 const interpretResponse = (serverResponse, request) => {
-  if ((serverResponse && serverResponse.mode === 'no-ad') && (!request.params)) {
+  if ((serverResponse && serverResponse.mode === 'no-ad')) {
     return []
   }
 
@@ -218,23 +227,40 @@ const interpretResponse = (serverResponse, request) => {
 
   const xml = parseXML(body)
 
-  if (xml) {
-    const price = xml.getElementsByTagName('Price') && xml.getElementsByTagName('Price')[0]
-    const currency = xml.getElementsByTagName('Currency') && xml.getElementsByTagName('Currency')[0]
-    const creativeId = xml.getElementsByTagName('CreativeId') && xml.getElementsByTagName('CreativeId')[0]
-
-    const creative = {
-      content: body,
-      price: (price && price.textContent) || 0,
-      currency: (currency && currency.textContent) || 'EUR',
-      creativeId: creativeId || 0,
-      media_type: 'video',
-    }
-
-    return buildBid(serverBody.bids[0], creative);
+  let creative;
+
+  switch (serverBody.bids[0].params.placement) {
+    case xml && VIDEO:
+      const price = xml.getElementsByTagName('Price') && xml.getElementsByTagName('Price')[0]
+      const currency = xml.getElementsByTagName('Currency') && xml.getElementsByTagName('Currency')[0]
+      const creativeId = xml.getElementsByTagName('CreativeId') && xml.getElementsByTagName('CreativeId')[0]
+
+      creative = {
+        content: body,
+        price: (price && price.textContent) || 0,
+        currency: (currency && currency.textContent) || 'EUR',
+        creativeId: creativeId || 0,
+        media_type: 'video',
+      }
+
+      return buildBid(serverBody.bids[0], creative)
+    case BANNER:
+      if (body) {
+        creative = {
+          content: body,
+          price: body.price,
+          currency: body.currency,
+          creativeId: 0,
+          media_type: 'banner',
+        }
+
+        return buildBid(serverBody.bids[0], creative)
+      }
+
+      break
+    default:
+      break
   }
-
-  return []
 }
 
 /**

package/modules/bliinkBidAdapter.md

@@ -31,7 +31,7 @@ const adUnits = [
         bidder: 'bliink',
         params: {
           placement: 'banner',
-          tagId: '14f30eca-85d2-11e8-9eed-0242ac120007'
+          tagId: '41'
         }
       }
     ]
@@ -50,11 +50,34 @@ const adUnits = [
     mediaTypes: {
       video: {
         context: 'instream',
-        playerSize: [640, 480],
-        mimes: ['video/mp4'],
-        protocols: [1, 2, 3, 4, 5, 6, 7, 8],
-        playbackmethod: [2],
-        skip: 1
+        playerSize: [[640,480]],
+      }
+    },
+    bids: [
+      {
+        bidder: 'bliink',
+        params: {
+          tagId: '41',
+          placement: 'video',
+        }
+      }
+    ]
+  }
+]
+```
+
+## Sample outstream Video Ad Unit
+
+```js
+const adUnits = [
+  {
+    code: '/19968336/prebid_cache_video_adunit',
+    sizes: [[640,480]],
+    mediaType: 'video',
+    mediaTypes: {
+      video: {
+        context: 'outstream',
+        playerSize: [[640,480]],
       }
     },
     bids: [

package/modules/browsiRtdProvider.js

@@ -15,21 +15,27 @@
  * @property {?string} keyName
  */
 
-import { deepClone, logError, isGptPubadsDefined } from '../src/utils.js';
+import { deepClone, logError, isGptPubadsDefined, isNumber, isFn, deepSetValue } from '../src/utils.js';
 import {submodule} from '../src/hook.js';
 import {ajaxBuilder} from '../src/ajax.js';
 import {loadExternalScript} from '../src/adloader.js';
 import {getStorageManager} from '../src/storageManager.js';
 import find from 'core-js-pure/features/array/find.js';
+import {getGlobal} from '../src/prebidGlobal.js';
+import includes from 'core-js-pure/features/array/includes.js';
 
 const storage = getStorageManager();
 
 /** @type {ModuleParams} */
 let _moduleParams = {};
 /** @type {null|Object} */
-let _predictionsData = null;
+let _browsiData = null;
 /** @type {string} */
 const DEF_KEYNAME = 'browsiViewability';
+/** @type {null | function} */
+let _dataReadyCallback = null;
+/** @type {null|Object} */
+let _ic = {};
 
 /**
  * add browsi script to page
@@ -78,29 +84,49 @@ export function collectData() {
   getPredictionsFromServer(`//${_moduleParams.url}/prebid?${toUrlParams(predictorData)}`);
 }
 
+/**
+ * wait for data from server
+ * call callback when data is ready
+ * @param {function} callback
+ */
+function waitForData(callback) {
+  if (_browsiData) {
+    _dataReadyCallback = null;
+    callback(_browsiData);
+  } else {
+    _dataReadyCallback = callback;
+  }
+}
+
 export function setData(data) {
-  _predictionsData = data;
+  _browsiData = data;
+  if (isFn(_dataReadyCallback)) {
+    _dataReadyCallback(_browsiData);
+    _dataReadyCallback = null;
+  }
 }
 
-function sendDataToModule(adUnitsCodes) {
+function getRTD(auc) {
   try {
-    const _predictions = (_predictionsData && _predictionsData.p) || {};
-    return adUnitsCodes.reduce((rp, adUnitCode) => {
-      if (!adUnitCode) {
+    const _bp = (_browsiData && _browsiData.p) || {};
+    return auc.reduce((rp, uc) => {
+      _ic[uc] = _ic[uc] || 0;
+      const _c = _ic[uc];
+      if (!uc) {
         return rp
       }
-      const adSlot = getSlotByCode(adUnitCode);
-      const identifier = adSlot ? getMacroId(_predictionsData['pmd'], adSlot) : adUnitCode;
-      const predictionData = _predictions[identifier];
-      rp[adUnitCode] = getKVObject(-1, _predictionsData['kn']);
-      if (!predictionData) {
+      const adSlot = getSlotByCode(uc);
+      const identifier = adSlot ? getMacroId(_browsiData['pmd'], adSlot) : uc;
+      const _pd = _bp[identifier];
+      rp[uc] = getKVObject(-1);
+      if (!_pd) {
         return rp
       }
-      if (predictionData.p) {
-        if (!isIdMatchingAdUnit(adSlot, predictionData.w)) {
+      if (_pd.ps) {
+        if (!isIdMatchingAdUnit(adSlot, _pd.w)) {
           return rp;
         }
-        rp[adUnitCode] = getKVObject(predictionData.p, _predictionsData.kn);
+        rp[uc] = getKVObject(getCurrentData(_pd.ps, _c));
       }
       return rp;
     }, {});
@@ -109,6 +135,31 @@ function sendDataToModule(adUnitsCodes) {
   }
 }
 
+/**
+ * get prediction
+ * return -1 if prediction not found
+ * @param {object} predictionObject
+ * @param {number} _c
+ * @return {number}
+ */
+export function getCurrentData(predictionObject, _c) {
+  if (!predictionObject || !isNumber(_c)) {
+    return -1;
+  }
+  if (isNumber(predictionObject[_c])) {
+    return predictionObject[_c];
+  }
+  if (Object.keys(predictionObject).length > 1) {
+    while (_c > 0) {
+      _c--;
+      if (isNumber(predictionObject[_c])) {
+        return predictionObject[_c];
+      }
+    }
+  }
+  return -1;
+}
+
 /**
  * get all slots on page
  * @return {Object[]} slot GoogleTag slots
@@ -122,12 +173,16 @@ function getAllSlots() {
  * @param {string?} keyName
  * @return {Object} key:value
  */
-function getKVObject(p, keyName) {
+function getKVObject(p) {
   const prValue = p < 0 ? 'NA' : (Math.floor(p * 10) / 10).toFixed(2);
   let prObject = {};
-  prObject[((_moduleParams['keyName'] || keyName || DEF_KEYNAME).toString())] = prValue.toString();
+  prObject[getKey()] = prValue.toString();
   return prObject;
 }
+
+function getKey() {
+  return ((_moduleParams['keyName'] || (_browsiData && _browsiData['kn']) || DEF_KEYNAME).toString())
+}
 /**
  * check if placement id matches one of given ad units
  * @param {Object} slot google slot
@@ -238,6 +293,28 @@ function toUrlParams(data) {
     .join('&');
 }
 
+function setBidRequestsData(bidObj, callback) {
+  let adUnitCodes = bidObj.adUnitCodes;
+  let adUnits = bidObj.adUnits || getGlobal().adUnits || [];
+  if (adUnitCodes) {
+    adUnits = adUnits.filter(au => includes(adUnitCodes, au.code));
+  } else {
+    adUnitCodes = adUnits.map(au => au.code);
+  }
+  waitForData(() => {
+    const data = getRTD(adUnitCodes);
+    if (data) {
+      adUnits.forEach(adUnit => {
+        const adUnitCode = adUnit.code;
+        if (data[adUnitCode]) {
+          deepSetValue(adUnit, 'ortb2Imp.ext.data.browsi', {[getKey()]: data[adUnitCode][getKey()]});
+        }
+      });
+    }
+    callback();
+  })
+}
+
 /** @type {RtdSubmodule} */
 export const browsiSubmodule = {
   /**
@@ -250,10 +327,21 @@ export const browsiSubmodule = {
    * @function
    * @param {string[]} adUnitsCodes
    */
-  getTargetingData: sendDataToModule,
+  getTargetingData: getTargetingData,
   init: init,
+  getBidRequestData: setBidRequestsData
 };
 
+function getTargetingData(uc) {
+  const targetingData = getRTD(uc);
+  uc.forEach(auc => {
+    if (isNumber(_ic[auc])) {
+      _ic[auc] = _ic[auc] + 1;
+    }
+  });
+  return targetingData;
+}
+
 function init(moduleConfig) {
   _moduleParams = moduleConfig.params;
   if (_moduleParams && _moduleParams.siteKey && _moduleParams.pubKey && _moduleParams.url) {