prebid.js 9.2.0 → 9.4.0

package/modules/consentManagementGpp.js

@@ -7,12 +7,12 @@
 import {deepSetValue, isEmpty, isNumber, isPlainObject, isStr, logError, logInfo, logWarn} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {gppDataHandler} from '../src/adapterManager.js';
-import {timedAuctionHook} from '../src/utils/perfMetrics.js';
 import {enrichFPD} from '../src/fpd/enrichment.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 import {cmpClient, MODE_CALLBACK} from '../libraries/cmp/cmpClient.js';
 import {GreedyPromise} from '../src/utils/promise.js';
 import {buildActivityParams} from '../src/activities/params.js';
+import {consentManagementHook} from '../libraries/consentManagement/cmUtils.js';
 
 const DEFAULT_CMP = 'iab';
 const DEFAULT_CONSENT_TIMEOUT = 10000;
@@ -228,20 +228,6 @@ function loadConsentData(cb) {
   }
 }
 
-/**
- * Like `loadConsentData`, but cache and re-use previously loaded data.
- * @param cb
- */
-function loadIfMissing(cb) {
-  if (consentData) {
-    logInfo('User consent information already known.  Pulling internally stored information...');
-    // eslint-disable-next-line standard/no-callback-literal
-    cb(false);
-  } else {
-    loadConsentData(cb);
-  }
-}
-
 /**
  * If consentManagement module is enabled (ie included in setConfig), this hook function will attempt to fetch the
  * user's encoded consent string from the supported CMP.  Once obtained, the module will store this
@@ -250,29 +236,7 @@ function loadIfMissing(cb) {
  * @param {object} reqBidsConfigObj required; This is the same param that's used in pbjs.requestBids.
  * @param {function} fn required; The next function in the chain, used by hook.js
  */
-export const requestBidsHook = timedAuctionHook('gpp', function requestBidsHook(fn, reqBidsConfigObj) {
-  loadIfMissing(function (shouldCancelAuction, errMsg, ...extraArgs) {
-    if (errMsg) {
-      let log = logWarn;
-      if (shouldCancelAuction) {
-        log = logError;
-        errMsg = `${errMsg} Canceling auction as per consentManagement config.`;
-      }
-      log(errMsg, ...extraArgs);
-    }
-
-    if (shouldCancelAuction) {
-      fn.stopTiming();
-      if (typeof reqBidsConfigObj.bidsBackHandler === 'function') {
-        reqBidsConfigObj.bidsBackHandler();
-      } else {
-        logError('Error executing bidsBackHandler');
-      }
-    } else {
-      fn.call(this, reqBidsConfigObj);
-    }
-  });
-});
+export const requestBidsHook = consentManagementHook('gpp', () => consentData, loadConsentData);
 
 function processCmpData(consentData) {
   if (

package/modules/consentManagementTcf.js

@@ -8,11 +8,11 @@ import {deepSetValue, isNumber, isPlainObject, isStr, logError, logInfo, logWarn
 import {config} from '../src/config.js';
 import {gdprDataHandler} from '../src/adapterManager.js';
 import {includes} from '../src/polyfill.js';
-import {timedAuctionHook} from '../src/utils/perfMetrics.js';
 import {registerOrtbProcessor, REQUEST} from '../src/pbjsORTB.js';
 import {enrichFPD} from '../src/fpd/enrichment.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 import {cmpClient} from '../libraries/cmp/cmpClient.js';
+import {consentManagementHook} from '../libraries/consentManagement/cmUtils.js';
 
 const DEFAULT_CMP = 'iab';
 const DEFAULT_CONSENT_TIMEOUT = 10000;
@@ -22,6 +22,7 @@ export let userCMP;
 export let consentTimeout;
 export let gdprScope;
 export let staticConsentData;
+let dsaPlatform = false;
 let actionTimeout;
 
 let consentData;
@@ -156,20 +157,6 @@ function loadConsentData(cb) {
   }
 }
 
-/**
- * Like `loadConsentData`, but cache and re-use previously loaded data.
- * @param cb
- */
-function loadIfMissing(cb) {
-  if (consentData) {
-    logInfo('User consent information already known.  Pulling internally stored information...');
-    // eslint-disable-next-line standard/no-callback-literal
-    cb(false);
-  } else {
-    loadConsentData(cb);
-  }
-}
-
 /**
  * If consentManagement module is enabled (ie included in setConfig), this hook function will attempt to fetch the
  * user's encoded consent string from the supported CMP.  Once obtained, the module will store this
@@ -178,29 +165,7 @@ function loadIfMissing(cb) {
  * @param {object} reqBidsConfigObj required; This is the same param that's used in pbjs.requestBids.
  * @param {function} fn required; The next function in the chain, used by hook.js
  */
-export const requestBidsHook = timedAuctionHook('gdpr', function requestBidsHook(fn, reqBidsConfigObj) {
-  loadIfMissing(function (shouldCancelAuction, errMsg, ...extraArgs) {
-    if (errMsg) {
-      let log = logWarn;
-      if (shouldCancelAuction) {
-        log = logError;
-        errMsg = `${errMsg} Canceling auction as per consentManagement config.`;
-      }
-      log(errMsg, ...extraArgs);
-    }
-
-    if (shouldCancelAuction) {
-      fn.stopTiming();
-      if (typeof reqBidsConfigObj.bidsBackHandler === 'function') {
-        reqBidsConfigObj.bidsBackHandler();
-      } else {
-        logError('Error executing bidsBackHandler');
-      }
-    } else {
-      fn.call(this, reqBidsConfigObj);
-    }
-  });
-});
+export const requestBidsHook = consentManagementHook('gdpr', () => consentData, loadConsentData);
 
 /**
  * This function checks the consent data provided by CMP to ensure it's in an expected state.
@@ -282,6 +247,7 @@ export function setConsentConfig(config) {
 
   // if true, then gdprApplies should be set to true
   gdprScope = config.defaultGdprScope === true;
+  dsaPlatform = !!config.dsaPlatform;
 
   logInfo('consentManagement module has been activated...');
 
@@ -315,6 +281,9 @@ export function enrichFPDHook(next, fpd) {
       }
       deepSetValue(ortb2, 'user.ext.consent', consent.consentString);
     }
+    if (dsaPlatform) {
+      deepSetValue(ortb2, 'regs.ext.dsa.dsarequired', 3);
+    }
     return ortb2;
   }));
 }

package/modules/conversantAnalyticsAdapter.js

@@ -1,7 +1,6 @@
 import {ajax} from '../src/ajax.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import { EVENTS } from '../src/constants.js';
-import {getGlobal} from '../src/prebidGlobal.js';
 import adapterManager from '../src/adapterManager.js';
 import {logInfo, logWarn, logError, logMessage, deepAccess, isInteger} from '../src/utils.js';
 import {getRefererInfo} from '../src/refererDetection.js';
@@ -515,7 +514,7 @@ cnvrHelper.createPayload = function(payloadType, auctionId, timestamp) {
     cnvrSampleRate: initOptions.cnvr_sample_rate,
     auction: {
       auctionId: auctionId,
-      preBidVersion: getGlobal().version,
+      preBidVersion: '$prebid.version$',
       sid: initOptions.site_id,
       auctionTimestamp: timestamp
     },

package/modules/copper6sspBidAdapter.js

@@ -0,0 +1,19 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+import { isBidRequestValid, buildRequests, interpretResponse, getUserSyncs } from '../libraries/teqblazeUtils/bidderUtils.js';
+
+const BIDDER_CODE = 'copper6ssp';
+const AD_URL = 'https://endpoint.copper6.com/pbjs';
+const SYNC_URL = 'https://сsync.copper6.com';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: isBidRequestValid(),
+  buildRequests: buildRequests(AD_URL),
+  interpretResponse,
+  getUserSyncs: getUserSyncs(SYNC_URL)
+};
+
+registerBidder(spec);

package/modules/copper6sspBidAdapter.md

@@ -0,0 +1,79 @@
+# Overview
+
+```
+Module Name: Copper6SSP Bidder Adapter
+Module Type: Copper6SSP Bidder Adapter
+Maintainer: info@copper6.com
+```
+
+# Description
+
+Connects to Copper6SSP exchange for bids.
+Copper6SSP bid adapter supports Banner, Video (instream and outstream) and Native.
+
+# Test Parameters
+```
+    var adUnits = [
+                // Will return static test banner
+                {
+                    code: 'adunit1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [ [300, 250], [320, 50] ],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'copper6ssp',
+                            params: {
+                                placementId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit2',
+                    mediaTypes: {
+                        video: {
+                            playerSize: [ [640, 480] ],
+                            context: 'instream',
+                            minduration: 5,
+                            maxduration: 60,
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'copper6ssp',
+                            params: {
+                                placementId: 'testVideo',
+                            }
+                        }
+                    ]
+                },
+                {
+                    code: 'addunit3',
+                    mediaTypes: {
+                        native: {
+                            title: {
+                                required: true
+                            },
+                            body: {
+                                required: true
+                            },
+                            icon: {
+                                required: true,
+                                size: [64, 64]
+                            }
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'copper6ssp',
+                            params: {
+                                placementId: 'testNative',
+                            }
+                        }
+                    ]
+                }
+            ];
+```

package/modules/cpmstarBidAdapter.js

@@ -1,8 +1,8 @@
 import * as utils 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 {getBidIdParameter} from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { VIDEO, BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
 
 const BIDDER_CODE = 'cpmstar';
 
@@ -12,15 +12,18 @@ const ENDPOINT_PRODUCTION = 'https://server.cpmstar.com/view.aspx';
 
 const DEFAULT_TTL = 300;
 const DEFAULT_CURRENCY = 'USD';
+const DEFAULT_NET_REVENUE = true;
 
-function fixedEncodeURIComponent(str) {
-  return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
-    return '%' + c.charCodeAt(0).toString(16);
-  });
-}
+export const converter = ortbConverter({
+  context: {
+    ttl: DEFAULT_TTL,
+    netRevenue: DEFAULT_NET_REVENUE
+  }
+});
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: 1317,
   supportedMediaTypes: [BANNER, VIDEO],
   pageID: Math.floor(Math.random() * 10e6),
 
@@ -43,22 +46,30 @@ export const spec = {
 
   buildRequests: function (validBidRequests, bidderRequest) {
     var requests = [];
-    // This reference to window.top can cause issues when loaded in an iframe if not protected with a try/catch.
 
     for (var i = 0; i < validBidRequests.length; i++) {
       var bidRequest = validBidRequests[i];
-      var referer = bidderRequest.refererInfo.page ? bidderRequest.refererInfo.page : bidderRequest.refererInfo.domain;
-      referer = encodeURIComponent(referer);
-      var e = getBidIdParameter('endpoint', bidRequest.params);
-      var ENDPOINT = e == 'dev' ? ENDPOINT_DEV : e == 'staging' ? ENDPOINT_STAGING : ENDPOINT_PRODUCTION;
-      var mediaType = spec.getMediaType(bidRequest);
-      var playerSize = spec.getPlayerSize(bidRequest);
-      var videoArgs = '&fv=0' + (playerSize ? ('&w=' + playerSize[0] + '&h=' + playerSize[1]) : '');
-      var url = ENDPOINT + '?media=' + mediaType + (mediaType == VIDEO ? videoArgs : '') +
-        '&json=c_b&mv=1&poolid=' + getBidIdParameter('placementId', bidRequest.params) +
-        '&reachedTop=' + encodeURIComponent(bidderRequest.refererInfo.reachedTop) +
-        '&requestid=' + bidRequest.bidId +
-        '&referer=' + encodeURIComponent(referer);
+      const referer = bidderRequest.refererInfo.page ? bidderRequest.refererInfo.page : bidderRequest.refererInfo.domain;
+      const e = utils.getBidIdParameter('endpoint', bidRequest.params);
+      const ENDPOINT = e == 'dev' ? ENDPOINT_DEV : e == 'staging' ? ENDPOINT_STAGING : ENDPOINT_PRODUCTION;
+      const url = new URL(ENDPOINT);
+      const body = {};
+      const mediaType = spec.getMediaType(bidRequest);
+      const playerSize = spec.getPlayerSize(bidRequest);
+      url.searchParams.set('media', mediaType);
+      if (mediaType == VIDEO) {
+        url.searchParams.set('fv', 0);
+        if (playerSize) {
+          url.searchParams.set('w', playerSize?.[0]);
+          url.searchParams.set('h', playerSize?.[1]);
+        }
+      }
+      url.searchParams.set('json', 'c_b');
+      url.searchParams.set('mv', 1);
+      url.searchParams.set('poolid', utils.getBidIdParameter('placementId', bidRequest.params));
+      url.searchParams.set('reachedTop', bidderRequest.refererInfo.reachedTop);
+      url.searchParams.set('requestid', bidRequest.bidId);
+      url.searchParams.set('referer', referer);
 
       if (bidRequest.schain && bidRequest.schain.nodes) {
         var schain = bidRequest.schain;
@@ -67,45 +78,49 @@ export const spec = {
         for (var i2 = 0; i2 < schain.nodes.length; i2++) {
           var node = schain.nodes[i2];
           schainString += '!' +
-            fixedEncodeURIComponent(node.asi || '') + ',' +
-            fixedEncodeURIComponent(node.sid || '') + ',' +
-            fixedEncodeURIComponent(node.hp || '') + ',' +
-            fixedEncodeURIComponent(node.rid || '') + ',' +
-            fixedEncodeURIComponent(node.name || '') + ',' +
-            fixedEncodeURIComponent(node.domain || '');
+            (node.asi || '') + ',' +
+            (node.sid || '') + ',' +
+            (node.hp || '') + ',' +
+            (node.rid || '') + ',' +
+            (node.name || '') + ',' +
+            (node.domain || '');
         }
-        url += '&schain=' + schainString;
+        url.searchParams.set('schain', schainString);
       }
 
       if (bidderRequest.gdprConsent) {
         if (bidderRequest.gdprConsent.consentString != null) {
-          url += '&gdpr_consent=' + bidderRequest.gdprConsent.consentString;
+          url.searchParams.set('gdpr_consent', bidderRequest.gdprConsent.consentString);
         }
         if (bidderRequest.gdprConsent.gdprApplies != null) {
-          url += '&gdpr=' + (bidderRequest.gdprConsent.gdprApplies ? 1 : 0);
+          url.searchParams.set('gdpr', (bidderRequest.gdprConsent.gdprApplies ? 1 : 0));
         }
       }
 
       if (bidderRequest.uspConsent != null) {
-        url += '&us_privacy=' + bidderRequest.uspConsent;
+        url.searchParams.set('us_privacy', bidderRequest.uspConsent);
       }
 
       if (config.getConfig('coppa')) {
-        url += '&tfcd=' + (config.getConfig('coppa') ? 1 : 0);
+        url.searchParams.set('tfcd', (config.getConfig('coppa') ? 1 : 0));
       }
 
-      let body = {};
       let adUnitCode = bidRequest.adUnitCode;
       if (adUnitCode) {
         body.adUnitCode = adUnitCode;
       }
       if (mediaType == VIDEO) {
         body.video = utils.deepAccess(bidRequest, 'mediaTypes.video');
+      } else if (mediaType == BANNER) {
+        body.banner = utils.deepAccess(bidRequest, 'mediaTypes.banner');
       }
 
+      const ortb = converter.toORTB({ bidderRequest, bidRequests: [bidRequest] });
+      Object.assign(body, ortb);
+
       requests.push({
         method: 'POST',
-        url: url,
+        url: url.toString(),
         bidRequest: bidRequest,
         data: body
       });
@@ -144,7 +159,7 @@ export const spec = {
         width: rawBid.width || 0,
         height: rawBid.height || 0,
         currency: rawBid.currency ? rawBid.currency : DEFAULT_CURRENCY,
-        netRevenue: rawBid.netRevenue ? rawBid.netRevenue : true,
+        netRevenue: rawBid.netRevenue ? rawBid.netRevenue : DEFAULT_NET_REVENUE,
         ttl: rawBid.ttl ? rawBid.ttl : DEFAULT_TTL,
         creativeId: rawBid.creativeid || 0,
         meta: {
@@ -191,4 +206,5 @@ export const spec = {
   }
 
 };
+
 registerBidder(spec);

package/modules/cpmstarBidAdapter.md

@@ -3,10 +3,7 @@
 ```
 Module Name: Cpmstar Bidder Adapter
 Module Type: Bidder Adapter
-Maintainer: josh@cpmstar.com
-gdpr_supported: true
-usp_supported: true
-coppa_supported: true
+Maintainer: prebid@cpmstar.com
 ```
 
 # Description

package/modules/criteoBidAdapter.js

@@ -540,9 +540,16 @@ function hasValidVideoMediaType(bidRequest) {
   var requiredMediaTypesParams = ['mimes', 'playerSize', 'maxduration', 'protocols', 'api', 'skip', 'placement', 'playbackmethod'];
 
   requiredMediaTypesParams.forEach(function (param) {
-    if (deepAccess(bidRequest, 'mediaTypes.video.' + param) === undefined && deepAccess(bidRequest, 'params.video.' + param) === undefined) {
-      isValid = false;
-      logError('Criteo Bid Adapter: mediaTypes.video.' + param + ' is required');
+    if (param === 'placement') {
+      if (deepAccess(bidRequest, 'mediaTypes.video.' + param) === undefined && deepAccess(bidRequest, 'params.video.' + param) === undefined && deepAccess(bidRequest, 'mediaTypes.video.plcmt') === undefined && deepAccess(bidRequest, 'params.video.plcmt') === undefined) {
+        isValid = false;
+        logError('Criteo Bid Adapter: mediaTypes.video.' + param + ' or mediaTypes.video.plcmt is required');
+      }
+    } else {
+      if (deepAccess(bidRequest, 'mediaTypes.video.' + param) === undefined && deepAccess(bidRequest, 'params.video.' + param) === undefined) {
+        isValid = false;
+        logError('Criteo Bid Adapter: mediaTypes.video.' + param + ' is required');
+      }
     }
   });
 

package/modules/dailymotionBidAdapter.js

@@ -224,7 +224,7 @@ export const spec = {
       const pixelSyncs = [];
 
       serverResponses.forEach((response) => {
-        (response.user_syncs || []).forEach((syncUrl) => {
+        (response?.body?.userSyncs || []).forEach((syncUrl) => {
           if (syncUrl.type === 'image') {
             pixelSyncs.push({ url: syncUrl.url, type: 'image' });
           }

package/modules/deltaprojectsBidAdapter.js

@@ -8,7 +8,8 @@ import {
   isFn,
   isNumber,
   logError,
-  logWarn
+  logWarn,
+  setOnAny
 } from '../src/utils.js';
 import {config} from '../src/config.js';
 
@@ -234,16 +235,6 @@ export function getBidFloor(bid, mediaType, size, currency) {
   }
 }
 
-/** -- Helper methods -- */
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
 /** -- Register -- */
 export const spec = {
   code: BIDDER_CODE,

package/modules/dianomiBidAdapter.js

@@ -10,6 +10,7 @@ import {
   parseSizesInput,
   deepSetValue,
   formatQS,
+  setOnAny
 } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { Renderer } from '../src/Renderer.js';
@@ -355,15 +356,6 @@ function parseNative(bid) {
   return result;
 }
 
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
 function flatten(arr) {
   return [].concat(...arr);
 }

package/modules/finativeBidAdapter.js

@@ -3,7 +3,7 @@
 
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {NATIVE} from '../src/mediaTypes.js';
-import {_map, deepAccess, deepSetValue, isEmpty} from '../src/utils.js';
+import {_map, deepSetValue, isEmpty, setOnAny} from '../src/utils.js';
 import {config} from '../src/config.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 
@@ -224,15 +224,6 @@ function parseNative(bid) {
   return result;
 }
 
-function setOnAny(collection, key) {
-  for (let i = 0, result; i < collection.length; i++) {
-    result = deepAccess(collection[i], key);
-    if (result) {
-      return result;
-    }
-  }
-}
-
 function flatten(arr) {
   return [].concat(...arr);
 }

package/modules/gridBidAdapter.js

@@ -15,6 +15,7 @@ import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 import { getStorageManager } from '../src/storageManager.js';
+import { getBidFromResponse } from '../libraries/processResponse/index.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -441,7 +442,7 @@ export const spec = {
 
     if (!errorMessage && serverResponse.seatbid) {
       serverResponse.seatbid.forEach(respItem => {
-        _addBidResponse(_getBidFromResponse(respItem), bidRequest, bidResponses, RendererConst, bidderCode);
+        _addBidResponse(getBidFromResponse(respItem, LOG_ERROR_MESS), bidRequest, bidResponses, RendererConst, bidderCode);
       });
     }
     if (errorMessage) logError(errorMessage);
@@ -512,17 +513,6 @@ function _getFloor (mediaTypes, bid) {
   return floor;
 }
 
-function _getBidFromResponse(respItem) {
-  if (!respItem) {
-    logError(LOG_ERROR_MESS.emptySeatbid);
-  } else if (!respItem.bid) {
-    logError(LOG_ERROR_MESS.hasNoArrayOfBids + JSON.stringify(respItem));
-  } else if (!respItem.bid[0]) {
-    logError(LOG_ERROR_MESS.noBid);
-  }
-  return respItem && respItem.bid && respItem.bid[0];
-}
-
 function _addBidResponse(serverBid, bidRequest, bidResponses, RendererConst, bidderCode) {
   if (!serverBid) return;
   let errorMessage;

package/modules/id5AnalyticsAdapter.js

@@ -4,7 +4,6 @@ import adapterManager from '../src/adapterManager.js';
 import { ajax } from '../src/ajax.js';
 import { logInfo, logError } from '../src/utils.js';
 import * as events from '../src/events.js';
-import {getGlobal} from '../src/prebidGlobal.js';
 
 const {
   AUCTION_END,
@@ -33,7 +32,7 @@ const FLUSH_EVENTS = [
 
 const CONFIG_URL_PREFIX = 'https://api.id5-sync.com/analytics'
 const TZ = new Date().getTimezoneOffset();
-const PBJS_VERSION = getGlobal().version;
+const PBJS_VERSION = 'v' + '$prebid.version$';
 const ID5_REDACTED = '__ID5_REDACTED__';
 const isArray = Array.isArray;