prebid.js 6.6.0 → 6.10.0

package/modules/beachfrontBidAdapter.js

@@ -3,8 +3,8 @@ import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
-import find from 'core-js-pure/features/array/find.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import find from 'prebidjs-polyfill/find.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 const ADAPTER_VERSION = '1.19';
 const ADAPTER_NAME = 'BFIO_PREBID';

package/modules/betweenBidAdapter.js

@@ -6,7 +6,7 @@ const BIDDER_CODE = 'between';
 let ENDPOINT = 'https://ads.betweendigital.com/adjson?t=prebid';
 const CODE_TYPES = ['inpage', 'preroll', 'midroll', 'postroll'];
 
-const includes = require('core-js-pure/features/array/includes.js');
+const includes = require('prebidjs-polyfill/includes.js');
 export const spec = {
   code: BIDDER_CODE,
   aliases: ['btw'],

package/modules/bidViewability.js

@@ -8,7 +8,7 @@ import CONSTANTS from '../src/constants.json';
 import { logWarn, isFn, triggerPixel } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
 import adapterManager, { gdprDataHandler, uspDataHandler } from '../src/adapterManager.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 
 const MODULE_NAME = 'bidViewability';
 const CONFIG_ENABLED = 'enabled';

package/modules/bluebillywigBidAdapter.js

@@ -1,5 +1,5 @@
 import { deepAccess, deepSetValue, deepClone, logWarn, logError } from '../src/utils.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { VIDEO } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';

package/modules/brandmetricsRtdProvider.js

@@ -0,0 +1,168 @@
+/**
+ * This module adds brandmetrics provider to the real time data module
+ * The {@link module:modules/realTimeData} module is required
+ * The module will load load the brandmetrics script and set survey- targeting to ad units of specific bidders.
+ * @module modules/brandmetricsRtdProvider
+ * @requires module:modules/realTimeData
+ */
+import { config } from '../src/config.js'
+import { submodule } from '../src/hook.js'
+import { deepSetValue, mergeDeep, logError, deepAccess } from '../src/utils.js'
+import {loadExternalScript} from '../src/adloader.js'
+const MODULE_NAME = 'brandmetrics'
+const MODULE_CODE = MODULE_NAME
+const RECEIVED_EVENTS = []
+const GVL_ID = 422
+const TCF_PURPOSES = [1, 7]
+
+function init (config, userConsent) {
+  const hasConsent = checkConsent(userConsent)
+
+  if (hasConsent) {
+    const moduleConfig = getMergedConfig(config)
+    initializeBrandmetrics(moduleConfig.params.scriptId)
+  }
+  return hasConsent
+}
+
+/**
+ * Checks TCF and USP consents
+ * @param {Object} userConsent
+ * @returns {boolean}
+ */
+function checkConsent (userConsent) {
+  let consent = false
+
+  if (userConsent && userConsent.gdpr && userConsent.gdpr.gdprApplies) {
+    const gdpr = userConsent.gdpr
+
+    if (gdpr.vendorData) {
+      const vendor = gdpr.vendorData.vendor
+      const purpose = gdpr.vendorData.purpose
+
+      let vendorConsent = false
+      if (vendor.consents) {
+        vendorConsent = vendor.consents[GVL_ID]
+      }
+
+      if (vendor.legitimateInterests) {
+        vendorConsent = vendorConsent || vendor.legitimateInterests[GVL_ID]
+      }
+
+      const purposes = TCF_PURPOSES.map(id => {
+        return (purpose.consents && purpose.consents[id]) || (purpose.legitimateInterests && purpose.legitimateInterests[id])
+      })
+      const purposesValid = purposes.filter(p => p === true).length === TCF_PURPOSES.length
+      consent = vendorConsent && purposesValid
+    }
+  } else if (userConsent.usp) {
+    const usp = userConsent.usp
+    consent = usp[1] !== 'N' && usp[2] !== 'Y'
+  }
+
+  return consent
+}
+
+/**
+* Add event- listeners to hook in to brandmetrics events
+* @param {Object} reqBidsConfigObj
+* @param {function} callback
+*/
+function processBrandmetricsEvents (reqBidsConfigObj, moduleConfig, callback) {
+  const callBidTargeting = (event) => {
+    if (event.available && event.conf) {
+      const targetingConf = event.conf.displayOption || {}
+      if (targetingConf.type === 'pbjs') {
+        setBidderTargeting(reqBidsConfigObj, moduleConfig, targetingConf.targetKey || 'brandmetrics_survey', event.survey.measurementId)
+      }
+    }
+    callback()
+  }
+
+  if (RECEIVED_EVENTS.length > 0) {
+    callBidTargeting(RECEIVED_EVENTS[RECEIVED_EVENTS.length - 1])
+  } else {
+    window._brandmetrics = window._brandmetrics || []
+    window._brandmetrics.push({
+      cmd: '_addeventlistener',
+      val: {
+        event: 'surveyloaded',
+        reEmitLast: true,
+        handler: (ev) => {
+          RECEIVED_EVENTS.push(ev)
+          if (RECEIVED_EVENTS.length === 1) {
+            // Call bid targeting only for the first received event, if called subsequently, last event from the RECEIVED_EVENTS array is used
+            callBidTargeting(ev)
+          }
+        },
+      }
+    })
+  }
+}
+
+/**
+ * Sets bid targeting of specific bidders
+ * @param {Object} reqBidsConfigObj
+ * @param {string} key Targeting key
+ * @param {string} val Targeting value
+ */
+function setBidderTargeting (reqBidsConfigObj, moduleConfig, key, val) {
+  const bidders = deepAccess(moduleConfig, 'params.bidders')
+  if (bidders && bidders.length > 0) {
+    const ortb2 = {}
+    deepSetValue(ortb2, 'ortb2.user.ext.data.' + key, val)
+    config.setBidderConfig({
+      bidders: bidders,
+      config: ortb2
+    })
+  }
+}
+
+/**
+ * Add the brandmetrics script to the page.
+ * @param {string} scriptId - The script- id provided by brandmetrics or brandmetrics partner
+ */
+function initializeBrandmetrics(scriptId) {
+  if (scriptId) {
+    const path = 'https://cdn.brandmetrics.com/survey/script/'
+    const file = scriptId + '.js'
+    const url = path + file
+
+    loadExternalScript(url, MODULE_CODE)
+  }
+}
+
+/**
+ * Merges a provided config with default values
+ * @param {Object} customConfig
+ * @returns
+ */
+function getMergedConfig(customConfig) {
+  return mergeDeep({
+    waitForIt: false,
+    params: {
+      bidders: [],
+      scriptId: undefined,
+    }
+  }, customConfig)
+}
+
+/** @type {RtdSubmodule} */
+export const brandmetricsSubmodule = {
+  name: MODULE_NAME,
+  getBidRequestData: function (reqBidsConfigObj, callback, customConfig) {
+    try {
+      const moduleConfig = getMergedConfig(customConfig)
+      if (moduleConfig.waitForIt) {
+        processBrandmetricsEvents(reqBidsConfigObj, moduleConfig, callback)
+      } else {
+        callback()
+      }
+    } catch (e) {
+      logError(e)
+    }
+  },
+  init: init
+}
+
+submodule('realTimeData', brandmetricsSubmodule)

package/modules/brandmetricsRtdProvider.md

@@ -0,0 +1,40 @@
+# Brandmetrics Real-time Data Submodule
+This module is intended to be used by brandmetrics (https://brandmetrics.com) partners and sets targeting keywords to bids if the browser is eligeble to see a brandmetrics survey.
+The module hooks in to brandmetrics events and requires a brandmetrics script to be running. The module can optionally load and initialize brandmetrics by providing the 'scriptId'- parameter.
+
+## Usage
+Compile the Brandmetrics RTD module into your Prebid build:
+```
+gulp build --modules=rtdModule,brandmetricsRtdProvider
+```
+
+> Note that the global RTD module, `rtdModule`, is a prerequisite of the Brandmetrics RTD module.
+
+Enable the Brandmetrics RTD in your Prebid configuration, using the below format:
+
+```javascript
+pbjs.setConfig({
+  ...,
+  realTimeData: {
+    auctionDelay: 500, // auction delay
+    dataProviders: [{
+      name: 'brandmetrics',
+      waitForIt: true // should be true if there's an `auctionDelay`,
+      params: {
+        scriptId: '00000000-0000-0000-0000-000000000000',
+        bidders: ['ozone']
+      }
+    }]
+  },
+  ...
+})
+```
+
+## Parameters
+| Name              | Type                 | Description        | Default        |
+| ----------------- | -------------------- | ------------------ | ------------------ |
+| name              | String               | This should always be `brandmetrics` | - |
+| waitForIt         | Boolean              | Should be `true` if there's an `auctionDelay` defined (recommended) | `false` |
+| params            | Object               |                 | - |
+| params.bidders    | String[]             | An array of bidders which should receive targeting keys. | `[]` |
+| params.scriptId   | String               | A script- id GUID if the brandmetrics- script should be initialized. | `undefined` |

package/modules/bridgewellBidAdapter.js

@@ -1,7 +1,7 @@
 import { _each, inIframe, deepSetValue } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE } from '../src/mediaTypes.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 
 const BIDDER_CODE = 'bridgewell';
 const REQUEST_ENDPOINT = 'https://prebid.scupio.com/recweb/prebid.aspx?cb=';

package/modules/browsiRtdProvider.js

@@ -20,9 +20,9 @@ import {submodule} from '../src/hook.js';
 import {ajaxBuilder} from '../src/ajax.js';
 import {loadExternalScript} from '../src/adloader.js';
 import {getStorageManager} from '../src/storageManager.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import {getGlobal} from '../src/prebidGlobal.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 const storage = getStorageManager();
 

package/modules/cleanmedianetBidAdapter.js

@@ -3,7 +3,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
 import {Renderer} from '../src/Renderer.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 export const helper = {
   getTopWindowDomain: function (url) {

package/modules/colossussspBidAdapter.js

@@ -47,7 +47,10 @@ export const spec = {
    * @return boolean True if this is a valid bid, and false otherwise.
    */
   isBidRequestValid: (bid) => {
-    return Boolean(bid.bidId && bid.params && !isNaN(bid.params.placement_id));
+    const validPlacamentId = bid.params && !isNaN(bid.params.placement_id);
+    const validGroupId = bid.params && !isNaN(bid.params.group_id);
+
+    return Boolean(bid.bidId && (validPlacamentId || validGroupId));
   },
 
   /**
@@ -61,13 +64,13 @@ export const spec = {
     const location = winTop.location;
     let placements = [];
     let request = {
-      'deviceWidth': winTop.screen.width,
-      'deviceHeight': winTop.screen.height,
-      'language': (navigator && navigator.language) ? navigator.language : '',
-      'secure': location.protocol === 'https:' ? 1 : 0,
-      'host': location.host,
-      'page': location.pathname,
-      'placements': placements,
+      deviceWidth: winTop.screen.width,
+      deviceHeight: winTop.screen.height,
+      language: (navigator && navigator.language) ? navigator.language : '',
+      secure: location.protocol === 'https:' ? 1 : 0,
+      host: location.host,
+      page: location.pathname,
+      placements: placements,
     };
 
     if (bidderRequest) {
@@ -85,6 +88,7 @@ export const spec = {
       let traff = bid.params.traffic || BANNER
       let placement = {
         placementId: bid.params.placement_id,
+        groupId: bid.params.group_id,
         bidId: bid.bidId,
         sizes: bid.mediaTypes[traff].sizes,
         traffic: traff,

package/modules/colossussspBidAdapter.md

@@ -26,5 +26,19 @@ Module that connects to Colossus SSP demand sources
                 traffic: 'banner'
             }
         }]
-    ];
+    }, {
+        code: 'placementid_1',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250], [300,600]]
+            }
+        },
+        bids: [{
+            bidder: 'colossusssp',
+            params: {
+                group_id: 0,
+                traffic: 'banner'
+            }
+        }]
+    }];
 ```

package/modules/compassBidAdapter.js

@@ -97,7 +97,7 @@ export const spec = {
 
   isBidRequestValid: (bid = {}) => {
     const { params, bidId, mediaTypes } = bid;
-    let valid = Boolean(bidId && params && params.placementId);
+    let valid = Boolean(bidId && params && (params.placementId || params.endpointId));
 
     if (mediaTypes && mediaTypes[BANNER]) {
       valid = valid && Boolean(mediaTypes[BANNER] && mediaTypes[BANNER].sizes);

package/modules/connectIdSystem.js

@@ -8,7 +8,7 @@
 import {ajax} from '../src/ajax.js';
 import {submodule} from '../src/hook.js';
 import {logError, formatQS} from '../src/utils.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 const MODULE_NAME = 'connectId';
 const VENDOR_ID = 25;

package/modules/consentManagement.js

@@ -8,8 +8,7 @@
 import { logInfo, isFn, getAdUnitSizes, logWarn, isStr, isPlainObject, logError, isNumber } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { gdprDataHandler } from '../src/adapterManager.js';
-import includes from 'core-js-pure/features/array/includes.js';
-import strIncludes from 'core-js-pure/features/string/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 
 const DEFAULT_CMP = 'iab';
 const DEFAULT_CONSENT_TIMEOUT = 10000;
@@ -249,7 +248,7 @@ function lookupIabConsent(cmpSuccess, cmpError, hookConfig) {
 
     function readPostMessageResponse(event) {
       let cmpDataPkgName = `${apiName}Return`;
-      let json = (typeof event.data === 'string' && strIncludes(event.data, cmpDataPkgName)) ? JSON.parse(event.data) : event.data;
+      let json = (typeof event.data === 'string' && includes(event.data, cmpDataPkgName)) ? JSON.parse(event.data) : event.data;
       if (json[cmpDataPkgName] && json[cmpDataPkgName].callId) {
         let payload = json[cmpDataPkgName];
         // TODO - clean up this logic (move listeners?); we have duplicate messages responses because 2 eventlisteners are active from the 2 cmp requests running in parallel

package/modules/consumableBidAdapter.md

@@ -4,7 +4,7 @@ Module Name: Consumable Bid Adapter
 
 Module Type: Consumable Adapter
 
-Maintainer: naffis@consumable.com
+Maintainer: prebid@consumable.com
 
 # Description
 

package/modules/conversantBidAdapter.js

@@ -2,6 +2,7 @@ import { logWarn, isStr, deepAccess, isArray, getBidIdParameter, deepSetValue, i
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {getStorageManager} from '../src/storageManager.js';
+import { config } from '../src/config.js';
 
 const GVLID = 24;
 export const storage = getStorageManager(GVLID);
@@ -76,6 +77,9 @@ export const spec = {
         displaymanager: 'Prebid.js',
         displaymanagerver: '$prebid.version$'
       };
+      if (bid.ortb2Imp) {
+        mergeDeep(imp, bid.ortb2Imp);
+      }
 
       copyOptProperty(bid.params.tag_id, imp, 'tagid');
 
@@ -167,6 +171,9 @@ export const spec = {
       payload.user = {ext: userExt};
     }
 
+    const firstPartyData = config.getConfig('ortb2') || {};
+    mergeDeep(payload, firstPartyData);
+
     return {
       method: 'POST',
       url: bidurl,

package/modules/craftBidAdapter.js

@@ -2,8 +2,8 @@ import { logError, convertTypes, convertCamelToUnderscore, isArray, deepAccess,
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import { auctionManager } from '../src/auctionManager.js';
-import find from 'core-js-pure/features/array/find.js';
-import includes from 'core-js-pure/features/array/includes.js';
+import find from 'prebidjs-polyfill/find.js';
+import includes from 'prebidjs-polyfill/includes.js';
 import { getStorageManager } from '../src/storageManager.js';
 import {ajax} from '../src/ajax.js';
 

package/modules/criteoBidAdapter.js

@@ -3,7 +3,7 @@ import {loadExternalScript} from '../src/adloader.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { verify } from 'criteo-direct-rsa-validate/build/verify.js'; // ref#2
 import { getStorageManager } from '../src/storageManager.js';
 
@@ -281,6 +281,7 @@ function checkNativeSendId(bidRequest) {
  */
 function buildCdbRequest(context, bidRequests, bidderRequest) {
   let networkId;
+  let schain;
   const request = {
     publisher: {
       url: context.url,
@@ -288,6 +289,7 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
     },
     slots: bidRequests.map(bidRequest => {
       networkId = bidRequest.params.networkId || networkId;
+      schain = bidRequest.schain || schain;
       const slot = {
         impid: bidRequest.adUnitCode,
         transactionid: bidRequest.transactionId,
@@ -344,6 +346,13 @@ function buildCdbRequest(context, bidRequests, bidderRequest) {
   if (networkId) {
     request.publisher.networkid = networkId;
   }
+  if (schain) {
+    request.source = {
+      ext: {
+        schain: schain
+      }
+    }
+  };
   request.user = {
     ext: bidderRequest.userExt
   };

package/modules/currency.js

@@ -20,6 +20,25 @@ export var currencyRates = {};
 var bidderCurrencyDefault = {};
 var defaultRates;
 
+export const ready = (() => {
+  let isDone, resolver, promise;
+  function reset() {
+    isDone = false;
+    resolver = null;
+    promise = new Promise((resolve) => {
+      resolver = resolve;
+      if (isDone) resolve();
+    })
+  }
+  function done() {
+    isDone = true;
+    if (resolver != null) { resolver() }
+  }
+  reset();
+
+  return {done, reset, promise: () => promise}
+})();
+
 /**
  * Configuration function for currency
  * @param  {string} [config.adServerCurrency = 'USD']
@@ -138,11 +157,15 @@ function initCurrency(url) {
             logInfo('currencyRates set to ' + JSON.stringify(currencyRates));
             currencyRatesLoaded = true;
             processBidResponseQueue();
+            ready.done();
           } catch (e) {
             errorSettingsRates('Failed to parse currencyRates response: ' + response);
           }
         },
-        error: errorSettingsRates
+        error: function (...args) {
+          errorSettingsRates(...args);
+          ready.done();
+        }
       }
     );
   }
@@ -197,6 +220,8 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
   bidResponseQueue.push(wrapFunction(fn, this, [adUnitCode, bid]));
   if (!currencySupportEnabled || currencyRatesLoaded) {
     processBidResponseQueue();
+  } else {
+    fn.bail(ready.promise());
   }
 }
 
@@ -219,10 +244,7 @@ function wrapFunction(fn, context, params) {
         }
       } catch (e) {
         logWarn('Returning NO_BID, getCurrencyConversion threw error: ', e);
-        params[1] = createBid(CONSTANTS.STATUS.NO_BID, {
-          bidder: bid.bidderCode || bid.bidder,
-          bidId: bid.requestId
-        });
+        params[1] = createBid(CONSTANTS.STATUS.NO_BID, bid.getIdentifiers());
       }
     }
     return fn.apply(context, params);

package/modules/cwireBidAdapter.js

@@ -16,7 +16,7 @@ import {
   logWarn,
 } from '../src/utils.js';
 import { Renderer } from '../src/Renderer.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 
 // ------------------------------------
 const BIDDER_CODE = 'cwire';

package/modules/dailyhuntBidAdapter.js

@@ -2,7 +2,7 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
 import * as mediaTypes from '../src/mediaTypes.js';
 import {deepAccess, _map, isEmpty} from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
-import find from 'core-js-pure/features/array/find.js';
+import find from 'prebidjs-polyfill/find.js';
 import { OUTSTREAM, INSTREAM } from '../src/video.js';
 
 const BIDDER_CODE = 'dailyhunt';

package/modules/dchain.js

@@ -1,4 +1,4 @@
-import includes from 'core-js-pure/features/array/includes.js';
+import includes from 'prebidjs-polyfill/includes.js';
 import { config } from '../src/config.js';
 import { getHook } from '../src/hook.js';
 import { _each, isStr, isArray, isPlainObject, hasOwn, deepClone, deepAccess, logWarn, logError } from '../src/utils.js';