prebid.js 9.53.2 → 9.53.4

package/modules/fwsspBidAdapter.js

@@ -1,4 +1,4 @@
-import { logInfo, logError, logWarn, isArray, isFn, deepAccess, formatQS } from '../src/utils.js';
+import { logInfo, logError, logWarn, isArray, isFn, deepAccess } from '../src/utils.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
@@ -6,7 +6,8 @@ import { getGlobal } from '../src/prebidGlobal.js';
 
 const BIDDER_CODE = 'fwssp';
 const GVL_ID = 285;
-const USER_SYNC_URL = 'https://ads.stickyadstv.com/auto-user-sync';
+const USER_SYNC_URL = 'https://user-sync.fwmrm.net/ad/u?';
+let PRIVACY_VALUES = {};
 
 export const spec = {
   code: BIDDER_CODE,
@@ -21,7 +22,7 @@ export const spec = {
    * @return boolean True if this is a valid bid, and false otherwise.
    */
   isBidRequestValid(bid) {
-    return !!(bid.params.serverUrl && bid.params.networkId && bid.params.profile && bid.params.siteSectionId && bid.params.videoAssetId);
+    return !!(bid.params.serverUrl && bid.params.networkId && bid.params.profile && bid.params.siteSectionId);
   },
 
   /**
@@ -46,9 +47,9 @@ export const spec = {
     const buildRequest = (currentBidRequest, bidderRequest) => {
       const globalParams = constructGlobalParams(currentBidRequest);
       const keyValues = constructKeyValues(currentBidRequest, bidderRequest);
-
       const slotParams = constructSlotParams(currentBidRequest);
-      const dataString = constructDataString(globalParams, keyValues, slotParams);
+      const serializedSChain = constructSupplyChain(currentBidRequest, bidderRequest);
+      const dataString = constructDataString(globalParams, keyValues, serializedSChain, slotParams);
       return {
         method: 'GET',
         url: currentBidRequest.params.serverUrl,
@@ -57,6 +58,19 @@ export const spec = {
       };
     }
 
+    const constructSupplyChain = (currentBidRequest, bidderRequest) => {
+      // Add schain object
+      let schain = deepAccess(bidderRequest, 'ortb2.source.schain');
+      if (!schain) {
+        schain = deepAccess(bidderRequest, 'ortb2.source.ext.schain');
+      }
+      if (!schain) {
+        schain = currentBidRequest.schain;
+      }
+
+      return this.serializeSupplyChain(schain)
+    }
+
     const constructGlobalParams = currentBidRequest => {
       const sdkVersion = getSDKVersion(currentBidRequest);
       const prebidVersion = getGlobal().version;
@@ -65,7 +79,7 @@ export const spec = {
         resp: 'vast4',
         prof: currentBidRequest.params.profile,
         csid: currentBidRequest.params.siteSectionId,
-        caid: currentBidRequest.params.videoAssetId,
+        caid: currentBidRequest.params.videoAssetId ? currentBidRequest.params.videoAssetId : 0,
         pvrn: getRandomNumber(),
         vprn: getRandomNumber(),
         flag: setFlagParameter(currentBidRequest.params.flags),
@@ -88,9 +102,9 @@ export const spec = {
       const keyValues = currentBidRequest.params.adRequestKeyValues || {};
 
       // Add bidfloor to keyValues
-      const bidfloor = getBidFloor(currentBidRequest, config);
-      keyValues._fw_bidfloor = (bidfloor > 0) ? bidfloor : 0;
-      keyValues._fw_bidfloorcur = (bidfloor > 0) ? getFloorCurrency(config) : '';
+      const { floor, currency } = getBidFloor(currentBidRequest, config);
+      keyValues._fw_bidfloor = floor;
+      keyValues._fw_bidfloorcur = currency;
 
       // Add GDPR flag and consent string
       if (bidderRequest && bidderRequest.gdprConsent) {
@@ -127,16 +141,6 @@ export const spec = {
         }
       }
 
-      // Add schain object
-      const schain = currentBidRequest.schain;
-      if (schain) {
-        try {
-          keyValues.schain = JSON.stringify(schain);
-        } catch (error) {
-          logWarn('PREBID - ' + BIDDER_CODE + ': Unable to stringify the schain: ' + error);
-        }
-      }
-
       // Add 3rd party user ID
       if (currentBidRequest.userIdAsEids && currentBidRequest.userIdAsEids.length > 0) {
         try {
@@ -179,7 +183,7 @@ export const spec = {
         let videoPlacement = currentBidRequest.mediaTypes.video.placement ? currentBidRequest.mediaTypes.video.placement : null;
         const videoPlcmt = currentBidRequest.mediaTypes.video.plcmt ? currentBidRequest.mediaTypes.video.plcmt : null;
 
-        if (currentBidRequest.params.format == 'inbanner') {
+        if (currentBidRequest.params.format === 'inbanner') {
           videoContext = 'In-Banner';
           videoPlacement = 2;
         }
@@ -188,6 +192,34 @@ export const spec = {
         keyValues._fw_placement_type = videoPlacement;
         keyValues._fw_plcmt_type = videoPlcmt;
       }
+
+      const coppa = deepAccess(bidderRequest, 'ortb2.regs.coppa');
+      if (typeof coppa === 'number') {
+        keyValues._fw_coppa = coppa;
+      }
+
+      const atts = deepAccess(bidderRequest, 'ortb2.device.ext.atts');
+      if (typeof atts === 'number') {
+        keyValues._fw_atts = atts;
+      }
+
+      const lmt = deepAccess(bidderRequest, 'ortb2.device.lmt');
+      if (typeof lmt === 'number') {
+        keyValues._fw_is_lat = lmt;
+      }
+
+      PRIVACY_VALUES = {}
+      if (keyValues._fw_coppa != null) {
+        PRIVACY_VALUES._fw_coppa = keyValues._fw_coppa;
+      }
+
+      if (keyValues._fw_atts != null) {
+        PRIVACY_VALUES._fw_atts = keyValues._fw_atts;
+      }
+      if (keyValues._fw_is_lat != null) {
+        PRIVACY_VALUES._fw_is_lat = keyValues._fw_is_lat;
+      }
+
       return keyValues;
     }
 
@@ -212,28 +244,23 @@ export const spec = {
         slid: currentBidRequest.params.slid ? currentBidRequest.params.slid : 'Preroll_1',
         slau: currentBidRequest.params.slau ? currentBidRequest.params.slau : 'preroll',
       }
-      if (currentBidRequest.params.minD) {
-        slotParams.mind = currentBidRequest.params.minD;
+      const video = deepAccess(currentBidRequest, 'mediaTypes.video') || {};
+      const mind = video.minduration || currentBidRequest.params.minD;
+      const maxd = video.maxduration || currentBidRequest.params.maxD;
+
+      if (mind) {
+        slotParams.mind = mind;
       }
-      if (currentBidRequest.params.maxD) {
-        slotParams.maxd = currentBidRequest.params.maxD
+      if (maxd) {
+        slotParams.maxd = maxd;
       }
       return slotParams
     }
 
-    const constructDataString = (globalParams, keyValues, slotParams) => {
-      // Helper function to append parameters to the data string and to not include the last '&' param before ';
-      const appendParams = (params) => {
-        const keys = Object.keys(params);
-        return keys.map((key, index) => {
-          const encodedKey = encodeURIComponent(key);
-          const encodedValue = encodeURIComponent(params[key]);
-          return `${encodedKey}=${encodedValue}${index < keys.length - 1 ? '&' : ''}`;
-        }).join('');
-      };
-
+    const constructDataString = (globalParams, keyValues, serializedSChain, slotParams) => {
       const globalParamsString = appendParams(globalParams) + ';';
-      const keyValuesString = appendParams(keyValues) + ';';
+      // serializedSChain requires special encoding logic as outlined in the ORTB spec https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/supplychainobject.md
+      const keyValuesString = appendParams(keyValues) + serializedSChain + ';';
       const slotParamsString = appendParams(slotParams) + ';';
 
       return globalParamsString + keyValuesString + slotParamsString;
@@ -244,6 +271,21 @@ export const spec = {
     });
   },
 
+  /**
+   * Serialize a supply chain object to a string uri encoded
+   *
+   * @param {*} schain object
+   */
+  serializeSupplyChain: function(schain) {
+    if (!schain || !schain.nodes) return '';
+    const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+    return `&schain=${schain.ver},${schain.complete}!` +
+      schain.nodes.map(node => nodesProperties.map(prop =>
+        node[prop] ? encodeURIComponent(node[prop]) : '')
+        .join(','))
+        .join('!');
+  },
+
   /**
    * Unpack the response from the server into a list of bids.
    *
@@ -269,7 +311,7 @@ export const spec = {
       playerSize = getBiggerSize(bidrequest.sizes);
     }
 
-    if (typeof serverResponse == 'object' && typeof serverResponse.body == 'string') {
+    if (typeof serverResponse === 'object' && typeof serverResponse.body === 'string') {
       serverResponse = serverResponse.body;
     }
 
@@ -323,7 +365,10 @@ export const spec = {
   },
 
   getUserSyncs: function(syncOptions, responses, gdprConsent, uspConsent, gppConsent) {
-    const params = {};
+    const params = {
+      mode: 'auto-user-sync',
+      ...PRIVACY_VALUES
+    };
 
     if (gdprConsent) {
       if (typeof gdprConsent.gdprApplies === 'boolean') {
@@ -347,21 +392,19 @@ export const spec = {
       }
     }
 
-    let queryString = '';
-    if (params) {
-      queryString = '?' + `${formatQS(params)}`;
-    }
+    const url = USER_SYNC_URL + appendParams(params);
 
     const syncs = [];
     if (syncOptions && syncOptions.pixelEnabled) {
       syncs.push({
         type: 'image',
-        url: USER_SYNC_URL + queryString
+        url: url
       });
-    } else if (syncOptions.iframeEnabled) {
+    }
+    if (syncOptions && syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: USER_SYNC_URL + queryString
+        url: url
       });
     }
 
@@ -379,8 +422,8 @@ export function formatAdHTML(bidrequest, size) {
   const sdkUrl = getSdkUrl(bidrequest);
   const displayBaseId = 'fwssp_display_base';
 
-  const startMuted = typeof bidrequest.params.isMuted == 'boolean' ? bidrequest.params.isMuted : true
-  const showMuteButton = typeof bidrequest.params.showMuteButton == 'boolean' ? bidrequest.params.showMuteButton : false
+  const startMuted = typeof bidrequest.params.isMuted === 'boolean' ? bidrequest.params.isMuted : true
+  const showMuteButton = typeof bidrequest.params.showMuteButton === 'boolean' ? bidrequest.params.showMuteButton : false
 
   let playerParams = null;
   try {
@@ -450,7 +493,7 @@ export function formatAdHTML(bidrequest, size) {
 }
 
 function getSdkUrl(bidrequest) {
-  const isStg = bidrequest.params.env && bidrequest.params.env.toLowerCase() == 'stg';
+  const isStg = bidrequest.params.env && bidrequest.params.env.toLowerCase() === 'stg';
   const host = isStg ? 'adm.stg.fwmrm.net' : 'mssl.fwmrm.net';
   const sdkVersion = getSDKVersion(bidrequest);
   return `https://${host}/libs/adm/${sdkVersion}/AdManager-prebid.js`
@@ -463,7 +506,7 @@ function getSdkUrl(bidrequest) {
  * @returns {string} The SDK version to use, defaults to '7.10.0' if version parsing fails
  */
 export function getSDKVersion(bidRequest) {
-  const DEFAULT = '7.10.0';
+  const DEFAULT = '7.11.0';
 
   try {
     const paramVersion = getSdkVersionFromBidRequest(bidRequest);
@@ -519,25 +562,37 @@ function compareVersions(versionA, versionB) {
   return 0;
 };
 
-function getBidFloor(bid, config) {
-  if (!isFn(bid.getFloor)) {
-    return deepAccess(bid, 'params.bidfloor', 0);
-  }
+export function getBidFloor(bid, config) {
+  logInfo('PREBID -: getBidFloor called with:', bid);
+  let floor = deepAccess(bid, 'params.bidfloor', 0); // fallback bid params
+  let currency = deepAccess(bid, 'params.bidfloorcur', 'USD'); // fallback bid params
 
-  try {
-    const bidFloor = bid.getFloor({
-      currency: getFloorCurrency(config),
-      mediaType: typeof bid.mediaTypes['banner'] == 'object' ? 'banner' : 'video',
-      size: '*',
-    });
-    return bidFloor.floor;
-  } catch (e) {
-    return -1;
-  }
-}
+  if (isFn(bid.getFloor)) {
+    logInfo('PREBID - : getFloor() present and use it to retrieve floor and currency.');
+    try {
+      const floorInfo = bid.getFloor({
+        currency: config.getConfig('floors.data.currency') || 'USD',
+        mediaType: bid.mediaTypes.banner ? 'banner' : 'video',
+        size: '*',
+      }) || {};
+
+      // Use getFloor's results if valid
+      if (typeof floorInfo.floor === 'number') {
+        floor = floorInfo.floor;
+      }
 
-function getFloorCurrency(config) {
-  return config.getConfig('floors.data.currency') != null ? config.getConfig('floors.data.currency') : 'USD';
+      if (floorInfo.currency) {
+        currency = floorInfo.currency;
+      }
+      logInfo('PREBID - : getFloor() returned floor:', floor, 'currency:', currency);
+    } catch (e) {
+      // fallback to static bid.params.bidfloor
+      floor = deepAccess(bid, 'params.bidfloor', 0);
+      currency = deepAccess(bid, 'params.bidfloorcur', 'USD');
+      logInfo('PREBID - : getFloor() exception, fallback to static bid.params.bidfloor:', floor, 'currency:', currency);
+    }
+  }
+  return { floor, currency };
 }
 
 function isValidUrl(str) {
@@ -658,13 +713,13 @@ function getValueFromKeyInImpressionNode(xmlNode, key) {
     let tempValue = '';
     queries.forEach(item => {
       const split = item.split('=');
-      if (split[0] == key) {
+      if (split[0] === key) {
         tempValue = split[1];
       }
-      if (split[0] == 'reqType' && split[1] == 'AdsDisplayStarted') {
+      if (split[0] === 'reqType' && split[1] === 'AdsDisplayStarted') {
         isAdsDisplayStartedPresent = true;
       }
-      if (split[0] == 'rootViewKey') {
+      if (split[0] === 'rootViewKey') {
         isRootViewKeyPresent = true;
       }
     });
@@ -705,4 +760,14 @@ function getTopMostWindow() {
   return res;
 }
 
+// Helper function to append parameters to the data string and to not include the last '&' param before ';
+function appendParams(params) {
+  const keys = Object.keys(params);
+  return keys.map((key, index) => {
+    const encodedKey = encodeURIComponent(key);
+    const encodedValue = encodeURIComponent(params[key]);
+    return `${encodedKey}=${encodedValue}${index < keys.length - 1 ? '&' : ''}`;
+  }).join('');
+}
+
 registerBidder(spec);

package/modules/fwsspBidAdapter.md

@@ -8,31 +8,126 @@ Maintainer:  vis@freewheel.com
 
 Module that connects to Freewheel MRM's demand sources
 
-# Test Parameters
+# Basic Test Request
 ```
-	var adUnits = [
-		   {
-			   bids: [
-				   {
-						bidder: 'fwssp',    // or use alias 'freewheel-mrm'
-						params: {
-							serverUrl: 'https://example.com/ad/g/1',
-							networkId: '42015',
-							profile: '42015:js_allinone_profile',
-							siteSectionId: 'js_allinone_demo_site_section',
-							videoAssetId: '0',
-							flags: '+play-uapl'    // optional: users may include capability if needed
-							mode: 'live',
-							minD: 30,
-							maxD: 60,
-							adRequestKeyValues: {    // optional: users may include adRequestKeyValues if needed
-								_fw_player_width: '1920',
-								_fw_player_height: '1080'
-							},
-							format: 'inbanner'
-						}
-				   }
-			   ]
-		   }
-	   ];
+const adUnits = [{
+    code: 'adunit-code',
+    mediaTypes: {
+        video: {
+            playerSize: [640, 480],
+            minduration: 30,
+            maxduration: 60
+        }
+    },
+    bids: [{
+        bidder: 'fwssp',  // or use alias 'freewheel-mrm'
+        params: {
+            serverUrl: 'https://example.com/ad/g/1',
+            networkId: '42015',
+            profile: '42015:js_allinone_profile',
+            siteSectionId: 'js_allinone_demo_site_section',
+            videoAssetId: '1',  // optional: default value of 0 will used if not included
+            flags: '+play-uapl'  // optional: users may include capability if needed
+            mode: 'live',
+            adRequestKeyValues: {  // optional: users may include adRequestKeyValues if needed
+                _fw_player_width: '1920',
+                _fw_player_height: '1080'
+            },
+            format: 'inbanner'
+        }
+    }]
+}];
 ```
+
+# Example Inbanner Ad Request
+```
+{
+    code: 'adunit-code',
+    mediaTypes: {
+        banner: {
+            'sizes': [[300, 250], [300, 600]]
+        }
+    },
+    bids: [{
+        bidder: 'fwssp',
+        schain: {
+            ver: '1.0',
+            complete: 1,
+            nodes: [{
+                asi: 'example.com',
+                sid: '0',
+                hp: 1,
+                rid: 'bidrequestid',
+                domain: 'example.com'
+            }]
+        },
+        params: {
+            bidfloor: 2.00,
+            serverUrl: 'https://example.com/ad/g/1',
+            networkId: '42015',
+            profile: '42015:js_allinone_profile',
+            siteSectionId: 'js_allinone_demo_site_section',
+            flags: '+play',
+            videoAssetId: '1`,  // optional: default value of 0 will used if not included
+            timePosition: 120,
+            adRequestKeyValues: {
+                _fw_player_width: '1920',
+                _fw_player_height: '1080',
+                _fw_content_programmer_brand: 'NEEDS_TO_REPLACE_BY_BRAND_NAME',
+                _fw_content_programmer_brand_channel: 'NEEDS_TO_REPLACE_BY_CHANNEL_NAME',
+                _fw_content_genre: 'NEEDS_TO_REPLACE_BY_CONTENT_GENRE'
+            }
+        }
+    }]
+}
+```
+
+# Example Instream Ad Request
+```
+{
+    code: 'adunit-code',
+    mediaTypes: {
+        video: {
+            playerSize: [300, 600],
+        }
+    },
+    bids: [{
+        bidder: 'fwssp',
+        schain: {
+            ver: '1.0',
+            complete: 1,
+            nodes: [{
+                asi: 'example.com',
+                sid: '0',
+                hp: 1,
+                rid: 'bidrequestid',
+                domain: 'example.com'
+            }]
+        },
+        params: {
+            bidfloor: 2.00,
+            serverUrl: 'https://example.com/ad/g/1',
+            networkId: '42015',
+            profile: '42015:js_allinone_profile',
+            siteSectionId: 'js_allinone_demo_site_section',
+            flags: '+play',
+            videoAssetId: '1',  // optional: default value of 0 will used if not included
+            mode: 'live',
+            timePosition: 120,
+            tpos: 300,
+            slid: 'Midroll',
+            slau: 'midroll',
+            minD: 30,
+            maxD: 60,
+            adRequestKeyValues: {
+                _fw_player_width: '1920',
+                _fw_player_height: '1080',
+                _fw_content_progrmmer_brand: 'NEEDS_TO_REPLACE_BY_BRAND_NAME',
+                _fw_content_programmer_brand_channel: 'NEEDS_TO_REPLACE_BY_CHANNEL_NAME',
+                _fw_content_genre: 'NEEDS_TO_REPLACE_BY_CONTENT_GENRE'
+            },
+            gdpr_consented_providers: 'test_providers'
+        }
+    }]
+}
+```

package/modules/optableRtdProvider.js

@@ -15,8 +15,8 @@ const {logMessage, logWarn, logError} = optableLog;
  */
 export const parseConfig = (moduleConfig) => {
   let bundleUrl = deepAccess(moduleConfig, 'params.bundleUrl', null);
-  let adserverTargeting = deepAccess(moduleConfig, 'params.adserverTargeting', true);
-  let handleRtd = deepAccess(moduleConfig, 'params.handleRtd', null);
+  const adserverTargeting = deepAccess(moduleConfig, 'params.adserverTargeting', true);
+  const handleRtd = deepAccess(moduleConfig, 'params.handleRtd', null);
 
   // If present, trim the bundle URL
   if (typeof bundleUrl === 'string') {
@@ -37,6 +37,35 @@ export const parseConfig = (moduleConfig) => {
   return {bundleUrl, adserverTargeting, handleRtd};
 }
 
+/**
+ * Wait for Optable SDK event to fire with targeting data
+ * @param {string} eventName Name of the event to listen for
+ * @returns {Promise<Object|null>} Promise that resolves with targeting data or null
+ */
+const waitForOptableEvent = (eventName) => {
+  return new Promise((resolve) => {
+    const optableBundle = /** @type {Object} */ (window.optable);
+    const cachedData = optableBundle?.instance?.targetingFromCache();
+
+    if (cachedData && cachedData.ortb2) {
+      logMessage('Optable SDK already has cached data');
+      resolve(cachedData);
+      return;
+    }
+
+    const eventListener = (event) => {
+      logMessage(`Received ${eventName} event`);
+      // Extract targeting data from event detail
+      const targetingData = event.detail;
+      window.removeEventListener(eventName, eventListener);
+      resolve(targetingData);
+    };
+
+    window.addEventListener(eventName, eventListener);
+    logMessage(`Waiting for ${eventName} event`);
+  });
+};
+
 /**
  * Default function to handle/enrich RTD data
  * @param reqBidsConfigObj Bid request configuration object
@@ -45,15 +74,8 @@ export const parseConfig = (moduleConfig) => {
  * @returns {Promise<void>}
  */
 export const defaultHandleRtd = async (reqBidsConfigObj, optableExtraData, mergeFn) => {
-  const optableBundle = /** @type {Object} */ (window.optable);
-  // Get targeting data from cache, if available
-  let targetingData = optableBundle?.instance?.targetingFromCache();
-  // If no targeting data is found in the cache, call the targeting function
-  if (!targetingData) {
-    // Call Optable DCN for targeting data and return the ORTB2 object
-    targetingData = await optableBundle?.instance?.targeting();
-  }
-  logMessage('Original targeting data from targeting(): ', targetingData);
+  // Wait for the Optable SDK to dispatch targeting data via event
+  let targetingData = await waitForOptableEvent('optable-targeting:change');
 
   if (!targetingData || !targetingData.ortb2) {
     logWarn('No targeting data found');
@@ -92,7 +114,6 @@ export const getBidRequestData = (reqBidsConfigObj, callback, moduleConfig, user
   try {
     // Extract the bundle URL from the module configuration
     const {bundleUrl, handleRtd} = parseConfig(moduleConfig);
-
     const handleRtdFn = handleRtd || defaultHandleRtd;
     const optableExtraData = config.getConfig('optableRtdConfig') || {};