prebid.js 7.8.0 → 7.11.0

package/modules/boldwinBidAdapter.md

@@ -47,5 +47,22 @@ Module that connects to boldwin demand sources
                         }
                     ]
                 }
+                // Will return static test banner
+                {
+                    code: 'endpointId_0',
+                    mediaTypes: {
+                        banner: {
+                            sizes: [[300, 250]],
+                        }
+                    },
+                    bids: [
+                        {
+                            bidder: 'boldwin',
+                            params: {
+                                endpointId: 'testBanner',
+                            }
+                        }
+                    ]
+                },
             ];
 ```

package/modules/brightMountainMediaBidAdapter.js

@@ -99,7 +99,7 @@ export const spec = {
     let response;
 
     try {
-      response = serverResponse.body
+      response = serverResponse.body;
       bid = response.seatbid[0].bid[0];
     } catch (e) {
       response = null;

package/modules/browsiRtdProvider.js

@@ -57,6 +57,16 @@ export function addBrowsiTag(data) {
   return script;
 }
 
+export function sendPageviewEvent(eventType) {
+  if (eventType === 'PAGEVIEW') {
+    events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
+      vendor: 'browsi',
+      type: 'pageview',
+      billingId: generateUUID()
+    })
+  }
+}
+
 /**
  * collect required data from page
  * send data to browsi server to get predictions
@@ -93,7 +103,7 @@ export function collectData() {
 function waitForData(callback) {
   if (_browsiData) {
     _dataReadyCallback = null;
-    callback(_browsiData);
+    callback();
   } else {
     _dataReadyCallback = callback;
   }
@@ -102,7 +112,7 @@ function waitForData(callback) {
 export function setData(data) {
   _browsiData = data;
   if (isFn(_dataReadyCallback)) {
-    _dataReadyCallback(_browsiData);
+    _dataReadyCallback();
     _dataReadyCallback = null;
   }
 }
@@ -262,10 +272,11 @@ function getPredictionsFromServer(url) {
           try {
             const data = JSON.parse(response);
             if (data && data.p && data.kn) {
-              setData({p: data.p, kn: data.kn, pmd: data.pmd});
+              setData({p: data.p, kn: data.kn, pmd: data.pmd, bet: data.bet});
             } else {
               setData({});
             }
+            sendPageviewEvent(data.bet);
             addBrowsiTag(data);
           } catch (err) {
             logError('unable to parse data');
@@ -336,19 +347,22 @@ export const browsiSubmodule = {
 
 function getTargetingData(uc, c, us, a) {
   const targetingData = getRTD(uc);
-  const auctionId = a.auctionId
+  const auctionId = a.auctionId;
+  const sendAdRequestEvent = _browsiData['bet'] === 'AD_REQUEST';
   uc.forEach(auc => {
     if (isNumber(_ic[auc])) {
       _ic[auc] = _ic[auc] + 1;
     }
-    const transactionId = a.adUnits.find(adUnit => adUnit.code === auc).transactionId;
-    events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
-      vendor: 'browsi',
-      type: 'adRequest',
-      billingId: generateUUID(),
-      transactionId: transactionId,
-      auctionId: auctionId
-    })
+    if (sendAdRequestEvent) {
+      const transactionId = a.adUnits.find(adUnit => adUnit.code === auc).transactionId;
+      events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
+        vendor: 'browsi',
+        type: 'adRequest',
+        billingId: generateUUID(),
+        transactionId: transactionId,
+        auctionId: auctionId
+      })
+    }
   });
   logInfo('Browsi RTD provider returned targeting data', targetingData, 'for', uc)
   return targetingData;

package/modules/byDataAnalyticsAdapter.js

@@ -2,7 +2,7 @@ import { deepClone, logInfo, logError } from '../src/utils.js';
 import Base64 from 'crypto-js/enc-base64';
 import hmacSHA512 from 'crypto-js/hmac-sha512';
 import enc from 'crypto-js/enc-utf8';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -266,7 +266,7 @@ ascAdapter.getVisitorData = function (data = {}) {
   }
 
   const { clientId } = initOptions;
-  var userId = storage.getDataFromLocalStorage('userId')
+  var userId = storage.getDataFromLocalStorage('userId');
   if (!userId) {
     userId = generateUid();
     storage.setDataInLocalStorage('userId', userId);

package/modules/c1xBidAdapter.js

@@ -0,0 +1,209 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { logInfo, logError } from '../src/utils.js';
+import { BANNER } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'c1x';
+const URL = 'https://hb-stg.c1exchange.com/ht';
+// const PIXEL_ENDPOINT = '//px.c1exchange.com/pubpixel/';
+const LOG_MSG = {
+  invalidBid: 'C1X: [ERROR] bidder returns an invalid bid',
+  noSite: 'C1X: [ERROR] no site id supplied',
+  noBid: 'C1X: [INFO] creating a NO bid for Adunit: ',
+  bidWin: 'C1X: [INFO] creating a bid for Adunit: '
+};
+
+/**
+ * Adapter for requesting bids from C1X header tag server.
+ * v3.1 (c) C1X Inc., 2018
+ */
+
+export const c1xAdapter = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER],
+
+  /**
+   * Determines whether or not the given bid request is valid.
+   *
+   * @param {object} bid The bid to validate.
+   * @return boolean True if this is a valid bid, and false otherwise.
+   */
+  // check the bids sent to c1x bidder
+  isBidRequestValid: function (bid) {
+    if (bid.bidder !== BIDDER_CODE || typeof bid.params === 'undefined') {
+      return false;
+    }
+    if (typeof bid.params.placementId === 'undefined') {
+      return false;
+    }
+    return true;
+  },
+
+  /**
+   * 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, bidderRequest) {
+    let payload = {};
+    let tagObj = {};
+    let bidRequest = [];
+    const adunits = validBidRequests.length;
+    const rnd = new Date().getTime();
+    const c1xTags = validBidRequests.map(bidToTag);
+    const bidIdTags = validBidRequests.map(bidToShortTag); // include only adUnitCode and bidId from request obj
+
+    // flattened tags in a tag object
+    tagObj = c1xTags.reduce((current, next) => Object.assign(current, next));
+
+    payload = {
+      adunits: adunits.toString(),
+      rnd: rnd.toString(),
+      response: 'json',
+      compress: 'gzip'
+    };
+
+    // for GDPR support
+    if (bidderRequest && bidderRequest.gdprConsent) {
+      payload['consent_string'] = bidderRequest.gdprConsent.consentString;
+      payload['consent_required'] = (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') ? bidderRequest.gdprConsent.gdprApplies.toString() : 'true'
+      ;
+    }
+
+    Object.assign(payload, tagObj);
+    let payloadString = stringifyPayload(payload);
+    // ServerRequest object
+    bidRequest.push({
+      method: 'GET',
+      url: URL,
+      data: payloadString,
+      bids: bidIdTags
+    });
+    return bidRequest;
+  },
+
+  interpretResponse: function (serverResponse, requests) {
+    serverResponse = serverResponse.body;
+    requests = requests.bids || [];
+    const currency = 'USD';
+    const bidResponses = [];
+    let netRevenue = false;
+
+    if (!serverResponse || serverResponse.error) {
+      let errorMessage = serverResponse.error;
+      logError(LOG_MSG.invalidBid + errorMessage);
+      return bidResponses;
+    } else {
+      serverResponse.forEach(bid => {
+        logInfo(bid)
+        if (bid.bid) {
+          if (bid.bidType === 'NET_BID') {
+            netRevenue = !netRevenue;
+          }
+          const curBid = {
+            requestId: bid.bidId,
+            width: bid.width,
+            height: bid.height,
+            cpm: bid.cpm,
+            ad: bid.ad,
+            creativeId: bid.crid,
+            currency: currency,
+            ttl: 300,
+            netRevenue: netRevenue
+          };
+
+          if (bid.dealId) {
+            curBid['dealId'] = bid.dealId
+          }
+
+          for (let i = 0; i < requests.length; i++) {
+            if (bid.adId === requests[i].adUnitCode) {
+              curBid.requestId = requests[i].bidId;
+            }
+          }
+          logInfo(LOG_MSG.bidWin + bid.adId + ' size: ' + curBid.width + 'x' + curBid.height);
+          bidResponses.push(curBid);
+        } else {
+          // no bid
+          logInfo(LOG_MSG.noBid + bid.adId);
+        }
+      });
+    }
+
+    return bidResponses;
+  }
+
+}
+
+function bidToTag(bid, index) {
+  const tag = {};
+  const adIndex = 'a' + (index + 1).toString(); // ad unit id for c1x
+  const sizeKey = adIndex + 's';
+  const priceKey = adIndex + 'p';
+  const dealKey = adIndex + 'd';
+  // TODO: Multiple Floor Prices
+
+  const sizesArr = bid.sizes;
+  const floorPriceMap = getBidFloor(bid);
+
+  const dealId = bid.params.dealId || '';
+
+  if (dealId) {
+    tag[dealKey] = dealId;
+  }
+
+  tag[adIndex] = bid.adUnitCode;
+  tag[sizeKey] = sizesArr.reduce((prev, current) => prev + (prev === '' ? '' : ',') + current.join('x'), '');
+  const newSizeArr = tag[sizeKey].split(',');
+  if (floorPriceMap) {
+    newSizeArr.forEach(size => {
+      if (size in floorPriceMap) {
+        tag[priceKey] = floorPriceMap[size].toString();
+      } // we only accept one cpm price in floorPriceMap
+    });
+  }
+  if (bid.params.pageurl) {
+    tag['pageurl'] = bid.params.pageurl;
+  }
+
+  return tag;
+}
+
+function getBidFloor(bidRequest) {
+  let floorInfo = {};
+
+  if (typeof bidRequest.getFloor === 'function') {
+    floorInfo = bidRequest.getFloor({
+      currency: 'USD',
+      mediaType: 'banner',
+      size: '*',
+    });
+  }
+
+  let floor =
+    floorInfo.floor ||
+    bidRequest.params.bidfloor ||
+    bidRequest.params.floorPriceMap ||
+    0;
+
+  return floor;
+}
+
+function bidToShortTag(bid) {
+  const tag = {};
+  tag.adUnitCode = bid.adUnitCode;
+  tag.bidId = bid.bidId;
+  return tag;
+}
+
+function stringifyPayload(payload) {
+  let payloadString = [];
+  for (var key in payload) {
+    if (payload.hasOwnProperty(key)) {
+      payloadString.push(key + '=' + payload[key]);
+    }
+  }
+  return payloadString.join('&');
+}
+
+registerBidder(c1xAdapter);

package/modules/c1xBidAdapter.md

@@ -0,0 +1,70 @@
+# Overview
+
+Module Name: C1X Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: vishnu@c1exchange.com
+
+# Description
+
+Module that connects to C1X's demand sources
+
+# Test Parameters
+```
+  var adUnits = [{
+    code: 'test-div-1',
+    mediaTypes: {
+        banner: {
+            sizes: [[750, 200]],
+        }
+    },
+    bids: [{
+        bidder: 'c1x',
+        params: {
+            placementId: 'div-gpt-ad-1654594619717-0',
+            'floorPriceMap': {
+                    '300x250': 4.35
+            }
+        }
+    }]
+  }, {
+    code: 'test-div-2',
+    mediaTypes: {
+        banner: {
+            sizes: [[300, 250], [750, 200]],
+        }
+    },
+    bids: [{
+        bidder: 'c1x',
+        params: {
+            placementId: 'div-gpt-ad-1654940683355-0',
+            'floorPriceMap': {
+                    '300x250': 4.35
+            }
+            dealId: '1233' // optional parameter
+        }
+    }]
+  }];
+
+
+  pbjs.bidderSettings = {
+    c1x: {
+      siteId: 999,
+      adserverTargeting: [{
+          key: "hb_bidder",
+          val: function(bidResponse) {
+              return bidResponse.bidderCode;
+          }
+      }, {
+          key: "hb_adid",
+          val: function(bidResponse) {
+              return bidResponse.adId;
+          }
+      }, {
+          key: "hb_pb",
+          val: function(bidResponse) {
+              return bidResponse.pbLg;
+          }
+      }]
+    }
+  }
+```

package/modules/cleanioRtdProvider.js

@@ -8,6 +8,8 @@
 
 import { submodule } from '../src/hook.js';
 import { logError, generateUUID, insertElement } from '../src/utils.js';
+import * as events from '../src/events.js';
+import CONSTANTS from '../src/constants.json';
 
 // ============================ MODULE STATE ===============================
 
@@ -147,6 +149,26 @@ function readConfig(config) {
   }
 }
 
+/**
+ * The function to be called upon module init
+ * Defined as a variable to be able to reset it naturally
+ */
+let startBillableEvents = function() {
+  // Upon clean.io submodule initialization, every winner bid is considered to be protected
+  // and therefore, subjected to billing
+  events.on(CONSTANTS.EVENTS.BID_WON, winnerBidResponse => {
+    events.emit(CONSTANTS.EVENTS.BILLABLE_EVENT, {
+      vendor: 'clean.io',
+      billingId: generateUUID(),
+      type: 'impression',
+      // TODO: if absolutely crucial, winnerBidResponse may be used
+      // to track down auctionId and transactionId
+      // However, those seem to be of importance for Demand Managers,
+      // while these billable events are for publishers
+    });
+  });
+}
+
 // ============================ MODULE REGISTRATION ===============================
 
 /**
@@ -160,6 +182,13 @@ function beforeInit() {
       try {
         readConfig(config);
         onModuleInit();
+
+        // Subscribing once to ensure no duplicate events
+        // in case module initialization code runs multiple times
+        // This should have been a part of submodule definition, but well...
+        // The assumption here is that in production init() will be called exactly once
+        startBillableEvents();
+        startBillableEvents = () => {};
         return true;
       } catch (err) {
         if (err instanceof ConfigError) {

package/modules/cleanmedianetBidAdapter.js

@@ -104,7 +104,7 @@ export const spec = {
           ext: {
             consent: bidderRequest.gdprConsent.consentString
           }
-        }
+        };
       }
 
       const imp = {

package/modules/colossussspBidAdapter.js

@@ -105,8 +105,8 @@ export const spec = {
         request.ccpa = bidderRequest.uspConsent;
       }
       if (bidderRequest.gdprConsent) {
-        request.gdpr_consent = bidderRequest.gdprConsent.consentString || 'ALL'
-        request.gdpr_require = bidderRequest.gdprConsent.gdprApplies ? 1 : 0
+        request.gdpr_consent = bidderRequest.gdprConsent.consentString || 'ALL';
+        request.gdpr_require = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
       }
     }
 

package/modules/concertAnalyticsAdapter.js

@@ -1,6 +1,6 @@
 import { logMessage } from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
-import adapter from '../src/AnalyticsAdapter.js';
+import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
 

package/modules/consentManagementUsp.js

@@ -44,7 +44,7 @@ function lookupUspConsent({onSuccess, onError}) {
     let uspapiFrame;
     let uspapiFunction;
 
-    while (!uspapiFrame) {
+    while (true) {
       try {
         if (typeof f.__uspapi === 'function') {
           uspapiFunction = f.__uspapi;
@@ -304,4 +304,4 @@ function enableConsentManagement(configFromUser = false) {
   loadConsentData(); // immediately look up consent data to make it available without requiring an auction
 }
 config.getConfig('consentManagement', config => setConsentConfig(config.consentManagement));
-setTimeout(() => !addedConsentHook && enableConsentManagement())
+setTimeout(() => !addedConsentHook && enableConsentManagement());

package/modules/consumableBidAdapter.js

@@ -1,16 +1,18 @@
 import { logWarn, createTrackPixelHtml, deepAccess, isArray, deepSetValue } from '../src/utils.js';
 import {config} from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'consumable';
 
-const BASE_URI = 'https://e.serverbid.com/api/v2'
+const BASE_URI = 'https://e.serverbid.com/api/v2';
 
 let siteId = 0;
 let bidder = 'consumable';
 
 export const spec = {
   code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
 
   /**
    * Determines whether or not the given bid request is valid.
@@ -82,6 +84,10 @@ export const spec = {
         adTypes: bid.adTypes || getSize(sizes)
       }, bid.params);
 
+      if (bid.mediaTypes.video && bid.mediaTypes.video.playerSize) {
+        placement.video = bid.mediaTypes.video;
+      }
+
       if (placement.networkId && placement.siteId && placement.unitId && placement.unitName) {
         data.placements.push(placement);
       }
@@ -155,6 +161,13 @@ export const spec = {
 
           if (decision.mediaType) {
             bid.meta.mediaType = decision.mediaType;
+
+            if (decision.mediaType === 'video') {
+              bid.mediaType = 'video';
+              bid.vastUrl = decision.vastUrl || undefined;
+              bid.vastXml = decision.vastXml || undefined;
+              bid.videoCacheKey = decision.uuid || undefined;
+            }
           }
 
           bidResponses.push(bid);
@@ -240,8 +253,13 @@ function getSize(sizes) {
 }
 
 function retrieveAd(decision, unitId, unitName) {
-  let ad = decision.contents && decision.contents[0] && decision.contents[0].body + createTrackPixelHtml(decision.impressionUrl);
-
+  let ad;
+  if (decision.contents && decision.contents[0]) {
+    ad = decision.contents[0].body + createTrackPixelHtml(decision.impressionUrl);
+  }
+  if (decision.vastXml) {
+    ad = decision.vastXml;
+  }
   return ad;
 }
 

package/modules/cpmstarBidAdapter.js

@@ -1,4 +1,5 @@
-import { deepAccess, getBidIdParameter, logWarn, logError } from '../src/utils.js';
+
+import * as utils from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
@@ -25,11 +26,11 @@ export const spec = {
 
   getMediaType: function (bidRequest) {
     if (bidRequest == null) return BANNER;
-    return !deepAccess(bidRequest, 'mediaTypes.video') ? BANNER : VIDEO;
+    return !utils.deepAccess(bidRequest, 'mediaTypes.video') ? BANNER : VIDEO;
   },
 
   getPlayerSize: function (bidRequest) {
-    var playerSize = deepAccess(bidRequest, 'mediaTypes.video.playerSize');
+    var playerSize = utils.deepAccess(bidRequest, 'mediaTypes.video.playerSize');
     if (playerSize == null) return [640, 440];
     if (playerSize[0] != null) playerSize = playerSize[0];
     if (playerSize == null || playerSize[0] == null || playerSize[1] == null) return [640, 440];
@@ -46,15 +47,14 @@ export const spec = {
 
     for (var i = 0; i < validBidRequests.length; i++) {
       var bidRequest = validBidRequests[i];
-      // TODO: is 'page' the right value here?
-      var referer = encodeURIComponent(bidderRequest.refererInfo.page);
-      var e = getBidIdParameter('endpoint', bidRequest.params);
+      var referer = encodeURIComponent(bidderRequest.refererInfo.referer);
+      var e = utils.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) +
+        '&json=c_b&mv=1&poolid=' + utils.getBidIdParameter('placementId', bidRequest.params) +
         '&reachedTop=' + encodeURIComponent(bidderRequest.refererInfo.reachedTop) +
         '&requestid=' + bidRequest.bidId +
         '&referer=' + encodeURIComponent(referer);
@@ -73,7 +73,7 @@ export const spec = {
             fixedEncodeURIComponent(node.name || '') + ',' +
             fixedEncodeURIComponent(node.domain || '');
         }
-        url += '&schain=' + schainString
+        url += '&schain=' + schainString;
       }
 
       if (bidderRequest.gdprConsent) {
@@ -93,10 +93,20 @@ export const spec = {
         url += '&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');
+      }
+
       requests.push({
-        method: 'GET',
+        method: 'POST',
         url: url,
         bidRequest: bidRequest,
+        data: body
       });
     }
 
@@ -117,13 +127,13 @@ export const spec = {
       var raw = serverResponse.body[i];
       var rawBid = raw.creatives[0];
       if (!rawBid) {
-        logWarn('cpmstarBidAdapter: server response failed check');
+        utils.logWarn('cpmstarBidAdapter: server response failed check');
         return;
       }
       var cpm = (parseFloat(rawBid.cpm) || 0);
 
       if (!cpm) {
-        logWarn('cpmstarBidAdapter: server response failed check. Missing cpm')
+        utils.logWarn('cpmstarBidAdapter: server response failed check. Missing cpm');
         return;
       }
 
@@ -142,7 +152,7 @@ export const spec = {
       };
 
       if (rawBid.hasOwnProperty('dealId')) {
-        bidResponse.dealId = rawBid.dealId
+        bidResponse.dealId = rawBid.dealId;
       }
 
       if (mediaType == BANNER && rawBid.code) {
@@ -156,7 +166,7 @@ export const spec = {
         bidResponse.mediaType = VIDEO;
         bidResponse.vastXml = rawBid.creativemacros.HTML5VID_VASTSTRING;
       } else {
-        return logError('bad response', rawBid);
+        return utils.logError('bad response', rawBid);
       }
 
       bidResponses.push(bidResponse);