prebid.js 5.16.0 → 5.20.0

package/modules/openxBidAdapter.js

@@ -256,27 +256,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 +304,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 +345,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,

package/modules/pixfutureBidAdapter.js

@@ -1,9 +1,9 @@
-import { convertCamelToUnderscore, isArray, isNumber, isPlainObject, deepAccess, isEmpty, transformBidderParamKeywords, isFn } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 import includes from 'core-js-pure/features/array/includes.js';
+import { convertCamelToUnderscore, isArray, isNumber, isPlainObject, deepAccess, isEmpty, transformBidderParamKeywords, isFn } from '../src/utils.js';
 import { auctionManager } from '../src/auctionManager.js';
 import find from 'core-js-pure/features/array/find.js';
 
@@ -12,7 +12,7 @@ const storageManager = getStorageManager();
 const USER_PARAMS = ['age', 'externalUid', 'segments', 'gender', 'dnt', 'language'];
 export const spec = {
   code: 'pixfuture',
-  hostname: 'https://prebid-js.pixfuture.com',
+  hostname: 'https://gosrv.pixfuture.com',
 
   getHostname() {
     let ret = this.hostname;
@@ -77,7 +77,7 @@ export const spec = {
       };
 
       if (bidderRequest && bidderRequest.uspConsent) {
-        payload.us_privacy = bidderRequest.uspConsent
+        payload.us_privacy = bidderRequest.uspConsent;
       }
 
       if (bidderRequest && bidderRequest.refererInfo) {
@@ -112,7 +112,7 @@ export const spec = {
       }
 
       const ret = {
-        url: `${hostname}/`,
+        url: `${hostname}/pixservices`,
         method: 'POST',
         options: {withCredentials: false},
         data: {
@@ -153,6 +153,16 @@ export const spec = {
 
     return bids;
   },
+  getUserSyncs: function (syncOptions, bid, gdprConsent) {
+    var pixid = '';
+    if (typeof bid[0] === 'undefined' || bid[0] === null) { pixid = '0'; } else { pixid = bid[0].body.pix_id; }
+    if (syncOptions.iframeEnabled && hasPurpose1Consent({gdprConsent})) {
+      return [{
+        type: 'iframe',
+        url: 'https://gosrv.pixfuture.com/cookiesync?adsync=' + gdprConsent.consentString + '&pixid=' + pixid + '&gdprconcent=' + gdprConsent.gdprApplies
+      }];
+    }
+  }
 };
 
 function newBid(serverBid, rtbBid, placementId, uuid) {
@@ -179,6 +189,16 @@ function newBid(serverBid, rtbBid, placementId, uuid) {
   return bid;
 }
 
+function hasPurpose1Consent(bidderRequest) {
+  let result = true;
+  if (bidderRequest && bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent.gdprApplies && bidderRequest.gdprConsent.apiVersion === 2) {
+      result = !!(deepAccess(bidderRequest.gdprConsent, 'vendorData.purpose.consents.1') === true);
+    }
+  }
+  return result;
+}
+
 // Functions related optional parameters
 function bidToTag(bid) {
   const tag = {};

package/modules/pixfutureBidAdapter.md

@@ -25,3 +25,130 @@ var adUnits = [{
                 "pix_id": "Abc123"
             }];
 ```
+
+# Test Example
+...
+<html>
+
+    <head>
+        <link rel="icon" type="image/png" href="/favicon.ico">
+        <script async src="//www.googletagservices.com/tag/js/gpt.js"></script>
+        <script async src="https://cdn.pixfuture.com/pixfuture_prebidjs/prebid.js"></script>
+        <script>
+            var div_1_sizes = [
+                [300, 250],
+                [300, 600]
+            ];
+            var div_2_sizes = [
+                [728, 90],
+                [970, 250]
+            ];
+            var PREBID_TIMEOUT = 1000;
+            var FAILSAFE_TIMEOUT = 3000;
+
+            var adUnits = [
+                {
+                    code: '/19968336/header-bid-tag-0',
+                    mediaTypes: {
+                        banner: {
+                            sizes: div_1_sizes
+                        }
+                    },
+                    bids: [{
+                        bidder: 'pixfuture',
+                        params: {
+                            "pix_id": "777"
+                        }
+                    }]
+                },
+                {
+                    code: '/19968336/header-bid-tag-1',
+                    mediaTypes: {
+                        banner: {
+                            sizes: div_2_sizes
+                        }
+                    },
+                    bids: [{
+                        bidder: 'appnexus',
+                        params: {
+                            placementId: 13144370
+                        }
+                    }]
+                }
+            ];
+
+            // ======== DO NOT EDIT BELOW THIS LINE =========== //
+            var googletag = googletag || {};
+            googletag.cmd = googletag.cmd || [];
+            googletag.cmd.push(function() {
+                googletag.pubads().disableInitialLoad();
+            });
+
+            var pbjs = pbjs || {};
+            pbjs.que = pbjs.que || [];
+
+            pbjs.que.push(function() {
+                pbjs.addAdUnits(adUnits);
+                pbjs.requestBids({
+                    bidsBackHandler: initAdserver,
+                    timeout: PREBID_TIMEOUT
+                });
+            });
+
+            function initAdserver() {
+                if (pbjs.initAdserverSet) return;
+                pbjs.initAdserverSet = true;
+                googletag.cmd.push(function() {
+                    pbjs.que.push(function() {
+                        pbjs.setTargetingForGPTAsync();
+                        googletag.pubads().refresh();
+                    });
+                });
+            }
+            // in case PBJS doesn't load
+            setTimeout(function() {
+                initAdserver();
+            }, FAILSAFE_TIMEOUT);
+
+            googletag.cmd.push(function() {
+                googletag.defineSlot('/19968336/header-bid-tag-0', div_1_sizes, 'div-1').addService(googletag.pubads());
+                googletag.pubads().enableSingleRequest();
+                googletag.enableServices();
+            });
+            googletag.cmd.push(function() {
+                googletag.defineSlot('/19968336/header-bid-tag-1', div_2_sizes, 'div-2').addService(googletag.pubads());
+                googletag.pubads().enableSingleRequest();
+                googletag.enableServices();
+            });
+
+        </script>
+
+    </head>
+
+    <body>
+        <h2>Basic Prebid.js Example</h2>
+        <h5>Div-1</h5>
+        <div id='div-1'>
+            <script type='text/javascript'>
+                googletag.cmd.push(function() {
+                    googletag.display('div-1');
+                });
+
+            </script>
+        </div>
+
+        <br>
+
+        <h5>Div-2</h5>
+        <div id='div-2'>
+            <script type='text/javascript'>
+                googletag.cmd.push(function() {
+                    googletag.display('div-2');
+                });
+
+            </script>
+        </div>
+
+    </body>
+
+</html>

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

@@ -799,7 +799,7 @@ const OPEN_RTB_PROTOCOL = {
       if (requestedBidders && isArray(requestedBidders)) {
         eidPermissions.forEach(i => {
           if (i.bidders) {
-            i.bidders = i.bidders.filter(bidder => requestedBidders.includes(bidder))
+            i.bidders = i.bidders.filter(bidder => includes(requestedBidders, bidder))
           }
         });
       }

package/modules/proxistoreBidAdapter.js

@@ -4,7 +4,8 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
 const BIDDER_CODE = 'proxistore';
 const PROXISTORE_VENDOR_ID = 418;
 const COOKIE_BASE_URL = 'https://abs.proxistore.com/v3/rtb/prebid/multi';
-const COOKIE_LESS_URL = 'https://abs.cookieless-proxistore.com/v3/rtb/prebid/multi';
+const COOKIE_LESS_URL =
+  'https://abs.cookieless-proxistore.com/v3/rtb/prebid/multi';
 
 function _createServerRequest(bidRequests, bidderRequest) {
   var sizeIds = [];
@@ -181,11 +182,7 @@ function _assignFloor(bid) {
     size: '*',
   });
 
-  if (
-    isPlainObject(floor) &&
-    !isNaN(floor.floor) &&
-    floor.currency === 'EUR'
-  ) {
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === 'EUR') {
     return floor.floor;
   }
   return null;
@@ -196,6 +193,7 @@ export const spec = {
   isBidRequestValid: isBidRequestValid,
   buildRequests: buildRequests,
   interpretResponse: interpretResponse,
+  gvlid: PROXISTORE_VENDOR_ID,
 };
 
 registerBidder(spec);