prebid.js 5.18.0 → 6.1.0

package/modules/livewrappedAnalyticsAdapter.js

@@ -3,6 +3,7 @@ import {ajax} from '../src/ajax.js';
 import adapter from '../src/AnalyticsAdapter.js';
 import CONSTANTS from '../src/constants.json';
 import adapterManager from '../src/adapterManager.js';
+import { getGlobal } from '../src/prebidGlobal.js';
 
 const ANALYTICSTYPE = 'endpoint';
 const URL = 'https://lwadm.com/analytics/10';
@@ -11,8 +12,10 @@ const REQUESTSENT = 1;
 const RESPONSESENT = 2;
 const WINSENT = 4;
 const TIMEOUTSENT = 8;
+const ADRENDERFAILEDSENT = 16;
 
 let initOptions;
+let prebidGlobal = getGlobal();
 export const BID_WON_TIMEOUT = 500;
 
 const cache = {
@@ -78,6 +81,7 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
         bidResponse.width = args.width;
         bidResponse.height = args.height;
         bidResponse.cpm = args.cpm;
+        bidResponse.originalCpm = prebidGlobal.convertCurrency(args.originalCpm, args.originalCurrency, args.currency);
         bidResponse.ttr = args.timeToRespond;
         bidResponse.readyToSend = 1;
         bidResponse.mediaType = args.mediaType == 'native' ? 2 : (args.mediaType == 'video' ? 4 : 1);
@@ -114,6 +118,16 @@ let livewrappedAnalyticsAdapter = Object.assign(adapter({EMPTYURL, ANALYTICSTYPE
           livewrappedAnalyticsAdapter.sendEvents();
         }
         break;
+      case CONSTANTS.EVENTS.AD_RENDER_FAILED:
+        logInfo('LIVEWRAPPED_AD_RENDER_FAILED:', args);
+        let adRenderFailedBid = cache.auctions[args.bid.auctionId].bids[args.bid.requestId];
+        adRenderFailedBid.adRenderFailed = true;
+        adRenderFailedBid.reason = args.reason;
+        adRenderFailedBid.message = args.message;
+        if (adRenderFailedBid.sendStatus != 0) {
+          livewrappedAnalyticsAdapter.sendEvents();
+        }
+        break;
       case CONSTANTS.EVENTS.BID_TIMEOUT:
         logInfo('LIVEWRAPPED_BID_TIMEOUT:', args);
         args.forEach(timeout => {
@@ -151,13 +165,15 @@ livewrappedAnalyticsAdapter.sendEvents = function() {
     wins: getWins(sentRequests.gdpr, sentRequests.auctionIds),
     timeouts: getTimeouts(sentRequests.auctionIds),
     bidAdUnits: getbidAdUnits(),
+    rf: getAdRenderFailed(sentRequests.auctionIds),
     rcv: getAdblockerRecovered()
   };
 
   if (events.requests.length == 0 &&
       events.responses.length == 0 &&
       events.wins.length == 0 &&
-      events.timeouts.length == 0) {
+      events.timeouts.length == 0 &&
+      events.rf.length == 0) {
     return;
   }
 
@@ -224,6 +240,7 @@ function getResponses(gdpr, auctionIds) {
           width: bid.width,
           height: bid.height,
           cpm: bid.cpm,
+          orgCpm: bid.originalCpm,
           ttr: bid.ttr,
           IsBid: bid.isBid,
           mediaType: bid.mediaType,
@@ -263,6 +280,7 @@ function getWins(gdpr, auctionIds) {
           width: bid.width,
           height: bid.height,
           cpm: bid.cpm,
+          orgCpm: bid.originalCpm,
           mediaType: bid.mediaType,
           gdpr: gdprPos,
           floor: bid.lwFloor ? bid.lwFloor : (bid.floorData ? bid.floorData.floorValue : undefined),
@@ -338,6 +356,36 @@ function getTimeouts(auctionIds) {
   return timeouts;
 }
 
+function getAdRenderFailed(auctionIds) {
+  var adRenderFails = [];
+
+  Object.keys(cache.auctions).forEach(auctionId => {
+    let auctionIdPos = getAuctionIdPos(auctionIds, auctionId);
+    Object.keys(cache.auctions[auctionId].bids).forEach(bidId => {
+      let auction = cache.auctions[auctionId];
+      let bid = auction.bids[bidId];
+      if (!(bid.sendStatus & ADRENDERFAILEDSENT) && bid.adRenderFailed) {
+        bid.sendStatus |= ADRENDERFAILEDSENT;
+
+        adRenderFails.push({
+          bidder: bid.bidder,
+          adUnit: bid.adUnit,
+          adUnitId: bid.adUnitId,
+          timeStamp: auction.timeStamp,
+          auctionId: auctionIdPos,
+          auc: bid.auc,
+          buc: bid.buc,
+          lw: bid.lw,
+          rsn: bid.reason,
+          msg: bid.message
+        });
+      }
+    });
+  });
+
+  return adRenderFails;
+}
+
 function getbidAdUnits() {
   var bidAdUnits = [];
 

package/modules/merkleIdSystem.js

@@ -149,6 +149,11 @@ export const merkleIdSubmodule = {
     logInfo('User ID - merkleId stored id ' + storedId);
     const configParams = (config && config.params) || {};
 
+    if (typeof configParams.endpoint !== 'string') {
+      logWarn('User ID - merkleId submodule endpoint string is not defined');
+      configParams.endpoint = ID_URL
+    }
+
     if (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) {
       logError('User ID - merkleId submodule does not currently handle consent strings');
       return;

package/modules/multibid/index.js

@@ -112,7 +112,7 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
     if (multiConfig[bid.bidderCode].prefix) bid.multibidPrefix = multiConfig[bid.bidderCode].prefix;
     bid.originalBidder = bid.bidderCode;
     // Check if stored bids for auction include adUnitCode.bidder and max limit not reach for ad unit
-    if (deepAccess(multibidUnits, `${adUnitCode}.${bid.bidderCode}`)) {
+    if (deepAccess(multibidUnits, [adUnitCode, bid.bidderCode])) {
       // Store request id under new property originalRequestId, create new unique bidId,
       // and push bid into multibid stored bids for auction if max not reached and bid cpm above floor
       if (!multibidUnits[adUnitCode][bid.bidderCode].maxReached && (!floor || floor <= bid.cpm)) {
@@ -131,9 +131,9 @@ export function addBidResponseHook(fn, adUnitCode, bid) {
         logWarn(`Filtering multibid received from bidder ${bid.bidderCode}: ` + ((multibidUnits[adUnitCode][bid.bidderCode].maxReached) ? `Maximum bid limit reached for ad unit code ${adUnitCode}` : 'Bid cpm under floors value.'));
       }
     } else {
-      if (deepAccess(bid, 'floorData.floorValue')) deepSetValue(multibidUnits, `${adUnitCode}.${bid.bidderCode}`, {floor: deepAccess(bid, 'floorData.floorValue')});
+      if (deepAccess(bid, 'floorData.floorValue')) deepSetValue(multibidUnits, [adUnitCode, bid.bidderCode], {floor: deepAccess(bid, 'floorData.floorValue')});
 
-      deepSetValue(multibidUnits, `${adUnitCode}.${bid.bidderCode}`, {ads: [bid]});
+      deepSetValue(multibidUnits, [adUnitCode, bid.bidderCode], {ads: [bid]});
       if (multibidUnits[adUnitCode][bid.bidderCode].ads.length === multiConfig[bid.bidderCode].maxbids) multibidUnits[adUnitCode][bid.bidderCode].maxReached = true;
 
       fn.call(this, adUnitCode, bid);

package/modules/nativoBidAdapter.js

@@ -17,6 +17,16 @@ const adUnitsRequested = {}
 
 // Prebid adapter referrence doc: https://docs.prebid.org/dev-docs/bidder-adaptor.html
 
+// Validity checks for optionsl paramters
+const validParameter = {
+  url: (value) => typeof value === 'string',
+  placementId: (value) => {
+    const isString = typeof value === 'string'
+    const isNumber = typeof value === 'number'
+    return isString || isNumber
+  },
+}
+
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVLID,
@@ -30,7 +40,23 @@ export const spec = {
    * @return boolean True if this is a valid bid, and false otherwise.
    */
   isBidRequestValid: function (bid) {
-    return true
+    // We don't need any specific parameters to make a bid request
+    // If not parameters are supplied just verify it's the correct bidder code
+    if (!bid.params) return bid.bidder === BIDDER_CODE
+
+    // Check if any supplied parameters are invalid
+    const hasInvalidParameters = Object.keys(bid.params).some(key => {
+      const value = bid.params[key]
+      const validityCheck = validParameter[key]
+
+      // We don't have a test for this so it's not a paramter we care about
+      if (!validityCheck) return false
+
+      // Return if the check is not passed
+      return !validityCheck(value)
+    })
+
+    return !hasInvalidParameters
   },
 
   /**
@@ -98,7 +124,11 @@ export const spec = {
     ]
 
     if (placementIds.size > 0) {
-      params.unshift({ key: 'ntv_ptd', value: [...placementIds].join(',') })
+      // Convert Set to Array (IE 11 Safe)
+      const placements = []
+      placementIds.forEach((value) => placements.push(value))
+      // Append to query string paramters
+      params.unshift({ key: 'ntv_ptd', value: placements.join(',') })
     }
 
     if (bidderRequest.gdprConsent) {

package/modules/nextMillenniumBidAdapter.js

@@ -30,14 +30,23 @@ export const spec = {
           }
         }
       }
+
       const gdprConsent = bidderRequest && bidderRequest.gdprConsent;
+      const uspConsent = bidderRequest && bidderRequest.uspConsent
+
+      if (gdprConsent || uspConsent) {
+        postBody.regs = { ext: {} }
 
-      if (gdprConsent) {
+        if (uspConsent) {
+          postBody.regs.ext.us_privacy = uspConsent;
+        }
         if (typeof gdprConsent.gdprApplies !== 'undefined') {
-          postBody.gdprApplies = !!gdprConsent.gdprApplies;
+          postBody.regs.ext.gdpr = gdprConsent.gdprApplies ? 1 : 0;
         }
         if (typeof gdprConsent.consentString !== 'undefined') {
-          postBody.consentString = gdprConsent.consentString;
+          postBody.user = {
+            ext: { consent: gdprConsent.consentString }
+          }
         }
       }
 

package/modules/oguryBidAdapter.js

@@ -1,7 +1,7 @@
 'use strict';
 
 import { BANNER } from '../src/mediaTypes.js';
-import { getAdUnitSizes, logWarn, isFn } from '../src/utils.js';
+import { getAdUnitSizes, logWarn, isFn, getWindowTop, getWindowSelf } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { ajax } from '../src/ajax.js'
 
@@ -83,7 +83,8 @@ function buildRequests(validBidRequests, bidderRequest) {
         bidfloor: getFloor(bidRequest),
         banner: {
           format: sizes
-        }
+        },
+        ext: bidRequest.params
       });
     }
   });
@@ -145,7 +146,19 @@ function getFloor(bid) {
   return floorResult.currency === 'USD' ? floorResult.floor : 0;
 }
 
+function getWindowContext() {
+  try {
+    return getWindowTop()
+  } catch (e) {
+    return getWindowSelf()
+  }
+}
+
 function onBidWon(bid) {
+  const w = getWindowContext()
+  w.OG_PREBID_BID_OBJECT = {
+    ...(bid && { ...bid }),
+  }
   if (bid && bid.hasOwnProperty('nurl') && bid.nurl.length > 0) ajax(bid['nurl'], null);
 }
 
@@ -165,6 +178,7 @@ export const spec = {
   interpretResponse,
   getFloor,
   onBidWon,
+  getWindowContext,
   onTimeout
 }
 

package/modules/openxBidAdapter.js

@@ -42,7 +42,12 @@ export const USER_ID_CODE_TO_QUERY_ARG = {
   novatiq: 'novatiqid', // Novatiq ID
   mwOpenLinkId: 'mwopenlinkid', // MediaWallah OpenLink ID
   dapId: 'dapid', // Akamai DAP ID
-  amxId: 'amxid' // AMX RTB ID
+  amxId: 'amxid', // AMX RTB ID
+  kpuid: 'kpuid', // Kinesso ID
+  publinkId: 'publinkid', // Publisher Link
+  naveggId: 'naveggid', // Navegg ID
+  imuid: 'imuid', // IM-UID by Intimate Merger
+  adtelligentId: 'adtelligentid' // Adtelligent ID
 };
 
 export const spec = {
@@ -256,27 +261,14 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
     nocache: new Date().getTime()
   };
 
-  const firstPartyData = config.getConfig('ortb2.user.data')
-  if (Array.isArray(firstPartyData) && firstPartyData.length > 0) {
-    // extract and merge valid segments by provider/taxonomy
-    const fpd = firstPartyData
-      .filter(
-        data => (Array.isArray(data.segment) &&
-                data.segment.length > 0 &&
-                data.name !== undefined &&
-                data.name.length > 0)
-      )
-      .reduce((acc, data) => {
-        const name = typeof data.ext === 'object' && data.ext.segtax ? `${data.name}/${data.ext.segtax}` : data.name;
-        acc[name] = (acc[name] || []).concat(data.segment.map(seg => seg.id));
-        return acc;
-      }, {})
-    const sm = Object.keys(fpd)
-      .map((name, _) => name + ':' + fpd[name].join('|'))
-      .join(',')
-    if (sm.length > 0) {
-      defaultParams.sm = encodeURIComponent(sm);
-    }
+  const userDataSegments = buildFpdQueryParams('ortb2.user.data');
+  if (userDataSegments.length > 0) {
+    defaultParams.sm = userDataSegments;
+  }
+
+  const siteContentDataSegments = buildFpdQueryParams('ortb2.site.content.data');
+  if (siteContentDataSegments.length > 0) {
+    defaultParams.scsm = siteContentDataSegments;
   }
 
   if (bids[0].params.platform) {
@@ -317,12 +309,37 @@ function buildCommonQueryParamsFromBids(bids, bidderRequest) {
   return defaultParams;
 }
 
+function buildFpdQueryParams(fpdPath) {
+  const firstPartyData = config.getConfig(fpdPath);
+  if (!Array.isArray(firstPartyData) || !firstPartyData.length) {
+    return '';
+  }
+  const fpd = firstPartyData
+    .filter(
+      data => (Array.isArray(data.segment) &&
+            data.segment.length > 0 &&
+            data.name !== undefined &&
+            data.name.length > 0)
+    )
+    .reduce((acc, data) => {
+      const name = typeof data.ext === 'object' && data.ext.segtax ? `${data.name}/${data.ext.segtax}` : data.name;
+      acc[name] = (acc[name] || []).concat(data.segment.map(seg => seg.id));
+      return acc;
+    }, {})
+  return Object.keys(fpd)
+    .map((name, _) => name + ':' + fpd[name].join('|'))
+    .join(',')
+}
+
 function appendUserIdsToQueryParams(queryParams, userIds) {
   _each(userIds, (userIdObjectOrValue, userIdProviderKey) => {
     const key = USER_ID_CODE_TO_QUERY_ARG[userIdProviderKey];
 
     if (USER_ID_CODE_TO_QUERY_ARG.hasOwnProperty(userIdProviderKey)) {
       switch (userIdProviderKey) {
+        case 'merkleId':
+          queryParams[key] = userIdObjectOrValue.id;
+          break;
         case 'flocId':
           queryParams[key] = userIdObjectOrValue.id;
           break;
@@ -333,7 +350,7 @@ function appendUserIdsToQueryParams(queryParams, userIds) {
           queryParams[key] = userIdObjectOrValue.lipbid;
           if (Array.isArray(userIdObjectOrValue.segments) && userIdObjectOrValue.segments.length > 0) {
             const liveIntentSegments = 'liveintent:' + userIdObjectOrValue.segments.join('|')
-            queryParams.sm = `${queryParams.sm ? queryParams.sm + encodeURIComponent(',') : ''}${encodeURIComponent(liveIntentSegments)}`;
+            queryParams.sm = `${queryParams.sm ? queryParams.sm + ',' : ''}${liveIntentSegments}`;
           }
           break;
         case 'parrableId':

package/modules/operaadsBidAdapter.js

@@ -8,6 +8,7 @@ import { OUTSTREAM } from '../src/video.js';
 const BIDDER_CODE = 'operaads';
 
 const ENDPOINT = 'https://s.adx.opera.com/ortb/v2/';
+const USER_SYNC_ENDPOINT = 'https://s.adx.opera.com/usersync/page';
 
 const OUTSTREAM_RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
 
@@ -137,6 +138,25 @@ export const spec = {
    * @return {UserSync[]} The user syncs which should be dropped.
    */
   getUserSyncs: function (syncOptions, serverResponses, gdprConsent, uspConsent) {
+    if ('iframeEnabled' in syncOptions && syncOptions.iframeEnabled) {
+      return [{
+        type: 'iframe',
+        url: USER_SYNC_ENDPOINT
+      }];
+    }
+    if ('pixelEnabled' in syncOptions && syncOptions.pixelEnabled) {
+      const pixels = deepAccess(serverResponses, '0.body.pixels')
+      if (Array.isArray(pixels)) {
+        const userSyncPixels = []
+        for (const pixel of pixels) {
+          userSyncPixels.push({
+            type: 'image',
+            url: pixel
+          })
+        }
+        return userSyncPixels;
+      }
+    }
     return [];
   },
 
@@ -212,7 +232,7 @@ function buildOpenRtbBidRequest(bidRequest, bidderRequest) {
       ext: {}
     },
     user: {
-      id: getUserId(bidRequest)
+      buyeruid: getUserId(bidRequest)
     }
   }
 

package/modules/otmBidAdapter.js

@@ -0,0 +1,146 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import {logInfo, logError, getBidIdParameter, _each, getValue, isFn, isPlainObject} from '../src/utils.js';
+import { BANNER } from '../src/mediaTypes.js';
+
+const BIDDER_CODE = 'otm';
+const OTM_BID_URL = 'https://ssp.otm-r.com/adjson';
+const DEF_CUR = 'RUB'
+
+export const spec = {
+
+  code: BIDDER_CODE,
+  url: OTM_BID_URL,
+  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.
+   */
+  isBidRequestValid: function (bid) {
+    return !!bid.params.tid;
+  },
+
+  /**
+   * Build bidder requests.
+   *
+   * @param validBidRequests
+   * @param bidderRequest
+   * @returns {[]}
+   */
+  buildRequests: function (validBidRequests, bidderRequest) {
+    logInfo('validBidRequests', validBidRequests);
+
+    const bidRequests = [];
+    let tz = new Date().getTimezoneOffset()
+    let referrer = '';
+    if (bidderRequest && bidderRequest.refererInfo) {
+      referrer = bidderRequest.refererInfo.referer;
+    }
+
+    _each(validBidRequests, (bid) => {
+      let domain = getValue(bid.params, 'domain') || ''
+      let tid = getValue(bid.params, 'tid')
+      let cur = getValue(bid.params, 'currency') || DEF_CUR
+      let bidid = getBidIdParameter('bidId', bid)
+      let transactionid = getBidIdParameter('transactionId', bid)
+      let auctionid = getBidIdParameter('auctionId', bid)
+      let bidfloor = _getBidFloor(bid)
+
+      _each(bid.sizes, size => {
+        let width = 0;
+        let height = 0;
+        if (size.length && typeof size[0] === 'number' && typeof size[1] === 'number') {
+          width = size[0];
+          height = size[1];
+        }
+        bidRequests.push({
+          method: 'GET',
+          url: OTM_BID_URL,
+          data: {
+            tz: tz,
+            w: width,
+            h: height,
+            domain: domain,
+            l: referrer,
+            s: tid,
+            cur: cur,
+            bidid: bidid,
+            transactionid: transactionid,
+            auctionid: auctionid,
+            bidfloor: bidfloor,
+          },
+        })
+      })
+    })
+    return bidRequests;
+  },
+
+  /**
+   * Generate response.
+   *
+   * @param serverResponse
+   * @param request
+   * @returns {[]|*[]}
+   */
+  interpretResponse: function (serverResponse, request) {
+    logInfo('serverResponse', serverResponse.body);
+
+    const responsesBody = serverResponse ? serverResponse.body : {};
+    const bidResponses = [];
+    try {
+      if (responsesBody.length === 0) {
+        return [];
+      }
+
+      _each(responsesBody, (bid) => {
+        if (bid.ad) {
+          bidResponses.push({
+            requestId: bid.bidid,
+            cpm: bid.cpm,
+            width: bid.w,
+            height: bid.h,
+            creativeId: bid.creativeid,
+            currency: bid.currency || 'RUB',
+            netRevenue: true,
+            ad: bid.ad,
+            ttl: bid.ttl,
+            transactionId: bid.transactionid,
+            meta: {
+              advertiserDomains: bid.adDomain ? [bid.adDomain] : []
+            }
+          });
+        }
+      });
+    } catch (error) {
+      logError(error);
+    }
+
+    return bidResponses;
+  }
+};
+
+/**
+ * Get floor value
+ * @param bid
+ * @returns {null|*}
+ * @private
+ */
+function _getBidFloor(bid) {
+  if (!isFn(bid.getFloor)) {
+    return bid.params.bidfloor ? bid.params.bidfloor : 0;
+  }
+
+  let floor = bid.getFloor({
+    currency: DEF_CUR,
+    mediaType: '*',
+    size: '*'
+  });
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === DEF_CUR) {
+    return floor.floor;
+  }
+  return 0;
+}
+
+registerBidder(spec);

package/modules/otmBidAdapter.md

@@ -1,36 +1,37 @@
 # Overview
 
-Module Name: OTM Bidder Adapter
-Module Type: Bidder Adapter
-Maintainer: ?
+**Module Name**: OTM Bidder Adapter
+**Module Type**: Bidder Adapter  
+**Maintainer**: e.kretsu@otm-r.com
 
 # Description
 
-You can use this adapter to get a bid from otm-r.com.
+OTM Bidder Adapter for Prebid.js. About: https://otm-r.com
 
-About us : http://otm-r.com
+Use `otm` as bidder:
 
+# Params
+- `tid` required, specific id AdUnit slot.
+- `domain` optional, specific custom domain.
+- `bidfloor` optional.
 
-# Test Parameters
-```javascript
-    var adUnits = [
-        {
-            code: 'div-otm-example',
-            sizes: [[320, 480]],
-            bids: [
-                {
-                    bidder: "otm",
-                    params: {
-                        tid: "99",
-                        bidfloor: 20
-                    }
-                }
-            ]
-        }
-    ];
+## AdUnits configuration example
 ```
+    var adUnits = [{
+      code: 'your-slot', //use exactly the same code as your slot div id.
+      mediaTypes: {
+          banner: {
+              sizes: [[320, 480]]
+          }
+      },
+      bids: [{
+        bidder: 'otm',
+        params: { 
+            tid: 'XXXXX',
+            domain: 'specific custom domain, if needed',
+            bidfloor: 20
+        }
+      }]
+    }];
 
-Where:
-
-* tid - A tag id (should have low cardinality)
-* bidfloor - Floor price
+```

package/modules/outbrainBidAdapter.js

@@ -40,6 +40,7 @@ export const spec = {
     const publisher = setOnAny(validBidRequests, 'params.publisher');
     const bcat = setOnAny(validBidRequests, 'params.bcat');
     const badv = setOnAny(validBidRequests, 'params.badv');
+    const eids = setOnAny(validBidRequests, 'userIdAsEids')
     const cur = CURRENCY;
     const endpointUrl = config.getConfig('outbrain.bidderUrl');
     const timeout = bidderRequest.timeout;
@@ -105,6 +106,10 @@ export const spec = {
       deepSetValue(request, 'regs.coppa', config.getConfig('coppa') & 1)
     }
 
+    if (eids) {
+      deepSetValue(request, 'user.ext.eids', eids);
+    }
+
     return {
       method: 'POST',
       url: endpointUrl,