prebid.js 7.4.0 → 7.7.0

package/modules/ixBidAdapter.js

@@ -30,7 +30,6 @@ import {Renderer} from '../src/Renderer.js';
 const BIDDER_CODE = 'ix';
 const ALIAS_BIDDER_CODE = 'roundel';
 const GLOBAL_VENDOR_ID = 10;
-const MODULE_TYPE = 'bid-adapter';
 const SECURE_BID_URL = 'https://htlb.casalemedia.com/openrtb/pbjs';
 const SUPPORTED_AD_TYPES = [BANNER, VIDEO, NATIVE];
 const BANNER_ENDPOINT_VERSION = 7.2;
@@ -46,9 +45,9 @@ const OUTSTREAM_MINIMUM_PLAYER_SIZE = [144, 144];
 const PRICE_TO_DOLLAR_FACTOR = {
   JPY: 1
 };
-const USER_SYNC_URL = 'https://js-sec.indexww.com/um/ixmatch.html';
-
+const IFRAME_USER_SYNC_URL = 'https://js-sec.indexww.com/um/ixmatch.html';
 const FLOOR_SOURCE = { PBJS: 'p', IX: 'x' };
+const IMG_USER_SYNC_URL = 'https://dsum.casalemedia.com/pbusermatch?origin=prebid'
 export const ERROR_CODES = {
   BID_SIZE_INVALID_FORMAT: 1,
   BID_SIZE_NOT_INCLUDED: 2,
@@ -191,6 +190,9 @@ const NATIVE_EVENT_TRACKING_METHOD = {
 const LOCAL_STORAGE_KEY = 'ixdiag';
 let hasRegisteredHandler = false;
 export const storage = getStorageManager({gvlid: GLOBAL_VENDOR_ID, bidderCode: BIDDER_CODE});
+let siteID = 0;
+let gdprConsent = '';
+let usPrivacy = '';
 
 // Possible values for bidResponse.seatBid[].bid[].mtype which indicates the type of the creative markup so that it can properly be associated with the right sub-object of the BidRequest.Imp.
 const MEDIA_TYPES = {
@@ -242,6 +244,8 @@ function bidToVideoImp(bid) {
   }
 
   imp.video = videoParamRef ? deepClone(bid.params.video) : {};
+  // populate imp level transactionId
+  imp.ext.tid = deepAccess(bid, 'ortb2Imp.ext.tid');
 
   // copy all video properties to imp object
   for (const adUnitProperty in videoAdUnitRef) {
@@ -353,6 +357,9 @@ function bidToNativeImp(bid) {
     ver: '1.2'
   };
 
+  // populate imp level transactionId
+  imp.ext.tid = deepAccess(bid, 'ortb2Imp.ext.tid');
+
   _applyFloor(bid, imp, NATIVE);
 
   return imp;
@@ -882,6 +889,11 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   if (tmax) {
     r.ext.ixdiag.tmax = tmax
   }
+
+  if (config.getConfig('userSync')) {
+    r.ext.ixdiag.syncsPerBidder = config.getConfig('userSync').syncsPerBidder;
+  }
+
   // Get cached errors stored in LocalStorage
   const cachedErrors = getCachedErrors();
 
@@ -910,7 +922,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   // Apply GDPR information to the request if GDPR is enabled.
   if (bidderRequest) {
     if (bidderRequest.gdprConsent) {
-      const gdprConsent = bidderRequest.gdprConsent;
+      gdprConsent = bidderRequest.gdprConsent;
 
       if (gdprConsent.hasOwnProperty('gdprApplies')) {
         r.regs = {
@@ -936,6 +948,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
     if (bidderRequest.uspConsent) {
       deepSetValue(r, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+      usPrivacy = bidderRequest.uspConsent;
     }
 
     if (pageUrl) {
@@ -949,7 +962,9 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
   const payload = {};
   // Use the siteId in the first bid request as the main siteId.
-  payload.s = validBidRequests[0].params.siteId;
+  siteID = validBidRequests[0].params.siteId;
+  payload.s = siteID;
+  payload.v = version;
   if (version) {
     payload.v = version;
   }
@@ -1038,8 +1053,14 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       currentImpressionSize = encodeURIComponent(JSON.stringify({ impressionObjects })).length;
     }
 
-    const gpid = impressions[transactionIds[adUnitIndex]].gpid;
+    let gpid = impressions[transactionIds[adUnitIndex]].gpid;
     const dfpAdUnitCode = impressions[transactionIds[adUnitIndex]].dfp_ad_unit_code;
+    const tid = impressions[transactionIds[adUnitIndex]].tid;
+    const divId = impressions[transactionIds[adUnitIndex]].divId;
+
+    if (!gpid && dfpAdUnitCode && divId) {
+      gpid = `${dfpAdUnitCode}#${divId}`
+    }
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
       const { id, banner: { topframe } } = impressionObjects[0];
       const _bannerImpression = {
@@ -1050,10 +1071,11 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       }
 
-      if (dfpAdUnitCode || gpid) {
+      if (dfpAdUnitCode || gpid || tid) {
         _bannerImpression.ext = {};
         _bannerImpression.ext.dfp_ad_unit_code = dfpAdUnitCode;
         _bannerImpression.ext.gpid = gpid;
+        _bannerImpression.ext.tid = tid;
       }
 
       if ('bidfloor' in impressionObjects[0]) {
@@ -1114,6 +1136,21 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
       }
     }
 
+    // add identifiers info to ixDiag
+    const pbaAdSlot = impressions[transactionIds[adUnitIndex]].pbadslot
+    const tagId = impressions[transactionIds[adUnitIndex]].tagId
+    const adUnitCode = impressions[transactionIds[adUnitIndex]].adUnitCode
+    if (pbaAdSlot || tagId || adUnitCode || divId) {
+      const clonedRObject = deepClone(r);
+      const requestSize = `${baseUrl}${parseQueryStringParameters({ ...payload, r: JSON.stringify(clonedRObject) })}`.length;
+      if (requestSize < MAX_REQUEST_SIZE) {
+        r.ext.ixdiag.pbadslot = pbaAdSlot;
+        r.ext.ixdiag.tagid = tagId;
+        r.ext.ixdiag.adunitcode = adUnitCode;
+        r.ext.ixdiag.divId = divId;
+      }
+    }
+
     const isLastAdUnit = adUnitIndex === transactionIds.length - 1;
 
     if (wasAdUnitImpressionsTrimmed || isLastAdUnit) {
@@ -1246,7 +1283,15 @@ function createNativeImps(validBidRequest, nativeImps) {
     nativeImps[validBidRequest.transactionId] = {};
     nativeImps[validBidRequest.transactionId].ixImps = [];
     nativeImps[validBidRequest.transactionId].ixImps.push(imp);
-    nativeImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid')
+    nativeImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
+    nativeImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
+    nativeImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
+    nativeImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
+
+    const adUnitCode = validBidRequest.adUnitCode;
+    const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
+    nativeImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
+    nativeImps[validBidRequest.transactionId].divId = divId;
   }
 }
 
@@ -1262,6 +1307,14 @@ function createVideoImps(validBidRequest, videoImps) {
     videoImps[validBidRequest.transactionId].ixImps = [];
     videoImps[validBidRequest.transactionId].ixImps.push(imp);
     videoImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
+    videoImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
+    videoImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
+    videoImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
+
+    const adUnitCode = validBidRequest.adUnitCode;
+    const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
+    videoImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
+    videoImps[validBidRequest.transactionId].divId = divId;
   }
 }
 
@@ -1288,6 +1341,14 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
 
   bannerImps[validBidRequest.transactionId].gpid = deepAccess(validBidRequest, 'ortb2Imp.ext.gpid');
   bannerImps[validBidRequest.transactionId].dfp_ad_unit_code = deepAccess(validBidRequest, 'ortb2Imp.ext.data.adserver.adslot');
+  bannerImps[validBidRequest.transactionId].tid = deepAccess(validBidRequest, 'ortb2Imp.ext.tid');
+  bannerImps[validBidRequest.transactionId].pbadslot = deepAccess(validBidRequest, 'ortb2Imp.ext.data.pbadslot');
+  bannerImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
+
+  const adUnitCode = validBidRequest.adUnitCode;
+  const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
+  bannerImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
+  bannerImps[validBidRequest.transactionId].divId = divId;
 
   // Create IX imps from params.size
   if (bannerSizeDefined) {
@@ -1414,7 +1475,7 @@ function localStorageHandler(data) {
       hasEnforcementHook: false,
       valid: hasDeviceAccess()
     };
-    validateStorageEnforcement(GLOBAL_VENDOR_ID, BIDDER_CODE, MODULE_TYPE, DEFAULT_ENFORCEMENT_SETTINGS, (permissions) => {
+    validateStorageEnforcement(GLOBAL_VENDOR_ID, BIDDER_CODE, DEFAULT_ENFORCEMENT_SETTINGS, (permissions) => {
       if (permissions.valid) {
         storeErrorEventData(data);
       }
@@ -1596,7 +1657,17 @@ export const spec = {
     }
 
     if (mediaTypeVideoRef && paramsVideoRef) {
+      const videoImp = bidToVideoImp(bid).video;
       const errorList = checkVideoParams(mediaTypeVideoRef, paramsVideoRef);
+      if (deepAccess(bid, 'mediaTypes.video.context') === OUTSTREAM && isIndexRendererPreferred(bid) && videoImp) {
+        const outstreamPlayerSize = [deepAccess(videoImp, 'w'), deepAccess(videoImp, 'h')];
+        const isValidSize = outstreamPlayerSize[0] >= OUTSTREAM_MINIMUM_PLAYER_SIZE[0] && outstreamPlayerSize[1] >= OUTSTREAM_MINIMUM_PLAYER_SIZE[1];
+        if (!isValidSize) {
+          logError(`IX Bid Adapter: ${outstreamPlayerSize} is an invalid size for IX outstream renderer`);
+          return false;
+        }
+      }
+
       if (errorList.length) {
         errorList.forEach((err) => {
           logError(err, { bidder: BIDDER_CODE, code: ERROR_CODES.PROPERTY_NOT_INCLUDED });
@@ -1605,16 +1676,6 @@ export const spec = {
       }
     }
 
-    const videoImp = bidToVideoImp(bid).video;
-    if (deepAccess(bid, 'mediaTypes.video.context') === OUTSTREAM && isIndexRendererPreferred(bid) && videoImp) {
-      const outstreamPlayerSize = [deepAccess(videoImp, 'w'), deepAccess(videoImp, 'h')];
-      const isValidSize = outstreamPlayerSize[0] >= OUTSTREAM_MINIMUM_PLAYER_SIZE[0] && outstreamPlayerSize[1] >= OUTSTREAM_MINIMUM_PLAYER_SIZE[1];
-      if (!isValidSize) {
-        logError(`IX Bid Adapter: ${outstreamPlayerSize} is an invalid size for IX outstream renderer`);
-        return false;
-      }
-    }
-
     return nativeMediaTypeValid(mediaTypeNativeRef);
   },
 
@@ -1763,11 +1824,60 @@ export const spec = {
    * @returns {array} User sync pixels
    */
   getUserSyncs: function (syncOptions, serverResponses) {
-    return (syncOptions.iframeEnabled) ? [{
-      type: 'iframe',
-      url: USER_SYNC_URL
-    }] : [];
+    const syncs = [];
+    let publisherSyncsPerBidderOverride = null;
+    if (serverResponses.length > 0) {
+      publisherSyncsPerBidderOverride = deepAccess(serverResponses[0], 'body.ext.publishersyncsperbidderoverride');
+    }
+    if (publisherSyncsPerBidderOverride !== undefined && publisherSyncsPerBidderOverride == 0) {
+      return [];
+    }
+    if (syncOptions.iframeEnabled) {
+      syncs.push({
+        type: 'iframe',
+        url: IFRAME_USER_SYNC_URL
+      })
+    } else {
+      let publisherSyncsPerBidder = null;
+      if (config.getConfig('userSync')) {
+        publisherSyncsPerBidder = config.getConfig('userSync').syncsPerBidder
+      }
+      if (publisherSyncsPerBidder === 0) {
+        publisherSyncsPerBidder = publisherSyncsPerBidderOverride
+      }
+      if (publisherSyncsPerBidderOverride && (publisherSyncsPerBidder === 0 || publisherSyncsPerBidder)) {
+        publisherSyncsPerBidder = publisherSyncsPerBidderOverride > publisherSyncsPerBidder ? publisherSyncsPerBidder : publisherSyncsPerBidderOverride
+      } else {
+        publisherSyncsPerBidder = 1
+      }
+      for (let i = 0; i < publisherSyncsPerBidder; i++) {
+        syncs.push({
+          type: 'image',
+          url: buildImgSyncUrl(publisherSyncsPerBidder, i)
+        })
+      }
+    }
+    return syncs;
   }
 };
 
+/**
+   * Build img user sync url
+   * @param {int} syncsPerBidder number of syncs Per Bidder
+   * @param {int} index index to pass
+   * @returns {string} img user sync url
+   */
+function buildImgSyncUrl(syncsPerBidder, index) {
+  let consentString = '';
+  let gdprApplies = '0';
+  if (gdprConsent && gdprConsent.hasOwnProperty('gdprApplies')) {
+    gdprApplies = gdprConsent.gdprApplies ? '1' : '0';
+  }
+  if (gdprConsent && gdprConsent.hasOwnProperty('consentString')) {
+    consentString = gdprConsent.consentString || '';
+  }
+
+  return IMG_USER_SYNC_URL + '&site_id=' + siteID.toString() + '&p=' + syncsPerBidder.toString() + '&i=' + index.toString() + '&gdpr=' + gdprApplies + '&gdpr_consent=' + consentString + '&us_privacy=' + (usPrivacy || '');
+}
+
 registerBidder(spec);

package/modules/ixBidAdapter.md

@@ -502,11 +502,8 @@ to `'ix'` across all ad units that bids are being requested for does not exceed
 
 ### Time-To-Live (TTL)
 
-Banner bids from IX have a TTL of 300 seconds while video bids have a TTL of 1 hour, after which time they become
-invalid.
-
-If an invalid bid wins, and its associated ad is rendered, it will not count
-towards total impressions on IX's side.
+Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of three hours, after which time they become invalid.
+**Note:** Index supports the `bid.exp` attribute in the bid response which allows our adapter to specify the maximum number of seconds allowed between the auction and billing notice. In the absence of the `bid.exp` attribute, the TTL provided above applies.
 
 FAQs
 ====

package/modules/jixieBidAdapter.js

@@ -28,14 +28,14 @@ function setIds_(clientId, sessionId) {
     let expC = (new Date(new Date().setFullYear(new Date().getFullYear() + 1))).toUTCString();
     let expS = (new Date(new Date().setMinutes(new Date().getMinutes() + sidTTLMins_))).toUTCString();
 
-    storage.setCookie('_jx', clientId, expC, 'None', null);
-    storage.setCookie('_jx', clientId, expC, 'None', dd);
+    storage.setCookie('_jxx', clientId, expC, 'None', null);
+    storage.setCookie('_jxx', clientId, expC, 'None', dd);
 
-    storage.setCookie('_jxs', sessionId, expS, 'None', null);
-    storage.setCookie('_jxs', sessionId, expS, 'None', dd);
+    storage.setCookie('_jxxs', sessionId, expS, 'None', null);
+    storage.setCookie('_jxxs', sessionId, expS, 'None', dd);
 
-    storage.setDataInLocalStorage('_jx', clientId);
-    storage.setDataInLocalStorage('_jxs', sessionId);
+    storage.setDataInLocalStorage('_jxx', clientId);
+    storage.setDataInLocalStorage('_jxxs', sessionId);
   } catch (error) {}
 }
 
@@ -47,14 +47,14 @@ function fetchIds_() {
     session_id_ls: ''
   };
   try {
-    let tmp = storage.getCookie('_jx');
+    let tmp = storage.getCookie('_jxx');
     if (tmp) ret.client_id_c = tmp;
-    tmp = storage.getCookie('_jxs');
+    tmp = storage.getCookie('_jxxs');
     if (tmp) ret.session_id_c = tmp;
 
-    tmp = storage.getDataFromLocalStorage('_jx');
+    tmp = storage.getDataFromLocalStorage('_jxx');
     if (tmp) ret.client_id_ls = tmp;
-    tmp = storage.getDataFromLocalStorage('_jxs');
+    tmp = storage.getDataFromLocalStorage('_jxxs');
     if (tmp) ret.session_id_ls = tmp;
   } catch (error) {}
   return ret;

package/modules/kargoAnalyticsAdapter.js

@@ -1,14 +1,96 @@
+import { logError } from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
+import CONSTANTS from '../src/constants.json';
 
-var kargoAdapter = adapter({
-  analyticsType: 'endpoint',
-  url: 'https://krk.kargo.com/api/v1/event/prebid'
-});
+const EVENT_URL = 'https://krk.kargo.com/api/v1/event';
+const KARGO_BIDDER_CODE = 'kargo';
+
+const analyticsType = 'endpoint';
+
+let _initOptions = {};
+
+let _logBidResponseData = {
+  auctionId: '',
+  auctionTimeout: 0,
+  responseTime: 0,
+};
+
+let _bidResponseDataLogged = [];
+
+var kargoAnalyticsAdapter = Object.assign(
+  adapter({ analyticsType }), {
+    track({ eventType, args }) {
+      switch (eventType) {
+        case CONSTANTS.EVENTS.AUCTION_INIT: {
+          _logBidResponseData.auctionTimeout = args.timeout;
+          break;
+        }
+        case CONSTANTS.EVENTS.BID_RESPONSE: {
+          handleBidResponseData(args);
+          break;
+        }
+      }
+    }
+  }
+);
+
+// handleBidResponseData: Get auction data for Kargo bids and send to server
+function handleBidResponseData (bidResponse) {
+  // Verify this is Kargo and we haven't seen this auction data yet
+  if (bidResponse.bidder !== KARGO_BIDDER_CODE || _bidResponseDataLogged.includes(bidResponse.auctionId) !== false) {
+    return
+  }
+
+  _logBidResponseData.auctionId = bidResponse.auctionId;
+  _logBidResponseData.responseTime = bidResponse.timeToRespond;
+  sendAuctionData(_logBidResponseData);
+}
+
+// sendAuctionData: Send auction data to the server
+function sendAuctionData (data) {
+  try {
+    _bidResponseDataLogged.push(data.auctionId);
+
+    if (!shouldFireEventRequest()) {
+      return;
+    }
+
+    ajax(
+      `${EVENT_URL}/auction-data`,
+      null,
+      {
+        aid: data.auctionId,
+        ato: data.auctionTimeout,
+        rt: data.responseTime,
+        it: 0,
+      },
+      {
+        method: 'GET',
+      }
+    );
+  } catch (err) {
+    logError('Error sending auction data: ', err);
+  }
+}
+
+// Sampling rate out of 100
+function shouldFireEventRequest () {
+  const samplingRate = (_initOptions && _initOptions.sampling) || 100;
+  return ((Math.floor(Math.random() * 100) + 1) <= parseInt(samplingRate));
+}
+
+kargoAnalyticsAdapter.originEnableAnalytics = kargoAnalyticsAdapter.enableAnalytics;
+
+kargoAnalyticsAdapter.enableAnalytics = function (config) {
+  _initOptions = config.options;
+  kargoAnalyticsAdapter.originEnableAnalytics(config);
+};
 
 adapterManager.registerAnalyticsAdapter({
-  adapter: kargoAdapter,
+  adapter: kargoAnalyticsAdapter,
   code: 'kargo'
 });
 
-export default kargoAdapter;
+export default kargoAnalyticsAdapter;

package/modules/kargoAnalyticsAdapter.md

@@ -0,0 +1,33 @@
+# Overview
+
+Module Name: Kargo Analytics Adapter
+Module Type: Analytics Adapter
+Maintainer: support@kargo.com
+
+# Description
+
+Analytics adapter for Kargo. Contact support@kargo.com for information.
+
+# Usage
+
+The simplest way to enable the analytics adapter is this
+
+```javascript
+pbjs.enableAnalytics([{
+  provider: 'kargo',
+  options: {
+      sampling: 100 // value out of 100
+  }
+}]);
+```
+
+# Test Parameters
+
+```
+{
+  provider: 'kargo',
+  options: {
+      sampling: 100
+  }
+}
+```

package/modules/minutemediaBidAdapter.js

@@ -286,6 +286,7 @@ function generateBidParameters(bid, bidderRequest) {
     sizes: sizesArray,
     floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
     bidId: getBidIdParameter('bidId', bid),
+    loop: getBidIdParameter('bidderRequestsCount', bid),
     bidderRequestId: getBidIdParameter('bidderRequestId', bid),
     transactionId: getBidIdParameter('transactionId', bid),
   };

package/modules/naveggIdSystem.js

@@ -34,17 +34,6 @@ function readnavIDFromCookie() {
   return storage.cookiesAreEnabled ? (storage.findSimilarCookies('nav') ? storage.findSimilarCookies('nav')[0] : null) : null;
 }
 
-function readnvgnavFromLocalStorage() {
-  var i;
-  const query = /[nvga]{3}\d+/;
-  for (i in window.localStorage) {
-    if (i.match(query) || (!query && typeof i === 'string')) {
-      const naveggId = storage.getDataFromLocalStorage(i.match(query).input).split('|')[0]
-      return naveggId.split('_')[0];
-    }
-  }
-}
-
 /** @type {Submodule} */
 export const naveggIdSubmodule = {
   /**
@@ -73,7 +62,7 @@ export const naveggIdSubmodule = {
   getId() {
     let naveggIdStringFromLocalStorage = null;
     if (storage.localStorageIsEnabled) {
-      naveggIdStringFromLocalStorage = readnaveggIdFromLocalStorage() || readnvgnavFromLocalStorage();
+      naveggIdStringFromLocalStorage = readnaveggIdFromLocalStorage();
     }
 
     const naveggIdString = naveggIdStringFromLocalStorage || readnaveggIDFromCookie() || readoldnaveggIDFromCookie() || readnvgIDFromCookie() || readnavIDFromCookie();