prebid.js 7.0.0 → 7.1.0

package/modules/.submodules.json

@@ -1,71 +1,85 @@
 {
-  "userId": [
-    "33acrossIdSystem",
-    "admixerIdSystem",
-    "adtelligentIdSystem",
-    "amxIdSystem",
-    "britepoolIdSystem",
-    "connectIdSystem",
-    "cpexIdSystem",
-    "criteoIdSystem",
-    "dacIdSystem",
-    "deepintentDpesIdSystem",
-    "dmdIdSystem",
-    "fabrickIdSystem",
-    "hadronIdSystem",
-    "id5IdSystem",
-    "ftrackIdSystem",
-    "identityLinkIdSystem",
-    "idxIdSystem",
-    "imuIdSystem",
-    "intentIqIdSystem",
-    "justIdSystem",
-    "kinessoIdSystem",
-    "liveIntentIdSystem",
-    "lotamePanoramaIdSystem",
-    "merkleIdSystem",
-    "mwOpenLinkIdSystem",
-    "naveggIdSystem",
-    "netIdSystem",
-    "novatiqIdSystem",
-    "parrableIdSystem",
-    "pubProvidedIdSystem",
-    "publinkIdSystem",
-    "quantcastIdSystem",
-    "sharedIdSystem",
-    "tapadIdSystem",
-    "trustpidSystem",
-    "uid2IdSystem",
-    "unifiedIdSystem",
-    "verizonMediaIdSystem",
-    "zeotapIdPlusIdSystem",
-    "adqueryIdSystem", 
-    "gravitoIdSystem"
-  ],
-  "adpod": [
-    "freeWheelAdserverVideo",
-    "dfpAdServerVideo"
-  ],
-  "rtdModule": [
-    "airgridRtdProvider",
-    "akamaiDapRtdProvider",
-    "browsiRtdProvider",
-    "dgkeywordRtdProvider",
-    "geoedgeRtdProvider",
-    "hadronRtdProvider",
-    "haloRtdProvider",
-    "iasRtdProvider",
-    "jwplayerRtdProvider",
-    "medianetRtdProvider",
-    "optimeraRtdProvider",
-    "permutiveRtdProvider",
-    "reconciliationRtdProvider",
-    "sirdataRtdProvider",
-    "timeoutRtdProvider",
-    "weboramaRtdProvider"
-  ],
-  "fpdModule": [
-    "enrichmentFpdModule",
-    "validationFpdModule"
-  ]
+  "parentModules": {
+    "userId": [
+      "33acrossIdSystem",
+      "admixerIdSystem",
+      "adtelligentIdSystem",
+      "amxIdSystem",
+      "britepoolIdSystem",
+      "connectIdSystem",
+      "cpexIdSystem",
+      "criteoIdSystem",
+      "dacIdSystem",
+      "deepintentDpesIdSystem",
+      "dmdIdSystem",
+      "fabrickIdSystem",
+      "hadronIdSystem",
+      "id5IdSystem",
+      "ftrackIdSystem",
+      "identityLinkIdSystem",
+      "idxIdSystem",
+      "imuIdSystem",
+      "intentIqIdSystem",
+      "justIdSystem",
+      "kinessoIdSystem",
+      "liveIntentIdSystem",
+      "lotamePanoramaIdSystem",
+      "merkleIdSystem",
+      "mwOpenLinkIdSystem",
+      "naveggIdSystem",
+      "netIdSystem",
+      "novatiqIdSystem",
+      "parrableIdSystem",
+      "pubProvidedIdSystem",
+      "publinkIdSystem",
+      "quantcastIdSystem",
+      "sharedIdSystem",
+      "tapadIdSystem",
+      "trustpidSystem",
+      "uid2IdSystem",
+      "unifiedIdSystem",
+      "verizonMediaIdSystem",
+      "zeotapIdPlusIdSystem",
+      "adqueryIdSystem",
+      "gravitoIdSystem"
+    ],
+    "adpod": [
+      "freeWheelAdserverVideo",
+      "dfpAdServerVideo"
+    ],
+    "rtdModule": [
+      "airgridRtdProvider",
+      "akamaiDapRtdProvider",
+      "browsiRtdProvider",
+      "dgkeywordRtdProvider",
+      "geoedgeRtdProvider",
+      "hadronRtdProvider",
+      "haloRtdProvider",
+      "iasRtdProvider",
+      "jwplayerRtdProvider",
+      "medianetRtdProvider",
+      "optimeraRtdProvider",
+      "permutiveRtdProvider",
+      "reconciliationRtdProvider",
+      "sirdataRtdProvider",
+      "timeoutRtdProvider",
+      "weboramaRtdProvider"
+    ],
+    "fpdModule": [
+      "enrichmentFpdModule",
+      "validationFpdModule"
+    ]
+  },
+  "libraries": {
+    "getOrigin": {
+      "files": [
+        "./index.js"
+      ],
+      "dependants": [
+        "ooloAnalyticsAdapter",
+        "resetdigitalBidAdapter",
+        "rtbhouseBidAdapter.js"
+      ]
+    }
+  }
 }

package/modules/aduptechBidAdapter.js

@@ -94,6 +94,30 @@ export const internal = {
     return null;
   },
 
+  /**
+   * Extracts the floor price params from given bidRequest
+   *
+   * @param {BidRequest} bidRequest
+   * @returns {undefined|float}
+   */
+  extractFloorPrice: (bidRequest) => {
+    let floorPrice;
+    if (bidRequest && bidRequest.params && bidRequest.params.floor) {
+      // if there is a manual floorPrice set
+      floorPrice = !isNaN(parseInt(bidRequest.params.floor)) ? bidRequest.params.floor : undefined;
+    }
+    if (typeof bidRequest.getFloor === 'function') {
+      // use prebid floor module
+      let floorInfo;
+      try {
+        floorInfo = bidRequest.getFloor();
+      } catch (e) {}
+      floorPrice = typeof floorInfo === 'object' && !isNaN(parseInt(floorInfo.floor)) ? floorInfo.floor : floorPrice;
+    }
+
+    return floorPrice;
+  },
+
   /**
    * Group given array of bidRequests by params.publisher
    *
@@ -229,6 +253,12 @@ export const spec = {
           bid.native = nativeConfig;
         }
 
+        // add floor price
+        const floorPrice = internal.extractFloorPrice(bidRequest);
+        if (floorPrice) {
+          bid.floorPrice = floorPrice;
+        }
+
         request.data.imp.push(bid);
       });
 

package/modules/adxpremiumAnalyticsAdapter.js

@@ -233,6 +233,7 @@ function sendEventFallback() {
 }
 
 function sendEvent(completeObject) {
+  if (!adxpremiumAnalyticsAdapter.enabled) return;
   requestDelivered = true;
   try {
     let responseEvents = btoa(JSON.stringify(completeObject));

package/modules/consentManagement.js

@@ -20,6 +20,7 @@ export let staticConsentData;
 
 let consentData;
 let addedConsentHook = false;
+let provisionalConsent;
 
 // add new CMPs here, with their dedicated lookup function
 const cmpCallMap = {
@@ -78,6 +79,8 @@ function lookupIabConsent({onSuccess, onError}) {
     if (success) {
       if (tcfData.gdprApplies === false || tcfData.eventStatus === 'tcloaded' || tcfData.eventStatus === 'useractioncomplete') {
         processCmpData(tcfData, {onSuccess, onError});
+      } else {
+        provisionalConsent = tcfData;
       }
     } else {
       onError('CMP unable to register callback function.  Please check CMP setup.');
@@ -185,13 +188,19 @@ function loadConsentData(cb) {
   cmpCallMap[userCMP](callbacks);
 
   if (!isDone) {
+    const onTimeout = () => {
+      const continueToAuction = (data) => {
+        done(data, false, 'CMP did not load, continuing auction...');
+      }
+      processCmpData(provisionalConsent, {
+        onSuccess: continueToAuction,
+        onError: () => continueToAuction(storeConsentData(undefined))
+      })
+    }
     if (consentTimeout === 0) {
-      done(storeConsentData(undefined), false)
+      onTimeout();
     } else {
-      timer = setTimeout(function () {
-        // on timeout, allow the auction to continue
-        done(storeConsentData(undefined), false, `No response from CMP, continuing auction...`)
-      }, consentTimeout);
+      timer = setTimeout(onTimeout, consentTimeout);
     }
   }
 }
@@ -253,7 +262,7 @@ function processCmpData(consentObject, {onSuccess, onError}) {
     const tcString = consentObject && consentObject.tcString;
     return !!(
       (typeof gdprApplies !== 'boolean') ||
-      (gdprApplies === true && !isStr(tcString))
+      (gdprApplies === true && (!tcString || !isStr(tcString)))
     );
   }
 

package/modules/cwireBidAdapter.js

@@ -10,6 +10,7 @@ import {
   getValue,
   isArray,
   isNumber,
+  isStr,
   logError,
   logWarn,
   parseSizesInput,
@@ -129,6 +130,11 @@ export const spec = {
   isBidRequestValid: function(bid) {
     bid.params = bid.params || {};
 
+    if (bid.params.cwcreative && !isStr(bid.params.cwcreative)) {
+      logError('cwcreative must be of type string!');
+      return false;
+    }
+
     if (!bid.params.placementId || !isNumber(bid.params.placementId)) {
       logError('placementId not provided or invalid');
       return false;
@@ -177,7 +183,7 @@ export const spec = {
 
     let refgroups = [];
 
-    const cwCreativeId = parseInt(getQueryVariable(CW_CREATIVE_QUERY), 10) || null;
+    const cwCreative = getQueryVariable(CW_CREATIVE_QUERY) || null;
     const cwCreativeIdFromConfig = this.getFirstValueOrNull(slots, 'cwcreative');
     const refGroupsFromConfig = this.getFirstValueOrNull(slots, 'refgroups');
     const cwApiKeyFromConfig = this.getFirstValueOrNull(slots, 'cwapikey');
@@ -198,7 +204,7 @@ export const spec = {
     const payload = {
       cwid: localStorageCWID,
       refgroups,
-      cwcreative: cwCreativeId || cwCreativeIdFromConfig,
+      cwcreative: cwCreative || cwCreativeIdFromConfig,
       slots: slots,
       cwapikey: cwApiKeyFromConfig,
       httpRef: referer || '',

package/modules/cwireBidAdapter.md

@@ -13,12 +13,12 @@ Connects to C-WIRE demand source to fetch bids.
 
 Below, the list of C-WIRE params and where they can be set.
 
-| Param name | Global config | AdUnit config | Type | Required |
-| ---------- | ------------- | ------------- | ---- | ---------|
+| Param name | Global config | AdUnit config | Type   | Required |
+| ---------- | ------------- | ------------- |--------| ---------|
 | pageId |  | x | number | YES |
 | placementId |  | x | number | YES |
 | refgroups | | x | string | NO |
-| cwcreative |  | x | integer | NO |
+| cwcreative |  | x | string | NO |
 | cwapikey | | x | string | NO |
 
 

package/modules/ooloAnalyticsAdapter.js

@@ -1,4 +1,5 @@
-import { _each, deepClone, pick, deepSetValue, getOrigin, logError, logInfo } from '../src/utils.js';
+import { _each, deepClone, pick, deepSetValue, logError, logInfo } from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import adapter from '../src/AnalyticsAdapter.js'
 import adapterManager from '../src/adapterManager.js'
 import CONSTANTS from '../src/constants.json'

package/modules/pianoDmpAnalyticcsAdapter.md

@@ -0,0 +1,13 @@
+# Overview
+
+Module Name: Piano DMP Analytics Adapter
+
+Module Type: Analytics Adapter
+
+Maintainer: [support@piano.com](mailto:support@piano.com)
+
+# Description
+
+Analytics adapter to be used with cx.js
+
+Visit [https://piano.io/product/dmp/](https://piano.io/product/dmp/) for more information.

package/modules/pianoDmpAnalyticsAdapter.js

@@ -0,0 +1,38 @@
+import adapter from '../src/AnalyticsAdapter.js';
+import adapterManager from '../src/adapterManager.js';
+
+const pianoDmpAnalytics = adapter({ analyticsType: 'bundle', handler: 'on' });
+
+const { enableAnalytics: _enableAnalytics } = pianoDmpAnalytics;
+
+Object.assign(pianoDmpAnalytics, {
+  /**
+   * Save event in the global array that will be consumed later by cx.js
+   */
+  track: ({ eventType, args: params }) => {
+    window.cX.callQueue.push([
+      'prebid',
+      { eventType, params, time: Date.now() },
+    ]);
+  },
+
+  /**
+   * Before forwarding the call to the original enableAnalytics function -
+   * create (if needed) the global array that is used to pass events to the cx.js library
+   * by the 'track' function above.
+   */
+  enableAnalytics: function (...args) {
+    window.cX = window.cX || {};
+    window.cX.callQueue = window.cX.callQueue || [];
+
+    return _enableAnalytics.call(this, ...args);
+  },
+});
+
+adapterManager.registerAnalyticsAdapter({
+  adapter: pianoDmpAnalytics,
+  code: 'pianoDmp',
+  gvlid: 412,
+});
+
+export default pianoDmpAnalytics;

package/modules/resetdigitalBidAdapter.js

@@ -1,5 +1,6 @@
 
-import { timestamp, deepAccess, getOrigin } from '../src/utils.js';
+import { timestamp, deepAccess } from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import { config } from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 const BIDDER_CODE = 'resetdigital';

package/modules/rtbhouseBidAdapter.js

@@ -1,4 +1,5 @@
-import {deepAccess, getOrigin, isArray, logError} from '../src/utils.js';
+import {deepAccess, isArray, logError} from '../src/utils.js';
+import { getOrigin } from '../libraries/getOrigin/index.js';
 import {BANNER, NATIVE} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {includes} from '../src/polyfill.js';

package/modules/synacormediaBidAdapter.js

@@ -49,6 +49,13 @@ export const spec = {
       imp: []
     };
 
+    const callbackTimeout = bidderRequest.timeout;
+    const globalTimeout = config.getConfig('bidderTimeout');
+    const tmax = globalTimeout ? Math.min(globalTimeout, callbackTimeout) : callbackTimeout;
+    if (tmax) {
+      openRtbBidRequest.tmax = tmax;
+    }
+
     const schain = validBidReqs[0].schain;
     if (schain) {
       openRtbBidRequest.source = { ext: { schain } };

package/modules/trafficgateBidAdapter.js

@@ -0,0 +1,92 @@
+import { getWindowLocation, deepAccess } from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'trafficgate';
+const URL = 'https://[HOST].bc-plugin.com/?c=o&m=multi'
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: function (bid) {
+    return !!(bid.bidId && bid.params && parseInt(bid.params.placementId) && bid.params.host)
+  },
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} validBidRequests A non-empty list of valid bid requests that should be sent to the Server.
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests) {
+    if (validBidRequests && validBidRequests.length === 0) return [];
+
+    const location = getWindowLocation()
+    const placements = []
+
+    validBidRequests.forEach((bidReq) => {
+      placements.push({
+        placementId: bidReq.params.placementId,
+        bidId: bidReq.bidId,
+        traffic: getMediatype(bidReq)
+      })
+    })
+
+    return {
+      method: 'POST',
+      url: URL.replace('[HOST]', validBidRequests[0].params.host),
+      data: {
+        language: (navigator && navigator.language) ? navigator.language : '',
+        secure: +(location.protocol === 'https:'),
+        host: location.hostname,
+        page: location.pathname,
+        placements: placements
+      }
+    }
+  },
+
+  interpretResponse: function (opts) {
+    const body = opts.body
+    const response = []
+
+    for (let i = 0; i < body.length; i++) {
+      const item = body[i]
+      if (isBidResponseValid(item)) {
+        response.push(item)
+      }
+    }
+
+    return response
+  }
+}
+
+registerBidder(spec)
+
+function isBidResponseValid (bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
+    !bid.ttl || !bid.currency) {
+    return false
+  }
+  switch (bid['mediaType']) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad)
+    case VIDEO:
+      return Boolean(bid.vastUrl)
+    case NATIVE:
+      return Boolean(bid.title && bid.image && bid.impressionTrackers)
+    default:
+      return false
+  }
+}
+
+function getMediatype(bidRequest) {
+  if (deepAccess(bidRequest, 'mediaTypes.banner')) {
+    return BANNER;
+  }
+  if (deepAccess(bidRequest, 'mediaTypes.video')) {
+    return VIDEO;
+  }
+  if (deepAccess(bidRequest, 'mediaTypes.native')) {
+    return NATIVE;
+  }
+}

package/modules/trafficgateBidAdapter.md

@@ -0,0 +1,30 @@
+# Overview
+
+```
+Module Name: TrafficGate Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: publishers@bidscube.com
+```
+
+# Description
+
+Module that connects to TrafficGate demand sources
+
+# Test Parameters
+```
+    var adUnits = [{
+        code: 'placementId_0',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]]
+            }
+        },
+        bids: [{
+            bidder: 'trafficgate',
+            params: {
+                placementId: 0,
+                host: 'example'
+            }
+        }]
+    }];
+```

package/modules/tripleliftBidAdapter.js

@@ -2,6 +2,7 @@ import { tryAppendQueryString, logMessage, logError, isEmpty, isStr, isPlainObje
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
+import { getStorageManager } from '../src/storageManager.js';
 
 const GVLID = 28;
 const BIDDER_CODE = 'triplelift';
@@ -10,6 +11,7 @@ const BANNER_TIME_TO_LIVE = 300;
 const INSTREAM_TIME_TO_LIVE = 3600;
 let gdprApplies = true;
 let consentString = null;
+export const storage = getStorageManager({gvlid: GVLID, bidderCode: BIDDER_CODE});
 
 export const tripleliftAdapterSpec = {
   gvlid: GVLID,
@@ -197,10 +199,23 @@ function _getGlobalFpd(bidderRequest) {
   const context = {}
   const user = {};
   const ortbData = bidderRequest.ortb2 || {};
+  const opeCloudStorage = _fetchOpeCloud();
 
   const fpdContext = Object.assign({}, ortbData.site);
   const fpdUser = Object.assign({}, ortbData.user);
 
+  if (opeCloudStorage) {
+    fpdUser.data = fpdUser.data || []
+    try {
+      fpdUser.data.push({
+        name: 'www.1plusx.com',
+        ext: opeCloudStorage
+      })
+    } catch (err) {
+      logError('Triplelift: error adding 1plusX segments: ', err);
+    }
+  }
+
   _addEntries(context, fpdContext);
   _addEntries(user, fpdUser);
 
@@ -213,6 +228,18 @@ function _getGlobalFpd(bidderRequest) {
   return fpd;
 }
 
+function _fetchOpeCloud() {
+  const opeCloud = storage.getDataFromLocalStorage('opecloud_ctx');
+  if (!opeCloud) return null;
+  try {
+    const parsedJson = JSON.parse(opeCloud);
+    return parsedJson
+  } catch (err) {
+    logError('Triplelift: error parsing JSON: ', err);
+    return null
+  }
+}
+
 function _getAdUnitFpd(adUnitFpd) {
   const fpd = {};
   const context = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/AnalyticsAdapter.js

@@ -34,16 +34,17 @@ const BUNDLE = 'bundle';
 var _sampled = true;
 
 export default function AnalyticsAdapter({ url, analyticsType, global, handler }) {
-  var _queue = [];
-  var _eventCount = 0;
-  var _enableCheck = true;
-  var _handlers;
+  const _queue = [];
+  let _eventCount = 0;
+  let _enableCheck = true;
+  let _handlers;
+  let _enabled = false;
 
   if (analyticsType === ENDPOINT || BUNDLE) {
     _emptyQueue();
   }
 
-  return {
+  return Object.defineProperties({
     track: _track,
     enqueue: _enqueue,
     enableAnalytics: _enable,
@@ -52,7 +53,11 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
     getGlobal: () => global,
     getHandler: () => handler,
     getUrl: () => url
-  };
+  }, {
+    enabled: {
+      get: () => _enabled
+    }
+  });
 
   function _track({ eventType, args }) {
     if (this.getAdapterType() === BUNDLE) {
@@ -140,6 +145,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
     this.enableAnalytics = function _enable() {
       return logMessage(`Analytics adapter for "${global}" already enabled, unnecessary call to \`enableAnalytics\`.`);
     };
+    _enabled = true;
   }
 
   function _disable() {
@@ -147,6 +153,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
       events.off(event, handler);
     });
     this.enableAnalytics = this._oldEnable ? this._oldEnable : _enable;
+    _enabled = false;
   }
 
   function _emptyQueue() {

package/src/utils.js

@@ -925,17 +925,6 @@ export function getUserConfiguredParams(adUnits, adUnitCode, bidder) {
     .filter((bidderData) => bidderData.bidder === bidder)
     .map((bidderData) => bidderData.params || {});
 }
-/**
- * Returns the origin
- */
-export function getOrigin() {
-  // IE10 does not have this property. https://gist.github.com/hbogs/7908703
-  if (!window.location.origin) {
-    return window.location.protocol + '//' + window.location.hostname + (window.location.port ? ':' + window.location.port : '');
-  } else {
-    return window.location.origin;
-  }
-}
 
 /**
  * Returns Do Not Track state