prebid.js 7.50.0 → 7.52.0

package/modules/oxxionAnalyticsAdapter.js

@@ -0,0 +1,212 @@
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
+import adapterManager from '../src/adapterManager.js';
+import CONSTANTS from '../src/constants.json';
+import { ajax } from '../src/ajax.js';
+import { getRefererInfo } from '../src/refererDetection.js';
+
+const analyticsType = 'endpoint';
+const url = 'URL_TO_SERVER_ENDPOINT';
+
+const {
+  EVENTS: {
+    AUCTION_END,
+    BID_WON,
+    BID_RESPONSE,
+    BID_REQUESTED,
+    BID_TIMEOUT,
+  }
+} = CONSTANTS;
+
+let saveEvents = {}
+let allEvents = {}
+let auctionEnd = {}
+let initOptions = {}
+let endpoint = 'https://default'
+let requestsAttributes = ['adUnitCode', 'auctionId', 'bidder', 'bidderCode', 'bidId', 'cpm', 'creativeId', 'currency', 'width', 'height', 'mediaType', 'netRevenue', 'originalCpm', 'originalCurrency', 'requestId', 'size', 'source', 'status', 'timeToRespond', 'transactionId', 'ttl', 'sizes', 'mediaTypes', 'src', 'params', 'userId', 'labelAny', 'bids', 'adId'];
+
+function getAdapterNameForAlias(aliasName) {
+  return adapterManager.aliasRegistry[aliasName] || aliasName;
+}
+
+function filterAttributes(arg, removead) {
+  let response = {};
+  if (typeof arg == 'object') {
+    if (typeof arg['bidderCode'] == 'string') {
+      response['originalBidder'] = getAdapterNameForAlias(arg['bidderCode']);
+    } else if (typeof arg['bidder'] == 'string') {
+      response['originalBidder'] = getAdapterNameForAlias(arg['bidder']);
+    }
+    if (!removead && typeof arg['ad'] != 'undefined') {
+      response['ad'] = arg['ad'];
+    }
+    if (typeof arg['gdprConsent'] != 'undefined') {
+      response['gdprConsent'] = {};
+      if (typeof arg['gdprConsent']['consentString'] != 'undefined') { response['gdprConsent']['consentString'] = arg['gdprConsent']['consentString']; }
+    }
+    if (typeof arg['meta'] == 'object' && typeof arg['meta']['advertiserDomains'] != 'undefined') {
+      response['meta'] = {'advertiserDomains': arg['meta']['advertiserDomains']};
+    }
+    requestsAttributes.forEach((attr) => {
+      if (typeof arg[attr] != 'undefined') { response[attr] = arg[attr]; }
+    });
+    if (typeof response['creativeId'] == 'number') { response['creativeId'] = response['creativeId'].toString(); }
+  }
+  return response;
+}
+
+function cleanAuctionEnd(args) {
+  let response = {};
+  let filteredObj;
+  let objects = ['bidderRequests', 'bidsReceived', 'noBids', 'adUnits'];
+  objects.forEach((attr) => {
+    if (Array.isArray(args[attr])) {
+      response[attr] = [];
+      args[attr].forEach((obj) => {
+        filteredObj = filterAttributes(obj, true);
+        if (typeof obj['bids'] == 'object') {
+          filteredObj['bids'] = [];
+          obj['bids'].forEach((bid) => {
+            filteredObj['bids'].push(filterAttributes(bid, true));
+          });
+        }
+        response[attr].push(filteredObj);
+      });
+    }
+  });
+  return response;
+}
+
+function cleanCreatives(args) {
+  return filterAttributes(args, false);
+}
+
+function enhanceMediaType(arg) {
+  saveEvents['bidRequested'].forEach((bidRequested) => {
+    if (bidRequested['auctionId'] == arg['auctionId'] && Array.isArray(bidRequested['bids'])) {
+      bidRequested['bids'].forEach((bid) => {
+        if (bid['transactionId'] == arg['transactionId'] && bid['bidId'] == arg['requestId']) { arg['mediaTypes'] = bid['mediaTypes']; }
+      });
+    }
+  });
+  return arg;
+}
+
+function addBidResponse(args) {
+  let eventType = BID_RESPONSE;
+  let argsCleaned = cleanCreatives(JSON.parse(JSON.stringify(args))); ;
+  if (allEvents[eventType] == undefined) { allEvents[eventType] = [] }
+  allEvents[eventType].push(argsCleaned);
+}
+
+function addBidRequested(args) {
+  let eventType = BID_REQUESTED;
+  let argsCleaned = filterAttributes(args, true);
+  if (saveEvents[eventType] == undefined) { saveEvents[eventType] = [] }
+  saveEvents[eventType].push(argsCleaned);
+}
+
+function addTimeout(args) {
+  let eventType = BID_TIMEOUT;
+  if (saveEvents[eventType] == undefined) { saveEvents[eventType] = [] }
+  saveEvents[eventType].push(args);
+  let argsCleaned = [];
+  let argsDereferenced = JSON.parse(JSON.stringify(args));
+  argsDereferenced.forEach((attr) => {
+    argsCleaned.push(filterAttributes(JSON.parse(JSON.stringify(attr)), false));
+  });
+  if (auctionEnd[eventType] == undefined) { auctionEnd[eventType] = [] }
+  auctionEnd[eventType].push(argsCleaned);
+}
+
+function addAuctionEnd(args) {
+  let eventType = AUCTION_END;
+  if (saveEvents[eventType] == undefined) { saveEvents[eventType] = [] }
+  saveEvents[eventType].push(args);
+  let argsCleaned = cleanAuctionEnd(JSON.parse(JSON.stringify(args)));
+  if (auctionEnd[eventType] == undefined) { auctionEnd[eventType] = [] }
+  auctionEnd[eventType].push(argsCleaned);
+}
+
+function handleBidWon(args) {
+  args = enhanceMediaType(filterAttributes(JSON.parse(JSON.stringify(args)), true));
+  let increment = args['cpm'];
+  if (typeof saveEvents['auctionEnd'] == 'object') {
+    saveEvents['auctionEnd'].forEach((auction) => {
+      if (auction['auctionId'] == args['auctionId'] && typeof auction['bidsReceived'] == 'object') {
+        auction['bidsReceived'].forEach((bid) => {
+          if (bid['transactionId'] == args['transactionId'] && bid['adId'] != args['adId']) {
+            if (args['cpm'] < bid['cpm']) {
+              increment = 0;
+            } else if (increment > args['cpm'] - bid['cpm']) {
+              increment = args['cpm'] - bid['cpm'];
+            }
+          }
+        });
+      }
+    });
+  }
+  args['cpmIncrement'] = increment;
+  args['referer'] = encodeURIComponent(getRefererInfo().page || getRefererInfo().topmostLocation);
+  if (typeof saveEvents.bidRequested == 'object' && saveEvents.bidRequested.length > 0 && saveEvents.bidRequested[0].gdprConsent) { args.gdpr = saveEvents.bidRequested[0].gdprConsent; }
+  ajax(endpoint + '.oxxion.io/analytics/bid_won', null, JSON.stringify(args), {method: 'POST', withCredentials: true});
+}
+
+function handleAuctionEnd() {
+  ajax(endpoint + '.oxxion.io/analytics/auctions', function (data) {
+    let list = JSON.parse(data);
+    if (Array.isArray(list) && typeof allEvents['bidResponse'] != 'undefined') {
+      let alreadyCalled = [];
+      allEvents['bidResponse'].forEach((bidResponse) => {
+        let tmpId = bidResponse['originalBidder'] + '_' + bidResponse['creativeId'];
+        if (list.includes(tmpId) && !alreadyCalled.includes(tmpId)) {
+          alreadyCalled.push(tmpId);
+          ajax(endpoint + '.oxxion.io/analytics/creatives', null, JSON.stringify(bidResponse), {method: 'POST', withCredentials: true});
+        }
+      });
+    }
+    allEvents = {};
+  }, JSON.stringify(auctionEnd), {method: 'POST', withCredentials: true});
+  auctionEnd = {};
+}
+
+let oxxionAnalytics = Object.assign(adapter({url, analyticsType}), {
+  track({
+    eventType,
+    args
+  }) {
+    switch (eventType) {
+      case AUCTION_END:
+        addAuctionEnd(args);
+        handleAuctionEnd();
+        break;
+      case BID_WON:
+        handleBidWon(args);
+        break;
+      case BID_RESPONSE:
+        addBidResponse(args);
+        break;
+      case BID_REQUESTED:
+        addBidRequested(args);
+        break;
+      case BID_TIMEOUT:
+        addTimeout(args);
+        break;
+    }
+  }});
+
+// save the base class function
+oxxionAnalytics.originEnableAnalytics = oxxionAnalytics.enableAnalytics;
+
+// override enableAnalytics so we can get access to the config passed in from the page
+oxxionAnalytics.enableAnalytics = function (config) {
+  oxxionAnalytics.originEnableAnalytics(config); // call the base class function
+  initOptions = config.options;
+  if (initOptions.domain) { endpoint = 'https://' + initOptions.domain; }
+};
+
+adapterManager.registerAnalyticsAdapter({
+  adapter: oxxionAnalytics,
+  code: 'oxxion'
+});
+
+export default oxxionAnalytics;

package/modules/oxxionAnalyticsAdapter.md

@@ -0,0 +1,33 @@
+# Overview
+Module Name: oxxion Analytics Adapter
+
+Module Type: Analytics Adapter
+
+Maintainer: tech@oxxion.io
+
+# Oxxion Analytics Adapter
+
+Oxxion helps you to understand how your prebid stack performs.
+
+# Integration
+
+Add the oxxion analytics adapter module to your prebid configuration :
+```
+pbjs.enableAnalytics(
+  ...
+  {
+    provider: 'oxxion',
+    options : {
+          domain: 'test.endpoint'
+    }
+  }
+  ...
+)
+```
+
+# Parameters
+
+| Name                           | Type     | Description                                                                                                 |
+|:-------------------------------|:---------|:------------------------------------------------------------------------------------------------------------|
+| domain                         | String   | This string identifies yourself in Oxxion's systems and is provided to you by your Oxxion representative.   |
+

package/modules/pairIdSystem.js

@@ -7,7 +7,7 @@
 
 import { submodule } from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js'
-import { logError } from '../src/utils.js';
+import { logInfo } from '../src/utils.js';
 import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'pairId';
@@ -17,11 +17,11 @@ const DEFAULT_LIVERAMP_PAIR_ID_KEY = '_lr_pairId';
 export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 function pairIdFromLocalStorage(key) {
-  return storage.localStorageIsEnabled ? storage.getDataFromLocalStorage(key) : null;
+  return storage.localStorageIsEnabled() ? storage.getDataFromLocalStorage(key) : null;
 }
 
 function pairIdFromCookie(key) {
-  return storage.cookiesAreEnabled ? storage.getCookie(key) : null;
+  return storage.cookiesAreEnabled() ? storage.getCookie(key) : null;
 }
 
 /** @type {Submodule} */
@@ -52,7 +52,7 @@ export const pairIdSubmodule = {
       try {
         ids = ids.concat(JSON.parse(atob(pairIdsString)))
       } catch (error) {
-        logError(error)
+        logInfo(error)
       }
     }
 
@@ -64,12 +64,12 @@ export const pairIdSubmodule = {
         const obj = JSON.parse(atob(liverampValue));
         ids = ids.concat(obj.envelope);
       } catch (error) {
-        logError(error)
+        logInfo(error)
       }
     }
 
     if (ids.length == 0) {
-      logError('PairId not found.')
+      logInfo('PairId not found.')
       return undefined;
     }
     return {'id': ids};

package/modules/prebidServerBidAdapter/index.js

@@ -472,7 +472,13 @@ export function PrebidServer() {
             bidRequests.forEach(bidderRequest => events.emit(CONSTANTS.EVENTS.BIDDER_DONE, bidderRequest));
           }
           if (shouldEmitNonbids(s2sBidRequest.s2sConfig, response)) {
-            emitNonBids(response.ext.seatnonbid, bidRequests[0].auctionId);
+            events.emit(CONSTANTS.EVENTS.SEAT_NON_BID, {
+              seatnonbid: response.ext.seatnonbid,
+              auctionId: bidRequests[0].auctionId,
+              requestedBidders,
+              response,
+              adapterMetrics
+            });
           }
           done();
           doClientSideSyncs(requestedBidders, gdprConsent, uspConsent, gppConsent);
@@ -578,13 +584,6 @@ function shouldEmitNonbids(s2sConfig, response) {
   return s2sConfig?.extPrebid?.returnallbidstatus && response?.ext?.seatnonbid;
 }
 
-function emitNonBids(seatnonbid, auctionId) {
-  events.emit(CONSTANTS.EVENTS.SEAT_NON_BID, {
-    seatnonbid,
-    auctionId
-  });
-}
-
 /**
  * Global setter that sets eids permissions for bidders
  * This setter is to be used by userId module when included

package/modules/pubmaticBidAdapter.js

@@ -51,6 +51,7 @@ const VIDEO_CUSTOM_PARAMS = {
   'battr': DATA_TYPES.ARRAY,
   'linearity': DATA_TYPES.NUMBER,
   'placement': DATA_TYPES.NUMBER,
+  'plcmt': DATA_TYPES.NUMBER,
   'minbitrate': DATA_TYPES.NUMBER,
   'maxbitrate': DATA_TYPES.NUMBER,
   'skip': DATA_TYPES.NUMBER

package/modules/riseBidAdapter.js

@@ -320,6 +320,16 @@ function generateBidParameters(bid, bidderRequest) {
     bidObject.api = api;
   }
 
+  const sua = deepAccess(bid, `ortb2.device.sua`);
+  if (sua) {
+    bidObject.sua = sua;
+  }
+
+  const coppa = deepAccess(bid, `ortb2.regs.coppa`)
+  if (coppa) {
+    bidObject.coppa = 1;
+  }
+
   if (mediaType === VIDEO) {
     const playbackMethod = deepAccess(bid, `mediaTypes.video.playbackmethod`);
     let playbackMethodValue;
@@ -366,9 +376,9 @@ function generateBidParameters(bid, bidderRequest) {
       bidObject.protocols = protocols;
     }
 
-    const coppa = deepAccess(bid, 'ortb2.regs.coppa')
-    if (coppa) {
-      bidObject.coppa = 1;
+    const plcmt = deepAccess(bid, `mediaTypes.video.plcmt`);
+    if (plcmt) {
+      bidObject.plcmt = plcmt;
     }
   }
 

package/modules/rtbhouseBidAdapter.md

@@ -65,3 +65,27 @@ Please reach out to pmp@rtbhouse.com to receive your own
            }
        ];
 ```
+
+# Protected Audience API (FLEDGE) support
+There’s an option to receive demand for Protected Audience API (FLEDGE/PAAPI) 
+ads using RTB House bid adapter. 
+Prebid’s [fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) 
+module and Google Ad Manager is currently required.
+
+The following steps should be taken to setup Protected Audience for RTB House:
+
+1. Reach out to your RTB House representative for setup coordination.
+
+2. Build and enable FLEDGE module as described in 
+[fledgeForGpt](https://docs.prebid.org/dev-docs/modules/fledgeForGpt.html) 
+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
+    }
+});
+```

package/modules/rtdModule/index.js

@@ -168,6 +168,10 @@ import {find} from '../../src/polyfill.js';
 import {timedAuctionHook} from '../../src/utils/perfMetrics.js';
 import {GDPR_GVLIDS} from '../../src/consentHandler.js';
 import {MODULE_TYPE_RTD} from '../../src/activities/modules.js';
+import {guardOrtb2Fragments} from '../../libraries/objectGuard/ortbGuard.js';
+import {activityParamsBuilder} from '../../src/activities/params.js';
+
+const activityParams = activityParamsBuilder((al) => adapterManager.resolveAlias(al));
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
@@ -299,6 +303,7 @@ export const setBidRequestsData = timedAuctionHook('rtd', function setBidRequest
   let callbacksExpected = prioritySubModules.length;
   let isDone = false;
   let waitTimeout;
+  const verifiers = [];
 
   if (!relevantSubModules.length) {
     return exitHook();
@@ -307,7 +312,12 @@ export const setBidRequestsData = timedAuctionHook('rtd', function setBidRequest
   waitTimeout = setTimeout(exitHook, shouldDelayAuction ? _moduleConfig.auctionDelay : 0);
 
   relevantSubModules.forEach(sm => {
-    sm.getBidRequestData(reqBidsConfigObj, onGetBidRequestDataCallback.bind(sm), sm.config, _userConsent)
+    const fpdGuard = guardOrtb2Fragments(reqBidsConfigObj.ortb2Fragments || {}, activityParams(MODULE_TYPE_RTD, sm.name));
+    verifiers.push(fpdGuard.verify);
+    sm.getBidRequestData({
+      ...reqBidsConfigObj,
+      ortb2Fragments: fpdGuard.obj
+    }, onGetBidRequestDataCallback.bind(sm), sm.config, _userConsent)
   });
 
   function onGetBidRequestDataCallback() {
@@ -328,6 +338,7 @@ export const setBidRequestsData = timedAuctionHook('rtd', function setBidRequest
     }
     isDone = true;
     clearTimeout(waitTimeout);
+    verifiers.forEach(fn => fn());
     fn.call(this, reqBidsConfigObj);
   }
 });

package/modules/sharethroughBidAdapter.js

@@ -93,8 +93,8 @@ export const sharethroughAdapterSpec = {
       if (videoRequest) {
         // default playerSize, only change this if we know width and height are properly defined in the request
         let [w, h] = [640, 360];
-        if (videoRequest.playerSize && videoRequest.playerSize[0] && videoRequest.playerSize[1]) {
-          [w, h] = videoRequest.playerSize;
+        if (videoRequest.playerSize && videoRequest.playerSize[0] && videoRequest.playerSize[0][0] && videoRequest.playerSize[0][1]) {
+          [w, h] = videoRequest.playerSize[0];
         }
 
         impression.video = {

package/modules/smartadserverBidAdapter.js

@@ -159,6 +159,11 @@ export const spec = {
         sdc: sellerDefinedContext
       };
 
+      const gpid = deepAccess(bid, 'ortb2Imp.ext.gpid', deepAccess(bid, 'ortb2Imp.ext.data.pbadslot', ''));
+      if (gpid) {
+        payload.gpid = gpid;
+      }
+
       if (bidderRequest) {
         if (bidderRequest.gdprConsent) {
           payload.addtl_consent = bidderRequest.gdprConsent.addtlConsent;

package/modules/stvBidAdapter.js

@@ -50,10 +50,16 @@ export const spec = {
         ref: referrer,
         bid_id: bidId,
         pbver: '$prebid.version$',
+        schain: '',
       };
       if (!isVideoRequest(bidRequest)) {
         payload._f = 'html';
       }
+      if (bidRequest.schain) {
+        payload.schain = serializeSChain(bidRequest.schain);
+      } else {
+        delete payload.schain;
+      }
 
       payload.pfilter = { ...params };
       delete payload.pfilter.placement;
@@ -195,12 +201,39 @@ function objectToQueryString(obj, prefix) {
       let v = obj[p];
       str.push((v !== null && typeof v === 'object')
         ? objectToQueryString(v, k)
-        : encodeURIComponent(k) + '=' + encodeURIComponent(v));
+        : (k == 'schain' ? k + '=' + v : encodeURIComponent(k) + '=' + encodeURIComponent(v)));
     }
   }
   return str.join('&');
 }
 
+function serializeSChain(schain) {
+  let ret = '';
+
+  ret += encodeURIComponent(schain.ver);
+  ret += ',';
+  ret += encodeURIComponent(schain.complete);
+
+  for (let node of schain.nodes) {
+    ret += '!';
+    ret += encodeURIComponent(node.asi);
+    ret += ',';
+    ret += encodeURIComponent(node.sid);
+    ret += ',';
+    ret += encodeURIComponent(node.hp);
+    ret += ',';
+    ret += encodeURIComponent(node.rid ?? '');
+    ret += ',';
+    ret += encodeURIComponent(node.name ?? '');
+    ret += ',';
+    ret += encodeURIComponent(node.domain ?? '');
+    ret += ',';
+    ret += encodeURIComponent(node.ext ?? '');
+  }
+
+  return ret;
+}
+
 /**
  * Check if it's a banner bid request
  *

package/modules/undertoneBidAdapter.js

@@ -124,6 +124,12 @@ export const spec = {
       reqUrl += `&ccpa=${bidderRequest.uspConsent}`;
     }
 
+    if (bidderRequest.gppConsent) {
+      const gppString = bidderRequest.gppConsent.gppString ?? '';
+      const ggpSid = bidderRequest.gppConsent.applicableSections ?? '';
+      reqUrl += `&gpp=${gppString}&gpp_sid=${ggpSid}`;
+    }
+
     validBidRequests.map(bidReq => {
       const bid = {
         bidRequestId: bidReq.bidId,
@@ -146,7 +152,9 @@ export const spec = {
           streamType: deepAccess(bidReq, 'mediaTypes.video.context') || null,
           playbackMethod: deepAccess(bidReq, 'params.video.playbackMethod') || null,
           maxDuration: deepAccess(bidReq, 'params.video.maxDuration') || null,
-          skippable: deepAccess(bidReq, 'params.video.skippable') || null
+          skippable: deepAccess(bidReq, 'params.video.skippable') || null,
+          placement: deepAccess(bidReq, 'mediaTypes.video.placement') || null,
+          plcmt: deepAccess(bidReq, 'mediaTypes.video.plcmt') || null
         };
       }
       payload['x-ut-hb-params'].push(bid);