prebid.js 8.1.0 → 8.3.0

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/intentIqIdSystem.js

@@ -59,7 +59,7 @@ export function readData(key) {
  * @param key
  * @param {string} value IntentIQ ID value to sintentIqIdSystem_spec.jstore
  */
-function storeData(key, value) {
+function storeData(key, value, cookieStorageEnabled = false) {
   try {
     logInfo(MODULE_NAME + ': storing data: key=' + key + ' value=' + value);
 
@@ -68,7 +68,7 @@ function storeData(key, value) {
         storage.setDataInLocalStorage(key, value);
       }
       const expiresStr = (new Date(Date.now() + (PCID_EXPIRY * (60 * 60 * 24 * 1000)))).toUTCString();
-      if (storage.cookiesAreEnabled()) {
+      if (storage.cookiesAreEnabled() && cookieStorageEnabled) {
         storage.setCookie(key, value, expiresStr, 'LAX');
       }
     }
@@ -119,6 +119,7 @@ export const intentIqIdSubmodule = {
       logError('User ID - intentIqId submodule requires a valid partner to be defined');
       return;
     }
+    const cookieStorageEnabled = typeof configParams.enableCookieStorage === 'boolean' ? configParams.enableCookieStorage : false
     if (!FIRST_PARTY_DATA_KEY.includes(configParams.partner)) { FIRST_PARTY_DATA_KEY += '_' + configParams.partner; }
     let rrttStrtTime = 0;
 
@@ -127,7 +128,7 @@ export const intentIqIdSubmodule = {
     if (!firstPartyData || !firstPartyData.pcid || firstPartyData.pcidDate) {
       const firstPartyId = generateGUID();
       firstPartyData = { 'pcid': firstPartyId, 'pcidDate': Date.now() };
-      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData));
+      storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
     }
 
     let partnerData = tryParse(readData(FIRST_PARTY_DATA_KEY));
@@ -172,8 +173,8 @@ export const intentIqIdSubmodule = {
             }
             if (shouldUpdateLs === true) {
               partnerData.date = Date.now();
-              storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData));
-              storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData));
+              storeData(FIRST_PARTY_KEY, JSON.stringify(firstPartyData), cookieStorageEnabled);
+              storeData(FIRST_PARTY_DATA_KEY, JSON.stringify(partnerData), cookieStorageEnabled);
             }
             callback(respJson.data);
           } else {

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/liveIntentIdSystem.js

@@ -14,6 +14,7 @@ import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const EVENTS_TOPIC = 'pre_lips'
 const MODULE_NAME = 'liveIntentId';
+const LI_PROVIDER_DOMAIN = 'liveintent.com';
 export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 const defaultRequestedAttributes = {'nonId': true}
 const calls = {
@@ -189,15 +190,19 @@ export const liveIntentIdSubmodule = {
       // As adapters are applied in lexicographical order, we will always
       // be overwritten by the 'proper' uid2 module if it is present.
       if (value.uid2) {
-        result.uid2 = { 'id': value.uid2 }
+        result.uid2 = { 'id': value.uid2, ext: { provider: LI_PROVIDER_DOMAIN } }
       }
 
       if (value.bidswitch) {
-        result.bidswitch = { 'id': value.bidswitch }
+        result.bidswitch = { 'id': value.bidswitch, ext: { provider: LI_PROVIDER_DOMAIN } }
       }
 
       if (value.medianet) {
-        result.medianet = { 'id': value.medianet }
+        result.medianet = { 'id': value.medianet, ext: { provider: LI_PROVIDER_DOMAIN } }
+      }
+
+      if (value.magnite) {
+        result.magnite = { 'id': value.magnite, ext: { provider: LI_PROVIDER_DOMAIN } }
       }
 
       return result

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/mediasquareBidAdapter.js

@@ -120,23 +120,17 @@ export const spec = {
           netRevenue: value['net_revenue'],
           ttl: value['ttl'],
           ad: value['ad'],
-          mediasquare: {
-            'bidder': value['bidder'],
-            'code': value['code']
-          },
+          mediasquare: {},
           meta: {
             'advertiserDomains': value['adomain']
           }
         };
-        if ('context' in value) {
-          bidResponse['mediasquare']['context'] = value['context'];
-        }
-        if ('match' in value) {
-          bidResponse['mediasquare']['match'] = value['match'];
-        }
-        if ('hasConsent' in value) {
-          bidResponse['mediasquare']['hasConsent'] = value['hasConsent'];
-        }
+        let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context', 'increment'];
+        paramsToSearchFor.forEach(param => {
+          if (param in value) {
+            bidResponse['mediasquare'][param] = value[param];
+          }
+        });
         if ('native' in value) {
           bidResponse['native'] = value['native'];
           bidResponse['mediaType'] = 'native';
@@ -180,21 +174,23 @@ export const spec = {
     }
     let params = { pbjs: '$prebid.version$', referer: encodeURIComponent(getRefererInfo().page || getRefererInfo().topmostLocation) };
     let endpoint = document.location.search.match(/msq_test=true/) ? BIDDER_URL_TEST : BIDDER_URL_PROD;
-    let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context'];
+    let paramsToSearchFor = ['bidder', 'code', 'match', 'hasConsent', 'context', 'increment'];
     if (bid.hasOwnProperty('mediasquare')) {
-      for (let i = 0; i < paramsToSearchFor.length; i++) {
-        if (bid['mediasquare'].hasOwnProperty(paramsToSearchFor[i])) {
-          params[paramsToSearchFor[i]] = bid['mediasquare'][paramsToSearchFor[i]];
+      paramsToSearchFor.forEach(param => {
+        if (bid['mediasquare'].hasOwnProperty(param)) {
+          params[param] = bid['mediasquare'][param];
         }
-      }
+      });
     };
     paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId', 'originalCpm', 'originalCurrency'];
-    for (let i = 0; i < paramsToSearchFor.length; i++) {
-      if (bid.hasOwnProperty(paramsToSearchFor[i])) {
-        params[paramsToSearchFor[i]] = bid[paramsToSearchFor[i]];
-        if (typeof params[paramsToSearchFor[i]] == 'number') { params[paramsToSearchFor[i]] = params[paramsToSearchFor[i]].toString() }
+    paramsToSearchFor.forEach(param => {
+      if (bid.hasOwnProperty(param)) {
+        params[param] = bid[param];
+        if (typeof params[param] == 'number') {
+          params[param] = params[param].toString();
+        }
       }
-    }
+    });
     ajax(endpoint + BIDDER_ENDPOINT_WINNING, null, JSON.stringify(params), {method: 'POST', withCredentials: true});
     return true;
   }

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/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}`
       });
     }