prebid.js 7.53.0 → 8.0.0

package/modules/gridBidAdapter.js

@@ -6,8 +6,6 @@ import {
   generateUUID,
   mergeDeep,
   logWarn,
-  parseUrl,
-  isArray,
   isNumber,
   isStr
 } from '../src/utils.js';
@@ -16,25 +14,16 @@ import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 import { getStorageManager } from '../src/storageManager.js';
-import { find } from '../src/polyfill.js';
 
 const BIDDER_CODE = 'grid';
 const ENDPOINT_URL = 'https://grid.bidswitch.net/hbjson';
 
-const ADAPTER_VERSION_FOR_CRITEO_MODE = 34;
-const CDB_ENDPOINT = 'https://bidder.criteo.com/cdb';
-const PROFILE_ID_INLINE = 207;
-const SID_COOKIE_NAME = 'cto_sid';
-const IDCPY_COOKIE_NAME = 'cto_idcpy';
-const OPTOUT_COOKIE_NAME = 'cto_optout';
-const BUNDLE_COOKIE_NAME = 'cto_bundle';
-
 const SYNC_URL = 'https://x.bidswitch.net/sync?ssp=themediagrid';
 const TIME_TO_LIVE = 360;
 const USER_ID_KEY = 'tmguid';
 const GVLID = 686;
 const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
-export const storage = getStorageManager({bidderCode: BIDDER_CODE});
+export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
 
 const LOG_ERROR_MESS = {
   noAuid: 'Bid from response has no auid parameter - ',
@@ -98,33 +87,24 @@ export const spec = {
     let userExt = null;
     let endpoint = null;
     let forceBidderName = false;
-    let {bidderRequestId, auctionId, gdprConsent, uspConsent, timeout, refererInfo, gppConsent} = bidderRequest || {};
+    let {bidderRequestId, gdprConsent, uspConsent, timeout, refererInfo, gppConsent} = bidderRequest || {};
 
     const referer = refererInfo ? encodeURIComponent(refererInfo.page) : '';
     const tmax = timeout;
     const imp = [];
     const bidsMap = {};
     const requests = [];
-    const criteoBidsMap = {};
-    const criteoBidRequests = [];
     const sources = [];
     const bidsArray = [];
 
     validBidRequests.forEach((bid) => {
       const bidObject = { bid, savedPrebidBid: null };
-      if (bid.params.withCriteo && criteoSpec.isBidRequestValid(bid)) {
-        criteoBidsMap[bid.bidId] = bidObject;
-        criteoBidRequests.push(bid);
-      }
       if (!bid.params.uid && !bid.params.secid) {
         return;
       }
       if (!bidderRequestId) {
         bidderRequestId = bid.bidderRequestId;
       }
-      if (!auctionId) {
-        auctionId = bid.auctionId;
-      }
       if (!schain) {
         schain = bid.schain;
       }
@@ -196,7 +176,7 @@ export const spec = {
       if (impObj.banner || impObj.video) {
         if (multiRequest) {
           const reqSource = {
-            tid: bid.auctionId && bid.auctionId.toString(),
+            tid: bidderRequest?.ortb2?.source?.tid?.toString?.(),
             ext: {
               wrapper: 'Prebid_js',
               wrapper_version: '$prebid.version$'
@@ -247,7 +227,7 @@ export const spec = {
     }
 
     const reqSource = {
-      tid: auctionId && auctionId.toString(),
+      tid: bidderRequest?.ortb2?.source?.tid?.toString?.(),
       ext: {
         wrapper: 'Prebid_js',
         wrapper_version: '$prebid.version$'
@@ -405,11 +385,6 @@ export const spec = {
       }
     });
 
-    const criteoRequest = criteoBidRequests.length && criteoSpec.buildRequests(criteoBidRequests, bidderRequest);
-    if (criteoRequest) {
-      criteoRequest.criteoBidsMap = criteoBidsMap;
-    }
-
     return [...requests.map((req, i) => {
       let sp;
       const url = (endpoint || ENDPOINT_URL).replace(/[?&]sp=([^?&=]+)/, (i, found) => {
@@ -431,7 +406,7 @@ export const spec = {
       url: endpoint || ENDPOINT_URL,
       data: JSON.stringify(mainRequest),
       bidsMap
-    }] : []), ...(criteoRequest ? [criteoRequest] : [])];
+    }] : [])];
   },
   /**
    * Unpack the response from the server into a list of bids.
@@ -441,34 +416,26 @@ export const spec = {
    * @param {*} RendererConst
    * @return {Bid[]} An array of bids which were nested inside the server.
    */
-  interpretResponse: function(serverResponse, bidRequest, RendererConst = Renderer) {
-    if (bidRequest.criteoBidsMap && bidRequest.bidRequests) {
-      const criteoBids = criteoSpec.interpretResponse(serverResponse, bidRequest);
-      return criteoBids.filter((bid) => {
-        const { savedPrebidBid } = bidRequest.criteoBidsMap[bid.requestId] || {};
-        return canPublishResponse(bid.cpm, savedPrebidBid && savedPrebidBid.cpm);
-      });
-    } else {
-      serverResponse = serverResponse && serverResponse.body;
-      const bidResponses = [];
+  interpretResponse: function (serverResponse, bidRequest, RendererConst = Renderer) {
+    serverResponse = serverResponse && serverResponse.body;
+    const bidResponses = [];
 
-      let errorMessage;
+    let errorMessage;
 
-      if (!serverResponse) errorMessage = LOG_ERROR_MESS.emptyResponse;
-      else if (serverResponse.seatbid && !serverResponse.seatbid.length) {
-        errorMessage = LOG_ERROR_MESS.hasEmptySeatbidArray;
-      }
+    if (!serverResponse) errorMessage = LOG_ERROR_MESS.emptyResponse;
+    else if (serverResponse.seatbid && !serverResponse.seatbid.length) {
+      errorMessage = LOG_ERROR_MESS.hasEmptySeatbidArray;
+    }
 
-      const bidderCode = this.forceBidderName || this.code;
+    const bidderCode = this.forceBidderName || this.code;
 
-      if (!errorMessage && serverResponse.seatbid) {
-        serverResponse.seatbid.forEach(respItem => {
-          _addBidResponse(_getBidFromResponse(respItem), bidRequest, bidResponses, RendererConst, bidderCode);
-        });
-      }
-      if (errorMessage) logError(errorMessage);
-      return bidResponses;
+    if (!errorMessage && serverResponse.seatbid) {
+      serverResponse.seatbid.forEach(respItem => {
+        _addBidResponse(_getBidFromResponse(respItem), bidRequest, bidResponses, RendererConst, bidderCode);
+      });
     }
+    if (errorMessage) logError(errorMessage);
+    return bidResponses;
   },
   getUserSyncs: function (...args) {
     const [syncOptions,, gdprConsent, uspConsent] = args;
@@ -746,372 +713,4 @@ export function getSyncUrl() {
   return SYNC_URL;
 }
 
-// ================ Criteo methods ==================
-
-const criteoSpec = {
-  /** f
-   * @param {object} bid
-   * @return {boolean}
-   */
-  isBidRequestValid: (bid) => {
-    // either one of zoneId or networkId should be set
-    if (!(bid && bid.params && (bid.params.zoneId || bid.params.networkId))) {
-      return false;
-    }
-
-    // video media types requires some mandatory params
-    if (hasVideoMediaType(bid)) {
-      if (!hasValidVideoMediaType(bid)) {
-        return false;
-      }
-    }
-
-    return true;
-  },
-
-  /**
-   * @param {BidRequest[]} bidRequests
-   * @param {*} bidderRequest
-   * @return {ServerRequest}
-   */
-  buildRequests: (bidRequests, bidderRequest) => {
-    let url;
-    let data;
-    let fpd = bidderRequest.ortb2 || {};
-
-    Object.assign(bidderRequest, {
-      publisherExt: fpd.site?.ext,
-      userExt: fpd.user?.ext,
-      ceh: config.getConfig('criteo.ceh'),
-      coppa: config.getConfig('coppa')
-    });
-
-    const context = buildContext(bidRequests, bidderRequest);
-    url = buildCdbUrl(context);
-    data = buildCdbRequest(context, bidRequests, bidderRequest);
-
-    if (data) {
-      return { method: 'POST', url, data, bidRequests };
-    }
-  },
-
-  /**
-   * @param {*} response
-   * @param {ServerRequest} request
-   * @return {Bid[]}
-   */
-  interpretResponse: (response, request) => {
-    const body = response.body || response;
-    const bids = [];
-
-    if (body && body.slots && isArray(body.slots)) {
-      body.slots.forEach(slot => {
-        const bidRequest = find(request.bidRequests, b => b.adUnitCode === slot.impid && (!b.params.zoneId || parseInt(b.params.zoneId) === slot.zoneid));
-        const bidId = bidRequest.bidId;
-        const bid = {
-          requestId: bidId,
-          cpm: slot.cpm,
-          currency: slot.currency,
-          netRevenue: true,
-          ttl: slot.ttl || 60,
-          creativeId: slot.creativecode,
-          width: slot.width,
-          height: slot.height,
-          dealId: slot.dealCode,
-        };
-        if (body.ext?.paf?.transmission && slot.ext?.paf?.content_id) {
-          const pafResponseMeta = {
-            content_id: slot.ext.paf.content_id,
-            transmission: response.ext.paf.transmission
-          };
-          bid.meta = Object.assign({}, bid.meta, { paf: pafResponseMeta });
-        }
-        if (slot.adomain) {
-          bid.meta = Object.assign({}, bid.meta, { advertiserDomains: slot.adomain });
-        }
-        if (slot.video) {
-          bid.vastUrl = slot.displayurl;
-          bid.mediaType = VIDEO;
-        } else {
-          bid.ad = slot.creative;
-        }
-        bids.push(bid);
-      });
-    }
-
-    return bids;
-  }
-};
-
-function readFromAllStorages(name) {
-  const fromCookie = storage.getCookie(name);
-  const fromLocalStorage = storage.getDataFromLocalStorage(name);
-
-  return fromCookie || fromLocalStorage || undefined;
-}
-
-/**
- * @param {BidRequest[]} bidRequests
- * @param bidderRequest
- */
-function buildContext(bidRequests, bidderRequest) {
-  let referrer = '';
-  if (bidderRequest && bidderRequest.refererInfo) {
-    referrer = bidderRequest.refererInfo.page;
-  }
-  const queryString = parseUrl(bidderRequest?.refererInfo?.topmostLocation).search;
-
-  const context = {
-    url: referrer,
-    debug: queryString['pbt_debug'] === '1',
-    noLog: queryString['pbt_nolog'] === '1',
-    amp: false,
-  };
-
-  bidRequests.forEach(bidRequest => {
-    if (bidRequest.params.integrationMode === 'amp') {
-      context.amp = true;
-    }
-  });
-
-  return context;
-}
-
-/**
- * @param {CriteoContext} context
- * @return {string}
- */
-function buildCdbUrl(context) {
-  let url = CDB_ENDPOINT;
-  url += '?profileId=' + PROFILE_ID_INLINE;
-  url += '&av=' + String(ADAPTER_VERSION_FOR_CRITEO_MODE);
-  url += '&wv=' + encodeURIComponent('$prebid.version$');
-  url += '&cb=' + String(Math.floor(Math.random() * 99999999999));
-
-  if (storage.localStorageIsEnabled()) {
-    url += '&lsavail=1';
-  } else {
-    url += '&lsavail=0';
-  }
-
-  if (context.amp) {
-    url += '&im=1';
-  }
-  if (context.debug) {
-    url += '&debug=1';
-  }
-  if (context.noLog) {
-    url += '&nolog=1';
-  }
-
-  const bundle = readFromAllStorages(BUNDLE_COOKIE_NAME);
-  if (bundle) {
-    url += `&bundle=${bundle}`;
-  }
-
-  const optout = readFromAllStorages(OPTOUT_COOKIE_NAME);
-  if (optout) {
-    url += `&optout=1`;
-  }
-
-  const sid = readFromAllStorages(SID_COOKIE_NAME);
-  if (sid) {
-    url += `&sid=${sid}`;
-  }
-
-  const idcpy = readFromAllStorages(IDCPY_COOKIE_NAME);
-  if (idcpy) {
-    url += `&idcpy=${idcpy}`;
-  }
-
-  return url;
-}
-
-/**
- * @param {CriteoContext} context
- * @param {BidRequest[]} bidRequests
- * @param bidderRequest
- * @return {*}
- */
-function buildCdbRequest(context, bidRequests, bidderRequest) {
-  let networkId;
-  let schain;
-  const request = {
-    publisher: {
-      url: context.url,
-      ext: bidderRequest.publisherExt,
-    },
-    regs: {
-      coppa: bidderRequest.coppa === true ? 1 : (bidderRequest.coppa === false ? 0 : undefined)
-    },
-    slots: bidRequests.map(bidRequest => {
-      networkId = bidRequest.params.networkId || networkId;
-      schain = bidRequest.schain || schain;
-      const slot = {
-        impid: bidRequest.adUnitCode,
-        transactionid: bidRequest.transactionId,
-        auctionId: bidRequest.auctionId,
-      };
-      if (bidRequest.params.zoneId) {
-        slot.zoneid = bidRequest.params.zoneId;
-      }
-      if (deepAccess(bidRequest, 'ortb2Imp.ext')) {
-        slot.ext = bidRequest.ortb2Imp.ext;
-      }
-      if (bidRequest.params.ext) {
-        slot.ext = Object.assign({}, slot.ext, bidRequest.params.ext);
-      }
-      if (bidRequest.params.publisherSubId) {
-        slot.publishersubid = bidRequest.params.publisherSubId;
-      }
-
-      if (hasBannerMediaType(bidRequest)) {
-        slot.sizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'), parseSize);
-      } else {
-        slot.sizes = [];
-      }
-
-      if (hasVideoMediaType(bidRequest)) {
-        const video = {
-          playersizes: parseSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'), parseSize),
-          mimes: bidRequest.mediaTypes.video.mimes,
-          protocols: bidRequest.mediaTypes.video.protocols,
-          maxduration: bidRequest.mediaTypes.video.maxduration,
-          api: bidRequest.mediaTypes.video.api,
-          skip: bidRequest.mediaTypes.video.skip,
-          placement: bidRequest.mediaTypes.video.placement,
-          minduration: bidRequest.mediaTypes.video.minduration,
-          playbackmethod: bidRequest.mediaTypes.video.playbackmethod,
-          startdelay: bidRequest.mediaTypes.video.startdelay
-        };
-        if ('plcmt' in bidRequest.mediaTypes.video) {
-          video.plcmt = bidRequest.mediaTypes.video.plcmt;
-        }
-        const paramsVideo = bidRequest.params.video;
-        if (paramsVideo !== undefined) {
-          video.skip = video.skip || paramsVideo.skip || 0;
-          video.placement = video.placement || paramsVideo.placement;
-          video.minduration = video.minduration || paramsVideo.minduration;
-          video.playbackmethod = video.playbackmethod || paramsVideo.playbackmethod;
-          video.startdelay = video.startdelay || paramsVideo.startdelay || 0;
-        }
-
-        slot.video = video;
-      }
-
-      enrichSlotWithFloors(slot, bidRequest);
-
-      return slot;
-    }),
-  };
-  if (networkId) {
-    request.publisher.networkid = networkId;
-  }
-  if (schain) {
-    request.source = {
-      ext: {
-        schain: schain
-      }
-    };
-  }
-  request.user = {
-    ext: bidderRequest.userExt
-  };
-  if (bidderRequest && bidderRequest.ceh) {
-    request.user.ceh = bidderRequest.ceh;
-  }
-  if (bidderRequest && bidderRequest.gdprConsent) {
-    request.gdprConsent = {};
-    if (typeof bidderRequest.gdprConsent.gdprApplies !== 'undefined') {
-      request.gdprConsent.gdprApplies = !!(bidderRequest.gdprConsent.gdprApplies);
-    }
-    request.gdprConsent.version = bidderRequest.gdprConsent.apiVersion;
-    if (typeof bidderRequest.gdprConsent.consentString !== 'undefined') {
-      request.gdprConsent.consentData = bidderRequest.gdprConsent.consentString;
-    }
-  }
-  if (bidderRequest && bidderRequest.uspConsent) {
-    request.user.uspIab = bidderRequest.uspConsent;
-  }
-  return request;
-}
-
-function parseSizes(sizes, parser = s => s) {
-  if (sizes === undefined) {
-    return [];
-  }
-  if (Array.isArray(sizes[0])) { // is there several sizes ? (ie. [[728,90],[200,300]])
-    return sizes.map(size => parser(size));
-  }
-  return [parser(sizes)]; // or a single one ? (ie. [728,90])
-}
-
-function parseSize(size) {
-  return size[0] + 'x' + size[1];
-}
-
-function hasVideoMediaType(bidRequest) {
-  return deepAccess(bidRequest, 'mediaTypes.video') !== undefined;
-}
-
-function hasBannerMediaType(bidRequest) {
-  return deepAccess(bidRequest, 'mediaTypes.banner') !== undefined;
-}
-
-function hasValidVideoMediaType(bidRequest) {
-  let isValid = true;
-
-  var requiredMediaTypesParams = ['mimes', 'playerSize', 'maxduration', 'protocols', 'api', 'skip', 'placement', 'playbackmethod'];
-
-  requiredMediaTypesParams.forEach(function (param) {
-    if (deepAccess(bidRequest, 'mediaTypes.video.' + param) === undefined && deepAccess(bidRequest, 'params.video.' + param) === undefined) {
-      isValid = false;
-      logError('TheMediaGrid Bid Adapter (withCriteo mode): mediaTypes.video.' + param + ' is required');
-    }
-  });
-
-  if (isValid) {
-    const videoPlacement = bidRequest.mediaTypes.video.placement || bidRequest.params.video.placement;
-    // We do not support long form for now, also we have to check that context & placement are consistent
-    if (bidRequest.mediaTypes.video.context === 'instream' && videoPlacement === 1) {
-      return true;
-    } else if (bidRequest.mediaTypes.video.context === 'outstream' && videoPlacement !== 1) {
-      return true;
-    }
-  }
-
-  return false;
-}
-
-function enrichSlotWithFloors(slot, bidRequest) {
-  try {
-    const slotFloors = {};
-
-    if (bidRequest.getFloor) {
-      if (bidRequest.mediaTypes?.banner) {
-        slotFloors.banner = {};
-        const bannerSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.banner.sizes'))
-        bannerSizes.forEach(bannerSize => slotFloors.banner[parseSize(bannerSize).toString()] = bidRequest.getFloor({ size: bannerSize, mediaType: BANNER }));
-      }
-
-      if (bidRequest.mediaTypes?.video) {
-        slotFloors.video = {};
-        const videoSizes = parseSizes(deepAccess(bidRequest, 'mediaTypes.video.playerSize'))
-        videoSizes.forEach(videoSize => slotFloors.video[parseSize(videoSize).toString()] = bidRequest.getFloor({ size: videoSize, mediaType: VIDEO }));
-      }
-
-      if (Object.keys(slotFloors).length > 0) {
-        if (!slot.ext) {
-          slot.ext = {}
-        }
-        Object.assign(slot.ext, {
-          floors: slotFloors
-        });
-      }
-    }
-  } catch (e) {
-    logError('Could not parse floors from Prebid: ' + e);
-  }
-}
-
 registerBidder(spec);

package/modules/gumgumBidAdapter.js

@@ -293,7 +293,6 @@ function buildRequests(validBidRequests, bidderRequest) {
       mediaTypes = {},
       params = {},
       schain,
-      transactionId,
       userId = {},
       ortb2Imp,
       adUnitCode = ''
@@ -404,7 +403,7 @@ function buildRequests(validBidRequests, bidderRequest) {
     bids.push({
       id: bidId,
       tmax: timeout,
-      tId: transactionId,
+      tId: ortb2Imp?.ext?.tid,
       pi: data.pi,
       selector: params.selector,
       sizes,

package/modules/h12mediaBidAdapter.js

@@ -41,7 +41,7 @@ export const spec = {
 
       const bidrequest = {
         bidId: bidRequest.bidId,
-        transactionId: bidRequest.transactionId,
+        transactionId: bidRequest.ortb2Imp?.ext?.tid,
         adunitId: bidRequest.adUnitCode,
         pubid: bidderParams.pubid,
         placementid: bidderParams.placementid || '',

package/modules/holidBidAdapter.js

@@ -1,15 +1,9 @@
-import {
-  deepAccess,
-  getBidIdParameter,
-  isStr,
-  logMessage,
-  triggerPixel,
-} from '../src/utils.js'
-import * as events from '../src/events.js'
-import CONSTANTS from '../src/constants.json'
-import { BANNER } from '../src/mediaTypes.js'
-
-import { registerBidder } from '../src/adapters/bidderFactory.js'
+import {deepAccess, getBidIdParameter, isStr, logMessage, triggerPixel, } from '../src/utils.js';
+import * as events from '../src/events.js';
+import CONSTANTS from '../src/constants.json';
+import {BANNER} from '../src/mediaTypes.js';
+
+import {registerBidder} from '../src/adapters/bidderFactory.js';
 
 const BIDDER_CODE = 'holid'
 const GVLID = 1177
@@ -33,7 +27,7 @@ export const spec = {
     return validBidRequests.map((bid) => {
       const requestData = {
         ...bid.ortb2,
-        id: bid.auctionId,
+        id: _bidderRequest.bidderRequestId,
         imp: [getImp(bid)],
       }
 
@@ -56,6 +50,7 @@ export const spec = {
     serverResponse.body.seatbid.map((response) => {
       response.bid.map((bid) => {
         const requestId = bidRequest.bidId
+        // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
         const auctionId = bidRequest.auctionId
         const wurl = deepAccess(bid, 'ext.prebid.events.win')
         const bidResponse = {

package/modules/hybridBidAdapter.js

@@ -25,7 +25,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: placementTypes[params.placement],
       placeId: params.placeId,
@@ -88,6 +88,7 @@ function buildBid(bidData) {
     bid.vastXml = bidData.content;
     bid.mediaType = VIDEO;
 
+    // TODO: why does this need to iterate through every ad unit?
     let adUnit = find(auctionManager.getAdUnits(), function (unit) {
       return unit.transactionId === bidData.transactionId;
     });
@@ -244,7 +245,6 @@ export const spec = {
           return item.bidId === bid.bidId;
         });
         bid.placement = rawBid.placement;
-        bid.transactionId = rawBid.transactionId;
         bid.placeId = rawBid.placeId;
         return buildBid(bid);
       });