prebid.js 7.53.0 → 8.0.0

package/modules/appnexusBidAdapter.js

@@ -22,21 +22,25 @@ import {
   logError,
   logInfo,
   logMessage,
-  logWarn,
-  mergeDeep,
-  transformBidderParamKeywords
+  logWarn
 } from '../src/utils.js';
 import {Renderer} from '../src/Renderer.js';
 import {config} from '../src/config.js';
-import {getIabSubCategory, registerBidder} from '../src/adapters/bidderFactory.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {ADPOD, BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
-import {auctionManager} from '../src/auctionManager.js';
 import {find, includes} from '../src/polyfill.js';
 import {INSTREAM, OUTSTREAM} from '../src/video.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {bidderSettings} from '../src/bidderSettings.js';
 import {hasPurpose1Consent} from '../src/utils/gpdr.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
+import {APPNEXUS_CATEGORY_MAPPING} from '../libraries/categoryTranslationMapping/index.js';
+import {
+  convertKeywordStringToANMap,
+  getANKewyordParamFromMaps,
+  getANKeywordParam,
+  transformBidderParamKeywords
+} from '../libraries/appnexusKeywords/anKeywords.js';
 
 const BIDDER_CODE = 'appnexus';
 const URL = 'https://ib.adnxs.com/ut/v3/prebid';
@@ -89,7 +93,6 @@ const NATIVE_MAPPING = {
 };
 const SOURCE = 'pbjs';
 const MAX_IMPS_PER_REQUEST = 15;
-const mappingFileUrl = 'https://acdn.adnxs-simple.com/prebid/appnexus-mapping/mappings.json';
 const SCRIPT_TAG_START = '<script';
 const VIEWABILITY_URL_START = /\/\/cdn\.adnxs\.com\/v|\/\/cdn\.adnxs\-simple\.com\/v/;
 const VIEWABILITY_FILE_NAME = 'trk.js';
@@ -103,7 +106,6 @@ export const spec = {
     { code: 'appnexusAst', gvlid: 32 },
     { code: 'emxdigital', gvlid: 183 },
     { code: 'pagescience', gvlid: 32 },
-    { code: 'defymedia', gvlid: 32 },
     { code: 'gourmetads', gvlid: 32 },
     { code: 'matomy', gvlid: 32 },
     { code: 'featureforward', gvlid: 32 },
@@ -252,31 +254,12 @@ export const spec = {
       payload.app = appIdObj;
     }
 
-    function grabOrtb2Keywords(ortb2Obj) {
-      const fields = ['site.keywords', 'site.content.keywords', 'user.keywords', 'app.keywords', 'app.content.keywords'];
-      let result = [];
-
-      fields.forEach(path => {
-        let keyStr = deepAccess(ortb2Obj, path);
-        if (isStr(keyStr)) result.push(keyStr);
-      });
-      return result;
-    }
-
     // grab the ortb2 keyword data (if it exists) and convert from the comma list string format to object format
     let ortb2 = deepClone(bidderRequest && bidderRequest.ortb2);
-    let ortb2KeywordsObjList = grabOrtb2Keywords(ortb2).map(keyStr => convertStringToKeywordsObj(keyStr));
 
     let anAuctionKeywords = deepClone(config.getConfig('appnexusAuctionKeywords')) || {};
-    // need to convert the string values into array of strings, to properly merge values with other existing keys later
-    Object.keys(anAuctionKeywords).forEach(k => { if (isStr(anAuctionKeywords[k]) || isNumber(anAuctionKeywords[k])) anAuctionKeywords[k] = [anAuctionKeywords[k]] });
-    // combine all sources of keywords (converted from string comma list to object format) into one object (that combines the values for shared keys)
-    let mergedAuctionKeywords = mergeDeep({}, anAuctionKeywords, ...ortb2KeywordsObjList);
-
-    // convert to final format used by adserver
-    let auctionKeywords = transformBidderParamKeywords(mergedAuctionKeywords);
+    let auctionKeywords = getANKeywordParam(ortb2, anAuctionKeywords)
     if (auctionKeywords.length > 0) {
-      auctionKeywords.forEach(deleteValues);
       payload.keywords = auctionKeywords;
     }
 
@@ -422,24 +405,6 @@ export const spec = {
     return bids;
   },
 
-  /**
-   * @typedef {Object} mappingFileInfo
-   * @property {string} url  mapping file json url
-   * @property {number} refreshInDays prebid stores mapping data in localstorage so you can return in how many days you want to update value stored in localstorage.
-   * @property {string} localStorageKey unique key to store your mapping json in localstorage
-   */
-
-  /**
-   * Returns mapping file info. This info will be used by bidderFactory to preload mapping file and store data in local storage
-   * @returns {mappingFileInfo}
-   */
-  getMappingFileInfo: function () {
-    return {
-      url: mappingFileUrl,
-      refreshInDays: 2
-    }
-  },
-
   getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent, gppConsent) {
     function checkGppStatus(gppConsent) {
       // this is a temporary measure to supress usersync in US-based GPP regions
@@ -488,10 +453,6 @@ export const spec = {
     }, params);
 
     if (isOpenRtb) {
-      if (isPopulatedArray(params.keywords)) {
-        params.keywords.forEach(deleteValues);
-      }
-
       Object.keys(params).forEach(paramKey => {
         let convertedKey = convertCamelToUnderscore(paramKey);
         if (convertedKey !== paramKey) {
@@ -508,16 +469,6 @@ export const spec = {
   }
 };
 
-function isPopulatedArray(arr) {
-  return !!(isArray(arr) && arr.length > 0);
-}
-
-function deleteValues(keyPairObj) {
-  if (isPopulatedArray(keyPairObj.value) && keyPairObj.value[0] === '') {
-    delete keyPairObj.value;
-  }
-}
-
 function strIsAppnexusViewabilityScript(str) {
   if (!str || str === '') return false;
 
@@ -669,7 +620,7 @@ function newBid(serverBid, rtbBid, bidderRequest) {
     const videoContext = deepAccess(bidRequest, 'mediaTypes.video.context');
     switch (videoContext) {
       case ADPOD:
-        const primaryCatId = getIabSubCategory(bidRequest.bidder, rtbBid.brand_category_id);
+        const primaryCatId = (APPNEXUS_CATEGORY_MAPPING[rtbBid.brand_category_id]) ? APPNEXUS_CATEGORY_MAPPING[rtbBid.brand_category_id] : null;
         bid.meta = Object.assign({}, bid.meta, { primaryCatId });
         const dealTier = rtbBid.deal_priority;
         bid.video = {
@@ -832,24 +783,9 @@ function bidToTag(bid) {
     tag.external_imp_id = bid.params.external_imp_id;
   }
 
-  let ortb2ImpKwStr = deepAccess(bid, 'ortb2Imp.ext.data.keywords');
-  if ((isStr(ortb2ImpKwStr) && ortb2ImpKwStr !== '') || !isEmpty(bid.params.keywords)) {
-    // convert ortb2 from comma list string format to bid param object format
-    let ortb2ImpKwObj = convertStringToKeywordsObj(ortb2ImpKwStr);
-
-    let bidParamsKwObj = (isPlainObject(bid.params.keywords)) ? deepClone(bid.params.keywords) : {};
-    // need to convert the string values into an array of strings, to properly merge values with other existing keys later
-    Object.keys(bidParamsKwObj).forEach(k => { if (isStr(bidParamsKwObj[k]) || isNumber(bidParamsKwObj[k])) bidParamsKwObj[k] = [bidParamsKwObj[k]] });
-
-    // combine both sources of keywords into one merged object (that combines the values for shared keys)
-    let keywordsObj = mergeDeep({}, bidParamsKwObj, ortb2ImpKwObj);
-
-    // convert to final format used by adserver
-    let keywordsUt = transformBidderParamKeywords(keywordsObj);
-    if (keywordsUt.length > 0) {
-      keywordsUt.forEach(deleteValues);
-      tag.keywords = keywordsUt;
-    }
+  const auKeywords = getANKewyordParamFromMaps(convertKeywordStringToANMap(deepAccess(bid, 'ortb2Imp.ext.data.keywords')), bid.params?.keywords);
+  if (auKeywords.length > 0) {
+    tag.keywords = auKeywords;
   }
 
   let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
@@ -980,8 +916,7 @@ function bidToTag(bid) {
     tag['banner_frameworks'] = bid.params.frameworks;
   }
 
-  let adUnit = find(auctionManager.getAdUnits(), au => bid.transactionId === au.transactionId);
-  if (adUnit && adUnit.mediaTypes && adUnit.mediaTypes.banner) {
+  if (deepAccess(bid, `mediaTypes.${BANNER}`)) {
     tag.ad_types.push(BANNER);
   }
 
@@ -1277,37 +1212,4 @@ function convertKeywordsToString(keywords) {
   return result;
 }
 
-// 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': [''] }
-function convertStringToKeywordsObj(keyStr) {
-  let result = {};
-
-  if (isStr(keyStr) && keyStr !== '') {
-    // will split based on commas and will eat white space before/after the comma
-    let keywordList = keyStr.split(/\s*(?:,)\s*/);
-    keywordList.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 {
-        // make a key with '' value; if key already exists > don't add
-        if (!result.hasOwnProperty(kw)) {
-          result[kw] = [''];
-        }
-      }
-    });
-  }
-
-  return result;
-}
-
 registerBidder(spec);

package/modules/apstreamBidAdapter.js

@@ -421,6 +421,7 @@ function buildRequests(bidRequests, bidderRequest) {
   bidRequests = convertOrtbRequestToProprietaryNative(bidRequests);
   const data = {
     med: encodeURIComponent(window.location.href),
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     auid: bidderRequest.auctionId,
     ref: document.referrer,
     dnt: getDNT() ? 1 : 0,

package/modules/asoBidAdapter.js

@@ -300,7 +300,7 @@ function createBasePayload(bidRequest, bidderRequest) {
   const urlsInfo = getUrlsInfo(bidderRequest);
 
   const payload = {
-    id: bidRequest.auctionId + '_' + bidRequest.bidId,
+    id: bidRequest.bidId,
     at: 1,
     tmax: bidderRequest.timeout,
     site: {

package/modules/astraoneBidAdapter.js

@@ -11,7 +11,7 @@ function buildBidRequests(validBidRequests) {
     const params = validBidRequest.params;
     const bidRequest = {
       bidId: validBidRequest.bidId,
-      transactionId: validBidRequest.transactionId,
+      transactionId: validBidRequest.ortb2Imp?.ext?.tid,
       sizes: validBidRequest.sizes,
       placement: params.placement,
       placeId: params.placeId,

package/modules/audiencerunBidAdapter.js

@@ -114,8 +114,9 @@ export const spec = {
         bidId: bid.bidId,
         bidderRequestId: getBidIdParameter('bidderRequestId', bid),
         adUnitCode: getBidIdParameter('adUnitCode', bid),
+        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         auctionId: getBidIdParameter('auctionId', bid),
-        transactionId: getBidIdParameter('transactionId', bid),
+        transactionId: bid.ortb2Imp?.ext?.tid || '',
       };
     });
 

package/modules/automatadBidAdapter.js

@@ -1,7 +1,7 @@
-import { logInfo } from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js'
-import {BANNER} from '../src/mediaTypes.js'
-import {ajax} from '../src/ajax.js'
+import {logInfo} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER} from '../src/mediaTypes.js';
+import {ajax} from '../src/ajax.js';
 
 const BIDDER = 'automatad'
 
@@ -57,7 +57,7 @@ export const spec = {
 
     // params from bid request
     const openrtbRequest = {
-      id: validBidRequests[0].auctionId,
+      id: bidderRequest.bidderRequestId,
       imp: impressions,
       site: {
         id: siteId,

package/modules/beachfrontBidAdapter.js

@@ -103,7 +103,6 @@ export const spec = {
       let responseMeta = Object.assign({ mediaType: VIDEO, advertiserDomains: [] }, response.meta);
       let bidResponse = {
         requestId: bidRequest.bidId,
-        bidderCode: spec.code,
         cpm: response.bidPrice,
         width: firstSize.w,
         height: firstSize.h,

package/modules/beopBidAdapter.js

@@ -1,7 +1,18 @@
-import { deepAccess, isArray, isStr, logWarn, triggerPixel, buildUrl, logInfo, getValue, getBidIdParameter } from '../src/utils.js';
-import { getRefererInfo } from '../src/refererDetection.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { config } from '../src/config.js';
+import {
+  buildUrl,
+  deepAccess,
+  getBidIdParameter,
+  getValue,
+  isArray,
+  logInfo,
+  logWarn,
+  triggerPixel
+} from '../src/utils.js';
+import {getRefererInfo} from '../src/refererDetection.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {config} from '../src/config.js';
+import {getAllOrtbKeywords} from '../libraries/keywords/keywords.js';
+
 const BIDDER_CODE = 'beop';
 const ENDPOINT_URL = 'https://hb.beop.io/bid';
 const TCF_VENDOR_ID = 666;
@@ -43,18 +54,8 @@ export const spec = {
     const gdpr = bidderRequest.gdprConsent;
     const firstSlot = slots[0];
     const kwdsFromRequest = firstSlot.kwds;
-    let keywords = [];
-    if (kwdsFromRequest) {
-      if (isArray(kwdsFromRequest)) {
-        keywords = kwdsFromRequest;
-      } else if (isStr(kwdsFromRequest)) {
-        if (kwdsFromRequest.indexOf(',') != -1) {
-          keywords = kwdsFromRequest.split(',').map((e) => { return e.trim() });
-        } else {
-          keywords.push(kwdsFromRequest);
-        }
-      }
-    }
+    let keywords = getAllOrtbKeywords(bidderRequest.ortb2, kwdsFromRequest);
+
     const payloadObject = {
       at: new Date().toString(),
       nid: firstSlot.nid,
@@ -128,6 +129,7 @@ function buildTrackingParams(data, info, value) {
     nptnid: params.networkPartnerId,
     bid: data.bidId || data.requestId,
     sl_n: data.adUnitCode,
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     aid: data.auctionId,
     se_ca: 'bid',
     se_ac: info,
@@ -156,8 +158,9 @@ function beOpRequestSlotsMaker(bid) {
     bid: getBidIdParameter('bidId', bid),
     brid: getBidIdParameter('bidderRequestId', bid),
     name: getBidIdParameter('adUnitCode', bid),
+    // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
     aid: getBidIdParameter('auctionId', bid),
-    tid: getBidIdParameter('transactionId', bid),
+    tid: bid.ortb2Imp?.ext?.tid || '',
     brc: getBidIdParameter('bidRequestsCount', bid),
     bdrc: getBidIdParameter('bidderRequestCount', bid),
     bwc: getBidIdParameter('bidderWinsCount', bid),

package/modules/betweenBidAdapter.js

@@ -43,7 +43,8 @@ export const spec = {
         rr: getRr(),
         s: i.params && i.params.s,
         bidid: i.bidId,
-        transactionid: i.transactionId,
+        transactionid: i.ortb2Imp?.ext?.tid,
+        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         auctionid: i.auctionId
       };
 

package/modules/bizzclickBidAdapter.js

@@ -1,8 +1,9 @@
-import { logMessage, getDNT, deepSetValue, deepAccess, _map, logWarn } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import {_map, deepAccess, deepSetValue, getDNT, logMessage, logWarn} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
+
 const BIDDER_CODE = 'bizzclick';
 const ACCOUNTID_MACROS = '[account_id]';
 const URL_ENDPOINT = `https://us-e-node1.bizzclick.com/bid?rtb_seat_id=prebidjs&secret_key=${ACCOUNTID_MACROS}`;
@@ -92,7 +93,7 @@ export const spec = {
           host: location.host
         },
         source: {
-          tid: bidRequest.transactionId,
+          tid: bidRequest.ortb2Imp?.ext?.tid,
           ext: {
             schain: {}
           }
@@ -234,7 +235,9 @@ const prepareImpObject = (bidRequest) => {
 };
 const addNativeParameters = bidRequest => {
   let impObject = {
-    id: bidRequest.transactionId,
+    // TODO: top-level ID is not in ORTB native 1.2, is this intentional?
+    // (despite the name, this appears to be an ORTB native request - not an imp - object)
+    id: bidRequest.bidId,
     ver: NATIVE_VERSION,
   };
   const assets = _map(bidRequest.mediaTypes.native, (bidParams, key) => {

package/modules/bliinkBidAdapter.js

@@ -154,6 +154,7 @@ export const buildRequests = (validBidRequests, bidderRequest) => {
     return {
       sizes: bid.sizes.map((size) => ({ w: size[0], h: size[1] })),
       id: bid.params.tagId,
+      // TODO: bidId is globally unique, is it a good choice for transaction ID (vs ortb2Imp.ext.tid)?
       transactionId: bid.bidId,
       mediaTypes: Object.keys(bid.mediaTypes),
       imageUrl: deepAccess(bid, 'params.imageUrl', ''),

package/modules/bluebillywigBidAdapter.js

@@ -276,8 +276,8 @@ export const spec = {
     });
 
     const request = {
-      id: bidderRequest.auctionId,
-      source: {tid: bidderRequest.auctionId},
+      id: bidderRequest.bidderRequestId,
+      source: {tid: bidderRequest.ortb2?.source?.tid},
       tmax: BB_CONSTANTS.DEFAULT_TIMEOUT,
       imp: imps,
       test: DEV_MODE ? 1 : 0,

package/modules/braveBidAdapter.js

@@ -1,8 +1,8 @@
-import { parseUrl, isEmpty, isStr, triggerPixel } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js';
-import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { config } from '../src/config.js';
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import {isEmpty, isStr, parseUrl, triggerPixel} from '../src/utils.js';
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
+import {config} from '../src/config.js';
+import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 
 const BIDDER_CODE = 'brave';
 const DEFAULT_CUR = 'USD';
@@ -58,7 +58,8 @@ export const spec = {
         impObject.video = createVideoRequest(br);
       } else if (br.mediaTypes.native) {
         impObject.native = {
-          id: br.transactionId,
+          // TODO: `id` is not part of the ORTB native spec, is this intentional?
+          id: br.bidId,
           ver: '1.2',
           request: createNativeRequest(br)
         };
@@ -229,7 +230,8 @@ const createBannerRequest = br => {
 };
 
 const createVideoRequest = br => {
-  let videoObj = {id: br.transactionId};
+  // TODO: `id` is not part of imp.video in ORTB; is this intentional?
+  let videoObj = {id: br.bidId};
   let supportParamsList = ['mimes', 'minduration', 'maxduration', 'protocols', 'startdelay', 'skip', 'minbitrate', 'maxbitrate', 'api', 'linearity'];
 
   for (let param of supportParamsList) {

package/modules/browsiBidAdapter.js

@@ -38,7 +38,7 @@ export const spec = {
     const requests = [];
     const {refererInfo, bidderRequestId, gdprConsent, uspConsent} = bidderRequest;
     validBidRequests.forEach(bidRequest => {
-      const {bidId, adUnitCode, auctionId, transactionId, schain, params} = bidRequest;
+      const {bidId, adUnitCode, auctionId, ortb2Imp, schain, params} = bidRequest;
       const video = getVideoMediaType(bidRequest);
 
       const request = {
@@ -55,8 +55,9 @@ export const spec = {
           sizes: video.playerSize,
           video: video,
           aUCode: adUnitCode,
+          // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
           aID: auctionId,
-          tID: transactionId,
+          tID: ortb2Imp?.ext?.tid,
           schain: schain,
           params: params
         }
@@ -98,7 +99,6 @@ export const spec = {
       width: w,
       height: h,
       currency: cur,
-      bidderCode: BIDDER_CODE,
       ...extraParams
     };
     bidResponses.push(bidResponse);