prebid.js 7.53.0 → 8.0.0

package/libraries/appnexusKeywords/anKeywords.js

@@ -0,0 +1,140 @@
+import {_each, deepAccess, getValueString, isArray, isStr, mergeDeep, isNumber} from '../../src/utils.js';
+import {getAllOrtbKeywords} from '../keywords/keywords.js';
+import {CLIENT_SECTIONS} from '../../src/fpd/oneClient.js';
+
+const ORTB_SEGTAX_KEY_MAP = {
+  526: '1plusX',
+  527: '1plusX',
+  541: 'captify_segments',
+  540: 'perid'
+};
+const ORTB_SEG_PATHS = ['user.data'].concat(
+  CLIENT_SECTIONS.map((prefix) => `${prefix}.content.data`)
+);
+
+/**
+ * Converts an object of arrays (either strings or numbers) into an array of objects containing key and value properties
+ * normally read from bidder params
+ * eg { foo: ['bar', 'baz'], fizz: ['buzz'] }
+ * becomes [{ key: 'foo', value: ['bar', 'baz']}, {key: 'fizz', value: ['buzz']}]
+ * @param {Object} keywords object of arrays representing keyvalue pairs
+ * @param {string} paramName name of parent object (eg 'keywords') containing keyword data, used in error handling
+ * @returns {Array<{key, value}>}
+ */
+export function transformBidderParamKeywords(keywords, paramName = 'keywords') {
+  const arrs = [];
+
+  _each(keywords, (v, k) => {
+    if (isArray(v)) {
+      let values = [];
+      _each(v, (val) => {
+        val = getValueString(paramName + '.' + k, val);
+        if (val || val === '') {
+          values.push(val);
+        }
+      });
+      v = values;
+    } else {
+      v = getValueString(paramName + '.' + k, v);
+      if (isStr(v)) {
+        v = [v];
+      } else {
+        return;
+      } // unsuported types - don't send a key
+    }
+    v = v.filter(kw => kw !== '')
+    const entry = {key: k}
+    if (v.length > 0) {
+      entry.value = v;
+    }
+    arrs.push(entry);
+  });
+
+  return arrs;
+}
+
+// converts a comma separated list of keywords into the standard keyword object format used in appnexus bid params
+// 'genre=rock,genre=pop,pets=dog,music' goes to { 'genre': ['rock', 'pop'], 'pets': ['dog'], 'music': [''] }
+export function convertKeywordStringToANMap(keyStr) {
+  if (isStr(keyStr) && keyStr !== '') {
+    // will split based on commas and will eat white space before/after the comma
+    return convertKeywordsToANMap(keyStr.split(/\s*(?:,)\s*/));
+  } else {
+    return {}
+  }
+}
+
+/**
+ * @param {Array<String>} kwarray: keywords as an array of strings
+ * @return {{}} appnexus-style keyword map
+ */
+function convertKeywordsToANMap(kwarray) {
+  const result = {};
+  kwarray.forEach(kw => {
+    // if = exists, then split
+    if (kw.indexOf('=') !== -1) {
+      let kwPair = kw.split('=');
+      let key = kwPair[0];
+      let val = kwPair[1];
+
+      // then check for existing key in result > if so add value to the array > if not, add new key and create value array
+      if (result.hasOwnProperty(key)) {
+        result[key].push(val);
+      } else {
+        result[key] = [val];
+      }
+    } else {
+      if (!result.hasOwnProperty(kw)) {
+        result[kw] = [];
+      }
+    }
+  })
+  return result;
+}
+
+/**
+ * @param ortb2
+ * @return {{}} appnexus-style keyword map using all keywords contained in ortb2
+ */
+export function getANMapFromOrtbKeywords(ortb2) {
+  return convertKeywordsToANMap(getAllOrtbKeywords(ortb2));
+}
+
+export function getANKewyordParamFromMaps(...anKeywordMaps) {
+  return transformBidderParamKeywords(
+    mergeDeep(...anKeywordMaps.map(kwMap => Object.fromEntries(
+      Object.entries(kwMap || {})
+        .map(([k, v]) => [k, (isNumber(v) || isStr(v)) ? [v] : v])
+    )))
+  )
+}
+
+export function getANKeywordParam(ortb2, ...anKeywordsMaps) {
+  return getANKewyordParamFromMaps(
+    getANMapFromOrtbKeywords(ortb2),
+    getANMapFromOrtbSegments(ortb2),
+    ...anKeywordsMaps
+  )
+}
+
+export function getANMapFromOrtbSegments(ortb2) {
+  let ortbSegData = {};
+  ORTB_SEG_PATHS.forEach(path => {
+    let ortbSegsArrObj = deepAccess(ortb2, path) || [];
+    ortbSegsArrObj.forEach(segObj => {
+      // only read segment data from known sources
+      const segtax = ORTB_SEGTAX_KEY_MAP[deepAccess(segObj, 'ext.segtax')];
+      if (segtax) {
+        segObj.segment.forEach(seg => {
+          // if source was in multiple locations of ortb or had multiple segments in same area, stack them together into an array
+          if (ortbSegData[segtax]) {
+            ortbSegData[segtax].push(seg.id);
+          } else {
+            ortbSegData[segtax] = [seg.id]
+          }
+        });
+      }
+    });
+  });
+  return ortbSegData;
+}

package/libraries/categoryTranslationMapping/index.js

@@ -0,0 +1,100 @@
+/**
+ * Provides mapping objects used by bidders for categoryTranslation type logic for Adpod feature
+ */
+export const APPNEXUS_CATEGORY_MAPPING = {
+  '1': 'IAB20-3',
+  '2': 'IAB18-5',
+  '3': 'IAB10-1',
+  '4': 'IAB2-3',
+  '5': 'IAB19-8',
+  '6': 'IAB22-1',
+  '7': 'IAB18-1',
+  '8': 'IAB12-3',
+  '9': 'IAB5-1',
+  '10': 'IAB4-5',
+  '11': 'IAB13-4',
+  '12': 'IAB8-7',
+  '13': 'IAB9-7',
+  '14': 'IAB7-1',
+  '15': 'IAB20-18',
+  '16': 'IAB10-7',
+  '17': 'IAB19-18',
+  '18': 'IAB13-6',
+  '19': 'IAB18-4',
+  '20': 'IAB1-5',
+  '21': 'IAB1-6',
+  '22': 'IAB3-4',
+  '23': 'IAB19-13',
+  '24': 'IAB22-2',
+  '25': 'IAB3-9',
+  '26': 'IAB17-18',
+  '27': 'IAB19-6',
+  '28': 'IAB1-7',
+  '29': 'IAB9-30',
+  '30': 'IAB20-7',
+  '31': 'IAB20-17',
+  '32': 'IAB7-32',
+  '33': 'IAB16-5',
+  '34': 'IAB19-34',
+  '35': 'IAB11-5',
+  '36': 'IAB12-3',
+  '37': 'IAB11-4',
+  '38': 'IAB12-3',
+  '39': 'IAB9-30',
+  '41': 'IAB7-44',
+  '42': 'IAB7-1',
+  '43': 'IAB7-30',
+  '50': 'IAB19-30',
+  '51': 'IAB17-12',
+  '52': 'IAB19-30',
+  '53': 'IAB3-1',
+  '55': 'IAB13-2',
+  '56': 'IAB19-30',
+  '57': 'IAB19-30',
+  '58': 'IAB7-39',
+  '59': 'IAB22-1',
+  '60': 'IAB7-39',
+  '61': 'IAB21-3',
+  '62': 'IAB5-1',
+  '63': 'IAB12-3',
+  '64': 'IAB20-18',
+  '65': 'IAB11-2',
+  '66': 'IAB17-18',
+  '67': 'IAB9-9',
+  '68': 'IAB9-5',
+  '69': 'IAB7-44',
+  '71': 'IAB22-3',
+  '73': 'IAB19-30',
+  '74': 'IAB8-5',
+  '78': 'IAB22-1',
+  '85': 'IAB12-2',
+  '86': 'IAB22-3',
+  '87': 'IAB11-3',
+  '112': 'IAB7-32',
+  '113': 'IAB7-32',
+  '114': 'IAB7-32',
+  '115': 'IAB7-32',
+  '118': 'IAB9-5',
+  '119': 'IAB9-5',
+  '120': 'IAB9-5',
+  '121': 'IAB9-5',
+  '122': 'IAB9-5',
+  '123': 'IAB9-5',
+  '124': 'IAB9-5',
+  '125': 'IAB9-5',
+  '126': 'IAB9-5',
+  '127': 'IAB22-1',
+  '132': 'IAB1-2',
+  '133': 'IAB19-30',
+  '137': 'IAB3-9',
+  '138': 'IAB19-3',
+  '140': 'IAB2-3',
+  '141': 'IAB2-1',
+  '142': 'IAB2-3',
+  '143': 'IAB17-13',
+  '166': 'IAB11-4',
+  '175': 'IAB3-1',
+  '176': 'IAB13-4',
+  '182': 'IAB8-9',
+  '183': 'IAB3-5'
+};

package/libraries/keywords/keywords.js

@@ -0,0 +1,31 @@
+import {CLIENT_SECTIONS} from '../../src/fpd/oneClient.js';
+import {deepAccess} from '../../src/utils.js';
+
+const ORTB_KEYWORDS_PATHS = ['user.keywords'].concat(
+  CLIENT_SECTIONS.flatMap((prefix) => ['keywords', 'content.keywords'].map(suffix => `${prefix}.${suffix}`))
+);
+
+/**
+ * @param commaSeparatedKeywords: any number of either keyword arrays, or comma-separated keyword strings
+ * @returns an array with all unique keywords contained across all inputs
+ */
+export function mergeKeywords(...commaSeparatedKeywords) {
+  const keywords = new Set();
+  commaSeparatedKeywords
+    .filter(kwds => kwds)
+    .flatMap(kwds => Array.isArray(kwds) ? kwds : kwds.split(','))
+    .map(kw => kw.replace(/^\s*/, '').replace(/\s*$/, ''))
+    .filter(kw => kw)
+    .forEach(kw => keywords.add(kw));
+  return Array.from(keywords.keys());
+}
+
+/**
+ * Get an array with all keywords contained in an ortb2 object.
+ */
+export function getAllOrtbKeywords(ortb2, ...extraCommaSeparatedKeywords) {
+  return mergeKeywords(
+    ...ORTB_KEYWORDS_PATHS.map(path => deepAccess(ortb2, path)),
+    ...extraCommaSeparatedKeywords
+  )
+}

package/libraries/objectGuard/objectGuard.js

@@ -1,4 +1,4 @@
-import {isData, objectTransformer} from '../../src/activities/redactor.js';
+import {isData, objectTransformer, sessionedApplies} from '../../src/activities/redactor.js';
 import {deepAccess, deepClone, deepEqual, deepSetValue} from '../../src/utils.js';
 
 /**
@@ -41,15 +41,6 @@ export function objectGuard(rules) {
 
   const wpTransformer = objectTransformer(writeRules);
 
-  function mkApplies(session, args) {
-    return function applies(rule) {
-      if (!session.hasOwnProperty(rule.name)) {
-        session[rule.name] = rule.applies(...args);
-      }
-      return session[rule.name];
-    }
-  }
-
   function mkGuard(obj, tree, applies) {
     return new Proxy(obj, {
       get(target, prop, receiver) {
@@ -76,7 +67,7 @@ export function objectGuard(rules) {
   return function guard(obj, ...args) {
     const session = {};
     return {
-      obj: mkGuard(obj, root.children || {}, mkApplies(session, args)),
+      obj: mkGuard(obj, root.children || {}, sessionedApplies(session, ...args)),
       verify: mkVerify(wpTransformer(session, obj, ...args))
     }
   };

package/libraries/ortbConverter/processors/default.js

@@ -1,4 +1,4 @@
-import {deepSetValue, mergeDeep} from '../../../src/utils.js';
+import {generateUUID, mergeDeep} from '../../../src/utils.js';
 import {bannerResponseProcessor, fillBannerImp} from './banner.js';
 import {fillVideoImp, fillVideoResponse} from './video.js';
 import {setResponseMediaType} from './mediaType.js';
@@ -21,17 +21,16 @@ export const DEFAULT_PROCESSORS = {
       fn: clientSectionChecker('ORTB request')
     },
     props: {
-      // sets request properties id, tmax, test, source.tid
+      // sets request properties id, tmax, test
       fn(ortbRequest, bidderRequest) {
         Object.assign(ortbRequest, {
-          id: ortbRequest.id || bidderRequest.auctionId,
+          id: ortbRequest.id || generateUUID(),
           test: ortbRequest.test || 0
         });
         const timeout = parseInt(bidderRequest.timeout, 10);
         if (!isNaN(timeout)) {
           ortbRequest.tmax = timeout;
         }
-        deepSetValue(ortbRequest, 'source.tid', ortbRequest.source?.tid || bidderRequest.auctionId);
       }
     }
   },

package/modules/.submodules.json

@@ -38,7 +38,7 @@
       "tapadIdSystem",
       "teadsIdSystem",
       "tncIdSystem",
-      "trustpidSystem",
+      "utiqSystem",
       "uid2IdSystem",
       "euidIdSystem",
       "unifiedIdSystem",

package/modules/1plusXRtdProvider.js

@@ -152,19 +152,15 @@ const getTargetingDataFromPapi = (papiUrl) => {
 export const buildOrtb2Updates = ({ segments = [], topics = [] }) => {
   const userData = {
     name: ORTB2_NAME,
-    segment: segments.map((segmentId) => ({ id: segmentId }))
+    segment: segments.map((segmentId) => ({ id: segmentId })),
+    ext: { segtax: segtaxes.AUDIENCE }
   };
   const siteContentData = {
     name: ORTB2_NAME,
     segment: topics.map((topicId) => ({ id: topicId })),
     ext: { segtax: segtaxes.CONTENT }
   }
-  // Currently appnexus bidAdapter doesn't support topics in `site.content.data.segment`
-  // Therefore, writing them in `site.keywords` until it's supported
-  // Other bidAdapters do fine with `site.content.data.segment`
-  const siteKeywords = topics.map(topic => `1plusX=${topic}`).join(',');
-
-  return { userData, siteContentData, siteKeywords };
+  return { userData, siteContentData };
 }
 
 /**
@@ -174,16 +170,10 @@ export const buildOrtb2Updates = ({ segments = [], topics = [] }) => {
  * @param {Object} biddersOrtb2 All current bidder configs
  */
 export const updateBidderConfig = (bidder, ortb2Updates, biddersOrtb2) => {
-  const { siteKeywords, siteContentData, userData } = ortb2Updates;
+  const { siteContentData, userData } = ortb2Updates;
   mergeDeep(biddersOrtb2, { [bidder]: {} });
   const bidderConfig = deepAccess(biddersOrtb2, bidder);
 
-  {
-    // Legacy : cf. comment on buildOrtb2Updates
-    const siteKeywordsPath = 'site.keywords';
-    deepSetValue(bidderConfig, siteKeywordsPath, siteKeywords);
-  }
-
   {
     const siteDataPath = 'site.content.data';
     const currentSiteContentData = deepAccess(bidderConfig, siteDataPath) || [];

package/modules/33acrossBidAdapter.js

@@ -1,19 +1,19 @@
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { config } from '../src/config.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {config} from '../src/config.js';
 import {
   deepAccess,
-  uniques,
-  isArray,
+  getWindowSelf,
   getWindowTop,
+  isArray,
   isGptPubadsDefined,
   isSlotMatchingAdUnitCode,
   logInfo,
   logWarn,
-  getWindowSelf,
   mergeDeep,
-  pick
+  pick,
+  uniques
 } from '../src/utils.js';
-import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 
 // **************************** UTILS *************************** //
 const BIDDER_CODE = '33across';
@@ -183,7 +183,8 @@ function buildRequests(bidRequests, bidderRequest) {
         uspConsent,
         pageUrl,
         referer,
-        ttxSettings
+        ttxSettings,
+        bidderRequest,
       })
     )
   }
@@ -246,7 +247,7 @@ function _getMRAKey(bidRequest) {
 }
 
 // Infer the necessary data from valid bid for a minimal ttxRequest and create HTTP request
-function _createServerRequest({ bidRequests, gdprConsent = {}, uspConsent, pageUrl, referer, ttxSettings }) {
+function _createServerRequest({ bidRequests, gdprConsent = {}, uspConsent, pageUrl, referer, ttxSettings, bidderRequest }) {
   const ttxRequest = {};
   const firstBidRequest = bidRequests[0];
   const { siteId, test } = firstBidRequest.params;
@@ -271,7 +272,7 @@ function _createServerRequest({ bidRequests, gdprConsent = {}, uspConsent, pageU
     ttxRequest.site.ref = referer;
   }
 
-  ttxRequest.id = firstBidRequest.auctionId;
+  ttxRequest.id = bidderRequest?.bidderRequestId;
 
   if (gdprConsent.consentString) {
     ttxRequest.user = setExtensions(ttxRequest.user, {
@@ -681,7 +682,6 @@ function _createBidResponse(bid, cur) {
     bid.adomain && bid.adomain.length;
   const bidResponse = {
     requestId: bid.impid,
-    bidderCode: BIDDER_CODE,
     cpm: bid.price,
     width: bid.w,
     height: bid.h,

package/modules/adWMGBidAdapter.js

@@ -59,11 +59,12 @@ export const spec = {
       }
 
       const request = {
+        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         auctionId: bidRequest.auctionId,
         requestId: bidRequest.bidId,
         bidRequestsCount: bidRequest.bidRequestsCount,
         bidderRequestId: bidRequest.bidderRequestId,
-        transactionId: bidRequest.transactionId,
+        transactionId: bidRequest.ortb2Imp?.ext?.tid,
         referrer: referrer,
         timeout: timeout,
         adUnit: adUnit,

package/modules/adagioBidAdapter.js

@@ -860,7 +860,7 @@ function storeRequestInAdagioNS(bidRequest) {
       bidder: bidRequest.bidder,
       params: bidRequest.params // use the updated bid.params object with auto-detected params
     }],
-    auctionId: bidRequest.auctionId,
+    auctionId: bidRequest.auctionId, // this auctionId has been generated by adagioBidAdapter
     pageviewId: internal.getPageviewId(),
     printNumber,
     localPbjs: '$$PREBID_GLOBAL$$',
@@ -869,7 +869,7 @@ function storeRequestInAdagioNS(bidRequest) {
 
   // (legacy) Store internal adUnit information
   w.ADAGIO.adUnits[bidRequest.adUnitCode] = {
-    auctionId: bidRequest.auctionId,
+    auctionId: bidRequest.auctionId, // this auctionId has been generated by adagioBidAdapter
     pageviewId: internal.getPageviewId(),
     printNumber,
   };
@@ -981,7 +981,14 @@ export const spec = {
     const syncEnabled = deepAccess(config.getConfig('userSync'), 'syncEnabled')
     const usIfr = syncEnabled && userSync.canBidderRegisterSync('iframe', 'adagio')
 
-    const adUnits = _map(validBidRequests, (bidRequest) => {
+    const aucId = generateUUID()
+
+    const adUnits = _map(validBidRequests, (rawBidRequest) => {
+      const bidRequest = {...rawBidRequest}
+
+      // Fix https://github.com/prebid/Prebid.js/issues/9781
+      bidRequest.auctionId = aucId
+
       const globalFeatures = GlobalExchange.getOrSetGlobalFeatures();
       const features = {
         ...globalFeatures,
@@ -1094,6 +1101,12 @@ export const spec = {
 
       storeRequestInAdagioNS(bidRequest);
 
+      // Remove these fields at the very end, so we can still use them before.
+      delete bidRequest.transactionId;
+      delete bidRequest.ortb2Imp;
+      delete bidRequest.ortb2;
+      delete bidRequest.sizes;
+
       return bidRequest;
     });
 
@@ -1232,33 +1245,8 @@ export const spec = {
    * @returns {object} updated params
    */
   transformBidParams(params, isOrtb, adUnit, bidRequests) {
-    const adagioBidderRequest = find(bidRequests, bidRequest => bidRequest.bidderCode === 'adagio');
-    const adagioBid = find(adagioBidderRequest.bids, bid => bid.adUnitCode === adUnit.code);
-
-    if (isOrtb) {
-      autoFillParams(adagioBid);
-
-      adagioBid.params.auctionId = deepAccess(adagioBidderRequest, 'auctionId');
-
-      const globalFeatures = GlobalExchange.getOrSetGlobalFeatures();
-      adagioBid.params.features = {
-        ...globalFeatures,
-        print_number: getPrintNumber(adagioBid.adUnitCode, adagioBidderRequest).toString(),
-        adunit_position: getSlotPosition(adagioBid.params.adUnitElementId) // adUnitElementId à déplacer ???
-      };
-
-      adagioBid.params.pageviewId = internal.getPageviewId();
-      adagioBid.params.prebidVersion = '$prebid.version$';
-      adagioBid.params.data = GlobalExchange.getExchangeData();
-
-      if (deepAccess(adagioBid, 'mediaTypes.video.context') === OUTSTREAM) {
-        adagioBid.params.playerName = setPlayerName(adagioBid);
-      }
-
-      storeRequestInAdagioNS(adagioBid);
-    }
-
-    return adagioBid.params;
+    // We do not have a prebid server adapter. So let's return unchanged params.
+    return params;
   }
 };
 

package/modules/adbookpspBidAdapter.js

@@ -203,7 +203,7 @@ function buildRegs(bidderRequest) {
 function buildSource(bidRequests, bidderRequest) {
   const source = {
     fd: 1,
-    tid: bidderRequest.auctionId,
+    tid: bidderRequest.ortb2.source.tid,
   };
   const schain = deepAccess(bidRequests, '0.schain');
 

package/modules/addefendBidAdapter.js

@@ -30,6 +30,7 @@ export const spec = {
     for (var i = 0; i < validBidRequests.length; i++) {
       let vb = validBidRequests[i];
       let o = vb.params;
+      // TODO: fix auctionId/transactionId leak: https://github.com/prebid/Prebid.js/issues/9781
       bid.auctionId = vb.auctionId;
       o.bidId = vb.bidId;
       o.transactionId = vb.transactionId;

package/modules/adfBidAdapter.js

@@ -3,7 +3,7 @@
 
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
-import {deepAccess, deepSetValue, mergeDeep, parseSizesInput, deepClone} from '../src/utils.js';
+import {deepAccess, deepClone, deepSetValue, mergeDeep, parseSizesInput} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {Renderer} from '../src/Renderer.js';
 
@@ -58,7 +58,7 @@ export const spec = {
     const adxDomain = setOnAny(validBidRequests, 'params.adxDomain') || 'adx.adform.net';
 
     const pt = setOnAny(validBidRequests, 'params.pt') || setOnAny(validBidRequests, 'params.priceType') || 'net';
-    const tid = bidderRequest.auctionId;
+    const tid = bidderRequest.ortb2?.source?.tid;
     const test = setOnAny(validBidRequests, 'params.test');
     const currency = getConfig('currency.adServerCurrency');
     const cur = currency && [ currency ];
@@ -139,7 +139,7 @@ export const spec = {
     });
 
     const request = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       site,
       app,
       user,

package/modules/adgenerationBidAdapter.js

@@ -48,7 +48,7 @@ export const spec = {
       data = tryAppendQueryString(data, 'sdktype', '0');
       data = tryAppendQueryString(data, 'hb', 'true');
       data = tryAppendQueryString(data, 't', 'json3');
-      data = tryAppendQueryString(data, 'transactionid', validReq.transactionId);
+      data = tryAppendQueryString(data, 'transactionid', validReq.ortb2Imp?.ext?.tid);
       data = tryAppendQueryString(data, 'sizes', getSizes(validReq));
       data = tryAppendQueryString(data, 'currency', getCurrencyType());
       data = tryAppendQueryString(data, 'pbver', '$prebid.version$');