prebid.js 7.4.0 → 7.7.0

package/modules/byDataAnalyticsAdapter.js

@@ -5,38 +5,80 @@ import enc from 'crypto-js/enc-utf8';
 import adapter from '../src/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { auctionManager } from '../src/auctionManager.js';
 import { ajax } from '../src/ajax.js';
 
-const secretKey = 'bydata@123456';
-const { EVENTS: { NO_BID, BID_TIMEOUT, AUCTION_END } } = CONSTANTS;
-const DEFAULT_EVENT_URL = 'https://pbjs-stream.bydata.com/topics/prebid';
-const analyticsType = 'endpoint';
-var payload = {};
-var bdNbTo = { 'to': [], 'nb': [] };
-let initOptions = {};
+const versionCode = '4.4.1'
+const secretKey = 'bydata@123456'
+const { EVENTS: { NO_BID, BID_TIMEOUT, AUCTION_END, AUCTION_INIT, BID_WON } } = CONSTANTS
+const DEFAULT_EVENT_URL = 'https://pbjs-stream.bydata.com/topics/prebid'
+const analyticsType = 'endpoint'
+const isBydata = isKeyInUrl('bydata_debug')
+const adunitsMap = {}
+const storage = getStorageManager();
+let initOptions = {}
+var payload = {}
+var winPayload = {}
+var isDataSend = window.asc_data || false
+var bdNbTo = { 'to': [], 'nb': [] }
 
+/* method used for testing parameters */
+function isKeyInUrl(name) {
+  const queryString = window.location.search;
+  const urlParams = new URLSearchParams(queryString);
+  const param = urlParams.get(name)
+  return param
+}
+
+/* return ad unit full path wrt custom ad unit code */
+function getAdunitName(code) {
+  var name = code;
+  for (const [key, value] of Object.entries(adunitsMap)) {
+    if (key === code) { name = value; }
+  }
+  return name;
+}
+
+/* EVENT: auction init */
+function onAuctionStart(t) {
+  /* map of ad unit code - ad unit full path */
+  t.adUnits && t.adUnits.length && t.adUnits.forEach((adu) => {
+    const { code, adunit } = adu
+    adunitsMap[code] = adunit
+  });
+}
+
+/* EVENT: bid timeout */
 function onBidTimeout(t) {
   if (payload['visitor_data'] && t && t.length > 0) {
-    bdNbTo['to'] = t;
+    bdNbTo['to'] = t
   }
 }
 
+/* EVENT: no bid */
 function onNoBidData(t) {
   if (payload['visitor_data'] && t) {
-    bdNbTo['nb'].push(t);
+    bdNbTo['nb'].push(t)
+  }
+}
+
+/* EVENT: bid won */
+function onBidWon(t) {
+  const { isCorrectOption } = initOptions
+  if (isCorrectOption && (isDataSend || isBydata)) {
+    ascAdapter.getBidWonData(t)
+    ascAdapter.sendPayload(winPayload)
   }
 }
 
+/* EVENT: auction end */
 function onAuctionEnd(t) {
-  _logInfo('onAuctionEnd', t);
-  const {isCorrectOption, logFrequency} = initOptions;
-  var value = Math.floor(Math.random() * 10000 + 1);
-  _logInfo(' value - frequency ', (value + '-' + logFrequency));
+  const { isCorrectOption } = initOptions;
   setTimeout(() => {
-    if (isCorrectOption && value < logFrequency) {
+    if (isCorrectOption && (isDataSend || isBydata)) {
       ascAdapter.dataProcess(t);
-      addKeyForPrebidWinningAndWinningsBids();
-      ascAdapter.sendPayload();
+      ascAdapter.sendPayload(payload);
     }
   }, 500);
 }
@@ -44,6 +86,9 @@ function onAuctionEnd(t) {
 const ascAdapter = Object.assign(adapter({ url: DEFAULT_EVENT_URL, analyticsType: analyticsType }), {
   track({ eventType, args }) {
     switch (eventType) {
+      case AUCTION_INIT:
+        onAuctionStart(args);
+        break;
       case NO_BID:
         onNoBidData(args);
         break;
@@ -53,6 +98,9 @@ const ascAdapter = Object.assign(adapter({ url: DEFAULT_EVENT_URL, analyticsType
       case AUCTION_END:
         onAuctionEnd(args);
         break;
+      case BID_WON:
+        onBidWon(args);
+        break;
       default:
         break;
     }
@@ -62,9 +110,8 @@ const ascAdapter = Object.assign(adapter({ url: DEFAULT_EVENT_URL, analyticsType
 // save the base class function
 ascAdapter.originEnableAnalytics = ascAdapter.enableAnalytics;
 // override enableAnalytics so we can get access to the config passed in from the page
-ascAdapter.enableAnalytics = function(config) {
+ascAdapter.enableAnalytics = function (config) {
   if (this.initConfig(config)) {
-    _logInfo('initiated:', initOptions);
     initOptions.isCorrectOption && ascAdapter.getVisitorData();
     ascAdapter.originEnableAnalytics(config);
   }
@@ -73,7 +120,7 @@ ascAdapter.enableAnalytics = function(config) {
 ascAdapter.initConfig = function (config) {
   let isCorrectOption = true;
   initOptions = {};
-  _logInfo('initConfig', config);
+  var rndNum = Math.floor(Math.random() * 10000 + 1);
   initOptions.options = deepClone(config.options);
   initOptions.clientId = initOptions.options.clientId || null;
   initOptions.logFrequency = initOptions.options.logFrequency;
@@ -81,13 +128,41 @@ ascAdapter.initConfig = function (config) {
     _logError('"options.clientId" should not empty!!');
     isCorrectOption = false;
   }
+  if (rndNum <= initOptions.logFrequency) { window.asc_data = isDataSend = true; }
   initOptions.isCorrectOption = isCorrectOption;
   this.initOptions = initOptions;
   return isCorrectOption;
 };
 
-ascAdapter.getVisitorData = function(data = {}) {
-  var ua = data.userId ? data : {};
+ascAdapter.getBidWonData = function(t) {
+  const { auctionId, adUnitCode, size, requestId, bidder, timeToRespond, currency, mediaType, cpm } = t
+  const aun = getAdunitName(adUnitCode)
+  winPayload['aid'] = auctionId
+  winPayload['as'] = '';
+  winPayload['auctionData'] = [];
+  var data = {}
+  data['au'] = aun
+  data['auc'] = adUnitCode
+  data['aus'] = size
+  data['bid'] = requestId
+  data['bidadv'] = bidder
+  data['br_pb_mg'] = cpm
+  data['br_tr'] = timeToRespond
+  data['bradv'] = bidder
+  data['brid'] = requestId
+  data['brs'] = size
+  data['cur'] = currency
+  data['inb'] = 0
+  data['ito'] = 0
+  data['ipwb'] = 1
+  data['iwb'] = 1
+  data['mt'] = mediaType
+  winPayload['auctionData'].push(data)
+  return winPayload
+}
+
+ascAdapter.getVisitorData = function (data = {}) {
+  var ua = data.uid ? data : {};
   var module = {
     options: [],
     header: [window.navigator.platform, window.navigator.userAgent, window.navigator.appVersion, window.navigator.vendor, window.opera],
@@ -152,7 +227,7 @@ ascAdapter.getVisitorData = function(data = {}) {
       crypto.getRandomValues(buffer);
       buffer[6] = (buffer[6] & ~176) | 64;
       buffer[8] = (buffer[8] & ~64) | 128;
-      var hex = Array.prototype.map.call(new Uint8Array(buffer), function(x) {
+      var hex = Array.prototype.map.call(new Uint8Array(buffer), function (x) {
         return ('00' + x.toString(16)).slice(-2);
       }).join('');
       return hex.slice(0, 5) + '-' + hex.slice(5, 9) + '-' + hex.slice(9, 13) + '-' + hex.slice(13, 18);
@@ -182,34 +257,46 @@ ascAdapter.getVisitorData = function(data = {}) {
     var signedToken = token + '.' + signature;
     return signedToken;
   }
-  const {clientId} = initOptions;
-  var userId = window.localStorage.getItem('userId');
+  function detectWidth() {
+    return window.screen.width || (window.innerWidth && document.documentElement.clientWidth) ? Math.min(window.innerWidth, document.documentElement.clientWidth) : window.innerWidth || document.documentElement.clientWidth || document.getElementsByTagName('body')[0].clientWidth;
+  }
+  function giveDeviceTypeOnScreenSize() {
+    var _dWidth = detectWidth();
+    return _dWidth > 1024 ? 'Desktop' : (_dWidth <= 1024 && _dWidth >= 768) ? 'Tablet' : 'Mobile';
+  }
+
+  const { clientId } = initOptions;
+  var userId = storage.getDataFromLocalStorage('userId')
   if (!userId) {
     userId = generateUid();
-    window.localStorage.setItem('userId', userId);
+    storage.setDataInLocalStorage('userId', userId);
   }
-  var screenSize = {width: window.screen.width, height: window.screen.height};
-  var deviceType = window.navigator.userAgent.match(/Android|BlackBerry|iPhone|iPad|iPod|Opera Mini|IEMobile/i) ? 'Mobile' : 'Desktop';
+  var screenSize = { width: window.screen.width, height: window.screen.height };
+  var deviceType = giveDeviceTypeOnScreenSize();
   var e = module.init();
-  if (!ua['userId']) {
-    ua['userId'] = userId;
-    ua['client_id'] = clientId;
-    ua['plateform_name'] = e.os.name;
-    ua['os_version'] = e.os.version;
-    ua['browser_name'] = e.browser.name;
-    ua['browser_version'] = e.browser.version;
-    ua['screen_size'] = screenSize;
-    ua['device_type'] = deviceType;
-    ua['time_zone'] = window.Intl.DateTimeFormat().resolvedOptions().timeZone;
+  if (!ua['uid']) {
+    ua['uid'] = userId;
+    ua['cid'] = clientId;
+    ua['pid'] = window.location.hostname;
+    ua['os'] = e.os.name;
+    ua['osv'] = e.os.version;
+    ua['br'] = e.browser.name;
+    ua['brv'] = e.browser.version;
+    ua['ss'] = screenSize;
+    ua['de'] = deviceType;
+    ua['tz'] = window.Intl.DateTimeFormat().resolvedOptions().timeZone;
   }
   var signedToken = getJWToken(ua);
   payload['visitor_data'] = signedToken;
+  winPayload['visitor_data'] = signedToken;
   return signedToken;
 }
 
-ascAdapter.dataProcess = function(t) {
-  payload['auction_id'] = t.auctionId;
-  payload['auction_start'] = t.timestamp;
+ascAdapter.dataProcess = function (t) {
+  if (isBydata) { payload['bydata_debug'] = 'true'; }
+  _logInfo('fulldata - ', t);
+  payload['aid'] = t.auctionId;
+  payload['as'] = t.timestamp;
   payload['auctionData'] = [];
   var bidderRequestsData = []; var bidsReceivedData = [];
   t.bidderRequests && t.bidderRequests.forEach(bidReq => {
@@ -228,69 +315,80 @@ ascAdapter.dataProcess = function(t) {
     bidderRequestsData.push(pObj);
   });
   t.bidsReceived && t.bidsReceived.forEach(bid => {
-    const {requestId, bidder, width, height, cpm, currency, timeToRespond, adUnitCode} = bid;
-    bidsReceivedData.push({requestId, bidder, width, height, cpm, currency, timeToRespond, adUnitCode});
+    const { requestId, bidder, width, height, cpm, currency, timeToRespond, adUnitCode } = bid;
+    bidsReceivedData.push({ requestId, bidder, width, height, cpm, currency, timeToRespond, adUnitCode });
   });
   bidderRequestsData.length > 0 && bidderRequestsData.forEach(bdObj => {
     var bdsArray = bdObj['bids'];
     bdsArray.forEach(bid => {
-      const {adUnitCode, sizes, bidder, bidId, mediaTypes} = bid;
+      const { adUnitCode, sizes, bidder, bidId, mediaTypes } = bid;
       sizes.forEach(size => {
         var sstr = size[0] + 'x' + size[1]
-        payload['auctionData'].push({adUnit: adUnitCode, size: sstr, media_type: mediaTypes[0], bids_bidder: bidder, bids_bid_id: bidId});
+        payload['auctionData'].push({ au: getAdunitName(adUnitCode), auc: adUnitCode, aus: sstr, mt: mediaTypes[0], bidadv: bidder, bid: bidId, inb: 0, ito: 0, ipwb: 0, iwb: 0 });
       });
     });
   });
+
   bidsReceivedData.length > 0 && bidsReceivedData.forEach(bdRecived => {
-    const {requestId, bidder, width, height, cpm, currency, timeToRespond} = bdRecived;
+    const { requestId, bidder, width, height, cpm, currency, timeToRespond } = bdRecived;
     payload['auctionData'].forEach(rwData => {
-      if (rwData['bids_bid_id'] === requestId && rwData['size'] === width + 'x' + height) {
-        rwData['br_request_id'] = requestId; rwData['br_bidder'] = bidder; rwData['br_pb_mg'] = cpm;
-        rwData['br_currency'] = currency; rwData['br_time_to_respond'] = timeToRespond; rwData['br_size'] = width + 'x' + height;
+      if (rwData['bid'] === requestId && rwData['aus'] === width + 'x' + height) {
+        rwData['brid'] = requestId; rwData['bradv'] = bidder; rwData['br_pb_mg'] = cpm;
+        rwData['cur'] = currency; rwData['br_tr'] = timeToRespond; rwData['brs'] = width + 'x' + height;
       }
     })
   });
+
+  var prebidWinningBids = auctionManager.getBidsReceived().filter(bid => bid.status === CONSTANTS.BID_STATUS.BID_TARGETING_SET);
+  prebidWinningBids && prebidWinningBids.length > 0 && prebidWinningBids.forEach(pbbid => {
+    payload['auctionData'] && payload['auctionData'].forEach(rwData => {
+      if (rwData['bid'] === pbbid.requestId && rwData['brs'] === pbbid.size) {
+        rwData['ipwb'] = 1;
+      }
+    });
+  })
+
+  var winningBids = auctionManager.getAllWinningBids();
+  winningBids && winningBids.length > 0 && winningBids.forEach(wBid => {
+    payload['auctionData'] && payload['auctionData'].forEach(rwData => {
+      if (rwData['bid'] === wBid.requestId && rwData['brs'] === wBid.size) {
+        rwData['iwb'] = 1;
+      }
+    });
+  })
+
   payload['auctionData'] && payload['auctionData'].length > 0 && payload['auctionData'].forEach(u => {
     bdNbTo['to'].forEach(i => {
-      if (u.bids_bid_id === i.bidId) u.is_timeout = 1;
+      if (u.bid === i.bidId) u.ito = 1;
     });
     bdNbTo['nb'].forEach(i => {
-      if (u.adUnit === i.adUnitCode && u.bids_bidder === i.bidder && u.bids_bid_id === i.bidId) { u.is_nobid = 1; }
+      if (u.bidadv === i.bidder && u.bid === i.bidId) { u.inb = 1; }
     })
   });
   return payload;
 }
 
-ascAdapter.sendPayload = function () {
-  var obj = { 'records': [ { 'value': payload } ] };
+ascAdapter.sendPayload = function (data) {
+  var obj = { 'records': [{ 'value': data }] };
   let strJSON = JSON.stringify(obj);
-  _logInfo(' sendPayload ', JSON.stringify(obj));
-  ajax(DEFAULT_EVENT_URL, undefined, strJSON, {
+  sendDataOnKf(strJSON);
+}
+
+function sendDataOnKf(dataObj) {
+  ajax(DEFAULT_EVENT_URL, {
+    success: function () {
+      _logInfo('send data success');
+    },
+    error: function (e) {
+      _logInfo('send data error', e);
+    }
+  }, dataObj, {
     contentType: 'application/vnd.kafka.json.v2+json',
     method: 'POST',
     withCredentials: true
   });
 }
 
-function addKeyForPrebidWinningAndWinningsBids() {
-  var prebidWinningBids = $$PREBID_GLOBAL$$.getAllPrebidWinningBids();
-  var winningBids = $$PREBID_GLOBAL$$.getAllWinningBids();
-  prebidWinningBids && prebidWinningBids.length > 0 && prebidWinningBids.forEach(pbbid => {
-    payload['auctionData'] && payload['auctionData'].forEach(rwData => {
-      if (rwData['bids_bid_id'] === pbbid.requestId && rwData['br_size'] === pbbid.size) {
-        rwData['is_prebid_winning_bid'] = 1;
-      }
-    });
-  })
-  winningBids && winningBids.length > 0 && winningBids.forEach(wBid => {
-    payload['auctionData'] && payload['auctionData'].forEach(rwData => {
-      if (rwData['bids_bid_id'] === wBid.requestId && rwData['br_size'] === wBid.size) {
-        rwData['is_winning_bid'] = 1;
-      }
-    });
-  })
-}
-
 adapterManager.registerAnalyticsAdapter({
   adapter: ascAdapter,
   code: 'bydata'
@@ -305,7 +403,7 @@ function _logError(message) {
 }
 
 function buildLogMessage(message) {
-  return 'Bydata Prebid Analytics: ' + message;
+  return 'Bydata Prebid Analytics ' + versionCode + ':' + message;
 }
 
 export default ascAdapter;

package/modules/byDataAnalyticsAdapter.md

@@ -1,7 +1,7 @@
 # Overview
 
 layout: Analytics Adapter
-title: Ascendeum Pvt Ltd. (https://ascendeum.com/)
+title: byData. (https://bydata.com/)
 description: Bydata Analytics Adapter
 modulecode: byDataAnalyticsAdapter
 gdpr_supported: false   (EU GDPR support)
@@ -13,11 +13,12 @@ enable_download: false       (in case you don't want users of the website to dow
 
 Module Name: Bydata Analytics Adapter
 Module Type: Analytics Adapter
-Maintainer: Ascendeum
+Maintainer: byData
 
 # Description
 
-Analytics adapter for https://ascendeum.com/. Contact engineering@ascendeum.com for information.
+Analytics adapter for https://bydata.com/. Contact admin@byData.com for information.
+
 
 # Test Parameters
 
@@ -25,10 +26,8 @@ Analytics adapter for https://ascendeum.com/. Contact engineering@ascendeum.com
 {
   provider: 'bydata',
     options : {
-        clientId: "ASCENDEUM_PROVIDED_CLIENT_ID",   
+        clientId: "please contact byData team to get a clientId",   
         logFrequency : 100, // Sample Rate Default - 1%   
     }
 }
 ```
-
-

package/modules/consumableBidAdapter.js

@@ -1,4 +1,5 @@
-import { logWarn, createTrackPixelHtml } from '../src/utils.js';
+import { logWarn, createTrackPixelHtml, deepAccess, isArray, deepSetValue } from '../src/utils.js';
+import {config} from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 
 const BIDDER_CODE = 'consumable';
@@ -66,6 +67,14 @@ export const spec = {
       data.ccpa = bidderRequest.uspConsent;
     }
 
+    if (bidderRequest && bidderRequest.schain) {
+      data.schain = bidderRequest.schain;
+    }
+
+    if (config.getConfig('coppa')) {
+      data.coppa = true;
+    }
+
     validBidRequests.map(bid => {
       const sizes = (bid.mediaTypes && bid.mediaTypes.banner && bid.mediaTypes.banner.sizes) || bid.sizes || [];
       const placement = Object.assign({
@@ -78,6 +87,8 @@ export const spec = {
       }
     });
 
+    handleEids(data, validBidRequests);
+
     ret.data = JSON.stringify(data);
     ret.bidRequest = validBidRequests;
     ret.bidderRequest = bidderRequest;
@@ -234,4 +245,13 @@ function retrieveAd(decision, unitId, unitName) {
   return ad;
 }
 
+function handleEids(data, validBidRequests) {
+  let bidUserIdAsEids = deepAccess(validBidRequests, '0.userIdAsEids');
+  if (isArray(bidUserIdAsEids) && bidUserIdAsEids.length > 0) {
+    deepSetValue(data, 'user.eids', bidUserIdAsEids);
+  } else {
+    deepSetValue(data, 'user.eids', undefined);
+  }
+}
+
 registerBidder(spec);

package/modules/criteoBidAdapter.js

@@ -13,7 +13,7 @@ const BIDDER_CODE = 'criteo';
 const CDB_ENDPOINT = 'https://bidder.criteo.com/cdb';
 const PROFILE_ID_INLINE = 207;
 export const PROFILE_ID_PUBLISHERTAG = 185;
-const storage = getStorageManager({ gvlid: GVLID, bidderCode: BIDDER_CODE });
+export const storage = getStorageManager({ gvlid: GVLID, bidderCode: BIDDER_CODE });
 const LOG_PREFIX = 'Criteo: ';
 
 /*
@@ -255,6 +255,12 @@ function buildCdbUrl(context) {
   url += '&wv=' + encodeURIComponent('$prebid.version$');
   url += '&cb=' + String(Math.floor(Math.random() * 99999999999));
 
+  if (storage.localStorageIsEnabled()) {
+    url += '&lsavail=1';
+  } else {
+    url += '&lsavail=0';
+  }
+
   if (context.amp) {
     url += '&im=1';
   }

package/modules/currency.js

@@ -5,7 +5,7 @@ import CONSTANTS from '../src/constants.json';
 import { ajax } from '../src/ajax.js';
 import { config } from '../src/config.js';
 import { getHook } from '../src/hook.js';
-import {promiseControls} from '../src/utils/promise.js';
+import {defer} from '../src/utils/promise.js';
 
 const DEFAULT_CURRENCY_RATE_URL = 'https://cdn.jsdelivr.net/gh/prebid/currency-file@1/latest.json?date=$$TODAY$$';
 const CURRENCY_RATE_PRECISION = 4;
@@ -24,7 +24,7 @@ var defaultRates;
 export const ready = (() => {
   let ctl;
   function reset() {
-    ctl = promiseControls();
+    ctl = defer();
   }
   reset();
   return {done: () => ctl.resolve(), reset, promise: () => ctl.promise}

package/modules/cwireBidAdapter.md

@@ -38,7 +38,7 @@ var adUnits = [
       params: {
         pageId: 1422,                 // required - number
         placementId: 2211521,         // required - number
-        cwcreative: 42,               // optional - id of creative to force
+        cwcreative: '42',             // optional - id of creative to force
         refgroups: 'test-user',       // optional - name of group or coma separated list of groups to force
         cwapikey: 'api_key_xyz',      // optional - api key for integration testing        
       }