prebid.js 6.26.0 → 6.29.0

package/modules/merkleIdSystem.js

@@ -11,7 +11,7 @@ import {submodule} from '../src/hook.js'
 import {getStorageManager} from '../src/storageManager.js';
 
 const MODULE_NAME = 'merkleId';
-const ID_URL = 'https://id2.sv.rkdms.com/identity/';
+const ID_URL = 'https://prebid.sv.rkdms.com/identity/';
 const DEFAULT_REFRESH = 7 * 3600;
 const SESSION_COOKIE_NAME = '_svsid';
 
@@ -30,19 +30,19 @@ function getSession(configParams) {
 function setCookie(name, value, expires) {
   let expTime = new Date();
   expTime.setTime(expTime.getTime() + expires * 1000 * 60);
-  storage.setCookie(name, value, expTime.toUTCString());
+  storage.setCookie(name, value, expTime.toUTCString(), 'Lax');
 }
 
 function setSession(storage, response) {
-  logInfo('Merkle setting session ');
-  if (response && response.c && response.c.value && typeof response.c.value === 'string') {
-    setCookie(SESSION_COOKIE_NAME, response.c.value, storage.expires);
+  logInfo('Merkle setting ' + `${SESSION_COOKIE_NAME}`);
+  if (response && response[SESSION_COOKIE_NAME] && typeof response[SESSION_COOKIE_NAME] === 'string') {
+    setCookie(SESSION_COOKIE_NAME, response[SESSION_COOKIE_NAME], storage.expires);
   }
 }
 
 function constructUrl(configParams) {
   const session = getSession(configParams);
-  let url = configParams.endpoint + `?vendor=${configParams.vendor}&sv_cid=${configParams.sv_cid}&sv_domain=${configParams.sv_domain}&sv_pubid=${configParams.sv_pubid}`;
+  let url = configParams.endpoint + `?sv_domain=${configParams.sv_domain}&sv_pubid=${configParams.sv_pubid}&ssp_ids=${configParams.ssp_ids.join()}`;
   if (session) {
     url = `${url}&sv_session=${session}`;
   }
@@ -86,45 +86,52 @@ function generateId(configParams, configStorage) {
 /** @type {Submodule} */
 export const merkleIdSubmodule = {
   /**
-   * 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 {string} value
-   * @returns {{merkleId:string}}
-   */
+     * decode the stored id value for passing to bid requests
+     * @function
+     * @param {string} value
+     * @returns {{eids:arrayofields}}
+     */
   decode(value) {
+    // Legacy support for a single id
     const id = (value && value.pam_id && typeof value.pam_id.id === 'string') ? value.pam_id : undefined;
     logInfo('Merkle id ' + JSON.stringify(id));
-    return id ? {'merkleId': id} : undefined;
+
+    if (id) {
+      return {'merkleId': id}
+    }
+
+    // Supports multiple IDs for different SSPs
+    const merkleIds = (value && value?.merkleId && Array.isArray(value.merkleId)) ? value.merkleId : undefined;
+    logInfo('merkleIds: ' + JSON.stringify(merkleIds));
+
+    return merkleIds ? {'merkleId': merkleIds} : undefined;
   },
+
   /**
-   * performs action to obtain id and return a value in the callback's response argument
-   * @function
-   * @param {SubmoduleConfig} [config]
-   * @param {ConsentData} [consentData]
-   * @returns {IdResponse|undefined}
-   */
+     * performs action to obtain id and return a value in the callback's response argument
+     * @function
+     * @param {SubmoduleConfig} [config]
+     * @param {ConsentData} [consentData]
+     * @returns {IdResponse|undefined}
+     */
   getId(config, consentData) {
     logInfo('User ID - merkleId generating id');
 
     const configParams = (config && config.params) || {};
 
-    if (!configParams || typeof configParams.vendor !== 'string') {
-      logError('User ID - merkleId submodule requires a valid vendor to be defined');
-      return;
-    }
-
-    if (typeof configParams.sv_cid !== 'string') {
-      logError('User ID - merkleId submodule requires a valid sv_cid string to be defined');
+    if (typeof configParams.sv_pubid !== 'string') {
+      logError('User ID - merkleId submodule requires a valid sv_pubid string to be defined');
       return;
     }
 
-    if (typeof configParams.sv_pubid !== 'string') {
-      logError('User ID - merkleId submodule requires a valid sv_pubid string to be defined');
+    if (!Array.isArray(configParams.ssp_ids)) {
+      logError('User ID - merkleId submodule requires a valid ssp_ids array to be defined');
       return;
     }
 
@@ -132,6 +139,7 @@ export const merkleIdSubmodule = {
       logError('User ID - merkleId submodule does not currently handle consent strings');
       return;
     }
+
     if (typeof configParams.endpoint !== 'string') {
       logWarn('User ID - merkleId submodule endpoint string is not defined');
       configParams.endpoint = ID_URL
@@ -146,7 +154,7 @@ export const merkleIdSubmodule = {
     return {callback: resp};
   },
   extendId: function (config = {}, consentData, storedId) {
-    logInfo('User ID - merkleId stored id ' + storedId);
+    logInfo('User ID - stored id ' + storedId);
     const configParams = (config && config.params) || {};
 
     if (typeof configParams.endpoint !== 'string') {
@@ -162,15 +170,18 @@ export const merkleIdSubmodule = {
     if (typeof configParams.sv_domain !== 'string') {
       configParams.sv_domain = merkleIdSubmodule.findRootDomain();
     }
+
     const configStorage = (config && config.storage) || {};
     if (configStorage && configStorage.refreshInSeconds && typeof configParams.refreshInSeconds === 'number') {
       return {id: storedId};
     }
+
     let refreshInSeconds = DEFAULT_REFRESH;
     if (configParams && configParams.refreshInSeconds && typeof configParams.refreshInSeconds === 'number') {
       refreshInSeconds = configParams.refreshInSeconds;
       logInfo('User ID - merkleId param refreshInSeconds' + refreshInSeconds);
     }
+
     const storedDate = new Date(storedId.date);
     let refreshNeeded = false;
     if (storedDate) {
@@ -181,6 +192,7 @@ export const merkleIdSubmodule = {
         return {callback: resp};
       }
     }
+
     logInfo('User ID - merkleId not refreshed');
     return {id: storedId};
   }

package/modules/naveggIdSystem.js

@@ -36,10 +36,11 @@ function readnavIDFromCookie() {
 
 function readnvgnavFromLocalStorage() {
   var i;
-  const query = '^nvg|^nav';
+  const query = /[nvga]{3}\d+/;
   for (i in window.localStorage) {
     if (i.match(query) || (!query && typeof i === 'string')) {
-      return storage.getDataFromLocalStorage(i.match(query).input);
+      const naveggId = storage.getDataFromLocalStorage(i.match(query).input).split('|')[0]
+      return naveggId.split('_')[0];
     }
   }
 }

package/modules/novatiqIdSystem.js

@@ -18,6 +18,11 @@ export const novatiqIdSubmodule = {
  * @type {string}
  */
   name: 'novatiq',
+  /**
+   * used to specify vendor id
+   * @type {number}
+   */
+  gvlid: 1119,
 
   /**
  * decode the stored id value for passing to bid requests
@@ -202,7 +207,7 @@ export const novatiqIdSubmodule = {
     let sharedId = null;
     if (this.useSharedId(configParams)) {
       let cookieOrStorageID = this.getCookieOrStorageID(configParams);
-      const storage = getStorageManager({moduleName: 'pubCommonId'});
+      const storage = getStorageManager({gvlid: this.gvlid, moduleName: 'pubCommonId'});
 
       // first check local storage
       if (storage.hasLocalStorage()) {

package/modules/pubCommonId.js

@@ -9,7 +9,8 @@ import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager } from '../src/storageManager.js';
 
-const storage = getStorageManager();
+const MODULE_TYPE = 'fpid-module';
+const storage = getStorageManager({moduleType: MODULE_TYPE});
 
 const ID_NAME = '_pubcid';
 const OPTOUT_NAME = '_pubcid_optout';

package/modules/pubmaticAnalyticsAdapter.js

@@ -83,6 +83,8 @@ function setMediaTypes(types, bid) {
 function copyRequiredBidDetails(bid) {
   return pick(bid, [
     'bidder',
+    'bidderCode',
+    'adapterCode',
     'bidId',
     'status', () => NO_BID, // default a bid to NO_BID until response is recieved or bid is timed out
     'finalSource as source',
@@ -90,7 +92,7 @@ function copyRequiredBidDetails(bid) {
     'adUnit', () => pick(bid, [
       'adUnitCode',
       'transactionId',
-      'sizes as dimensions', sizes => sizes.map(sizeToDimensions),
+      'sizes as dimensions', sizes => sizes && sizes.map(sizeToDimensions),
       'mediaTypes', (types) => setMediaTypes(types, bid)
     ])
   ]);
@@ -185,11 +187,11 @@ function getDevicePlatform() {
 }
 
 function getValueForKgpv(bid, adUnitId) {
-  if (bid.params.regexPattern) {
+  if (bid.params && bid.params.regexPattern) {
     return bid.params.regexPattern;
   } else if (bid.bidResponse && bid.bidResponse.regexPattern) {
     return bid.bidResponse.regexPattern;
-  } else if (bid.params.kgpv) {
+  } else if (bid.params && bid.params.kgpv) {
     return bid.params.kgpv;
   } else {
     return adUnitId;
@@ -218,30 +220,31 @@ function getAdDomain(bidResponse) {
 function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
   highestBid = (highestBid && highestBid.length > 0) ? highestBid[0] : null;
   return Object.keys(adUnit.bids).reduce(function(partnerBids, bidId) {
-    let bid = adUnit.bids[bidId];
-    partnerBids.push({
-      'pn': getAdapterNameForAlias(bid.bidder),
-      'bc': bid.bidder,
-      'bidid': bid.bidId,
-      'db': bid.bidResponse ? 0 : 1,
-      'kgpv': getValueForKgpv(bid, adUnitId),
-      'kgpsv': bid.params.kgpv ? bid.params.kgpv : adUnitId,
-      'psz': bid.bidResponse ? (bid.bidResponse.dimensions.width + 'x' + bid.bidResponse.dimensions.height) : '0x0',
-      'eg': bid.bidResponse ? bid.bidResponse.bidGrossCpmUSD : 0,
-      'en': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0,
-      'di': bid.bidResponse ? (bid.bidResponse.dealId || EMPTY_STRING) : EMPTY_STRING,
-      'dc': bid.bidResponse ? (bid.bidResponse.dealChannel || EMPTY_STRING) : EMPTY_STRING,
-      'l1': bid.bidResponse ? bid.clientLatencyTimeMs : 0,
-      'l2': 0,
-      'adv': bid.bidResponse ? getAdDomain(bid.bidResponse) || undefined : undefined,
-      'ss': (s2sBidders.indexOf(bid.bidder) > -1) ? 1 : 0,
-      't': (bid.status == ERROR && bid.error.code == TIMEOUT_ERROR) ? 1 : 0,
-      'wb': (highestBid && highestBid.requestId === bid.bidId ? 1 : 0),
-      'mi': bid.bidResponse ? (bid.bidResponse.mi || undefined) : undefined,
-      'af': bid.bidResponse ? (bid.bidResponse.mediaType || undefined) : undefined,
-      'ocpm': bid.bidResponse ? (bid.bidResponse.originalCpm || 0) : 0,
-      'ocry': bid.bidResponse ? (bid.bidResponse.originalCurrency || CURRENCY_USD) : CURRENCY_USD,
-      'piid': bid.bidResponse ? (bid.bidResponse.partnerImpId || EMPTY_STRING) : EMPTY_STRING
+    adUnit.bids[bidId].forEach(function(bid) {
+      partnerBids.push({
+        'pn': getAdapterNameForAlias(bid.adapterCode || bid.bidder),
+        'bc': bid.bidderCode || bid.bidder,
+        'bidid': bid.bidId || bidId,
+        'db': bid.bidResponse ? 0 : 1,
+        'kgpv': getValueForKgpv(bid, adUnitId),
+        'kgpsv': bid.params && bid.params.kgpv ? bid.params.kgpv : adUnitId,
+        'psz': bid.bidResponse ? (bid.bidResponse.dimensions.width + 'x' + bid.bidResponse.dimensions.height) : '0x0',
+        'eg': bid.bidResponse ? bid.bidResponse.bidGrossCpmUSD : 0,
+        'en': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0,
+        'di': bid.bidResponse ? (bid.bidResponse.dealId || EMPTY_STRING) : EMPTY_STRING,
+        'dc': bid.bidResponse ? (bid.bidResponse.dealChannel || EMPTY_STRING) : EMPTY_STRING,
+        'l1': bid.bidResponse ? bid.clientLatencyTimeMs : 0,
+        'l2': 0,
+        'adv': bid.bidResponse ? getAdDomain(bid.bidResponse) || undefined : undefined,
+        'ss': (s2sBidders.indexOf(bid.bidder) > -1) ? 1 : 0,
+        't': (bid.status == ERROR && bid.error.code == TIMEOUT_ERROR) ? 1 : 0,
+        'wb': (highestBid && highestBid.adId === bid.adId ? 1 : 0),
+        'mi': bid.bidResponse ? (bid.bidResponse.mi || undefined) : undefined,
+        'af': bid.bidResponse ? (bid.bidResponse.mediaType || undefined) : undefined,
+        'ocpm': bid.bidResponse ? (bid.bidResponse.originalCpm || 0) : 0,
+        'ocry': bid.bidResponse ? (bid.bidResponse.originalCurrency || CURRENCY_USD) : CURRENCY_USD,
+        'piid': bid.bidResponse ? (bid.bidResponse.partnerImpId || EMPTY_STRING) : EMPTY_STRING
+      });
     });
     return partnerBids;
   }, [])
@@ -307,8 +310,14 @@ function executeBidsLoggerCall(e, highestCpmBids) {
 
 function executeBidWonLoggerCall(auctionId, adUnitId) {
   const winningBidId = cache.auctions[auctionId].adUnitCodes[adUnitId].bidWon;
-  const winningBid = cache.auctions[auctionId].adUnitCodes[adUnitId].bids[winningBidId];
-  const adapterName = getAdapterNameForAlias(winningBid.bidder);
+  const winningBids = cache.auctions[auctionId].adUnitCodes[adUnitId].bids[winningBidId];
+  let winningBid = winningBids[0];
+
+  if (winningBids.length > 1) {
+    winningBid = winningBids.filter(bid => bid.adId === cache.auctions[auctionId].adUnitCodes[adUnitId].bidWonAdId)[0];
+  }
+
+  const adapterName = getAdapterNameForAlias(winningBid.adapterCode || winningBid.bidder);
   let pixelURL = END_POINT_WIN_BID_LOGGER;
   pixelURL += 'pubid=' + publisherId;
   pixelURL += '&purl=' + enc(config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '');
@@ -319,7 +328,7 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
   pixelURL += '&pdvid=' + enc(profileVersionId);
   pixelURL += '&slot=' + enc(adUnitId);
   pixelURL += '&pn=' + enc(adapterName);
-  pixelURL += '&bc=' + enc(winningBid.bidder);
+  pixelURL += '&bc=' + enc(winningBid.bidderCode || winningBid.bidder);
   pixelURL += '&en=' + enc(winningBid.bidResponse.bidPriceUSD);
   pixelURL += '&eg=' + enc(winningBid.bidResponse.bidGrossCpmUSD);
   pixelURL += '&kgpv=' + enc(getValueForKgpv(winningBid, adUnitId));
@@ -362,16 +371,22 @@ function bidRequestedHandler(args) {
         dimensions: bid.sizes
       };
     }
-    cache.auctions[args.auctionId].adUnitCodes[bid.adUnitCode].bids[bid.bidId] = copyRequiredBidDetails(bid);
+    cache.auctions[args.auctionId].adUnitCodes[bid.adUnitCode].bids[bid.bidId] = [copyRequiredBidDetails(bid)];
   })
 }
 
 function bidResponseHandler(args) {
-  let bid = cache.auctions[args.auctionId].adUnitCodes[args.adUnitCode].bids[args.requestId];
+  let bid = cache.auctions[args.auctionId].adUnitCodes[args.adUnitCode].bids[args.requestId][0];
   if (!bid) {
     logError(LOG_PRE_FIX + 'Could not find associated bid request for bid response with requestId: ', args.requestId);
     return;
   }
+
+  if (bid.bidder && args.bidderCode && bid.bidder !== args.bidderCode) {
+    bid = copyRequiredBidDetails(args);
+    cache.auctions[args.auctionId].adUnitCodes[args.adUnitCode].bids[args.requestId].push(bid)
+  }
+  bid.adId = args.adId;
   bid.source = formatSource(bid.source || args.source);
   setBidStatus(bid, args);
   bid.clientLatencyTimeMs = Date.now() - cache.auctions[args.auctionId].timestamp;
@@ -397,6 +412,7 @@ function bidderDoneHandler(args) {
 function bidWonHandler(args) {
   let auctionCache = cache.auctions[args.auctionId];
   auctionCache.adUnitCodes[args.adUnitCode].bidWon = args.requestId;
+  auctionCache.adUnitCodes[args.adUnitCode].bidWonAdId = args.adId;
   executeBidWonLoggerCall(args.auctionId, args.adUnitCode);
 }
 
@@ -413,7 +429,7 @@ function bidTimeoutHandler(args) {
   // db = 0 and t = 1 means bidder did  respond with a bid but post timeout
   args.forEach(badBid => {
     let auctionCache = cache.auctions[badBid.auctionId];
-    let bid = auctionCache.adUnitCodes[badBid.adUnitCode].bids[ badBid.bidId || badBid.requestId ];
+    let bid = auctionCache.adUnitCodes[badBid.adUnitCode].bids[ badBid.bidId || badBid.requestId ][0];
     if (bid) {
       bid.status = ERROR;
       bid.error = {

package/modules/relaidoBidAdapter.js

@@ -151,9 +151,6 @@ function interpretResponse(serverResponse, bidRequest) {
     }
     bidResponses.push(bidResponse);
   }
-
-  // eslint-disable-next-line no-console
-  console.log(JSON.stringify(bidResponses));
   return bidResponses;
 }
 

package/modules/sharedIdSystem.js

@@ -5,13 +5,13 @@
  * @requires module:modules/userId
  */
 
-import { parseUrl, buildUrl, triggerPixel, logInfo, hasDeviceAccess, generateUUID } from '../src/utils.js';
+import {buildUrl, generateUUID, hasDeviceAccess, logInfo, parseUrl, triggerPixel} from '../src/utils.js';
 import {submodule} from '../src/hook.js';
-import { coppaDataHandler } from '../src/adapterManager.js';
+import {coppaDataHandler} from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
 
-const GVLID = 887;
-export const storage = getStorageManager({gvlid: GVLID, moduleName: 'pubCommonId'});
+const MODULE_TYPE = 'fpid-module';
+export const storage = getStorageManager({moduleName: 'pubCommonId', moduleType: MODULE_TYPE});
 const COOKIE = 'cookie';
 const LOCAL_STORAGE = 'html5';
 const OPTOUT_NAME = '_pubcid_optout';
@@ -74,11 +74,6 @@ export const sharedIdSystemSubmodule = {
    */
   name: 'sharedId',
   aliasName: 'pubCommonId',
-  /**
-   * Vendor id of prebid
-   * @type {Number}
-   */
-  gvlid: GVLID,
 
   /**
    * decode the stored id value for passing to bid requests
@@ -93,8 +88,7 @@ export const sharedIdSystemSubmodule = {
       return undefined;
     }
     logInfo(' Decoded value PubCommonId ' + value);
-    const idObj = {'pubcid': value};
-    return idObj;
+    return {'pubcid': value};
   },
   /**
    * performs action to obtain id

package/modules/slimcutBidAdapter.js

@@ -9,8 +9,8 @@ const BIDDER_CODE = 'slimcut';
 const ENDPOINT_URL = 'https://sb.freeskreen.com/pbr';
 export const spec = {
   code: BIDDER_CODE,
-  gvlid: 52,
-  aliases: [{ code: 'scm', gvlid: 52 }],
+  gvlid: 102,
+  aliases: [{ code: 'scm', gvlid: 102 }],
   supportedMediaTypes: ['video', 'banner'],
   /**
      * Determines whether or not the given bid request is valid.

package/modules/spotxBidAdapter.js

@@ -11,7 +11,7 @@ export const GOOGLE_CONSENT = { consented_providers: ['3', '7', '11', '12', '15'
 
 export const spec = {
   code: BIDDER_CODE,
-  gvlid: 52,
+  gvlid: 165,
   supportedMediaTypes: [VIDEO],
 
   /**

package/modules/synacormediaBidAdapter.js

@@ -1,6 +1,6 @@
 'use strict';
 
-import {deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn} from '../src/utils.js';
+import {deepAccess, deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {includes} from '../src/polyfill.js';
@@ -79,7 +79,16 @@ export const spec = {
         imps = this.buildVideoImpressions(adSizes, bid, tagIdOrPlacementId, pos, videoOrBannerKey);
       }
       if (imps.length > 0) {
-        imps.forEach(i => openRtbBidRequest.imp.push(i));
+        imps.forEach(i => {
+          // Deeply add ext section to all imp[] for GPID, prebid slot id, and anything else down the line
+          const extSection = deepAccess(bid, 'ortb2Imp.ext');
+          if (extSection) {
+            deepSetValue(i, 'ext', extSection);
+          }
+
+          // Add imp[] to request object
+          openRtbBidRequest.imp.push(i);
+        });
       }
     });