prebid.js 8.1.0 → 8.3.0

package/modules/sovrnBidAdapter.js

@@ -169,6 +169,11 @@ export const spec = {
         };
       }
 
+      const tid = deepAccess(bidderRequest, 'ortb2.source.tid')
+      if (tid) {
+        deepSetValue(sovrnBidReq, 'source.tid', tid)
+      }
+
       if (bidderRequest.gdprConsent) {
         deepSetValue(sovrnBidReq, 'regs.ext.gdpr', +bidderRequest.gdprConsent.gdprApplies);
         deepSetValue(sovrnBidReq, 'user.ext.consent', bidderRequest.gdprConsent.consentString)

package/modules/trafficgateBidAdapter.js

@@ -1,95 +1,149 @@
-import { getWindowLocation, deepAccess } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {ortbConverter} from '../libraries/ortbConverter/converter.js';
+import {deepAccess, mergeDeep, convertTypes} from '../src/utils.js';
 
 const BIDDER_CODE = 'trafficgate';
-const URL = 'https://[HOST].bc-plugin.com/?c=o&m=multi'
+const URL = 'https://[HOST].bc-plugin.com/prebidjs'
 
 export const spec = {
   code: BIDDER_CODE,
-  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+  supportedMediaTypes: [BANNER, VIDEO],
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  transformBidParams,
+  isBannerBid
+};
 
-  isBidRequestValid: function (bid) {
-    return !!(bid.bidId && bid.params && parseInt(bid.params.placementId) && bid.params.host)
-  },
-  /**
-   * Make a server request from the list of BidRequests.
-   *
-   * @param {BidRequest[]} validBidRequests A non-empty list of valid bid requests that should be sent to the Server.
-   * @return ServerRequest Info describing the request to the server.
-   */
-  buildRequests: function (validBidRequests) {
-    // convert Native ORTB definition to old-style prebid native definition
-    validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
-    if (validBidRequests && validBidRequests.length === 0) return [];
-
-    const location = getWindowLocation()
-    const placements = []
-
-    validBidRequests.forEach((bidReq) => {
-      placements.push({
-        placementId: bidReq.params.placementId,
-        bidId: bidReq.bidId,
-        traffic: getMediatype(bidReq)
-      })
-    })
+registerBidder(spec)
 
-    return {
-      method: 'POST',
-      url: URL.replace('[HOST]', validBidRequests[0].params.host),
-      data: {
-        language: (navigator && navigator.language) ? navigator.language : '',
-        secure: +(location.protocol === 'https:'),
-        host: location.hostname,
-        page: location.pathname,
-        placements: placements
+const converter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 300
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    mergeDeep(imp, {
+      ext: {
+        bidder: {
+          placementId: bidRequest.params.placementId,
+          host: bidRequest.params.host
+        }
       }
+    });
+    if (bidRequest.params.customFloor && !imp.bidfloor) {
+      imp.bidfloor = bidRequest.params.customFloor;
     }
+    return imp;
   },
-
-  interpretResponse: function (opts) {
-    const body = opts.body
-    const response = []
-
-    for (let i = 0; i < body.length; i++) {
-      const item = body[i]
-      if (isBidResponseValid(item)) {
-        response.push(item)
+  request(buildRequest, imps, bidderRequest, context) {
+    const req = buildRequest(imps, bidderRequest, context);
+    mergeDeep(req, {
+      at: 1,
+    })
+    const bid = context.bidRequests[0];
+    if (bid.params.test) {
+      req.test = 1
+    }
+    return req;
+  },
+  bidResponse(buildBidResponse, bid, context) {
+    const bidResponse = buildBidResponse(bid, context);
+    if (bid.ext) {
+      bidResponse.meta.networkId = bid.ext.networkId;
+      bidResponse.meta.advertiserDomains = bid.ext.advertiserDomains;
+    }
+    return bidResponse;
+  },
+  response(buildResponse, bidResponses, ortbResponse, context) {
+    const response = buildResponse(bidResponses, ortbResponse, context);
+    return response.bids
+  },
+  overrides: {
+    imp: {
+      bidfloor(setBidFloor, imp, bidRequest, context) {
+        const floor = {};
+        setBidFloor(floor, bidRequest, {...context, currency: 'USD'});
+        if (floor.bidfloorcur === 'USD') {
+          Object.assign(imp, floor);
+        }
+      },
+      video(orig, imp, bidRequest, context) {
+        if (FEATURES.VIDEO) {
+          let videoParams = bidRequest.mediaTypes[VIDEO];
+          if (videoParams) {
+            videoParams = Object.assign({}, videoParams, bidRequest.params.video);
+            bidRequest = {...bidRequest, mediaTypes: {[VIDEO]: videoParams}}
+          }
+          orig(imp, bidRequest, context);
+          if (imp.video && videoParams?.context === 'outstream') {
+            imp.video.placement = imp.video.placement || 4;
+          }
+        }
       }
     }
-
-    return response
   }
-}
+});
 
-registerBidder(spec)
+function transformBidParams(params, isOpenRtb) {
+  return convertTypes({
+    'customFloor': 'number',
+    'placementId': 'number',
+    'host': 'string'
+  }, params);
+}
 
-function isBidResponseValid (bid) {
-  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
-    !bid.ttl || !bid.currency) {
+function isBidRequestValid(bidRequest) {
+  const isValid = bidRequest.params.placementId && bidRequest.params.host;
+  if (!isValid) {
     return false
   }
-  switch (bid['mediaType']) {
-    case BANNER:
-      return Boolean(bid.width && bid.height && bid.ad)
-    case VIDEO:
-      return Boolean(bid.vastUrl)
-    case NATIVE:
-      return Boolean(bid.title && bid.image && bid.impressionTrackers)
-    default:
-      return false
+  if (isBannerBid(bidRequest)) {
+    return deepAccess(bidRequest, 'mediaTypes.banner.sizes.length') > 0;
   }
+  return true
 }
 
-function getMediatype(bidRequest) {
-  if (deepAccess(bidRequest, 'mediaTypes.banner')) {
-    return BANNER;
-  }
-  if (deepAccess(bidRequest, 'mediaTypes.video')) {
-    return VIDEO;
+function buildRequests(bids, bidderRequest) {
+  let videoBids = bids.filter(bid => isVideoBid(bid));
+  let bannerBids = bids.filter(bid => isBannerBid(bid));
+  let requests = bannerBids.length ? [createRequest(bannerBids, bidderRequest, BANNER)] : [];
+  videoBids.forEach(bid => {
+    requests.push(createRequest([bid], bidderRequest, VIDEO));
+  });
+  return requests;
+}
+
+function createRequest(bidRequests, bidderRequest, mediaType) {
+  return {
+    method: 'POST',
+    url: URL.replace('[HOST]', bidRequests[0].params.host),
+    data: converter.toORTB({bidRequests, bidderRequest, context: {mediaType}})
   }
-  if (deepAccess(bidRequest, 'mediaTypes.native')) {
-    return NATIVE;
+}
+
+function isVideoBid(bid) {
+  return !!deepAccess(bid, 'mediaTypes.video');
+}
+
+function isBannerBid(bid) {
+  return !!deepAccess(bid, 'mediaTypes.banner');
+}
+
+function interpretResponse(resp, req) {
+  if (!resp.body) {
+    resp.body = {nbr: 0};
   }
+  return converter.fromORTB({request: req.data, response: resp.body});
+}
+
+export const spec2 = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
+
+  isBidRequestValid: function (bid) {
+    return !!(bid.bidId && bid.params && parseInt(bid.params.placementId) && bid.params.host)
+  },
 }

package/modules/tripleliftBidAdapter.js

@@ -56,6 +56,10 @@ export const tripleliftAdapterSpec = {
       tlCall = tryAppendQueryString(tlCall, 'us_privacy', bidderRequest.uspConsent);
     }
 
+    if (bidderRequest && bidderRequest.fledgeEnabled) {
+      tlCall = tryAppendQueryString(tlCall, 'fledge', bidderRequest.fledgeEnabled);
+    }
+
     if (config.getConfig('coppa') === true) {
       tlCall = tryAppendQueryString(tlCall, 'coppa', true);
     }
@@ -80,7 +84,7 @@ export const tripleliftAdapterSpec = {
     });
   },
 
-  getUserSyncs: function(syncOptions, responses, gdprConsent, usPrivacy) {
+  getUserSyncs: function(syncOptions, responses, gdprConsent, usPrivacy, gppConsent) {
     let syncType = _getSyncType(syncOptions);
     if (!syncType) return;
 
@@ -100,6 +104,15 @@ export const tripleliftAdapterSpec = {
       syncEndpoint = tryAppendQueryString(syncEndpoint, 'us_privacy', usPrivacy);
     }
 
+    if (gppConsent) {
+      if (gppConsent.gppString) {
+        syncEndpoint = tryAppendQueryString(syncEndpoint, 'gpp', gppConsent.gppString);
+      }
+      if (gppConsent.applicableSections && gppConsent.applicableSections.length !== 0) {
+        syncEndpoint = tryAppendQueryString(syncEndpoint, 'gpp_sid', _filterSid(gppConsent.applicableSections));
+      }
+    }
+
     return [{
       type: syncType,
       url: syncEndpoint
@@ -113,6 +126,13 @@ function _getSyncType(syncOptions) {
   if (syncOptions.pixelEnabled) return 'image';
 }
 
+function _filterSid(sid) {
+  return sid.filter(element => {
+    return Number.isInteger(element);
+  })
+    .join(',');
+}
+
 function _buildPostBody(bidRequests, bidderRequest) {
   let data = {};
   let { schain } = bidRequests[0];

package/modules/userId/eids.js

@@ -158,6 +158,11 @@ export const USER_IDS_CONFIG = {
     atype: 3,
     getValue: function(data) {
       return data.id;
+    },
+    getUidExt: function(data) {
+      if (data.ext) {
+        return data.ext;
+      }
     }
   },
 
@@ -167,6 +172,25 @@ export const USER_IDS_CONFIG = {
     atype: 3,
     getValue: function(data) {
       return data.id;
+    },
+    getUidExt: function(data) {
+      if (data.ext) {
+        return data.ext;
+      }
+    }
+  },
+
+  // magnite
+  'magnite': {
+    source: 'rubiconproject.com',
+    atype: 3,
+    getValue: function(data) {
+      return data.id;
+    },
+    getUidExt: function(data) {
+      if (data.ext) {
+        return data.ext;
+      }
     }
   },
 
@@ -288,6 +312,11 @@ export const USER_IDS_CONFIG = {
     atype: 3,
     getValue: function(data) {
       return data.id;
+    },
+    getUidExt: function(data) {
+      if (data.ext) {
+        return data.ext;
+      }
     }
   },
 

package/modules/userId/eids.md

@@ -110,7 +110,10 @@ userIdAsEids = [
         source: 'bidswitch.net',
         uids: [{
             id: 'some-random-id-value',
-            atype: 3
+            atype: 3,
+            ext: {
+                provider: 'liveintent.com'
+            }
         }]
     },
     
@@ -118,7 +121,21 @@ userIdAsEids = [
         source: 'media.net',
         uids: [{
             id: 'some-random-id-value',
-            atype: 3
+            atype: 3,
+            ext: {
+                provider: 'liveintent.com'
+            }
+        }]
+    },
+
+    {
+        source: 'rubiconproject.com',
+        uids: [{
+            id: 'some-random-id-value',
+            atype: 3,
+            ext: {
+                provider: 'liveintent.com'
+            }
         }]
     },
 

package/modules/userId/index.js

@@ -130,7 +130,7 @@ import {find, includes} from '../../src/polyfill.js';
 import {config} from '../../src/config.js';
 import * as events from '../../src/events.js';
 import {getGlobal} from '../../src/prebidGlobal.js';
-import adapterManager, {gdprDataHandler} from '../../src/adapterManager.js';
+import adapterManager, {gdprDataHandler, gppDataHandler} from '../../src/adapterManager.js';
 import CONSTANTS from '../../src/constants.json';
 import {module, ready as hooksReady} from '../../src/hook.js';
 import {buildEidPermissions, createEidsArray, USER_IDS_CONFIG} from './eids.js';
@@ -195,6 +195,9 @@ let initializedSubmodules;
 /** @type {SubmoduleConfig[]} */
 let configRegistry = [];
 
+/** @type {Object} */
+let idPriority = {};
+
 /** @type {Submodule[]} */
 let submoduleRegistry = [];
 
@@ -406,7 +409,7 @@ function storedConsentDataMatchesConsentData(storedConsentData, consentData) {
  * @param {SubmoduleContainer[]} submodules
  * @param {function} cb - callback for after processing is done.
  */
-function processSubmoduleCallbacks(submodules, cb) {
+function processSubmoduleCallbacks(submodules, cb, allModules) {
   cb = uidMetrics().fork().startTiming('userId.callbacks.total').stopBefore(cb);
   const done = delayExecution(() => {
     clearTimeout(timeoutID);
@@ -422,7 +425,7 @@ function processSubmoduleCallbacks(submodules, cb) {
         }
         // cache decoded value (this is copied to every adUnit bid)
         submodule.idObj = submodule.submodule.decode(idObj, submodule.config);
-        updatePPID(submodule.idObj);
+        updatePPID(getCombinedSubmoduleIds(allModules));
       } else {
         logInfo(`${MODULE_NAME}: ${submodule.submodule.name} - request id responded with an empty value`);
       }
@@ -447,14 +450,7 @@ function getCombinedSubmoduleIds(submodules) {
   if (!Array.isArray(submodules) || !submodules.length) {
     return {};
   }
-  const combinedSubmoduleIds = submodules.filter(i => isPlainObject(i.idObj) && Object.keys(i.idObj).length).reduce((carry, i) => {
-    Object.keys(i.idObj).forEach(key => {
-      carry[key] = i.idObj[key];
-    });
-    return carry;
-  }, {});
-
-  return combinedSubmoduleIds;
+  return getPrioritizedCombinedSubmoduleIds(submodules)
 }
 
 /**
@@ -466,9 +462,14 @@ function getSubmoduleId(submodules, sourceName) {
   if (!Array.isArray(submodules) || !submodules.length) {
     return {};
   }
-  const submodule = submodules.filter(sub => isPlainObject(sub.idObj) &&
-    Object.keys(sub.idObj).length && USER_IDS_CONFIG[Object.keys(sub.idObj)[0]]?.source === sourceName);
-  return !isEmpty(submodule) ? submodule[0].idObj : [];
+
+  const prioritisedIds = getPrioritizedCombinedSubmoduleIds(submodules);
+  const eligibleIdName = Object.keys(prioritisedIds).find(idName => {
+    const config = USER_IDS_CONFIG[idName];
+    return config?.source === sourceName || (isFn(config?.getSource) && config.getSource() === sourceName);
+  });
+
+  return eligibleIdName ? {[eligibleIdName]: prioritisedIds[eligibleIdName]} : [];
 }
 
 /**
@@ -480,15 +481,38 @@ function getCombinedSubmoduleIdsForBidder(submodules, bidder) {
   if (!Array.isArray(submodules) || !submodules.length || !bidder) {
     return {};
   }
-  return submodules
+  const eligibleSubmodules = submodules
     .filter(i => !i.config.bidders || !isArray(i.config.bidders) || includes(i.config.bidders, bidder))
+
+  return getPrioritizedCombinedSubmoduleIds(eligibleSubmodules);
+}
+
+/**
+ * @param {SubmoduleContainer[]} submodules
+ */
+function getPrioritizedCombinedSubmoduleIds(submodules) {
+  const combinedIdStates = submodules
     .filter(i => isPlainObject(i.idObj) && Object.keys(i.idObj).length)
     .reduce((carry, i) => {
       Object.keys(i.idObj).forEach(key => {
-        carry[key] = i.idObj[key];
+        const maybeCurrentIdPriority = idPriority[key]?.indexOf(i.submodule.name);
+        const currentIdPriority = isNumber(maybeCurrentIdPriority) ? maybeCurrentIdPriority : -1;
+        const currentIdState = {priority: currentIdPriority, value: i.idObj[key]};
+        if (carry[key]) {
+          const winnerIdState = currentIdState.priority > carry[key].priority ? currentIdState : carry[key];
+          carry[key] = winnerIdState;
+        } else {
+          carry[key] = currentIdState;
+        }
       });
       return carry;
     }, {});
+
+  const result = {};
+  Object.keys(combinedIdStates).forEach(key => {
+    result[key] = combinedIdStates[key].value
+  });
+  return result;
 }
 
 /**
@@ -550,10 +574,13 @@ function idSystemInitializer({delay = GreedyPromise.timeout} = {}) {
   function timeGdpr() {
     return gdprDataHandler.promise.finally(initMetrics.startTiming('userId.init.gdpr'));
   }
+  function timeGpp() {
+    return gppDataHandler.promise.finally(initMetrics.startTiming('userId.init.gpp'))
+  }
 
   let done = cancelAndTry(
     GreedyPromise.all([hooksReady, startInit.promise])
-      .then(timeGdpr)
+      .then(() => GreedyPromise.all([timeGdpr(), timeGpp()]).then(([gdpr]) => gdpr))
       .then(checkRefs((consentData) => {
         initSubmodules(initModules, allModules, consentData);
       }))
@@ -561,7 +588,7 @@ function idSystemInitializer({delay = GreedyPromise.timeout} = {}) {
       .then(checkRefs(() => {
         const modWithCb = initModules.filter(item => isFn(item.callback));
         if (modWithCb.length) {
-          return new GreedyPromise((resolve) => processSubmoduleCallbacks(modWithCb, resolve));
+          return new GreedyPromise((resolve) => processSubmoduleCallbacks(modWithCb, resolve, initModules));
         }
       }))
   );
@@ -600,7 +627,7 @@ function idSystemInitializer({delay = GreedyPromise.timeout} = {}) {
               return sm.callback != null;
             });
             if (cbModules.length) {
-              return new GreedyPromise((resolve) => processSubmoduleCallbacks(cbModules, resolve));
+              return new GreedyPromise((resolve) => processSubmoduleCallbacks(cbModules, resolve, initModules));
             }
           }))
       );
@@ -783,7 +810,7 @@ function getUserIdsAsync() {
   );
 }
 
-function populateSubmoduleId(submodule, consentData, storedConsentData, forceRefresh) {
+function populateSubmoduleId(submodule, consentData, storedConsentData, forceRefresh, allSubmodules) {
   // There are two submodule configuration types to handle: storage or value
   // 1. storage: retrieve user id data from cookie/html storage or with the submodule's getId method
   // 2. value: pass directly to bids
@@ -832,7 +859,7 @@ function populateSubmoduleId(submodule, consentData, storedConsentData, forceRef
       if (response.id) { submodule.idObj = submodule.submodule.decode(response.id, submodule.config); }
     }
   }
-  updatePPID(submodule.idObj);
+  updatePPID(getCombinedSubmoduleIds(allSubmodules));
 }
 
 function updatePPID(userIds = getUserIds()) {
@@ -879,7 +906,7 @@ function initSubmodules(dest, submodules, consentData, forceRefresh = false) {
     const initialized = submodules.reduce((carry, submodule) => {
       return submoduleMetrics(submodule.submodule.name).measureTime('init', () => {
         try {
-          populateSubmoduleId(submodule, consentData, storedConsentData, forceRefresh);
+          populateSubmoduleId(submodule, consentData, storedConsentData, forceRefresh, submodules);
           carry.push(submodule);
         } catch (e) {
           logError(`Error in userID module '${submodule.submodule.name}':`, e);
@@ -1010,6 +1037,25 @@ function updateSubmodules() {
   }
 }
 
+/**
+ * This function will update the idPriority according to the provided configuration
+ * @param {Object} idPriorityConfig
+ * @param {SubmoduleContainer[]} submodules
+ */
+function updateIdPriority(idPriorityConfig, submodules) {
+  if (idPriorityConfig) {
+    const result = {};
+    const aliasToName = new Map(submodules.map(s => s.submodule.aliasName ? [s.submodule.aliasName, s.submodule.name] : []));
+    Object.keys(idPriorityConfig).forEach(key => {
+      const priority = isArray(idPriorityConfig[key]) ? [...idPriorityConfig[key]].reverse() : []
+      result[key] = priority.map(s => aliasToName.has(s) ? aliasToName.get(s) : s);
+    });
+    idPriority = result;
+  } else {
+    idPriority = {};
+  }
+}
+
 export function requestDataDeletion(next, ...args) {
   logInfo('UserID: received data deletion request; deleting all stored IDs...')
   submodules.forEach(submodule => {
@@ -1069,13 +1115,16 @@ export function init(config, {delay = GreedyPromise.timeout} = {}) {
   configListener = config.getConfig('userSync', conf => {
     // Note: support for 'usersync' was dropped as part of Prebid.js 4.0
     const userSync = conf.userSync;
-    ppidSource = userSync.ppid;
-    if (userSync && userSync.userIds) {
-      configRegistry = userSync.userIds;
-      syncDelay = isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;
-      auctionDelay = isNumber(userSync.auctionDelay) ? userSync.auctionDelay : NO_AUCTION_DELAY;
-      updateSubmodules();
-      initIdSystem({ready: true});
+    if (userSync) {
+      ppidSource = userSync.ppid;
+      if (userSync.userIds) {
+        configRegistry = userSync.userIds;
+        syncDelay = isNumber(userSync.syncDelay) ? userSync.syncDelay : DEFAULT_SYNC_DELAY;
+        auctionDelay = isNumber(userSync.auctionDelay) ? userSync.auctionDelay : NO_AUCTION_DELAY;
+        updateSubmodules();
+        updateIdPriority(userSync.idPriority, submodules);
+        initIdSystem({ready: true});
+      }
     }
   });
 

package/modules/userId/userId.md

@@ -5,6 +5,9 @@ Example showing `cookie` storage for user id data for each of the submodules
 ```
 pbjs.setConfig({
     userSync: {
+        idPriority: {
+            uid2: ['uid2', 'liveIntentId']
+        }
         userIds: [{
             name: "33acrossId",
             storage: {