prebid.js 7.43.0 → 7.45.0

package/modules/dspxBidAdapter.js

@@ -1,12 +1,17 @@
-import { deepAccess } from '../src/utils.js';
+import {deepAccess, getBidIdParameter, logError, logMessage, logWarn, isFn} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {Renderer} from '../src/Renderer.js';
+import {includes} from '../src/polyfill.js';
 
 const BIDDER_CODE = 'dspx';
 const ENDPOINT_URL = 'https://buyer.dspx.tv/request/';
 const ENDPOINT_URL_DEV = 'https://dcbuyer.dspx.tv/request/';
 const GVLID = 602;
+const VIDEO_ORTB_PARAMS = ['mimes', 'minduration', 'maxduration', 'protocols', 'w', 'h', 'startdelay', 'placement', 'linearity', 'skip', 'skipmin',
+  'skipafter', 'sequence', 'battr', 'maxextended', 'minbitrate', 'maxbitrate', 'boxingallowed', 'playbackmethod', 'playbackend', 'delivery', 'pos', 'companionad',
+  'api', 'companiontype', 'ext'];
 
 export const spec = {
   code: BIDDER_CODE,
@@ -17,24 +22,34 @@ export const spec = {
     return !!(bid.params.placement);
   },
   buildRequests: function(validBidRequests, bidderRequest) {
+    let payload = {};
     return validBidRequests.map(bidRequest => {
       const params = bidRequest.params;
 
-      const placementId = params.placement;
       const rnd = Math.floor(Math.random() * 99999999999);
       const referrer = bidderRequest.refererInfo.page;
       const bidId = bidRequest.bidId;
-      const isDev = params.devMode || false;
       const pbcode = bidRequest.adUnitCode || false; // div id
       const auctionId = bidRequest.auctionId || false;
+      const isDev = params.devMode || false;
 
       let endpoint = isDev ? ENDPOINT_URL_DEV : ENDPOINT_URL;
+      let placementId = params.placement;
+
+      // dev config
+      if (isDev && params.dev) {
+        endpoint = params.dev.endpoint || endpoint;
+        placementId = params.dev.placement || placementId;
+        if (params.dev.pfilter !== undefined) {
+          params.pfilter = params.dev.pfilter;
+        }
+      }
 
       let mediaTypesInfo = getMediaTypesInfo(bidRequest);
       let type = isBannerRequest(bidRequest) ? BANNER : VIDEO;
       let sizes = mediaTypesInfo[type];
 
-      let payload = {
+      payload = {
         _f: 'auto',
         alternative: 'prebid_js',
         inventory_item_id: placementId,
@@ -47,10 +62,6 @@ export const spec = {
         pbver: '$prebid.version$'
       };
 
-      if (mediaTypesInfo[VIDEO] !== undefined && params.vastFormat !== undefined) {
-        payload.vf = params.vastFormat;
-      }
-
       if (params.pfilter !== undefined) {
         payload.pfilter = params.pfilter;
       }
@@ -79,11 +90,49 @@ export const spec = {
         payload.prebidDevMode = 1;
       }
 
-      if (bidRequest.userId && bidRequest.userId.netId) {
-        payload.did_netid = bidRequest.userId.netId;
+      // fill userId params
+      if (bidRequest.userId) {
+        if (bidRequest.userId.netId) {
+          payload.did_netid = bidRequest.userId.netId;
+        }
+        if (bidRequest.userId.id5id) {
+          payload.did_id5 = bidRequest.userId.id5id.uid || '0';
+          if (bidRequest.userId.id5id.ext.linkType !== undefined) {
+            payload.did_id5_linktype = bidRequest.userId.id5id.ext.linkType;
+          }
+        }
+        let uId2 = deepAccess(bidRequest, 'userId.uid2.id');
+        if (uId2) {
+          payload.did_uid2 = uId2;
+        }
+        let sharedId = deepAccess(bidRequest, 'userId.sharedid.id');
+        if (sharedId) {
+          payload.did_sharedid = sharedId;
+        }
+        let pubcId = deepAccess(bidRequest, 'userId.pubcid');
+        if (pubcId) {
+          payload.did_pubcid = pubcId;
+        }
+        let crumbsPubcid = deepAccess(bidRequest, 'crumbs.pubcid');
+        if (crumbsPubcid) {
+          payload.did_cpubcid = crumbsPubcid;
+        }
+      }
+
+      if (bidRequest.schain) {
+        payload.schain = bidRequest.schain;
       }
-      if (bidRequest.userId && bidRequest.userId.uid2) {
-        payload.did_uid2 = bidRequest.userId.uid2;
+
+      if (payload.pfilter === undefined || !payload.pfilter.floorprice) {
+        let bidFloor = getBidFloor(bidRequest);
+        if (bidFloor > 0) {
+          if (payload.pfilter !== undefined) {
+            payload.pfilter.floorprice = bidFloor;
+          } else {
+            payload.pfilter = { 'floorprice': bidFloor };
+          }
+          // payload.bidFloor = bidFloor;
+        }
       }
 
       if (auctionId) {
@@ -94,6 +143,17 @@ export const spec = {
       }
 
       payload.media_types = convertMediaInfoForRequest(mediaTypesInfo);
+      if (mediaTypesInfo[VIDEO] !== undefined) {
+        payload.vctx = getVideoContext(bidRequest);
+        if (params.vastFormat !== undefined) {
+          payload.vf = params.vastFormat;
+        }
+        payload.vpl = {};
+        let videoParams = deepAccess(bidRequest, 'mediaTypes.video');
+        Object.keys(videoParams)
+          .filter(key => includes(VIDEO_ORTB_PARAMS, key))
+          .forEach(key => payload.vpl[key] = videoParams[key]);
+      }
 
       return {
         method: 'GET',
@@ -103,6 +163,8 @@ export const spec = {
     });
   },
   interpretResponse: function(serverResponse, bidRequest) {
+    logMessage('DSPx: serverResponse', serverResponse);
+    logMessage('DSPx: bidRequest', bidRequest);
     const bidResponses = [];
     const response = serverResponse.body;
     const crid = response.crid || 0;
@@ -126,13 +188,33 @@ export const spec = {
           advertiserDomains: response.adomain || []
         }
       };
+
+      if (response.vastUrl) {
+        bidResponse.vastUrl = response.vastUrl;
+        bidResponse.mediaType = 'video';
+      }
       if (response.vastXml) {
         bidResponse.vastXml = response.vastXml;
         bidResponse.mediaType = 'video';
-      } else {
+      }
+      if (response.renderer) {
+        bidResponse.renderer = newRenderer(bidRequest, response);
+      }
+
+      if (response.videoCacheKey) {
+        bidResponse.videoCacheKey = response.videoCacheKey;
+      }
+
+      if (response.adTag) {
         bidResponse.ad = response.adTag;
       }
 
+      if (response.bid_appendix) {
+        Object.keys(response.bid_appendix).forEach(fieldName => {
+          bidResponse[fieldName] = response.bid_appendix[fieldName];
+        });
+      }
+
       bidResponses.push(bidResponse);
     }
     return bidResponses;
@@ -217,12 +299,22 @@ function isVideoRequest(bid) {
  * Get video sizes
  *
  * @param {BidRequest} bid - Bid request generated from ad slots
- * @returns {object} True if it's a video bid
+ * @returns {object}
  */
 function getVideoSizes(bid) {
   return parseSizes(deepAccess(bid, 'mediaTypes.video.playerSize') || bid.sizes);
 }
 
+/**
+ * Get video context
+ *
+ * @param {BidRequest} bid - Bid request generated from ad slots
+ * @returns {object}
+ */
+function getVideoContext(bid) {
+  return deepAccess(bid, 'mediaTypes.video.context') || 'unknown';
+}
+
 /**
  * Get banner sizes
  *
@@ -296,4 +388,120 @@ function getMediaTypesInfo(bid) {
   return mediaTypesInfo;
 }
 
+/**
+ * Get Bid Floor
+ * @param bid
+ * @returns {number|*}
+ */
+function getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return deepAccess(bid, 'params.bidfloor', 0);
+  }
+
+  try {
+    const bidFloor = bid.getFloor({
+      currency: 'EUR',
+      mediaType: '*',
+      size: '*',
+    });
+    return bidFloor.floor;
+  } catch (_) {
+    return 0
+  }
+}
+
+/**
+ * Create a new renderer
+ *
+ * @param bidRequest
+ * @param response
+ * @returns {Renderer}
+ */
+function newRenderer(bidRequest, response) {
+  logMessage('DSPx: newRenderer', bidRequest, response);
+  const renderer = Renderer.install({
+    id: response.renderer.id || response.bid_id,
+    url: (bidRequest.params && bidRequest.params.rendererUrl) || response.renderer.url,
+    config: response.renderer.options || deepAccess(bidRequest, 'renderer.options'),
+    loaded: false
+  });
+
+  try {
+    renderer.setRender(outstreamRender);
+  } catch (err) {
+    logWarn('Prebid Error calling setRender on renderer', err);
+  }
+  return renderer;
+}
+
+/**
+ * Outstream Render Function
+ *
+ * @param bid
+ */
+function outstreamRender(bid) {
+  logMessage('DSPx: outstreamRender bid:', bid);
+  const embedCode = createOutstreamEmbedCode(bid);
+  try {
+    const inIframe = getBidIdParameter('iframe', bid.renderer.config);
+    if (inIframe && window.document.getElementById(inIframe).nodeName === 'IFRAME') {
+      const iframe = window.document.getElementById(inIframe);
+      let framedoc = iframe.contentDocument || (iframe.contentWindow && iframe.contentWindow.document);
+      framedoc.body.appendChild(embedCode);
+      if (typeof window.dspxRender === 'function') {
+        window.dspxRender(bid);
+      } else {
+        logError('[dspx][renderer] Error: dspxRender function is not found');
+      }
+      return;
+    }
+
+    const slot = getBidIdParameter('slot', bid.renderer.config) || bid.adUnitCode;
+    if (slot && window.document.getElementById(slot)) {
+      window.document.getElementById(slot).appendChild(embedCode);
+      if (typeof window.dspxRender === 'function') {
+        window.dspxRender(bid);
+      } else {
+        logError('[dspx][renderer] Error: dspxRender function is not found');
+      }
+    } else if (slot) {
+      logError('[dspx][renderer] Error: slot not found');
+    }
+  } catch (err) {
+    logError('[dspx][renderer] Error:' + err.message)
+  }
+}
+
+/**
+ * create Outstream Embed Code Node
+ *
+ * @param bid
+ * @returns {DocumentFragment}
+ */
+function createOutstreamEmbedCode(bid) {
+  const fragment = window.document.createDocumentFragment();
+  let div = window.document.createElement('div');
+  div.innerHTML = deepAccess(bid, 'renderer.config.code', '');
+  fragment.appendChild(div);
+
+  // run scripts
+  var scripts = div.getElementsByTagName('script');
+  var scriptsClone = [];
+  for (var idx = 0; idx < scripts.length; idx++) {
+    scriptsClone.push(scripts[idx]);
+  }
+  for (var i = 0; i < scriptsClone.length; i++) {
+    var currentScript = scriptsClone[i];
+    var s = document.createElement('script');
+    for (var j = 0; j < currentScript.attributes.length; j++) {
+      var a = currentScript.attributes[j];
+      s.setAttribute(a.name, a.value);
+    }
+    s.appendChild(document.createTextNode(currentScript.innerHTML));
+    currentScript.parentNode.replaceChild(s, currentScript);
+  }
+
+  return fragment;
+}
+
 registerBidder(spec);

package/modules/fintezaAnalyticsAdapter.js

@@ -2,10 +2,12 @@ import { parseUrl, logError } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import adapterManager from '../src/adapterManager.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
 import CONSTANTS from '../src/constants.json';
+import {MODULE_TYPE_ANALYTICS} from '../src/activities/modules.js';
 
-const storage = getStorageManager();
+const MODULE_CODE = 'finteza';
+const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: MODULE_CODE});
 
 const ANALYTICS_TYPE = 'endpoint';
 const FINTEZA_HOST = 'https://content.mql5.com/tr';
@@ -439,7 +441,7 @@ fntzAnalyticsAdapter.enableAnalytics = function (config) {
 
 adapterManager.registerAnalyticsAdapter({
   adapter: fntzAnalyticsAdapter,
-  code: 'finteza'
+  code: MODULE_CODE,
 });
 
 export default fntzAnalyticsAdapter;

package/modules/fledgeForGpt.js

@@ -5,6 +5,7 @@
 import { config } from '../src/config.js';
 import { getHook } from '../src/hook.js';
 import { getGptSlotForAdUnitCode, logInfo, logWarn } from '../src/utils.js';
+import {IMP, PBS, registerOrtbProcessor, RESPONSE} from '../src/pbjsORTB.js';
 
 const MODULE = 'fledgeForGpt'
 
@@ -21,22 +22,20 @@ export function init(cfg) {
       getHook('addComponentAuction').before(addComponentAuctionHook);
       isEnabled = true;
     }
-    logInfo(MODULE, `isEnabled`, cfg);
+    logInfo(`${MODULE} enabled (browser ${isFledgeSupported() ? 'supports' : 'does NOT support'} fledge)`, cfg);
   } else {
     if (isEnabled) {
       getHook('addComponentAuction').getHooks({hook: addComponentAuctionHook}).remove();
       isEnabled = false;
     }
-    logInfo(MODULE, `isDisabled`, cfg);
+    logInfo(`${MODULE} disabled`, cfg);
   }
 }
 
-export function addComponentAuctionHook(next, bidRequest, componentAuctionConfig) {
+export function addComponentAuctionHook(next, adUnitCode, componentAuctionConfig) {
   const seller = componentAuctionConfig.seller;
-  const adUnitCode = bidRequest.adUnitCode;
   const gptSlot = getGptSlotForAdUnitCode(adUnitCode);
   if (gptSlot && gptSlot.setConfig) {
-    delete componentAuctionConfig.bidId;
     gptSlot.setConfig({
       componentAuction: [{
         configKey: seller,
@@ -48,5 +47,54 @@ export function addComponentAuctionHook(next, bidRequest, componentAuctionConfig
     logWarn(MODULE, `unable to register component auction config for: ${adUnitCode} x ${seller}.`);
   }
 
-  next(bidRequest, componentAuctionConfig);
+  next(adUnitCode, componentAuctionConfig);
 }
+
+function isFledgeSupported() {
+  return 'runAdAuction' in navigator && 'joinAdInterestGroup' in navigator
+}
+
+export function markForFledge(next, bidderRequests) {
+  if (isFledgeSupported()) {
+    bidderRequests.forEach((req) => {
+      req.fledgeEnabled = config.runWithBidder(req.bidderCode, () => config.getConfig('fledgeEnabled'))
+    })
+  }
+  next(bidderRequests);
+}
+getHook('makeBidRequests').after(markForFledge);
+
+export function setImpExtAe(imp, bidRequest, context) {
+  if (!context.bidderRequest.fledgeEnabled) {
+    delete imp.ext?.ae;
+  }
+}
+registerOrtbProcessor({type: IMP, name: 'impExtAe', fn: setImpExtAe});
+
+// to make it easier to share code between the PBS adapter and adapters whose backend is PBS, break up
+// fledge response processing in two steps: first aggregate all the auction configs by their imp...
+
+export function parseExtPrebidFledge(response, ortbResponse, context) {
+  (ortbResponse.ext?.prebid?.fledge?.auctionconfigs || []).forEach((cfg) => {
+    const impCtx = context.impContext[cfg.impid];
+    if (!impCtx?.imp?.ext?.ae) {
+      logWarn('Received fledge auction configuration for an impression that was not in the request or did not ask for it', cfg, impCtx?.imp);
+    } else {
+      impCtx.fledgeConfigs = impCtx.fledgeConfigs || [];
+      impCtx.fledgeConfigs.push(cfg);
+    }
+  })
+}
+registerOrtbProcessor({type: RESPONSE, name: 'extPrebidFledge', fn: parseExtPrebidFledge, dialects: [PBS]});
+
+// ...then, make them available in the adapter's response. This is the client side version, for which the
+// interpretResponse api is {fledgeAuctionConfigs: [{bidId, config}]}
+
+export function setResponseFledgeConfigs(response, ortbResponse, context) {
+  const configs = Object.values(context.impContext)
+    .flatMap((impCtx) => (impCtx.fledgeConfigs || []).map(cfg => ({bidId: impCtx.bidRequest.bidId, config: cfg.config})));
+  if (configs.length > 0) {
+    response.fledgeAuctionConfigs = configs;
+  }
+}
+registerOrtbProcessor({type: RESPONSE, name: 'fledgeAuctionConfigs', priority: -1, fn: setResponseFledgeConfigs, dialects: [PBS]})

package/modules/freewheel-sspBidAdapter.js

@@ -424,6 +424,14 @@ export const spec = {
         requestParams.playerSize = playerSize[0] + 'x' + playerSize[1];
       }
 
+      // Add video context and placement in requestParams
+      if (currentBidRequest.mediaTypes.video) {
+        var videoContext = currentBidRequest.mediaTypes.video.context ? currentBidRequest.mediaTypes.video.context : 'instream';
+        var videoPlacement = currentBidRequest.mediaTypes.video.placement ? currentBidRequest.mediaTypes.video.placement : 1;
+        requestParams.video_context = videoContext;
+        requestParams.video_placement = videoPlacement;
+      }
+
       return {
         method: 'GET',
         url: FREEWHEEL_ADSSETUP,

package/modules/ftrackIdSystem.js

@@ -6,19 +6,19 @@
  */
 
 import * as utils from '../src/utils.js';
-import { submodule } from '../src/hook.js';
-import { getStorageManager } from '../src/storageManager.js';
-import { uspDataHandler } from '../src/adapterManager.js';
-import { loadExternalScript } from '../src/adloader.js';
+import {submodule} from '../src/hook.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {uspDataHandler} from '../src/adapterManager.js';
+import {loadExternalScript} from '../src/adloader.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'ftrackId';
 const LOG_PREFIX = 'FTRACK - ';
 const LOCAL_STORAGE_EXP_DAYS = 30;
-const VENDOR_ID = null;
 const LOCAL_STORAGE = 'html5';
 const FTRACK_STORAGE_NAME = 'ftrackId';
 const FTRACK_PRIVACY_STORAGE_NAME = `${FTRACK_STORAGE_NAME}_privacy`;
-const storage = getStorageManager({gvlid: VENDOR_ID, moduleName: MODULE_NAME});
+const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 let consentInfo = {
   gdpr: {