prebid.js 9.4.1 → 9.6.0

package/modules/permutiveRtdProvider.js

@@ -95,7 +95,8 @@ export function getModuleConfig(customModuleConfig) {
 /**
  * Sets ortb2 config for ac bidders
  * @param {Object} bidderOrtb2 - The ortb2 object for the all bidders
- * @param {Object} customModuleConfig - Publisher config for module
+ * @param {Object} moduleConfig - Publisher config for module
+ * @param {Object} segmentData - Segment data grouped by bidder or type
  */
 export function setBidderRtb (bidderOrtb2, moduleConfig, segmentData) {
   const acBidders = deepAccess(moduleConfig, 'params.acBidders')
@@ -129,13 +130,13 @@ export function setBidderRtb (bidderOrtb2, moduleConfig, segmentData) {
 
 /**
  * Updates `user.data` object in existing bidder config with Permutive segments
- * @param string bidder - The bidder
+ * @param {string} bidder - The bidder identifier
  * @param {Object} currConfig - Current bidder config
- * @param {Object[]} transformationConfigs - array of objects with `id` and `config` properties, used to determine
- *                                           the transformations on user data to include the ORTB2 object
  * @param {string[]} segmentIDs - Permutive segment IDs
  * @param {string[]} sspSegmentIDs - Permutive SSP segment IDs
  * @param {Object} topics - Privacy Sandbox Topics, keyed by IAB taxonomy version (600, 601, etc.)
+ * @param {Object[]} transformationConfigs - array of objects with `id` and `config` properties, used to determine
+ *                                           the transformations on user data to include the ORTB2 object
  * @param {Object} segmentData - The segments available for targeting
  * @return {Object} Merged ortb2 object
  */
@@ -270,7 +271,7 @@ function setSegments (reqBidsConfigObj, moduleConfig, segmentData) {
  */
 function makeSafe (fn) {
   try {
-    fn()
+    return fn()
   } catch (e) {
     logError(e)
   }
@@ -310,23 +311,71 @@ export function isPermutiveOnPage () {
  * @param {number} maxSegs - Maximum number of segments to be included
  * @return {Object}
  */
-export function getSegments (maxSegs) {
-  const legacySegs = readSegments('_psegs', []).map(Number).filter(seg => seg >= 1000000).map(String)
-  const _ppam = readSegments('_ppam', [])
-  const _pcrprs = readSegments('_pcrprs', [])
-
+export function getSegments(maxSegs) {
   const segments = {
-    ac: [..._pcrprs, ..._ppam, ...legacySegs],
-    ix: readSegments('_pindexs', []),
-    rubicon: readSegments('_prubicons', []),
-    appnexus: readSegments('_papns', []),
-    gam: readSegments('_pdfps', []),
-    ssp: readSegments('_pssps', {
-      cohorts: [],
-      ssps: []
+    ac:
+      makeSafe(() => {
+        const legacySegs =
+          makeSafe(() =>
+            readSegments('_psegs', [])
+              .map(Number)
+              .filter((seg) => seg >= 1000000)
+              .map(String),
+          ) || [];
+        const _ppam = makeSafe(() => readSegments('_ppam', []).map(String)) || [];
+        const _pcrprs = makeSafe(() => readSegments('_pcrprs', []).map(String)) || [];
+
+        return [..._pcrprs, ..._ppam, ...legacySegs];
+      }) || [],
+
+    ix:
+      makeSafe(() => {
+        const _pindexs = readSegments('_pindexs', []);
+        return _pindexs.map(String);
+      }) || [],
+
+    rubicon:
+      makeSafe(() => {
+        const _prubicons = readSegments('_prubicons', []);
+        return _prubicons.map(String);
+      }) || [],
+
+    appnexus:
+      makeSafe(() => {
+        const _papns = readSegments('_papns', []);
+        return _papns.map(String);
+      }) || [],
+
+    gam:
+      makeSafe(() => {
+        const _pdfps = readSegments('_pdfps', []);
+        return _pdfps.map(String);
+      }) || [],
+
+    ssp: makeSafe(() => {
+      const _pssps = readSegments('_pssps', {
+        cohorts: [],
+        ssps: [],
+      });
+
+      return {
+        cohorts: makeSafe(() => _pssps.cohorts.map(String)) || [],
+        ssps: makeSafe(() => _pssps.ssps.map(String)) || [],
+      };
     }),
-    topics: readSegments('_ppsts', {}),
-  }
+
+    topics:
+      makeSafe(() => {
+        const _ppsts = readSegments('_ppsts', {});
+
+        const topics = {};
+        for (const [k, value] of Object.entries(_ppsts)) {
+          topics[k] = makeSafe(() => value.map(String)) || [];
+        }
+
+        return topics;
+      }) || {},
+  };
 
   for (const bidder in segments) {
     if (bidder === 'ssp') {
@@ -342,7 +391,8 @@ export function getSegments (maxSegs) {
     }
   }
 
-  return segments
+  logger.logInfo(`Read segments`, segments)
+  return segments;
 }
 
 /**
@@ -393,7 +443,7 @@ function iabSegmentId(permutiveSegmentId, iabIds) {
  * Pull the latest configuration and cohort information and update accordingly.
  *
  * @param reqBidsConfigObj - Bidder provided config for request
- * @param customModuleConfig - Publisher provide config
+ * @param moduleConfig - Publisher provided config
  */
 export function readAndSetCohorts(reqBidsConfigObj, moduleConfig) {
   const segmentData = getSegments(deepAccess(moduleConfig, 'params.maxSegs'))

package/modules/playdigoBidAdapter.js

@@ -1,9 +1,10 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
-import { isBidRequestValid, buildRequests, interpretResponse } from '../libraries/teqblazeUtils/bidderUtils.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
 
 const BIDDER_CODE = 'playdigo';
 const AD_URL = 'https://server.playdigo.com/pbjs';
+const SYNC_URL = 'https://cs.playdigo.com';
 
 export const spec = {
   code: BIDDER_CODE,
@@ -11,7 +12,8 @@ export const spec = {
 
   isBidRequestValid: isBidRequestValid(),
   buildRequests: buildRequests(AD_URL),
-  interpretResponse
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
 };
 
 registerBidder(spec);

package/modules/prebidServerBidAdapter/index.js

@@ -25,7 +25,7 @@ import {includes} from '../../src/polyfill.js';
 import {S2S_VENDORS} from './config.js';
 import {ajax} from '../../src/ajax.js';
 import {hook} from '../../src/hook.js';
-import {hasPurpose1Consent} from '../../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../../src/utils/gdpr.js';
 import {buildPBSRequest, interpretPBSResponse} from './ortbConverter.js';
 import {useMetrics} from '../../src/utils/perfMetrics.js';
 import {isActivityAllowed} from '../../src/activities/rules.js';
@@ -515,7 +515,9 @@ export function PrebidServer() {
           }
         },
         onFledge: (params) => {
-          addPaapiConfig({auctionId: bidRequests[0].auctionId, ...params}, {config: params.config});
+          config.runWithBidder(params.bidder, () => {
+            addPaapiConfig({auctionId: bidRequests[0].auctionId, ...params}, {config: params.config});
+          })
         }
       })
     }

package/modules/prebidServerBidAdapter/ortbConverter.js

@@ -241,6 +241,7 @@ const PBS_CONVERTER = ortbConverter({
               adUnitCode: impCtx.adUnit.code,
               ortb2: bidderReq?.ortb2,
               ortb2Imp: bidReq?.ortb2Imp,
+              bidder: cfg.bidder,
               config: cfg.config
             };
           }));

package/modules/programmaticaBidAdapter.js

@@ -1,6 +1,6 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
-import { hasPurpose1Consent } from '../src/utils/gpdr.js';
+import { hasPurpose1Consent } from '../src/utils/gdpr.js';
 import { deepAccess, parseSizesInput, isArray } from '../src/utils.js';
 
 const BIDDER_CODE = 'programmatica';

package/modules/publirBidAdapter.js

@@ -2,32 +2,26 @@ import {
   logWarn,
   logInfo,
   isArray,
-  isFn,
   deepAccess,
-  isEmpty,
-  contains,
   timestamp,
   triggerPixel,
-  getDNT,
-  getBidIdParameter
 } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
-import { config } from '../src/config.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { ajax } from '../src/ajax.js';
+import {
+  generateBidsParams,
+  generateGeneralParams,
+} from '../libraries/riseUtils/index.js';
 
 const SUPPORTED_AD_TYPES = [BANNER, VIDEO];
 const BIDDER_CODE = 'publir';
 const ADAPTER_VERSION = '1.0.0';
 const TTL = 360;
 const CURRENCY = 'USD';
-const DEFAULT_SELLER_ENDPOINT = 'https://prebid.publir.com/publirPrebidEndPoint';
+const BASE_URL = 'https://prebid.publir.com/publirPrebidEndPoint';
 const DEFAULT_IMPS_ENDPOINT = 'https://prebidimpst.publir.com/publirPrebidImpressionTracker';
-const SUPPORTED_SYNC_METHODS = {
-  IFRAME: 'iframe',
-  PIXEL: 'pixel'
-}
 
 export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
 export const spec = {
@@ -40,25 +34,26 @@ export const spec = {
       logWarn('pubId is a mandatory param for Publir adapter');
       return false;
     }
-
     return true;
   },
   buildRequests: function (validBidRequests, bidderRequest) {
-    const reqObj = {};
+    const combinedRequestsObject = {};
+
     const generalObject = validBidRequests[0];
-    reqObj.params = generatePubGeneralsParams(generalObject, bidderRequest);
-    reqObj.bids = generatePubBidParams(validBidRequests, bidderRequest);
-    reqObj.bids.timestamp = timestamp();
+    combinedRequestsObject.params = generateGeneralParams(generalObject, bidderRequest, ADAPTER_VERSION);
+    combinedRequestsObject.bids = generateBidsParams(validBidRequests, bidderRequest);
+    combinedRequestsObject.bids.timestamp = timestamp();
+
     let options = {
       withCredentials: false
     };
 
     return {
       method: 'POST',
-      url: DEFAULT_SELLER_ENDPOINT,
-      data: reqObj,
+      url: BASE_URL,
+      data: combinedRequestsObject,
       options
-    }
+    };
   },
   interpretResponse: function ({ body }) {
     const bidResponses = [];
@@ -109,20 +104,20 @@ export const spec = {
     const syncs = [];
     for (const response of serverResponses) {
       if (response.body && response.body.params) {
-        if (syncOptions.iframeEnabled && response.body.params.userSyncURL) {
+        if (syncOptions.iframeEnabled && deepAccess(response, 'body.params.userSyncURL')) {
           syncs.push({
             type: 'iframe',
-            url: response.body.params.userSyncURL
+            url: deepAccess(response, 'body.params.userSyncURL')
           });
         }
-        if (syncOptions.pixelEnabled && isArray(response.body.params.userSyncPixels)) {
+        if (syncOptions.pixelEnabled && isArray(deepAccess(response, 'body.params.userSyncPixels'))) {
           const pixels = response.body.params.userSyncPixels.map(pixel => {
             return {
               type: 'image',
               url: pixel
-            }
-          })
-          syncs.push(...pixels)
+            };
+          });
+          syncs.push(...pixels);
         }
       }
     }
@@ -141,251 +136,3 @@ export const spec = {
 };
 
 registerBidder(spec);
-
-/**
- * Get floor price
- * @param bid {bid}
- * @returns {Number}
- */
-function getFloor(bid, mediaType) {
-  if (!isFn(bid.getFloor)) {
-    return 0;
-  }
-  let floorResult = bid.getFloor({
-    currency: CURRENCY,
-    mediaType: mediaType,
-    size: '*'
-  });
-  return floorResult.currency === CURRENCY && floorResult.floor ? floorResult.floor : 0;
-}
-
-/**
- * Get the the ad sizes array from the bid
- * @param bid {bid}
- * @returns {Array}
- */
-function getSizesArray(bid, mediaType) {
-  let sizesArray = []
-
-  if (deepAccess(bid, `mediaTypes.${mediaType}.sizes`)) {
-    sizesArray = bid.mediaTypes[mediaType].sizes;
-  } else if (Array.isArray(bid.sizes) && bid.sizes.length > 0) {
-    sizesArray = bid.sizes;
-  }
-
-  return sizesArray;
-}
-
-/**
- * Get schain string value
- * @param schainObject {Object}
- * @returns {string}
- */
-function getSupplyChain(schainObject) {
-  if (isEmpty(schainObject)) {
-    return '';
-  }
-  let scStr = `${schainObject.ver},${schainObject.complete}`;
-  schainObject.nodes.forEach((node) => {
-    scStr += '!';
-    scStr += `${getEncodedValIfNotEmpty(node.asi)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.sid)},`;
-    scStr += `${node.hp ? encodeURIComponent(node.hp) : ''},`;
-    scStr += `${getEncodedValIfNotEmpty(node.rid)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.name)},`;
-    scStr += `${getEncodedValIfNotEmpty(node.domain)}`;
-  });
-  return scStr;
-}
-
-/**
- * Get encoded node value
- * @param val {string}
- * @returns {string}
- */
-function getEncodedValIfNotEmpty(val) {
-  return !isEmpty(val) ? encodeURIComponent(val) : '';
-}
-
-function getAllowedSyncMethod(filterSettings, bidderCode) {
-  const iframeConfigsToCheck = ['all', 'iframe'];
-  const pixelConfigToCheck = 'image';
-  if (filterSettings && iframeConfigsToCheck.some(config => isSyncMethodAllowed(filterSettings[config], bidderCode))) {
-    return SUPPORTED_SYNC_METHODS.IFRAME;
-  }
-  if (!filterSettings || !filterSettings[pixelConfigToCheck] || isSyncMethodAllowed(filterSettings[pixelConfigToCheck], bidderCode)) {
-    return SUPPORTED_SYNC_METHODS.PIXEL;
-  }
-}
-
-/**
- * Check if sync rule is supported
- * @param syncRule {Object}
- * @param bidderCode {string}
- * @returns {boolean}
- */
-function isSyncMethodAllowed(syncRule, bidderCode) {
-  if (!syncRule) {
-    return false;
-  }
-  const isInclude = syncRule.filter === 'include';
-  const bidders = isArray(syncRule.bidders) ? syncRule.bidders : [bidderCode];
-  return isInclude && contains(bidders, bidderCode);
-}
-
-/**
- * get device type
- * @param ua {ua}
- * @returns {string}
- */
-function getDeviceType(ua) {
-  if (/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i.test(ua.toLowerCase())) {
-    return '5';
-  }
-  if (/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i.test(ua.toLowerCase())) {
-    return '4';
-  }
-  if (/smart[-_\s]?tv|hbbtv|appletv|googletv|hdmi|netcast|viera|nettv|roku|\bdtv\b|sonydtv|inettvbrowser|\btv\b/i.test(ua.toLowerCase())) {
-    return '3';
-  }
-  return '1';
-}
-
-function generatePubBidParams(validBidRequests, bidderRequest) {
-  const bidsArray = [];
-
-  if (validBidRequests.length) {
-    validBidRequests.forEach(bid => {
-      bidsArray.push(generateBidParameters(bid, bidderRequest));
-    });
-  }
-  return bidsArray;
-}
-
-/**
- * Generate bid specific parameters
- * @param {bid} bid
- * @param {bidderRequest} bidderRequest
- * @returns {Object} bid specific params object
- */
-function generateBidParameters(bid, bidderRequest) {
-  const { params } = bid;
-  const mediaType = isBanner(bid) ? BANNER : VIDEO;
-  const sizesArray = getSizesArray(bid, mediaType);
-
-  // fix floor price in case of NAN
-  if (isNaN(params.floorPrice)) {
-    params.floorPrice = 0;
-  }
-
-  const bidObject = {
-    mediaType,
-    adUnitCode: getBidIdParameter('adUnitCode', bid),
-    sizes: sizesArray,
-    floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
-    bidId: getBidIdParameter('bidId', bid),
-    bidderRequestId: getBidIdParameter('bidderRequestId', bid),
-    loop: getBidIdParameter('bidderRequestsCount', bid),
-    transactionId: bid.ortb2Imp?.ext?.tid,
-    coppa: 0
-  };
-
-  const pubId = params.pubId;
-  if (pubId) {
-    bidObject.pubId = pubId;
-  }
-
-  const sua = deepAccess(bid, `ortb2.device.sua`);
-  if (sua) {
-    bidObject.sua = sua;
-  }
-
-  const coppa = deepAccess(bid, `ortb2.regs.coppa`)
-  if (coppa) {
-    bidObject.coppa = 1;
-  }
-
-  return bidObject;
-}
-
-function isBanner(bid) {
-  return bid.mediaTypes && bid.mediaTypes.banner;
-}
-
-function getLocalStorage(cookieObjName) {
-  if (storage.localStorageIsEnabled()) {
-    const lstData = storage.getDataFromLocalStorage(cookieObjName);
-    return lstData;
-  }
-  return '';
-}
-
-/**
- * Generate params that are common between all bids
- * @param generalObject
- * @param {bidderRequest} bidderRequest
- * @returns {object} the common params object
- */
-function generatePubGeneralsParams(generalObject, bidderRequest) {
-  const domain = bidderRequest.refererInfo;
-  const { syncEnabled, filterSettings } = config.getConfig('userSync') || {};
-  const { bidderCode } = bidderRequest;
-  const generalBidParams = generalObject.params;
-  const timeout = bidderRequest.timeout;
-  const generalParams = {
-    wrapper_type: 'prebidjs',
-    wrapper_vendor: '$$PREBID_GLOBAL$$',
-    wrapper_version: '$prebid.version$',
-    adapter_version: ADAPTER_VERSION,
-    auction_start: bidderRequest.auctionStart,
-    publisher_id: generalBidParams.pubId,
-    publisher_name: domain,
-    site_domain: domain,
-    dnt: getDNT() ? 1 : 0,
-    device_type: getDeviceType(navigator.userAgent),
-    ua: navigator.userAgent,
-    is_wrapper: !!generalBidParams.isWrapper,
-    session_id: generalBidParams.sessionId || getBidIdParameter('bidderRequestId', generalObject),
-    tmax: timeout,
-    user_cookie: getLocalStorage('_publir_prebid_creative')
-  };
-
-  const userIdsParam = getBidIdParameter('userId', generalObject);
-  if (userIdsParam) {
-    generalParams.userIds = JSON.stringify(userIdsParam);
-  }
-
-  const ortb2Metadata = bidderRequest.ortb2 || {};
-  if (ortb2Metadata.site) {
-    generalParams.site_metadata = JSON.stringify(ortb2Metadata.site);
-  }
-  if (ortb2Metadata.user) {
-    generalParams.user_metadata = JSON.stringify(ortb2Metadata.user);
-  }
-
-  if (syncEnabled) {
-    const allowedSyncMethod = getAllowedSyncMethod(filterSettings, bidderCode);
-    if (allowedSyncMethod) {
-      generalParams.cs_method = allowedSyncMethod;
-    }
-  }
-
-  if (bidderRequest.uspConsent) {
-    generalParams.us_privacy = bidderRequest.uspConsent;
-  }
-
-  if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
-    generalParams.gdpr = bidderRequest.gdprConsent.gdprApplies;
-    generalParams.gdpr_consent = bidderRequest.gdprConsent.consentString;
-  }
-
-  if (generalObject.schain) {
-    generalParams.schain = getSupplyChain(generalObject.schain);
-  }
-
-  if (bidderRequest && bidderRequest.refererInfo) {
-    generalParams.page_url = deepAccess(bidderRequest, 'refererInfo.page') || deepAccess(window, 'location.href');
-  }
-
-  return generalParams;
-}

package/modules/pubmaticBidAdapter.js

@@ -68,6 +68,10 @@ const NATIVE_ASSET_IMAGE_TYPE = {
   'IMAGE': 3
 }
 
+const BANNER_CUSTOM_PARAMS = {
+  'battr': DATA_TYPES.ARRAY
+}
+
 const NET_REVENUE = true;
 const dealChannelValues = {
   1: 'PMP',
@@ -551,6 +555,14 @@ function _createBannerRequest(bid) {
     }
     bannerObj.pos = 0;
     bannerObj.topframe = inIframe() ? 0 : 1;
+
+    // Adding Banner custom params
+    const bannerCustomParams = {...deepAccess(bid, 'ortb2Imp.banner')};
+    for (let key in BANNER_CUSTOM_PARAMS) {
+      if (bannerCustomParams.hasOwnProperty(key)) {
+        bannerObj[key] = _checkParamDataType(key, bannerCustomParams[key], BANNER_CUSTOM_PARAMS[key]);
+      }
+    }
   } else {
     logWarn(LOG_WARN_PREFIX + 'Error: mediaTypes.banner.size missing for adunit: ' + bid.params.adUnit + '. Ignoring the banner impression in the adunit.');
     bannerObj = UNDEFINED;