prebid.js 8.0.0 → 8.2.0

package/modules/oxxionRtdProvider.js

@@ -1,10 +1,13 @@
 import { submodule } from '../src/hook.js'
-import { deepAccess, logInfo } from '../src/utils.js'
+import { deepAccess, logInfo, logError } from '../src/utils.js'
+import { ajax } from '../src/ajax.js';
+import adapterManager from '../src/adapterManager.js';
 
 const oxxionRtdSearchFor = [ 'adUnitCode', 'auctionId', 'bidder', 'bidderCode', 'bidId', 'cpm', 'creativeId', 'currency', 'width', 'height', 'mediaType', 'netRevenue', 'originalCpm', 'originalCurrency', 'requestId', 'size', 'source', 'status', 'timeToRespond', 'transactionId', 'ttl', 'sizes', 'mediaTypes', 'src', 'userId', 'labelAny', 'adId' ];
 const LOG_PREFIX = 'oxxionRtdProvider submodule: ';
 
 const allAdUnits = [];
+const bidderAliasRegistry = adapterManager.aliasRegistry || {};
 
 /** @type {RtdSubmodule} */
 export const oxxionSubmodule = {
@@ -12,23 +15,56 @@ export const oxxionSubmodule = {
   init: init,
   getBidRequestData: getAdUnits,
   onBidResponseEvent: insertVideoTracking,
+  getRequestsList: getRequestsList,
+  getFilteredAdUnitsOnBidRates: getFilteredAdUnitsOnBidRates,
 };
 
 function init(config, userConsent) {
-  if (!config.params || !config.params.domain || !config.params.contexts || !Array.isArray(config.params.contexts) || config.params.contexts.length == 0) {
-    return false
-  }
-  return true;
+  if (!config.params || !config.params.domain) { return false }
+  if (config.params.contexts && Array.isArray(config.params.contexts) && config.params.contexts.length > 0) { return true; }
+  if (typeof config.params.threshold != 'undefined' && typeof config.params.samplingRate == 'number') { return true }
+  return false;
 }
 
 function getAdUnits(reqBidsConfigObj, callback, config, userConsent) {
-  const reqAdUnits = reqBidsConfigObj.adUnits;
-  if (Array.isArray(reqAdUnits)) {
-    reqAdUnits.forEach(adunit => {
-      if (config.params.contexts.includes(deepAccess(adunit, 'mediaTypes.video.context'))) {
-        allAdUnits.push(adunit);
+  logInfo(LOG_PREFIX + 'started with ', config);
+  if (typeof config.params.threshold != 'undefined' && typeof config.params.samplingRate == 'number') {
+    let filteredBids;
+    const requests = getRequestsList(reqBidsConfigObj);
+    const gdpr = userConsent && userConsent.gdpr ? userConsent.gdpr.consentString : null;
+    const payload = {
+      gdpr,
+      requests
+    };
+    const endpoint = 'https://' + config.params.domain + '.oxxion.io/analytics/bid_rate_interests';
+    getPromisifiedAjax(endpoint, JSON.stringify(payload), {
+      method: 'POST',
+      withCredentials: true
+    }).then(bidsRateInterests => {
+      if (bidsRateInterests.length) {
+        [reqBidsConfigObj.adUnits, filteredBids] = getFilteredAdUnitsOnBidRates(bidsRateInterests, reqBidsConfigObj.adUnits, config.params, true);
       }
-    });
+      if (filteredBids.length > 0) {
+        getPromisifiedAjax('https://' + config.params.domain + '.oxxion.io/analytics/request_rejecteds', JSON.stringify({'bids': filteredBids, 'gdpr': gdpr}), {
+          method: 'POST',
+          withCredentials: true
+        });
+      }
+      if (typeof callback == 'function') { callback(); }
+    }).catch(error => logError(LOG_PREFIX, 'bidInterestError', error));
+  }
+  if (config.params.contexts && Array.isArray(config.params.contexts) && config.params.contexts.length > 0) {
+    const reqAdUnits = reqBidsConfigObj.adUnits;
+    if (Array.isArray(reqAdUnits)) {
+      reqAdUnits.forEach(adunit => {
+        if (config.params.contexts.includes(deepAccess(adunit, 'mediaTypes.video.context'))) {
+          allAdUnits.push(adunit);
+        }
+      });
+    }
+    if (!(typeof config.params.threshold != 'undefined' && typeof config.params.samplingRate == 'number') && typeof callback == 'function') {
+      callback();
+    }
   }
 }
 
@@ -94,4 +130,81 @@ function getImpUrl(config, data, maxCpm) {
   return trackingImpUrl + 'cpmIncrement=' + cpmIncrement + '&context=' + context;
 }
 
+function getPromisifiedAjax (url, data = {}, options = {}) {
+  return new Promise((resolve, reject) => {
+    const callbacks = {
+      success(responseText, { response }) {
+        resolve(JSON.parse(response));
+      },
+      error(error) {
+        reject(error);
+      }
+    };
+    ajax(url, callbacks, data, options);
+  })
+}
+
+function getFilteredAdUnitsOnBidRates (bidsRateInterests, adUnits, params, useSampling) {
+  const { threshold, samplingRate } = params;
+  const filteredBids = [];
+  // Separate bidsRateInterests in two groups against threshold & samplingRate
+  const { interestingBidsRates, uninterestingBidsRates } = bidsRateInterests.reduce((acc, interestingBid) => {
+    const isBidRateUpper = typeof threshold == 'number' ? interestingBid.rate === true || interestingBid.rate > threshold : interestingBid.suggestion;
+    const isBidInteresting = isBidRateUpper || (getRandomNumber(100) < samplingRate && useSampling);
+    const key = isBidInteresting ? 'interestingBidsRates' : 'uninterestingBidsRates';
+    acc[key].push(interestingBid);
+    return acc;
+  }, {
+    interestingBidsRates: [],
+    uninterestingBidsRates: [] // Do something with later
+  });
+  logInfo(LOG_PREFIX, 'getFilteredAdUnitsOnBidRates()', interestingBidsRates, uninterestingBidsRates);
+  // Filter bids and adUnits against interesting bids rates
+  const newAdUnits = adUnits.filter(({ bids = [] }, adUnitIndex) => {
+    adUnits[adUnitIndex].bids = bids.filter(bid => {
+      if (!params.bidders || params.bidders.includes(bid.bidder)) {
+        const index = interestingBidsRates.findIndex(({ id }) => id === bid._id);
+        if (index == -1) {
+          let tmpBid = bid;
+          tmpBid['code'] = adUnits[adUnitIndex].code;
+          tmpBid['mediaTypes'] = adUnits[adUnitIndex].mediaTypes;
+          tmpBid['originalBidder'] = bidderAliasRegistry[bid.bidder] || bid.bidder;
+          if (tmpBid.floorData) {
+            delete tmpBid.floorData;
+          }
+          filteredBids.push(tmpBid);
+        }
+        delete bid._id;
+        return index !== -1;
+      } else {
+        return true;
+      }
+    });
+    return !!adUnits[adUnitIndex].bids.length;
+  });
+  return [newAdUnits, filteredBids];
+}
+
+function getRandomNumber (max = 10) {
+  return Math.round(Math.random() * max);
+}
+
+function getRequestsList(reqBidsConfigObj) {
+  let count = 0;
+  return reqBidsConfigObj.adUnits.flatMap(({
+    bids = [],
+    mediaTypes = {},
+    code = ''
+  }) => bids.reduce((acc, { bidder = '', params = {} }, index) => {
+    const id = count++;
+    bids[index]._id = id;
+    return acc.concat({
+      id,
+      adUnit: code,
+      bidder,
+      mediaTypes,
+    });
+  }, []));
+}
+
 submodule('realTimeData', oxxionSubmodule);

package/modules/oxxionRtdProvider.md

@@ -7,12 +7,12 @@ Maintainer: tech@oxxion.io
 # Oxxion Real-Time-Data submodule
 
 Oxxion helps you to understand how your prebid stack performs.
-This Rtd module is to use in order to improve video events tracking.
+This Rtd module is to use in order to improve video events tracking and/or to filter bidder requested.
 
 # Integration
 
 Make sure to have the following modules listed while building prebid : `rtdModule,oxxionRtdProvider`
-`rtbModule` is required to activate real-time-data submodules.
+`rtdModule` is required to activate real-time-data submodules.
 For example :
 ```
 gulp build --modules=schain,priceFloors,currency,consentManagement,appnexusBidAdapter,rubiconBidAdapter,rtdModule,oxxionRtdProvider
@@ -23,7 +23,7 @@ Then add the oxxion Rtd module to your prebid configuration :
 pbjs.setConfig(
   ...
   realTimeData: {
-    auctionDelay: 200,
+    auctionDelay: 300,
     dataProviders: [
       {
           name: "oxxionRtd",
@@ -31,6 +31,8 @@ pbjs.setConfig(
           params: {
             domain: "test.endpoint",
             contexts: ["instream"],
+            threshold: false,
+            samplingRate: 10,
           }
        }
     ]
@@ -39,10 +41,23 @@ pbjs.setConfig(
 )
 ```
 
-# setConfig Parameters
+# setConfig Parameters General
 
 | Name                             | Type     | Description                                                                                                 |
 |:---------------------------------|:---------|:------------------------------------------------------------------------------------------------------------|
 | domain                           | String   | This string identifies yourself in Oxxion's systems and is provided to you by your Oxxion representative.   |
+
+# setConfig Parameters for Video Tracking
+
+| Name                             | Type     | Description                                                                                                 |
+|:---------------------------------|:---------|:------------------------------------------------------------------------------------------------------------|
 | contexts                         | Array    | Array defining which video contexts to add tracking events into. Values can be instream and/or outstream.   |
 
+# setConfig Parameters for bidder filtering
+
+| Name                             | Type       | Description                                                                                                 |
+|:---------------------------------|:-----------|:------------------------------------------------------------------------------------------------------------|
+| threshold                        | Float/Bool | False or minimum expected bid rate to call a bidder (ex: 1.0 for 1% bid rate).                              |
+| samplingRate                     | Integer    | Percentage of request not meeting the criterias to run anyway in order to check for any change.             |
+| bidders                          | Array      | Optional: If set, filtering will only be applied to bidders listed. 
+

package/modules/pubmaticBidAdapter.js

@@ -630,7 +630,7 @@ function _addJWPlayerSegmentData(imp, bid) {
   ext && ext.key_val === undefined ? ext.key_val = jwPlayerData : ext.key_val += '|' + jwPlayerData;
 }
 
-function _createImpressionObject(bid) {
+function _createImpressionObject(bid, bidderRequest) {
   var impObj = {};
   var bannerObj;
   var videoObj;
@@ -638,6 +638,7 @@ function _createImpressionObject(bid) {
   var sizes = bid.hasOwnProperty('sizes') ? bid.sizes : [];
   var mediaTypes = '';
   var format = [];
+  var isFledgeEnabled = bidderRequest?.fledgeEnabled;
 
   impObj = {
     id: bid.bidId,
@@ -708,11 +709,26 @@ function _createImpressionObject(bid) {
 
   _addFloorFromFloorModule(impObj, bid);
 
+  _addFledgeflag(impObj, bid, isFledgeEnabled)
+
   return impObj.hasOwnProperty(BANNER) ||
           impObj.hasOwnProperty(NATIVE) ||
           (FEATURES.VIDEO && impObj.hasOwnProperty(VIDEO)) ? impObj : UNDEFINED;
 }
 
+function _addFledgeflag(impObj, bid, isFledgeEnabled) {
+  if (isFledgeEnabled) {
+    impObj.ext = impObj.ext || {};
+    if (bid?.ortb2Imp?.ext?.ae !== undefined) {
+      impObj.ext.ae = bid.ortb2Imp.ext.ae;
+    }
+  } else {
+    if (impObj.ext?.ae) {
+      delete impObj.ext.ae;
+    }
+  }
+}
+
 function _addImpressionFPD(imp, bid) {
   const ortb2 = {...deepAccess(bid, 'ortb2Imp.ext.data')};
   Object.keys(ortb2).forEach(prop => {
@@ -1095,7 +1111,7 @@ export const spec = {
       if (bid.params.hasOwnProperty('acat') && isArray(bid.params.acat)) {
         allowedIabCategories = allowedIabCategories.concat(bid.params.acat);
       }
-      var impObj = _createImpressionObject(bid);
+      var impObj = _createImpressionObject(bid, bidderRequest);
       if (impObj) {
         payload.imp.push(impObj);
       }

package/modules/rtbhouseBidAdapter.js

@@ -10,6 +10,9 @@ const BIDDER_CODE = 'rtbhouse';
 const REGIONS = ['prebid-eu', 'prebid-us', 'prebid-asia'];
 const ENDPOINT_URL = 'creativecdn.com/bidder/prebid/bids';
 const FLEDGE_ENDPOINT_URL = 'creativecdn.com/bidder/prebidfledge/bids';
+const FLEDGE_SELLER_URL = 'https://fledge-ssp.creativecdn.com';
+const FLEDGE_DECISION_LOGIC_URL = 'https://fledge-ssp.creativecdn.com/component-seller-prebid.js';
+
 const DEFAULT_CURRENCY_ARR = ['USD']; // NOTE - USD is the only supported currency right now; Hardcoded for bids
 const SUPPORTED_MEDIA_TYPES = [BANNER, NATIVE];
 const TTL = 55;
@@ -94,8 +97,12 @@ export const spec = {
 
     let computedEndpointUrl = ENDPOINT_URL;
 
-    const fledgeConfig = config.getConfig('fledgeConfig');
-    if (bidderRequest.fledgeEnabled && fledgeConfig) {
+    if (bidderRequest.fledgeEnabled) {
+      const fledgeConfig = config.getConfig('fledgeConfig') || {
+        seller: FLEDGE_SELLER_URL,
+        decisionLogicUrl: FLEDGE_DECISION_LOGIC_URL,
+        sellerTimeout: 500
+      };
       mergeDeep(request, { ext: { fledge_config: fledgeConfig } });
       computedEndpointUrl = FLEDGE_ENDPOINT_URL;
     }

package/modules/rtbhouseBidAdapter.md

@@ -81,11 +81,30 @@ The following steps should be taken to setup Protected Audience for RTB House:
 module documentation.
 
     a. Make sure to enable RTB House bidder to participate in FLEDGE. If there are any other bidders to be allowed for that, add them to the **bidders** array:
-```javascript
-pbjs.setBidderConfig({
-    bidders: ["rtbhouse"],
-    config: {
-        fledgeEnabled: true
-    }
-});
-```
+    ```javascript
+    pbjs.setBidderConfig({
+        bidders: ["rtbhouse"],
+        config: {
+            fledgeEnabled: true
+        }
+    });
+    ```
+
+    b. If you as a publisher have your own [decisionLogicUrl](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#21-initiating-an-on-device-auction)
+    you may utilize it by setting up a dedicated `fledgeConfig` object:
+    ```javascript
+    pbjs.setBidderConfig({
+        bidders: ["rtbhouse"],
+        config: {
+            fledgeEnabled: true,
+            fledgeConfig: {
+                seller: 'https://seller.domain',
+                decisionLogicUrl: 'https://seller.domain/decisionLogicFile.js',
+                sellerTimeout: 100
+            }
+        }
+    });
+    ```
+    The `decisionLogicUrl` must be in the same domain as `seller` and has to respond with `X-Allow-FLEDGE: true` http header.
+
+    `sellerTimeout` is optional, defaults to 50 as per spec, will be clamped to 500 if greater.

package/modules/rubiconBidAdapter.js

@@ -383,6 +383,8 @@ export const spec = {
       'gdpr',
       'gdpr_consent',
       'us_privacy',
+      'gpp',
+      'gpp_sid',
       'rp_schain',
     ].concat(Object.keys(params).filter(item => containsUId.test(item)))
       .concat([
@@ -554,6 +556,11 @@ export const spec = {
       data['us_privacy'] = encodeURIComponent(bidderRequest.uspConsent);
     }
 
+    if (bidderRequest.gppConsent?.gppString) {
+      data['gpp'] = bidderRequest.gppConsent.gppString;
+      data['gpp_sid'] = bidderRequest.gppConsent?.applicableSections?.toString();
+    }
+
     data['rp_maxbids'] = bidderRequest.bidLimit || 1;
 
     applyFPD(bidRequest, BANNER, data);
@@ -696,7 +703,7 @@ export const spec = {
       return (adB.cpm || 0.0) - (adA.cpm || 0.0);
     });
   },
-  getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent) {
+  getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent, gppConsent) {
     if (!hasSynced && syncOptions.iframeEnabled) {
       // data is only assigned if params are available to pass to syncEndpoint
       let params = {};
@@ -714,6 +721,11 @@ export const spec = {
         params['us_privacy'] = encodeURIComponent(uspConsent);
       }
 
+      if (gppConsent?.gppString) {
+        params['gpp'] = gppConsent.gppString;
+        params['gpp_sid'] = gppConsent.applicableSections?.toString();
+      }
+
       params = Object.keys(params).length ? `?${formatQS(params)}` : '';
 
       hasSynced = true;

package/modules/sharethroughBidAdapter.js

@@ -154,6 +154,7 @@ export const sharethroughAdapterSpec = {
     }
 
     return body.seatbid[0].bid.map(bid => {
+      // Spec: https://docs.prebid.org/dev-docs/bidder-adaptor.html#interpreting-the-response
       const response = {
         requestId: bid.impid,
         width: +bid.w,
@@ -169,6 +170,19 @@ export const sharethroughAdapterSpec = {
         nurl: bid.nurl,
         meta: {
           advertiserDomains: bid.adomain || [],
+          networkId: bid.ext?.networkId || null,
+          networkName: bid.ext?.networkName || null,
+          agencyId: bid.ext?.agencyId || null,
+          agencyName: bid.ext?.agencyName || null,
+          advertiserId: bid.ext?.advertiserId || null,
+          advertiserName: bid.ext?.advertiserName || null,
+          brandId: bid.ext?.brandId || null,
+          brandName: bid.ext?.brandName || null,
+          demandSource: bid.ext?.demandSource || null,
+          dchain: bid.ext?.dchain || null,
+          primaryCatId: bid.ext?.primaryCatId || null,
+          secondaryCatIds: bid.ext?.secondaryCatIds || null,
+          mediaType: bid.ext?.mediaType || null,
         },
       };
 

package/modules/sonobiBidAdapter.js

@@ -5,7 +5,7 @@ import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
 import { userSync } from '../src/userSync.js';
 import { bidderSettings } from '../src/bidderSettings.js';
-import {getAllOrtbKeywords} from '../libraries/keywords/keywords.js';
+import { getAllOrtbKeywords } from '../libraries/keywords/keywords.js';
 const BIDDER_CODE = 'sonobi';
 const STR_ENDPOINT = 'https://apex.go.sonobi.com/trinity.json';
 const PAGEVIEW_ID = generateUUID();
@@ -39,8 +39,8 @@ export const spec = {
         return false;
       }
     } else if (deepAccess(bid, 'mediaTypes.video')) {
-      if (deepAccess(bid, 'mediaTypes.video.context') === 'outstream' && !bid.params.sizes) {
-        // bids.params.sizes is required for outstream video adUnits
+      if (deepAccess(bid, 'mediaTypes.video.context') === 'outstream' && !deepAccess(bid, 'mediaTypes.video.playerSize')) {
+        // playerSize is required for outstream video adUnits
         return false;
       }
       if (deepAccess(bid, 'mediaTypes.video.context') === 'instream' && !deepAccess(bid, 'mediaTypes.video.playerSize')) {
@@ -248,10 +248,7 @@ export const spec = {
             bidRequest,
             'renderer.options'
           ));
-          let videoSize = deepAccess(bidRequest, 'params.sizes');
-          if (Array.isArray(videoSize) && Array.isArray(videoSize[0])) { // handle case of multiple sizes
-            videoSize = videoSize[0]; // Only take the first size for outstream
-          }
+          let videoSize = deepAccess(bidRequest, 'mediaTypes.video.playerSize');
           if (videoSize) {
             bids.width = videoSize[0];
             bids.height = videoSize[1];

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'
+            }
         }]
     },