prebid.js 7.14.0 → 7.16.0

package/modules/liveIntentAnalyticsAdapter.js

@@ -0,0 +1,148 @@
+import {ajax} from '../src/ajax.js';
+import { generateUUID, logInfo, logWarn } from '../src/utils.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
+import CONSTANTS from '../src/constants.json';
+import adapterManager from '../src/adapterManager.js';
+import { auctionManager } from '../src/auctionManager.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+
+const ANALYTICS_TYPE = 'endpoint';
+const URL = 'https://wba.liadm.com/analytic-events';
+const GVL_ID = 148;
+const ADAPTER_CODE = 'liveintent';
+const DEFAULT_SAMPLING = 0.1;
+const DEFAULT_BID_WON_TIMEOUT = 2000;
+const { EVENTS: { AUCTION_END } } = CONSTANTS;
+let initOptions = {};
+let isSampled;
+let bidWonTimeout;
+
+function handleAuctionEnd(args) {
+  setTimeout(() => {
+    const auction = auctionManager.index.getAuction(args.auctionId);
+    const winningBids = (auction) ? auction.getWinningBids() : [];
+    const data = createAnalyticsEvent(args, winningBids);
+    sendAnalyticsEvent(data);
+  }, bidWonTimeout);
+}
+
+function getAnalyticsEventBids(bidsReceived) {
+  return bidsReceived.map(bid => {
+    return {
+      adUnitCode: bid.adUnitCode,
+      timeToRespond: bid.timeToRespond,
+      cpm: bid.cpm,
+      currency: bid.currency,
+      ttl: bid.ttl,
+      bidder: bid.bidder
+    };
+  });
+}
+
+function getBannerSizes(banner) {
+  if (banner && banner.sizes) {
+    return banner.sizes.map(size => {
+      const [width, height] = size;
+      return {w: width, h: height};
+    });
+  } else return [];
+}
+
+function getUniqueBy(arr, key) {
+  return [...new Map(arr.map(item => [item[key], item])).values()]
+}
+
+function createAnalyticsEvent(args, winningBids) {
+  let payload = {
+    instanceId: generateUUID(),
+    url: getRefererInfo().page,
+    bidsReceived: getAnalyticsEventBids(args.bidsReceived),
+    auctionStart: args.timestamp,
+    auctionEnd: args.auctionEnd,
+    adUnits: [],
+    userIds: [],
+    bidders: []
+  }
+  let allUserIds = [];
+
+  if (args.adUnits) {
+    args.adUnits.forEach(unit => {
+      if (unit.mediaTypes && unit.mediaTypes.banner) {
+        payload['adUnits'].push({
+          code: unit.code,
+          mediaType: 'banner',
+          sizes: getBannerSizes(unit.mediaTypes.banner),
+          ortb2Imp: unit.ortb2Imp
+        });
+      }
+      if (unit.bids) {
+        let userIds = unit.bids.flatMap(getAnalyticsEventUserIds);
+        allUserIds.push(...userIds);
+        let bidders = unit.bids.map(({bidder, params}) => {
+          return { bidder, params }
+        });
+
+        payload['bidders'].push(...bidders);
+      }
+    })
+    let uniqueUserIds = getUniqueBy(allUserIds, 'source');
+    payload['userIds'] = uniqueUserIds;
+  }
+  payload['winningBids'] = getAnalyticsEventBids(winningBids);
+  payload['auctionId'] = args.auctionId;
+  return payload;
+}
+
+function getAnalyticsEventUserIds(bid) {
+  if (bid && bid.userIdAsEids) {
+    return bid.userIdAsEids.map(({source, uids, ext}) => {
+      let analyticsEventUserId = {source, uids, ext};
+      return ignoreUndefined(analyticsEventUserId)
+    });
+  } else { return []; }
+}
+
+function sendAnalyticsEvent(data) {
+  ajax(URL, {
+    success: function () {
+      logInfo('LiveIntent Prebid Analytics: send data success');
+    },
+    error: function (e) {
+      logWarn('LiveIntent Prebid Analytics: send data error' + e);
+    }
+  }, JSON.stringify(data), {
+    contentType: 'application/json',
+    method: 'POST'
+  })
+}
+
+function ignoreUndefined(data) {
+  const filteredData = Object.entries(data).filter(([key, value]) => value)
+  return Object.fromEntries(filteredData)
+}
+
+let liAnalytics = Object.assign(adapter({URL, ANALYTICS_TYPE}), {
+  track({ eventType, args }) {
+    if (eventType == AUCTION_END && args && isSampled) { handleAuctionEnd(args); }
+  }
+});
+
+// save the base class function
+liAnalytics.originEnableAnalytics = liAnalytics.enableAnalytics;
+
+// override enableAnalytics so we can get access to the config passed in from the page
+liAnalytics.enableAnalytics = function (config) {
+  initOptions = config.options;
+  const sampling = (initOptions && initOptions.sampling) ?? DEFAULT_SAMPLING;
+  isSampled = Math.random() < parseFloat(sampling);
+  bidWonTimeout = (initOptions && initOptions.bidWonTimeout) ?? DEFAULT_BID_WON_TIMEOUT;
+  liAnalytics.originEnableAnalytics(config); // call the base class function
+};
+
+adapterManager.registerAnalyticsAdapter({
+  adapter: liAnalytics,
+  code: ADAPTER_CODE,
+  gvlid: GVL_ID
+});
+
+export default liAnalytics;

package/modules/liveIntentAnalyticsAdapter.md

@@ -0,0 +1,22 @@
+# Overview
+Module Name: LiveIntent Analytics Adapter
+
+Module Type: Analytics Adapter
+
+Maintainer: product@liveintent.com
+
+# Description
+
+Analytics adapter for [LiveIntent](https://www.liveintent.com/). Contact product@liveintent.com for information.
+
+# Test Parameters
+
+```
+{
+  provider: 'liveintent',
+  options: {
+     bidWonTimeout: 2000,
+     sampling: 0.5 // the tracked event percentage, a number between 0 to 1
+  }
+}
+```

package/modules/mass.js

@@ -5,6 +5,7 @@
 import {config} from '../src/config.js';
 import {getHook} from '../src/hook.js';
 import {auctionManager} from '../src/auctionManager.js';
+import {timedBidResponseHook} from '../src/utils/perfMetrics.js';
 
 const defaultCfg = {
   dealIdPattern: /^MASS/i
@@ -17,7 +18,6 @@ export let isEnabled = false;
 const matchedBids = {};
 let renderers;
 
-init();
 config.getConfig('mass', config => init(config.mass));
 
 /**
@@ -78,7 +78,7 @@ export function updateRenderers() {
 /**
  * Before hook for 'addBidResponse'.
  */
-export function addBidResponseHook(next, adUnitCode, bid, {index = auctionManager.index} = {}) {
+export const addBidResponseHook = timedBidResponseHook('mass', function addBidResponseHook(next, adUnitCode, bid, {index = auctionManager.index} = {}) {
   let renderer;
   for (let i = 0; i < renderers.length; i++) {
     if (renderers[i].match(bid)) {
@@ -105,7 +105,7 @@ export function addBidResponseHook(next, adUnitCode, bid, {index = auctionManage
   }
 
   next(adUnitCode, bid);
-}
+});
 
 /**
  * Add listener for the "message" event sent by the winning bid
@@ -180,3 +180,5 @@ export function useDefaultRender(renderUrl, namespace) {
     }
   };
 }
+
+init();

package/modules/multibid/index.js

@@ -12,6 +12,7 @@ import * as events from '../../src/events.js';
 import CONSTANTS from '../../src/constants.json';
 import {addBidderRequests} from '../../src/auction.js';
 import {getHighestCpmBidsFromBidPool, sortByDealAndPriceBucketOrCpm} from '../../src/targeting.js';
+import {timedBidResponseHook} from '../../src/utils/perfMetrics.js';
 
 const MODULE_NAME = 'multibid';
 let hasMultibid = false;
@@ -98,7 +99,7 @@ export function adjustBidderRequestsHook(fn, bidderRequests) {
    * @param {String} ad unit code for bid
    * @param {Object} bid object
 */
-export function addBidResponseHook(fn, adUnitCode, bid) {
+export const addBidResponseHook = timedBidResponseHook('multibid', function addBidResponseHook(fn, adUnitCode, bid) {
   let floor = deepAccess(bid, 'floorData.floorValue');
 
   if (!config.getConfig('multibid')) resetMultiConfig();
@@ -141,7 +142,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
   } else {
     fn.call(this, adUnitCode, bid);
   }
-}
+});
 
 /**
 * A descending sort function that will sort the list of objects based on the following:
@@ -227,6 +228,7 @@ export const resetMultibidUnits = () => multibidUnits = {};
 * Set up hooks on init
 */
 function init() {
+  // TODO: does this reset logic make sense - what about simultaneous auctions?
   events.on(CONSTANTS.EVENTS.AUCTION_INIT, resetMultibidUnits);
   setupBeforeHookFnOnce(addBidderRequests, adjustBidderRequestsHook);
   getHook('addBidResponse').before(addBidResponseHook, 3);

package/modules/naveggIdSystem.js

@@ -6,16 +6,52 @@
  */
 import { isStr, isPlainObject, logError } from '../src/utils.js';
 import { submodule } from '../src/hook.js';
+import { ajax } from '../src/ajax.js';
 import { getStorageManager } from '../src/storageManager.js';
 
 const MODULE_NAME = 'naveggId';
 const OLD_NAVEGG_ID = 'nid';
-const NAVEGG_ID = 'nvggid'
+const NAVEGG_ID = 'nvggid';
+const BASE_URL = 'https://id.navegg.com/uid/';
+const DEFAULT_EXPIRE = 8 * 24 * 3600 * 1000;
+const INVALID_EXPIRE = 3600 * 1000;
 
 export const storage = getStorageManager();
 
+function getNaveggIdFromApi() {
+  const callbacks = {
+    success: response => {
+      if (response) {
+        try {
+          const responseObj = JSON.parse(response);
+          writeCookie(NAVEGG_ID, responseObj[NAVEGG_ID]);
+        } catch (error) {
+          logError(error);
+        }
+      }
+    },
+    error: error => {
+      logError('Navegg ID fetch encountered an error', error);
+    }
+  };
+  ajax(BASE_URL, callbacks, undefined, { method: 'GET', withCredentials: false });
+}
+
+function writeCookie(key, value) {
+  try {
+    if (storage.cookiesAreEnabled) {
+      let expTime = new Date();
+      const expires = value ? DEFAULT_EXPIRE : INVALID_EXPIRE;
+      expTime.setTime(expTime.getTime() + expires);
+      storage.setCookie(key, value, expTime.toUTCString(), 'none');
+    }
+  } catch (e) {
+    logError(e);
+  }
+}
+
 function readnaveggIdFromLocalStorage() {
-  return storage.getDataFromLocalStorage(NAVEGG_ID);
+  return storage.localStorageIsEnabled ? storage.getDataFromLocalStorage(NAVEGG_ID) : null;
 }
 
 function readnaveggIDFromCookie() {
@@ -37,35 +73,30 @@ function readnavIDFromCookie() {
 /** @type {Submodule} */
 export const naveggIdSubmodule = {
   /**
-   * used to link submodule with config
-   * @type {string}
-   */
+  * used to link submodule with config
+  * @type {string}
+  */
   name: MODULE_NAME,
   /**
-   * decode the stored id value for passing to bid requests
-   * @function
-   * @param { Object | string | undefined } value
-   * @return { Object | string | undefined }
-   */
+  * decode the stored id value for passing to bid requests
+  * @function
+  * @param { Object | string | undefined } value
+  * @return { Object | string | undefined }
+  */
   decode(value) {
     const naveggIdVal = value ? isStr(value) ? value : isPlainObject(value) ? value.id : undefined : undefined;
     return naveggIdVal ? {
-      'naveggId': naveggIdVal
+      'naveggId': naveggIdVal.split('|')[0]
     } : undefined;
   },
   /**
-   * performs action to obtain id and return a value in the callback's response argument
-   * @function
-   * @param {SubmoduleConfig} config
-   * @return {{id: string | undefined } | undefined}
-   */
+  * performs action to obtain id and return a value in the callback's response argument
+  * @function
+  * @param {SubmoduleConfig} config
+  * @return {{id: string | undefined } | undefined}
+  */
   getId() {
-    let naveggIdStringFromLocalStorage = null;
-    if (storage.localStorageIsEnabled) {
-      naveggIdStringFromLocalStorage = readnaveggIdFromLocalStorage();
-    }
-
-    const naveggIdString = naveggIdStringFromLocalStorage || readnaveggIDFromCookie() || readoldnaveggIDFromCookie() || readnvgIDFromCookie() || readnavIDFromCookie();
+    const naveggIdString = readnaveggIdFromLocalStorage() || readnaveggIDFromCookie() || getNaveggIdFromApi() || readoldnaveggIDFromCookie() || readnvgIDFromCookie() || readnavIDFromCookie();
 
     if (typeof naveggIdString == 'string' && naveggIdString) {
       try {