prebid.js 5.19.0 → 6.2.0

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/oguryBidAdapter.js

@@ -83,7 +83,8 @@ function buildRequests(validBidRequests, bidderRequest) {
         bidfloor: getFloor(bidRequest),
         banner: {
           format: sizes
-        }
+        },
+        ext: bidRequest.params
       });
     }
   });

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 = {
@@ -322,7 +327,7 @@ function buildFpdQueryParams(fpdPath) {
       return acc;
     }, {})
   return Object.keys(fpd)
-    .map((name, _) => name + ':' + [...new Set(fpd[name])].join('|'))
+    .map((name, _) => name + ':' + fpd[name].join('|'))
     .join(',')
 }
 

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,

package/modules/playwireBidAdapter.md

@@ -0,0 +1,61 @@
+# Overview
+
+Module Name: Playwire Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: grid-tech@themediagrid.com
+
+# Description
+
+Module that connects to Grid demand source to fetch bids.
+The adapter is GDPR compliant and supports banner and video (instream and outstream).
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'test-div',
+               sizes: [[300, 250]],
+               bids: [
+                   {
+                       bidder: "playwire",
+                       params: {
+                           uid: '1',
+                           bidFloor: 0.5
+                       }
+                   }
+               ]
+           },{
+               code: 'test-div',
+               sizes: [[728, 90]],
+               bids: [
+                   {
+                       bidder: "playwire",
+                       params: {
+                           uid: 2,
+                           keywords: {
+                               brandsafety: ['disaster'],
+                               topic: ['stress', 'fear']
+                           }
+                       }
+                   }
+               ]
+           },
+           {
+               code: 'test-div',
+               sizes: [[728, 90]],
+               mediaTypes: { video: {
+                   context: 'instream',
+                   playerSize: [728, 90],
+                   mimes: ['video/mp4']
+               },
+               bids: [
+                   {
+                       bidder: "playwire",
+                       params: {
+                           uid: 11
+                       }
+                   }
+               ]
+          }
+       ];
+```

package/modules/prebidServerBidAdapter/index.js

@@ -731,7 +731,7 @@ const OPEN_RTB_PROTOCOL = {
       return;
     }
     const request = {
-      id: s2sBidRequest.tid,
+      id: firstBidRequest.auctionId,
       source: {tid: s2sBidRequest.tid},
       tmax: s2sConfig.timeout,
       imp: imps,
@@ -751,7 +751,7 @@ const OPEN_RTB_PROTOCOL = {
       }
     };
 
-    // Sets pbjs version, can be overwritten below if channel exists in s2sConfig.extPrebid
+    // This is no longer overwritten unless name and version explicitly overwritten by extPrebid (mergeDeep)
     request.ext.prebid = Object.assign(request.ext.prebid, {channel: {name: 'pbjs', version: $$PREBID_GLOBAL$$.version}})
 
     // set debug flag if in debug mode
@@ -761,7 +761,7 @@ const OPEN_RTB_PROTOCOL = {
 
     // s2sConfig video.ext.prebid is passed through openrtb to PBS
     if (s2sConfig.extPrebid && typeof s2sConfig.extPrebid === 'object') {
-      request.ext.prebid = Object.assign(request.ext.prebid, s2sConfig.extPrebid);
+      request.ext.prebid = mergeDeep(request.ext.prebid, s2sConfig.extPrebid);
     }
 
     /**

package/modules/pubmaticBidAdapter.js

@@ -11,6 +11,7 @@ const USER_SYNC_URL_IFRAME = 'https://ads.pubmatic.com/AdServer/js/user_sync.htm
 const USER_SYNC_URL_IMAGE = 'https://image8.pubmatic.com/AdServer/ImgSync?p=';
 const DEFAULT_CURRENCY = 'USD';
 const AUCTION_TYPE = 1;
+const GROUPM_ALIAS = {code: 'groupm', gvlid: 98};
 const UNDEFINED = undefined;
 const DEFAULT_WIDTH = 0;
 const DEFAULT_HEIGHT = 0;
@@ -866,10 +867,10 @@ function _handleEids(payload, validBidRequests) {
 
 function _checkMediaType(bid, newBid) {
   // Create a regex here to check the strings
-  if (bid.ext && bid.ext['BidType'] != undefined) {
-    newBid.mediaType = MEDIATYPE[bid.ext.BidType];
+  if (bid.ext && bid.ext['bidtype'] != undefined) {
+    newBid.mediaType = MEDIATYPE[bid.ext.bidtype];
   } else {
-    logInfo(LOG_WARN_PREFIX + 'bid.ext.BidType does not exist, checking alternatively for mediaType')
+    logInfo(LOG_WARN_PREFIX + 'bid.ext.bidtype does not exist, checking alternatively for mediaType')
     var adm = bid.adm;
     var admStr = '';
     var videoRegex = new RegExp(/VAST\s+version/);
@@ -1005,6 +1006,7 @@ export const spec = {
   code: BIDDER_CODE,
   gvlid: 76,
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+  aliases: [GROUPM_ALIAS],
   /**
   * Determines whether or not the given bid request is valid. Valid bid request must have placementId and hbid
   *

package/modules/relaidoBidAdapter.js

@@ -6,7 +6,7 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'relaido';
 const BIDDER_DOMAIN = 'api.relaido.jp';
-const ADAPTER_VERSION = '1.0.6';
+const ADAPTER_VERSION = '1.0.7';
 const DEFAULT_TTL = 300;
 const UUID_KEY = 'relaido_uuid';
 
@@ -31,14 +31,14 @@ function isBidRequestValid(bid) {
 }
 
 function buildRequests(validBidRequests, bidderRequest) {
-  let bidRequests = [];
+  const bids = [];
+  let imuid = null;
+  let bidDomain = null;
+  let bidder = null;
+  let count = null;
 
   for (let i = 0; i < validBidRequests.length; i++) {
     const bidRequest = validBidRequests[i];
-    const placementId = getBidIdParameter('placementId', bidRequest.params);
-    const bidDomain = bidRequest.params.domain || BIDDER_DOMAIN;
-    const bidUrl = `https://${bidDomain}/bid/v1/prebid/${placementId}`;
-    const uuid = getUuid();
     let mediaType = '';
     let width = 0;
     let height = 0;
@@ -55,46 +55,63 @@ function buildRequests(validBidRequests, bidderRequest) {
       mediaType = BANNER;
     }
 
-    let payload = {
-      version: ADAPTER_VERSION,
-      timeout_ms: bidderRequest.timeout,
-      ad_unit_code: bidRequest.adUnitCode,
-      auction_id: bidRequest.auctionId,
-      bidder: bidRequest.bidder,
-      bidder_request_id: bidRequest.bidderRequestId,
-      bid_requests_count: bidRequest.bidRequestsCount,
-      bid_id: bidRequest.bidId,
-      transaction_id: bidRequest.transactionId,
-      media_type: mediaType,
-      uuid: uuid,
-      width: width,
-      height: height,
-      pv: '$prebid.version$'
-    };
+    if (!imuid) {
+      const pickImuid = deepAccess(bidRequest, 'userId.imuid');
+      if (pickImuid) {
+        imuid = pickImuid;
+      }
+    }
+
+    if (!bidDomain) {
+      bidDomain = bidRequest.params.domain;
+    }
+
+    if (!bidder) {
+      bidder = bidRequest.bidder
+    }
+
+    if (!bidder) {
+      bidder = bidRequest.bidder
+    }
 
-    const imuid = deepAccess(bidRequest, 'userId.imuid');
-    if (imuid) {
-      payload.imuid = imuid;
+    if (!count) {
+      count = bidRequest.bidRequestsCount;
     }
 
-    // It may not be encoded, so add it at the end of the payload
-    payload.ref = bidderRequest.refererInfo.referer;
-
-    bidRequests.push({
-      method: 'GET',
-      url: bidUrl,
-      data: payload,
-      options: {
-        withCredentials: true
-      },
-      bidId: bidRequest.bidId,
+    bids.push({
+      bid_id: bidRequest.bidId,
+      placement_id: getBidIdParameter('placementId', bidRequest.params),
+      transaction_id: bidRequest.transactionId,
+      bidder_request_id: bidRequest.bidderRequestId,
+      ad_unit_code: bidRequest.adUnitCode,
+      auction_id: bidRequest.auctionId,
       player: bidRequest.params.player,
-      width: payload.width,
-      height: payload.height,
-      mediaType: payload.media_type
+      width: width,
+      height: height,
+      media_type: mediaType
     });
   }
-  return bidRequests;
+
+  const data = JSON.stringify({
+    version: ADAPTER_VERSION,
+    bids: bids,
+    timeout_ms: bidderRequest.timeout,
+    bidder: bidder,
+    bid_requests_count: count,
+    uuid: getUuid(),
+    pv: '$prebid.version$',
+    imuid: imuid,
+    ref: bidderRequest.refererInfo.referer
+  })
+
+  return {
+    method: 'POST',
+    url: `https://${bidDomain || BIDDER_DOMAIN}/bid/v1/sprebid`,
+    options: {
+      withCredentials: true
+    },
+    data: data
+  };
 }
 
 function interpretResponse(serverResponse, bidRequest) {
@@ -105,34 +122,38 @@ function interpretResponse(serverResponse, bidRequest) {
   }
 
   const playerUrl = bidRequest.player || body.playerUrl;
-  const mediaType = bidRequest.mediaType || VIDEO;
-
-  let bidResponse = {
-    requestId: bidRequest.bidId,
-    width: bidRequest.width,
-    height: bidRequest.height,
-    cpm: body.price,
-    currency: body.currency,
-    creativeId: body.creativeId,
-    dealId: body.dealId || '',
-    ttl: body.ttl || DEFAULT_TTL,
-    netRevenue: true,
-    mediaType: mediaType,
-    meta: {
-      advertiserDomains: body.adomain || [],
-      mediaType: VIDEO
+
+  for (const res of body.ads) {
+    let bidResponse = {
+      requestId: res.bidId,
+      width: res.width,
+      height: res.height,
+      cpm: res.price,
+      currency: res.currency,
+      creativeId: res.creativeId,
+      dealId: body.dealId || '',
+      ttl: body.ttl || DEFAULT_TTL,
+      netRevenue: true,
+      mediaType: res.mediaType || VIDEO,
+      meta: {
+        advertiserDomains: res.adomain || [],
+        mediaType: VIDEO
+      }
+    };
+
+    if (bidResponse.mediaType === VIDEO) {
+      bidResponse.vastXml = res.vast;
+      bidResponse.renderer = newRenderer(res.bidId, playerUrl);
+    } else {
+      const playerTag = createPlayerTag(playerUrl);
+      const renderTag = createRenderTag(res.width, res.height, res.vast);
+      bidResponse.ad = `<div id="rop-prebid">${playerTag}${renderTag}</div>`;
     }
-  };
-  if (mediaType === VIDEO) {
-    bidResponse.vastXml = body.vast;
-    bidResponse.renderer = newRenderer(bidRequest.bidId, playerUrl);
-  } else {
-    const playerTag = createPlayerTag(playerUrl);
-    const renderTag = createRenderTag(bidRequest.width, bidRequest.height, body.vast);
-    bidResponse.ad = `<div id="rop-prebid">${playerTag}${renderTag}</div>`;
+    bidResponses.push(bidResponse);
   }
-  bidResponses.push(bidResponse);
 
+  // eslint-disable-next-line no-console
+  console.log(JSON.stringify(bidResponses));
   return bidResponses;
 }
 

package/modules/richaudienceBidAdapter.js

@@ -296,7 +296,7 @@ function raiGetFloor(bid, config) {
     } else if (typeof bid.getFloor == 'function') {
       let floorSpec = bid.getFloor({
         currency: config.getConfig('currency.adServerCurrency'),
-        mediaType: bid.mediaType.banner ? 'banner' : 'video',
+        mediaType: typeof bid.mediaTypes['banner'] == 'object' ? 'banner' : 'video',
         size: '*'
       })