prebid.js 9.5.0 → 9.7.0

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

@@ -687,7 +687,8 @@ function _createImpressionObject(bid, bidderRequest) {
     },
     bidfloorcur: bid.params.currency ? _parseSlotParam('currency', bid.params.currency) : DEFAULT_CURRENCY,
     displaymanager: 'Prebid.js',
-    displaymanagerver: '$prebid.version$' // prebid version
+    displaymanagerver: '$prebid.version$', // prebid version
+    pmp: bid.ortb2Imp?.pmp || undefined
   };
 
   _addPMPDealsInImpression(impObj, bid);

package/modules/resetdigitalBidAdapter.md

@@ -3,7 +3,7 @@
 ```
 Module Name: ResetDigital Bidder Adapter
 Module Type: Bidder Adapter
-Maintainer: bruce@resetdigital.co
+Maintainer: BidderSupport@resetdigital.co
 ```
 
 # Description
@@ -15,49 +15,58 @@ Video is supported but requires a publisher supplied renderer at this time.
 
 ## Web
 ```
-    var adUnits = [
-           {
-               code: 'your-div',
-               mediaTypes: {
-                   banner: {
-                       sizes: [[300,250]]
-                   },
-                   
-               },
-               bids: [
-                   {
-                       bidder: "resetdigital",
-                       params: {
-                           pubId: "your-pub-id",
-                           site_id: "your-site-id",
-                           forceBid: true,
-                       }
-                   }
-               ]
-           }
-       ];
-
-
-    var videoAdUnits = [
-           {
-               code: 'your-div',
-               mediaTypes: {
-                   video: {
-                        playerSize: [640, 480]
-                   },
-                   
-               },
-               bids: [
-                   {
-                       bidder: "resetdigital",
-                       params: {
-                           pubId: "your-pub-id",
-                           site_id: "your-site-id",
-                           forceBid: true,
-                       }
-                   }
-               ]
-           }
-       ];
+// Define the ad units for banner ads
+var adUnits = [
+    {
+        code: 'your-div', // Replace with the actual ad unit code
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]] // Define the sizes for banner ads
+            }
+        },
+        bids: [
+            {
+                bidder: "resetdigital",
+                params: {
+                    pubId: "your-pub-id", // (required) Replace with your publisher ID
+                    site_id: "your-site-id", // Replace with your site ID
+                    endpoint: 'https://ads.resetsrv.com', // (optional) Endpoint URL for the ad server
+                    forceBid: true, // Optional parameter to force the bid
+                    zoneId: { // (optional) Zone ID parameters
+                        placementId: "<id>", // Optional ID used for reports
+                        deals: "<deal ids>", // Optional string of deal IDs, comma-separated
+                        test: 1 // Set to 1 to force the bidder to respond with a creative
+                    }
+                }
+            }
+        ]
+    }
+];
 
+// Define the ad units for video ads
+var videoAdUnits = [
+    {
+        code: 'your-div', // Replace with the actual video ad unit code
+        mediaTypes: {
+            video: {
+                playerSize: [640, 480] // Define the player size for video ads
+            }
+        },
+        bids: [
+            {
+                bidder: "resetdigital",
+                params: {
+                    pubId: "your-pub-id", // (required) Replace with your publisher ID
+                    site_id: "your-site-id", // Replace with your site ID
+                    forceBid: true, // Optional parameter to force the bid
+                    zoneId: { // (optional) Zone ID parameters
+                        placementId: "<id>", // Optional ID used for reports
+                        deals: "<deal ids>", // Optional string of deal IDs, comma-separated
+                        test: 1 // Set to 1 to force the bidder to respond with a creative
+                    }
+                }
+            }
+        ]
+    }
+];
 ```