prebid.js 7.43.0 → 7.45.0

package/modules/openxBidAdapter.md

@@ -9,30 +9,31 @@ Maintainer: team-openx@openx.com
 # Description
 
 Module that connects to OpenX's demand sources.
-Note there is an updated version of the OpenX bid adapter called openxOrtbBidAdapter.
-Publishers are welcome to test the other adapter and give feedback. Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
+Note that this adapter mirrors openxOrtbBidAdapter and any updates must be
+completed in both adapters.
+openxOrtbBidAdapter will be removed in a future release and should not be used.
+Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
 
 # Bid Parameters
 ## Banner
 
-| Name                            | Scope    | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                   | Example                           |
-|---------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|
-| `delDomain` ~~or `platform`~~** | required | String  | OpenX delivery domain provided by your OpenX representative.                                                                                                                                                                                                                                                                                                                                                                  | "PUBLISHER-d.openx.net"           |
-| `unit`                          | required | String  | OpenX ad unit ID provided by your OpenX representative.                                                                                                                                                                                                                                                                                                                                                                       | "1611023122"                      |
-| `customParams`                  | optional | Object  | User-defined targeting key-value pairs. customParams applies to a specific unit.                                                                                                                                                                                                                                                                                                                                              | `{key1: "v1", key2: ["v2","v3"]}` |
-| `customFloor`                   | optional | Number  | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue<br/><br/>Note: OpenX suggests using the [Price Floor Module](https://docs.prebid.org/dev-docs/modules/floors.html) instead of customFloor. The Price Floor Module is prioritized over customFloor if both are present. | 1.50                              |
-| `doNotTrack`                    | optional | Boolean | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Request-level setting.  May impact revenue.                                                                                                                                                                                                                                                                                                   | true                              |
-| `coppa`                         | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations.                                                                                                                                                                                                                                                                                                                                                            | true                              |
-
-** platform is deprecated. Please use delDomain instead. If you have any questions please contact your representative. 
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `delDomain` or `platform` | required | String | OpenX delivery domain or platform id provided by your OpenX representative.  | "PUBLISHER-d.openx.net" or "555not5a-real-plat-form-id0123456789"
+| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
+| `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}`
+| `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 1.50
+| `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Request-level setting.  May impact revenue. | true
+| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. Use of `pbjs.setConfig({coppa: true});` is now preferred. | true
 
 ## Video
 
-| Name        | Scope    | Type               | Description                                                  | Example                                                        |
-|-------------|----------|--------------------|--------------------------------------------------------------|----------------------------------------------------------------|
-| `unit`      | required | String             | OpenX ad unit ID provided by your OpenX representative.      | "1611023122"                                                   |
-| `delDomain` | required | String             | OpenX delivery domain provided by your OpenX representative. | "PUBLISHER-d.openx.net"                                        |
-| `openrtb`   | optional | OpenRTB Impression | An OpenRtb Impression with Video subtype properties          | `{ imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] }` |
+| Name | Scope | Type | Description | Example
+| ---- | ----- | ---- | ----------- | -------
+| `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
+| `delDomain` | required | String |  OpenX delivery domain provided by your OpenX representative.  | "PUBLISHER-d.openx.net"
+| `video` | optional | OpenRTB video subtypes | Use of adUnit.mediaTypes.video is now preferred. | `{ video: {mimes: ['video/mp4']}`
+
 
 # Example
 ```javascript
@@ -70,7 +71,8 @@ var adUnits = [
     mediaTypes: {
       video: {
         playerSize: [640, 480],
-        context: 'instream'
+        context: 'instream',
+        mimes: ['video/x-ms-wmv, video/mp4']
       }
     },
     bids: [{
@@ -79,10 +81,10 @@ var adUnits = [
         unit: '1611023124',
         delDomain: 'PUBLISHER-d.openx.net',
         video: {
-          mimes: ['video/x-ms-wmv, video/mp4']
+          mimes: ['video/x-ms-wmv, video/mp4'] // mediaTypes.video preferred
         }
       }
-    }]
+    }]p
   }
 ];
 ```

package/modules/openxOrtbBidAdapter.js

@@ -29,13 +29,6 @@ const converter = ortbConverter({
   },
   imp(buildImp, bidRequest, context) {
     const imp = buildImp(bidRequest, context);
-    if (bidRequest.mediaTypes[VIDEO]?.context === 'outstream') {
-      imp.video.placement = imp.video.placement || 4;
-    }
-    if (imp.ext?.ae && !context.bidderRequest.fledgeEnabled) {
-      // TODO: we may want to standardize this and move fledge logic to ortbConverter
-      delete imp.ext.ae;
-    }
     mergeDeep(imp, {
       tagid: bidRequest.params.unit,
       ext: {
@@ -59,6 +52,9 @@ const converter = ortbConverter({
       }
     })
     const bid = context.bidRequests[0];
+    if (bid.params.coppa) {
+      utils.deepSetValue(req, 'regs.coppa', 1);
+    }
     if (bid.params.doNotTrack) {
       utils.deepSetValue(req, 'device.dnt', 1);
     }
@@ -106,10 +102,12 @@ const converter = ortbConverter({
     let fledgeAuctionConfigs = utils.deepAccess(ortbResponse, 'ext.fledge_auction_configs');
     if (fledgeAuctionConfigs) {
       fledgeAuctionConfigs = Object.entries(fledgeAuctionConfigs).map(([bidId, cfg]) => {
-        return Object.assign({
+        return {
           bidId,
-          auctionSignals: {}
-        }, cfg);
+          config: Object.assign({
+            auctionSignals: {},
+          }, cfg)
+        }
       });
       return {
         bids: response.bids,
@@ -129,6 +127,22 @@ const converter = ortbConverter({
         if (floor.bidfloorcur === 'USD') {
           Object.assign(imp, floor);
         }
+      },
+      video(orig, imp, bidRequest, context) {
+        if (FEATURES.VIDEO) {
+          // `orig` is the video imp processor, which looks at bidRequest.mediaTypes[VIDEO]
+          // to populate imp.video
+          // alter its input `bidRequest` to also pick up parameters from `bidRequest.params`
+          let videoParams = bidRequest.mediaTypes[VIDEO];
+          if (videoParams) {
+            videoParams = Object.assign({}, videoParams, bidRequest.params.video);
+            bidRequest = {...bidRequest, mediaTypes: {[VIDEO]: videoParams}}
+          }
+          orig(imp, bidRequest, context);
+          if (imp.video && videoParams?.context === 'outstream') {
+            imp.video.placement = imp.video.placement || 4;
+          }
+        }
       }
     }
   }

package/modules/openxOrtbBidAdapter.md

@@ -1,15 +1,17 @@
 # Overview
 
 ```
-Module Name: OpenX OpenRTB Bidder Adapter
+Module Name: OpenX Bidder Adapter
 Module Type: Bidder Adapter
 Maintainer: team-openx@openx.com
 ```
 
 # Description
+DEPRECATED. Use openxBidAdapter.
 
-This is an updated version of the OpenX bid adapter which calls our new serving architecture.
-Publishers are welcome to test this adapter and give feedback. Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
+This adapter was originally an adapter used to test OpenX serving architecture changes.
+This adapter now mirrors openxBidAdapter and this adapter will be removed in a future release. Please use openxBidAdapter.
+Please note you should only include either openxBidAdapter or openxOrtbBidAdapter in your build.
 
 # Bid Parameters
 ## Banner
@@ -21,7 +23,7 @@ Publishers are welcome to test this adapter and give feedback. Please note you s
 | `customParams` | optional | Object | User-defined targeting key-value pairs. customParams applies to a specific unit. | `{key1: "v1", key2: ["v2","v3"]}`
 | `customFloor` | optional | Number | Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 1.50
 | `doNotTrack` | optional | Boolean | Prevents advertiser from using data for this user. <br/><br/> **WARNING:**<br/> Request-level setting.  May impact revenue. | true
-| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. | true
+| `coppa` | optional | Boolean | Enables Child's Online Privacy Protection Act (COPPA) regulations. Use of `pbjs.setConfig({coppa: true});` is now preferred. | true
 
 ## Video
 
@@ -29,7 +31,7 @@ Publishers are welcome to test this adapter and give feedback. Please note you s
 | ---- | ----- | ---- | ----------- | -------
 | `unit` | required | String | OpenX ad unit ID provided by your OpenX representative. | "1611023122"
 | `delDomain` | required | String |  OpenX delivery domain provided by your OpenX representative.  | "PUBLISHER-d.openx.net"
-| `video` | optional | OpenRTB video subtypes | Alternatively can be added under adUnit.mediaTypes.video | `{ video: {mimes: ['video/mp4']}`
+| `video` | optional | OpenRTB video subtypes | Use of adUnit.mediaTypes.video is now preferred. | `{ video: {mimes: ['video/mp4']}`
 
 
 # Example
@@ -68,7 +70,8 @@ var adUnits = [
     mediaTypes: {
       video: {
         playerSize: [640, 480],
-        context: 'instream'
+        context: 'instream',
+        mimes: ['video/x-ms-wmv, video/mp4']
       }
     },
     bids: [{
@@ -77,10 +80,10 @@ var adUnits = [
         unit: '1611023124',
         delDomain: 'PUBLISHER-d.openx.net',
         video: {
-          mimes: ['video/x-ms-wmv, video/mp4']
+          mimes: ['video/x-ms-wmv, video/mp4'] // mediaTypes.video preferred
         }
       }
-    }]
+    }]p
   }
 ];
 ```

package/modules/operaadsBidAdapter.js

@@ -228,7 +228,7 @@ function buildOpenRtbBidRequest(bidRequest, bidderRequest) {
   // build OpenRTB request body
   const payload = {
     id: bidderRequest.auctionId,
-    tmax: bidderRequest.timeout || config.getConfig('bidderTimeout'),
+    tmax: bidderRequest.timeout,
     test: config.getConfig('debug') ? 1 : 0,
     imp: createImp(bidRequest),
     device: getDevice(),

package/modules/parrableIdSystem.js

@@ -14,6 +14,7 @@ import {submodule} from '../src/hook.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {uspDataHandler} from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const PARRABLE_URL = 'https://h.parrable.com/prebid';
 const PARRABLE_COOKIE_NAME = '_parrable_id';
@@ -22,8 +23,9 @@ const LEGACY_ID_COOKIE_NAME = '_parrable_eid';
 const LEGACY_OPTOUT_COOKIE_NAME = '_parrable_optout';
 const ONE_YEAR_MS = 364 * 24 * 60 * 60 * 1000;
 const EXPIRE_COOKIE_DATE = 'Thu, 01 Jan 1970 00:00:00 GMT';
+const MODULE_NAME = 'parrableId';
 
-const storage = getStorageManager({gvlid: PARRABLE_GVLID});
+const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 function getExpirationDate() {
   const oneYearFromNow = new Date(timestamp() + ONE_YEAR_MS);
@@ -336,7 +338,7 @@ export const parrableIdSubmodule = {
    * used to link submodule with config
    * @type {string}
    */
-  name: 'parrableId',
+  name: MODULE_NAME,
   /**
    * Global Vendor List ID
    * @type {number}

package/modules/permutiveRtdProvider.js

@@ -10,6 +10,7 @@ import {submodule} from '../src/hook.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {deepAccess, deepSetValue, isFn, logError, mergeDeep, isPlainObject, safeJSONParse, prefixLog} from '../src/utils.js';
 import {includes} from '../src/polyfill.js';
+import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'permutive'
 
@@ -20,7 +21,7 @@ export const PERMUTIVE_STANDARD_KEYWORD = 'p_standard'
 export const PERMUTIVE_CUSTOM_COHORTS_KEYWORD = 'permutive'
 export const PERMUTIVE_STANDARD_AUD_KEYWORD = 'p_standard_aud'
 
-export const storage = getStorageManager({gvlid: null, moduleName: MODULE_NAME})
+export const storage = getStorageManager({moduleType: MODULE_TYPE_RTD, moduleName: MODULE_NAME})
 
 function init(moduleConfig, userConsent) {
   readPermutiveModuleConfigFromCache()

package/modules/prebidServerBidAdapter/index.js

@@ -20,7 +20,7 @@ import {
 import CONSTANTS from '../../src/constants.json';
 import adapterManager from '../../src/adapterManager.js';
 import {config} from '../../src/config.js';
-import {isValid} from '../../src/adapters/bidderFactory.js';
+import {addComponentAuction, isValid} from '../../src/adapters/bidderFactory.js';
 import * as events from '../../src/events.js';
 import {includes} from '../../src/polyfill.js';
 import {S2S_VENDORS} from './config.js';
@@ -496,6 +496,9 @@ export function PrebidServer() {
               addBidResponse.reject(adUnit, bid, CONSTANTS.REJECTION_REASON.INVALID);
             }
           }
+        },
+        onFledge: ({adUnitCode, config}) => {
+          addComponentAuction(adUnitCode, config);
         }
       })
     }
@@ -521,7 +524,7 @@ export function PrebidServer() {
  * @param onError {function(String, {})} invoked on HTTP failure - with status message and XHR error
  * @param onBid {function({})} invoked once for each bid in the response - with the bid as returned by interpretResponse
  */
-export const processPBSRequest = hook('sync', function (s2sBidRequest, bidRequests, ajax, {onResponse, onError, onBid}) {
+export const processPBSRequest = hook('sync', function (s2sBidRequest, bidRequests, ajax, {onResponse, onError, onBid, onFledge}) {
   let { gdprConsent } = getConsentData(bidRequests);
   const adUnits = deepClone(s2sBidRequest.ad_units);
 
@@ -545,8 +548,11 @@ export const processPBSRequest = hook('sync', function (s2sBidRequest, bidReques
           let result;
           try {
             result = JSON.parse(response);
-            const bids = s2sBidRequest.metrics.measureTime('interpretResponse', () => interpretPBSResponse(result, request).bids);
+            const {bids, fledgeAuctionConfigs} = s2sBidRequest.metrics.measureTime('interpretResponse', () => interpretPBSResponse(result, request));
             bids.forEach(onBid);
+            if (fledgeAuctionConfigs) {
+              fledgeAuctionConfigs.forEach(onFledge);
+            }
           } catch (error) {
             logError(error);
           }

package/modules/prebidServerBidAdapter/ortbConverter.js

@@ -221,6 +221,13 @@ const PBS_CONVERTER = ortbConverter({
       serverSideStats(orig, response, ortbResponse, context) {
         // override to process each request
         context.actualBidderRequests.forEach(req => orig(response, ortbResponse, {...context, bidderRequest: req, bidRequests: req.bids}));
+      },
+      fledgeAuctionConfigs(orig, response, ortbResponse, context) {
+        const configs = Object.values(context.impContext)
+          .flatMap((impCtx) => (impCtx.fledgeConfigs || []).map(cfg => ({adUnitCode: impCtx.adUnit.code, config: cfg.config})));
+        if (configs.length > 0) {
+          response.fledgeAuctionConfigs = configs;
+        }
       }
     }
   },
@@ -254,11 +261,14 @@ export function buildPBSRequest(s2sBidRequest, bidderRequests, adUnits, requeste
       ...adUnit,
       adUnitCode: adUnit.code,
       ...getDefinedParams(actualBidRequests.values().next().value || {}, ['userId', 'userIdAsEids', 'schain']),
-      pbsData: {impId, actualBidRequests, adUnit}
+      pbsData: {impId, actualBidRequests, adUnit},
     });
   });
 
-  const proxyBidderRequest = Object.fromEntries(Object.entries(bidderRequests[0]).filter(([k]) => !BIDDER_SPECIFIC_REQUEST_PROPS.has(k)))
+  const proxyBidderRequest = {
+    ...Object.fromEntries(Object.entries(bidderRequests[0]).filter(([k]) => !BIDDER_SPECIFIC_REQUEST_PROPS.has(k))),
+    fledgeEnabled: bidderRequests.some(req => req.fledgeEnabled)
+  }
 
   return PBS_CONVERTER.toORTB({
     bidderRequest: proxyBidderRequest,

package/modules/prebidmanagerAnalyticsAdapter.js

@@ -2,13 +2,14 @@ import { generateUUID, getParameterByName, logError, parseUrl, logInfo } from '.
 import {ajaxBuilder} 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';
 
 /**
  * prebidmanagerAnalyticsAdapter.js - analytics adapter for prebidmanager
  */
-export const storage = getStorageManager({gvlid: undefined, moduleName: 'prebidmanager'});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: 'prebidmanager'});
 const DEFAULT_EVENT_URL = 'https://endpt.prebidmanager.com/endpoint';
 const analyticsType = 'endpoint';
 const analyticsName = 'Prebid Manager Analytics';

package/modules/pubCommonId.js

@@ -7,12 +7,15 @@ import { logMessage, parseUrl, buildUrl, triggerPixel, generateUUID, isArray } f
 import { config } from '../src/config.js';
 import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
 import {timedAuctionHook} from '../src/utils/perfMetrics.js';
-import {VENDORLESS_GVLID} from '../src/consentHandler.js';
+import {GDPR_GVLIDS, VENDORLESS_GVLID} from '../src/consentHandler.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 import {getGlobal} from '../src/prebidGlobal.js';
 
-const storage = getStorageManager({moduleName: 'pubCommonId', gvlid: VENDORLESS_GVLID});
+const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: 'pubCommonId'});
+// register our GVL ID directly, since this is not a "real" user ID module we don't have a spec where to declare it
+GDPR_GVLIDS.register(MODULE_TYPE_UID, 'pubCommonId', VENDORLESS_GVLID);
 
 const ID_NAME = '_pubcid';
 const OPTOUT_NAME = '_pubcid_optout';

package/modules/publinkIdSystem.js

@@ -10,13 +10,14 @@ import {getStorageManager} from '../src/storageManager.js';
 import {ajax} from '../src/ajax.js';
 import { parseUrl, buildUrl, logError } from '../src/utils.js';
 import {uspDataHandler} from '../src/adapterManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'publinkId';
 const GVLID = 24;
 const PUBLINK_COOKIE = '_publink';
 const PUBLINK_S2S_COOKIE = '_publink_srv';
 
-export const storage = getStorageManager({gvlid: GVLID});
+export const storage = getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: MODULE_NAME});
 
 function isHex(s) {
   return /^[A-F0-9]+$/i.test(s);

package/modules/pubmaticAnalyticsAdapter.js

@@ -291,6 +291,17 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
   }, [])
 }
 
+function getSizesForAdUnit(adUnit) {
+  var bid = Object.values(adUnit.bids).filter((bid) => !!bid.bidResponse && bid.bidResponse.mediaType === 'native')[0];
+  if (!!bid || (bid === undefined && adUnit.dimensions.length === 0)) {
+    return ['1x1'];
+  } else {
+    return adUnit.dimensions.map(function (e) {
+      return e[0] + 'x' + e[1];
+    })
+  }
+}
+
 function getAdUnitAdFormats(adUnit) {
   var af = adUnit ? Object.keys(adUnit.mediaTypes || {}).map(format => MEDIATYPE[format.toUpperCase()]) : [];
   return af;
@@ -346,7 +357,7 @@ function executeBidsLoggerCall(e, highestCpmBids) {
       'sn': adUnitId,
       'au': origAdUnit.adUnitId || adUnitId,
       'mt': getAdUnitAdFormats(origAdUnit),
-      'sz': adUnit.dimensions.map(e => e[0] + 'x' + e[1]),
+      'sz': getSizesForAdUnit(adUnit, adUnitId),
       'ps': gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestCpmBids.filter(bid => bid.adUnitCode === adUnitId)),
       'fskp': floorData ? (floorData.floorRequestData ? (floorData.floorRequestData.skipped == false ? 0 : 1) : undefined) : undefined,
     };