prebid.js 8.2.0 → 8.3.0

package/modules/beopBidAdapter.md

@@ -9,13 +9,14 @@
 Module that connects to BeOp's demand sources
 
 # Test Parameters
+
 ```
     var adUnits = [
         {
             code: 'in-article',
             mediaTypes: {
                 banner: {
-                    sizes: [[1,1]], 
+                    sizes: [[1,1]],
                 }
             },
             bids: [
@@ -31,3 +32,36 @@ Module that connects to BeOp's demand sources
     ];
 ```
 
+# Custom Bidder data
+
+If you want to pass your first party data to BeOp, you can set your bidder `config.ortb2` object with
+
+```json
+{
+  "site": {
+    "ext": {
+      "bpsegs": ["Your", 1, "ST", "party", "data"],
+      "data": {
+        "bpsegs": ["Your", 1, "ST", "party", "data"]
+      }
+    }
+  },
+  "user": {
+    "ext": {
+      "bpsegs": ["Your", 1, "ST", "party", "data"],
+      "data": {
+        "bpsegs": ["Your", 1, "ST", "party", "data"]
+      }
+    }
+  }
+}
+```
+
+You can choose the location between:
+
+- `site.ext`
+- `site.ext.data`
+- `user.ext`
+- `user.ext.data`
+
+and our BidAdapter will be able to find them

package/modules/cadentApertureMXBidAdapter.md

@@ -3,14 +3,14 @@
 ```
 Module Name:  Cadent Aperture MX Adapter
 Module Type:  Bidder Adapter
-Maintainer: git@emxdigital.com
+Maintainer: contactaperturemx@cadent.tv
 ```
 
 # Description
 
 The Cadent Aperture MX adapter provides publishers with access to the Cadent Aperture MX SSP. The adapter is GDPR compliant. Please note that the adapter supports Banner and Video (Instream & Outstream) media types.
 
-Note: The Cadent Aperture MX adapter requires approval and implementation guidelines from the Cadent team, including existing publishers that work with Cadent. Please reach out to your account manager or prebid@emxdigital.com for more information.
+Note: The Cadent Aperture MX adapter requires approval and implementation guidelines from the Cadent team, including existing publishers that work with Cadent. Please reach out to your account manager or contactaperturemx@cadent.tv for more information.
 
 The bidder code should be ```cadent_aperture_mx```
 The params used by the bidder are :

package/modules/discoveryBidAdapter.js

@@ -258,7 +258,7 @@ function getItems(validBidRequests, bidderRequest) {
           format: sizes,
         },
         ext: {},
-        tagid: globals['tagid'],
+        tagid: req.params && req.params.tagid
       };
     }
     itemMaps[id] = {

package/modules/holidBidAdapter.js

@@ -1,4 +1,11 @@
-import {deepAccess, getBidIdParameter, isStr, logMessage, triggerPixel, } from '../src/utils.js';
+import {
+  deepAccess,
+  deepSetValue,
+  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';
@@ -10,6 +17,7 @@ const GVLID = 1177
 const ENDPOINT = 'https://helloworld.holid.io/openrtb2/auction'
 const COOKIE_SYNC_ENDPOINT = 'https://null.holid.io/sync.html'
 const TIME_TO_LIVE = 300
+const TMAX = 500
 let wurlMap = {}
 
 events.on(CONSTANTS.EVENTS.BID_WON, bidWonHandler)
@@ -23,12 +31,19 @@ export const spec = {
     return !!bid.params.adUnitID
   },
 
-  buildRequests: function (validBidRequests, _bidderRequest) {
+  buildRequests: function (validBidRequests, bidderRequest) {
     return validBidRequests.map((bid) => {
       const requestData = {
         ...bid.ortb2,
-        id: _bidderRequest.bidderRequestId,
+        source: {schain: bid.schain},
+        id: bidderRequest.bidderRequestId,
         imp: [getImp(bid)],
+        tmax: TMAX,
+        ...buildStoredRequest(bid)
+      }
+
+      if (bid.userIdAsEids) {
+        deepSetValue(requestData, 'user.ext.eids', bid.userIdAsEids)
       }
 
       return {
@@ -50,8 +65,6 @@ 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 = {
           requestId,
@@ -65,7 +78,7 @@ export const spec = {
           ttl: TIME_TO_LIVE,
         }
 
-        addWurl({ auctionId, requestId, wurl })
+        addWurl(requestId, wurl)
 
         bidResponses.push(bidResponse)
       })
@@ -75,11 +88,15 @@ export const spec = {
   },
 
   getUserSyncs(optionsType, serverResponse, gdprConsent, uspConsent) {
+    const syncs = [{
+      type: 'image',
+      url: 'https://track.adform.net/Serving/TrackPoint/?pm=2992097&lid=132720821'
+    }]
+
     if (!serverResponse || serverResponse.length === 0) {
-      return []
+      return syncs
     }
 
-    const syncs = []
     const bidders = getBidders(serverResponse)
 
     if (optionsType.iframeEnabled && bidders) {
@@ -100,24 +117,14 @@ export const spec = {
         type: 'iframe',
         url: COOKIE_SYNC_ENDPOINT + strQueryParams + '&type=iframe',
       })
-
-      return syncs
     }
 
-    return []
+    return syncs
   },
 }
 
 function getImp(bid) {
-  const imp = {
-    ext: {
-      prebid: {
-        storedrequest: {
-          id: getBidIdParameter('adUnitID', bid.params),
-        },
-      },
-    },
-  }
+  const imp = buildStoredRequest(bid)
   const sizes =
     bid.sizes && !Array.isArray(bid.sizes[0]) ? [bid.sizes] : bid.sizes
 
@@ -132,6 +139,18 @@ function getImp(bid) {
   return imp
 }
 
+function buildStoredRequest(bid) {
+  return {
+    ext: {
+      prebid: {
+        storedrequest: {
+          id: getBidIdParameter('adUnitID', bid.params),
+        },
+      },
+    },
+  }
+}
+
 function getBidders(serverResponse) {
   const bidders = serverResponse
     .map((res) => Object.keys(res.body.ext.responsetimemillis || []))
@@ -142,28 +161,28 @@ function getBidders(serverResponse) {
   }
 }
 
-function addWurl(auctionId, adId, wurl) {
-  if ([auctionId, adId].every(isStr)) {
-    wurlMap[`${auctionId}${adId}`] = wurl
+function addWurl(requestId, wurl) {
+  if (isStr(requestId)) {
+    wurlMap[requestId] = wurl
   }
 }
 
-function removeWurl(auctionId, adId) {
-  delete wurlMap[`${auctionId}${adId}`]
+function removeWurl(requestId) {
+  delete wurlMap[requestId]
 }
 
-function getWurl(auctionId, adId) {
-  if ([auctionId, adId].every(isStr)) {
-    return wurlMap[`${auctionId}${adId}`]
+function getWurl(requestId) {
+  if (isStr(requestId)) {
+    return wurlMap[requestId]
   }
 }
 
 function bidWonHandler(bid) {
-  const wurl = getWurl(bid.auctionId, bid.adId)
+  const wurl = getWurl(bid.requestId)
   if (wurl) {
     logMessage(`Invoking image pixel for wurl on BID_WIN: "${wurl}"`)
     triggerPixel(wurl)
-    removeWurl(bid.auctionId, bid.adId)
+    removeWurl(bid.requestId)
   }
 }
 

package/modules/ixBidAdapter.js

@@ -76,7 +76,8 @@ const SOURCE_RTI_MAPPING = {
   'audigent.com': '', // Hadron ID from Audigent, hadronId
   'pubcid.org': '', // SharedID, pubcid
   'utiq.com': '', // Utiq
-  'intimatemerger.com': ''
+  'intimatemerger.com': '',
+  '33across.com': ''
 };
 const PROVIDERS = [
   'britepoolid',

package/modules/livewrappedAnalyticsAdapter.js

@@ -168,7 +168,7 @@ livewrappedAnalyticsAdapter.sendEvents = function() {
     requests: sentRequests.sentRequests,
     responses: getResponses(sentRequests.gdpr, sentRequests.auctionIds),
     wins: getWins(sentRequests.gdpr, sentRequests.auctionIds),
-    timeouts: getTimeouts(sentRequests.auctionIds),
+    timeouts: getTimeouts(sentRequests.gdpr, sentRequests.auctionIds),
     bidAdUnits: getbidAdUnits(),
     rf: getAdRenderFailed(sentRequests.auctionIds),
     rcv: getAdblockerRecovered()
@@ -237,27 +237,9 @@ function getResponses(gdpr, auctionIds) {
       if (bid.readyToSend && !(bid.sendStatus & RESPONSESENT) && !bid.timeout) {
         bid.sendStatus |= RESPONSESENT;
 
-        responses.push({
-          timeStamp: auction.timeStamp,
-          adUnit: bid.adUnit,
-          adUnitId: bid.adUnitId,
-          bidder: bid.bidder,
-          width: bid.width,
-          height: bid.height,
-          cpm: bid.cpm,
-          orgCpm: bid.originalCpm,
-          ttr: bid.ttr,
-          IsBid: bid.isBid,
-          mediaType: bid.mediaType,
-          gdpr: gdprPos,
-          floor: bid.lwFloor ? bid.lwFloor : (bid.floorData ? bid.floorData.floorValue : undefined),
-          floorCur: bid.floorData ? bid.floorData.floorCurrency : undefined,
-          auctionId: auctionIdPos,
-          auc: bid.auc,
-          buc: bid.buc,
-          lw: bid.lw,
-          meta: bid.meta
-        });
+        let response = getResponseObject(auction, bid, gdprPos, auctionIdPos);
+
+        responses.push(response);
       }
     });
   });
@@ -337,27 +319,45 @@ function getAuctionIdPos(auctionIds, auctionId) {
   return auctionIdPos;
 }
 
-function getTimeouts(auctionIds) {
+function getResponseObject(auction, bid, gdprPos, auctionIdPos) {
+  return {
+    timeStamp: auction.timeStamp,
+    adUnit: bid.adUnit,
+    adUnitId: bid.adUnitId,
+    bidder: bid.bidder,
+    width: bid.width,
+    height: bid.height,
+    cpm: bid.cpm,
+    orgCpm: bid.originalCpm,
+    ttr: bid.ttr,
+    IsBid: bid.isBid,
+    mediaType: bid.mediaType,
+    gdpr: gdprPos,
+    floor: bid.lwFloor ? bid.lwFloor : (bid.floorData ? bid.floorData.floorValue : undefined),
+    floorCur: bid.floorData ? bid.floorData.floorCurrency : undefined,
+    auctionId: auctionIdPos,
+    auc: bid.auc,
+    buc: bid.buc,
+    lw: bid.lw,
+    meta: bid.meta
+  };
+}
+
+function getTimeouts(gdpr, auctionIds) {
   var timeouts = [];
 
   Object.keys(cache.auctions).forEach(auctionId => {
     let auctionIdPos = getAuctionIdPos(auctionIds, auctionId);
     Object.keys(cache.auctions[auctionId].bids).forEach(bidId => {
       let auction = cache.auctions[auctionId];
+      let gdprPos = getGdprPos(gdpr, auction);
       let bid = auction.bids[bidId];
       if (!(bid.sendStatus & TIMEOUTSENT) && bid.timeout) {
         bid.sendStatus |= TIMEOUTSENT;
 
-        timeouts.push({
-          bidder: bid.bidder,
-          adUnit: bid.adUnit,
-          adUnitId: bid.adUnitId,
-          timeStamp: auction.timeStamp,
-          auctionId: auctionIdPos,
-          auc: bid.auc,
-          buc: bid.buc,
-          lw: bid.lw
-        });
+        let timeout = getResponseObject(auction, bid, gdprPos, auctionIdPos);
+
+        timeouts.push(timeout);
       }
     });
   });

package/modules/mediagoBidAdapter.js

@@ -242,6 +242,7 @@ function getItems(validBidRequests, bidderRequest) {
         ext: {
           //   gpid: gpid, // 加入后无法返回广告
         },
+        tagid: req.params && req.params.tagid,
       };
       itemMaps[id] = {
         req,

package/modules/smartyadsBidAdapter.js

@@ -66,6 +66,9 @@ export const spec = {
       if (bidderRequest.gdprConsent) {
         request.gdpr = bidderRequest.gdprConsent
       }
+      if (bidderRequest.gppConsent) {
+        request.gpp = bidderRequest.gppConsent;
+      }
     }
     const len = validBidRequests.length;
 
@@ -102,19 +105,19 @@ export const spec = {
     return response;
   },
 
-  getUserSyncs: (syncOptions, serverResponses = [], gdprConsent = {}, uspConsent = '') => {
+  getUserSyncs: (syncOptions, serverResponses = [], gdprConsent = {}, uspConsent = '', gppConsent = '') => {
     let syncs = [];
     let { gdprApplies, consentString = '' } = gdprConsent;
 
     if (syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: `${URL_SYNC}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${consentString}&type=iframe&us_privacy=${uspConsent}`
+        url: `${URL_SYNC}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${consentString}&type=iframe&us_privacy=${uspConsent}&gpp=${gppConsent}`
       });
     } else {
       syncs.push({
         type: 'image',
-        url: `${URL_SYNC}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${consentString}&type=image&us_privacy=${uspConsent}`
+        url: `${URL_SYNC}&gdpr=${gdprApplies ? 1 : 0}&gdpr_consent=${consentString}&type=image&us_privacy=${uspConsent}&gpp=${gppConsent}`
       });
     }
 

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)
+  },
 }