prebid.js 7.26.0 → 7.27.0

package/modules/seedtagBidAdapter.js

@@ -1,19 +1,18 @@
 import { isArray, _map, triggerPixel } from '../src/utils.js';
-import { registerBidder } from '../src/adapters/bidderFactory.js'
-import { VIDEO, BANNER } from '../src/mediaTypes.js'
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'seedtag';
 const SEEDTAG_ALIAS = 'st';
 const SEEDTAG_SSP_ENDPOINT = 'https://s.seedtag.com/c/hb/bid';
 const SEEDTAG_SSP_ONTIMEOUT_ENDPOINT = 'https://s.seedtag.com/se/hb/timeout';
-const ALLOWED_PLACEMENTS = {
-  inImage: true,
-  inScreen: true,
-  inArticle: true,
-  banner: true,
-  video: true
-}
+const ALLOWED_DISPLAY_PLACEMENTS = [
+  'inScreen',
+  'inImage',
+  'inArticle',
+  'inBanner',
+];
 
 // Global Vendor List Id
 // https://iabeurope.eu/vendor-list-tcf-v2-0/
@@ -21,27 +20,33 @@ const GVLID = 157;
 
 const mediaTypesMap = {
   [BANNER]: 'display',
-  [VIDEO]: 'video'
+  [VIDEO]: 'video',
 };
 
 const deviceConnection = {
   FIXED: 'fixed',
   MOBILE: 'mobile',
-  UNKNOWN: 'unknown'
+  UNKNOWN: 'unknown',
 };
 
 const getConnectionType = () => {
-  const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection || {}
+  const connection =
+    navigator.connection ||
+    navigator.mozConnection ||
+    navigator.webkitConnection ||
+    {};
   switch (connection.type || connection.effectiveType) {
     case 'wifi':
     case 'ethernet':
-      return deviceConnection.FIXED
+      return deviceConnection.FIXED;
     case 'cellular':
     case 'wimax':
-      return deviceConnection.MOBILE
+      return deviceConnection.MOBILE;
     default:
-      const isMobile = /iPad|iPhone|iPod/.test(navigator.userAgent) || /android/i.test(navigator.userAgent)
-      return isMobile ? deviceConnection.UNKNOWN : deviceConnection.FIXED
+      const isMobile =
+        /iPad|iPhone|iPod/.test(navigator.userAgent) ||
+        /android/i.test(navigator.userAgent);
+      return isMobile ? deviceConnection.UNKNOWN : deviceConnection.FIXED;
   }
 };
 
@@ -52,24 +57,32 @@ function mapMediaType(seedtagMediaType) {
 }
 
 function hasVideoMediaType(bid) {
-  return (!!bid.mediaTypes && !!bid.mediaTypes.video) || (!!bid.params && !!bid.params.video)
+  return !!bid.mediaTypes && !!bid.mediaTypes.video;
 }
 
-function hasMandatoryParams(params) {
+function hasMandatoryDisplayParams(bid) {
+  const p = bid.params;
   return (
-    !!params.publisherId &&
-    !!params.adUnitId &&
-    !!params.placement &&
-    !!ALLOWED_PLACEMENTS[params.placement]
+    !!p.publisherId &&
+    !!p.adUnitId &&
+    ALLOWED_DISPLAY_PLACEMENTS.indexOf(p.placement) > -1
   );
 }
 
 function hasMandatoryVideoParams(bid) {
-  const videoParams = getVideoParams(bid)
+  const videoParams = getVideoParams(bid);
 
-  return hasVideoMediaType(bid) && !!videoParams.playerSize &&
+  return (
+    !!bid.params.publisherId &&
+    !!bid.params.adUnitId &&
+    hasVideoMediaType(bid) &&
+    !!videoParams.playerSize &&
     isArray(videoParams.playerSize) &&
-    videoParams.playerSize.length > 0;
+    videoParams.playerSize.length > 0 &&
+    // only instream is supported for video
+    videoParams.context === 'instream' &&
+    bid.params.placement === 'inStream'
+  );
 }
 
 function buildBidRequest(validBidRequest) {
@@ -89,15 +102,11 @@ function buildBidRequest(validBidRequest) {
     adUnitId: params.adUnitId,
     adUnitCode: validBidRequest.adUnitCode,
     placement: params.placement,
-    requestCount: validBidRequest.bidderRequestsCount || 1 // FIXME : in unit test the parameter bidderRequestsCount is undefined
+    requestCount: validBidRequest.bidderRequestsCount || 1, // FIXME : in unit test the parameter bidderRequestsCount is undefined
   };
 
-  if (params.adPosition) {
-    bidRequest.adPosition = params.adPosition;
-  }
-
   if (hasVideoMediaType(validBidRequest)) {
-    bidRequest.videoParams = getVideoParams(validBidRequest)
+    bidRequest.videoParams = getVideoParams(validBidRequest);
   }
 
   return bidRequest;
@@ -113,13 +122,7 @@ function getVideoParams(validBidRequest) {
     videoParams.h = videoParams.playerSize[0][1];
   }
 
-  const bidderVideoParams = (validBidRequest.params && validBidRequest.params.video) || {}
-  // override video params from seedtag bidder params
-  Object.keys(bidderVideoParams).forEach(key => {
-    videoParams[key] = validBidRequest.params.video[key]
-  })
-
-  return videoParams
+  return videoParams;
 }
 
 function buildBidResponse(seedtagBid) {
@@ -136,8 +139,11 @@ function buildBidResponse(seedtagBid) {
     ttl: seedtagBid.ttl,
     nurl: seedtagBid.nurl,
     meta: {
-      advertiserDomains: seedtagBid && seedtagBid.adomain && seedtagBid.adomain.length > 0 ? seedtagBid.adomain : []
-    }
+      advertiserDomains:
+        seedtagBid && seedtagBid.adomain && seedtagBid.adomain.length > 0
+          ? seedtagBid.adomain
+          : [],
+    },
   };
 
   if (mediaType === VIDEO) {
@@ -181,16 +187,21 @@ function ttfb() {
 export function getTimeoutUrl(data) {
   let queryParams = '';
   if (
-    isArray(data) && data[0] &&
-    isArray(data[0].params) && data[0].params[0]
+    isArray(data) &&
+    data[0] &&
+    isArray(data[0].params) &&
+    data[0].params[0]
   ) {
     const params = data[0].params[0];
-    const timeout = data[0].timeout
+    const timeout = data[0].timeout;
 
     queryParams =
-      '?publisherToken=' + params.publisherId +
-      '&adUnitId=' + params.adUnitId +
-      '&timeout=' + timeout;
+      '?publisherToken=' +
+      params.publisherId +
+      '&adUnitId=' +
+      params.adUnitId +
+      '&timeout=' +
+      timeout;
   }
   return SEEDTAG_SSP_ONTIMEOUT_ENDPOINT + queryParams;
 }
@@ -208,8 +219,8 @@ export const spec = {
    */
   isBidRequestValid(bid) {
     return hasVideoMediaType(bid)
-      ? hasMandatoryParams(bid.params) && hasMandatoryVideoParams(bid)
-      : hasMandatoryParams(bid.params);
+      ? hasMandatoryVideoParams(bid)
+      : hasMandatoryDisplayParams(bid);
   },
 
   /**
@@ -237,24 +248,24 @@ export const spec = {
       payload['cd'] = bidderRequest.gdprConsent.consentString;
     }
     if (bidderRequest.uspConsent) {
-      payload['uspConsent'] = bidderRequest.uspConsent
+      payload['uspConsent'] = bidderRequest.uspConsent;
     }
 
     if (validBidRequests[0].schain) {
       payload.schain = validBidRequests[0].schain;
     }
 
-    let coppa = config.getConfig('coppa')
+    let coppa = config.getConfig('coppa');
     if (coppa) {
-      payload.coppa = coppa
+      payload.coppa = coppa;
     }
 
-    const payloadString = JSON.stringify(payload)
+    const payloadString = JSON.stringify(payload);
     return {
       method: 'POST',
       url: SEEDTAG_SSP_ENDPOINT,
-      data: payloadString
-    }
+      data: payloadString,
+    };
   },
 
   /**
@@ -308,6 +319,6 @@ export const spec = {
     if (bid && bid.nurl) {
       triggerPixel(bid.nurl);
     }
-  }
-}
+  },
+};
 registerBidder(spec);

package/modules/seedtagBidAdapter.md

@@ -59,3 +59,63 @@ const adUnits = [
   }
 ]
 ```
+
+## InBanner
+```js
+const adUnits = [
+  {
+    code: '/21804003197/prebid_test_300x250',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]]
+      }
+    },
+    bids: [
+      {
+        bidder: 'seedtag',
+        params: {
+          publisherId: '0000-0000-01',      // required
+          adUnitId: '0000',                 // required
+          placement: 'inBanner',              // required
+        }
+      }
+    ]
+  }
+]
+```
+
+## inStream Video
+```js
+var adUnits = [{
+  code: 'video',
+  mediaTypes: {
+    video: {
+      context: 'instream',   // required
+      playerSize: [640, 360], // required
+      // Video object as specified in OpenRTB 2.5
+      mimes: ['video/mp4'], // recommended
+      minduration: 5,       // optional
+      maxduration: 60,      // optional
+      boxingallowed: 1,     // optional
+      skip: 1,              // optional
+      startdelay: 1,        // optional
+      linearity: 1,         // optional
+      battr: [1, 2],        // optional
+      maxbitrate: 10,       // optional
+      playbackmethod: [1],  // optional
+      delivery: [1],        // optional
+      placement: 1,         // optional
+    }
+  },
+  bids: [
+    {
+      bidder: 'seedtag',
+      params: {
+        publisherId: '0000-0000-01',    // required
+        adUnitId: '0000',               // required
+        placement: 'inStream',          // required
+      }
+    }
+  ]
+}];
+```

package/modules/sharedIdSystem.js

@@ -9,8 +9,9 @@ import { parseUrl, buildUrl, triggerPixel, logInfo, hasDeviceAccess, generateUUI
 import {submodule} from '../src/hook.js';
 import { coppaDataHandler } from '../src/adapterManager.js';
 import {getStorageManager} from '../src/storageManager.js';
+import {VENDORLESS_GVLID} from '../src/consentHandler.js';
 
-export const storage = getStorageManager({moduleName: 'pubCommonId'});
+export const storage = getStorageManager({moduleName: 'pubCommonId', gvlid: VENDORLESS_GVLID});
 const COOKIE = 'cookie';
 const LOCAL_STORAGE = 'html5';
 const OPTOUT_NAME = '_pubcid_optout';
@@ -73,6 +74,7 @@ export const sharedIdSystemSubmodule = {
    */
   name: 'sharedId',
   aliasName: 'pubCommonId',
+  gvlid: VENDORLESS_GVLID,
 
   /**
    * decode the stored id value for passing to bid requests

package/modules/smartxBidAdapter.js

@@ -245,7 +245,7 @@ export const spec = {
         options: {
           contentType: 'application/json',
           customHeaders: {
-            'x-openrtb-version': '2.3'
+            'x-openrtb-version': '2.5'
           }
         }
       };

package/modules/smnBidAdapter.md

@@ -0,0 +1,52 @@
+# Overview
+
+Module Name: SMN Bidder Adapter  
+Module Type: Bidder Adapter  
+Maintainer: smnoffice.belgrade@gmail.com
+
+# Description
+
+Connects to SMN demand source to fetch bids.  
+Banner and Video formats are supported.  
+Please use ```smn``` as the bidder code.  
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'desktop-banner-ad-div',
+               sizes: [[300, 250]],  // a display size
+               bids: [
+                   {
+                       bidder: "smn",
+                       params: {
+                           zone: '2eb6bd58-865c-47ce-af7f-a918108c3fd2'
+                       }
+                   }
+               ]
+           },{
+               code: 'mobile-banner-ad-div',
+               sizes: [[300, 50]],   // a mobile size
+               bids: [
+                   {
+                       bidder: "smn",
+                       params: {
+                           zone: '62211486-c50b-4356-9f0f-411778d31fcc'
+                       }
+                   }
+               ]
+           },{
+               code: 'video-ad',
+               sizes: [[300, 50]],
+               mediaType: 'video',
+               bids: [
+                   {
+                       bidder: "smn",
+                       params: {
+                           zone: 'ebeb1e79-8cb4-4473-b2d0-2e24b7ff47fd'
+                       }
+                   }
+               ]
+           },
+       ];
+```

package/modules/tripleliftBidAdapter.js

@@ -29,7 +29,7 @@ export const tripleliftAdapterSpec = {
     tlCall = tryAppendQueryString(tlCall, 'v', '$prebid.version$');
 
     if (bidderRequest && bidderRequest.refererInfo) {
-      let referrer = bidderRequest?.refererInfo?.topmostLocation || bidderRequest?.refererInfo?.page;
+      let referrer = bidderRequest.refererInfo.page;
       tlCall = tryAppendQueryString(tlCall, 'referrer', referrer);
     }
 

package/modules/ttdBidAdapter.js

@@ -38,6 +38,10 @@ function getRegs(bidderRequest) {
   if (config.getConfig('coppa') === true) {
     regs.coppa = 1;
   }
+  if (bidderRequest.ortb2?.regs) {
+    utils.mergeDeep(regs, bidderRequest.ortb2.regs);
+  }
+
   return regs;
 }
 

package/modules/vidazooBidAdapter.js

@@ -2,6 +2,7 @@ import { _each, deepAccess, parseSizesInput, parseUrl, uniques, isFn } from '../
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { getStorageManager } from '../src/storageManager.js';
+import { bidderSettings } from '../src/bidderSettings.js';
 
 const GVLID = 744;
 const DEFAULT_SUB_DOMAIN = 'prebid';
@@ -69,6 +70,11 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
   const pId = extractPID(params);
   const subDomain = extractSubDomain(params);
   const ptrace = getCacheOpt();
+  const isStorageAllowed = bidderSettings.get(BIDDER_CODE, 'storageAllowed');
+
+  const gpid = deepAccess(bid, 'ortb2Imp.ext.gpid', deepAccess(bid, 'ortb2Imp.ext.data.pbadslot', ''));
+  const cat = deepAccess(bidderRequest, 'ortb2.site.cat', []);
+  const pagecat = deepAccess(bidderRequest, 'ortb2.site.pagecat', []);
 
   if (isFn(bid.getFloor)) {
     const floorInfo = bid.getFloor({
@@ -99,7 +105,11 @@ function buildRequest(bid, topWindowUrl, sizes, bidderRequest) {
     prebidVersion: '$prebid.version$',
     res: `${screen.width}x${screen.height}`,
     schain: schain,
-    ptrace: ptrace
+    ptrace: ptrace,
+    isStorageAllowed: isStorageAllowed,
+    gpid: gpid,
+    cat: cat,
+    pagecat: pagecat
   };
 
   appendUserIdsToRequestPayload(data, userId);

package/modules/yandexBidAdapter.js

@@ -1,5 +1,6 @@
-import { formatQS, deepAccess, triggerPixel } from '../src/utils.js';
+import { formatQS, deepAccess, triggerPixel, isArray, isNumber } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js'
 
 const BIDDER_CODE = 'yandex';
 const BIDDER_URL = 'https://bs.yandex.ru/metadsp';
@@ -10,9 +11,19 @@ const SSP_ID = 10500;
 export const spec = {
   code: BIDDER_CODE,
   aliases: ['ya'], // short code
+  supportedMediaTypes: [ BANNER ],
 
   isBidRequestValid: function(bid) {
-    return !!(bid.params && bid.params.pageId && bid.params.impId);
+    const { params } = bid;
+    if (!params) {
+      return false;
+    }
+    const { pageId, impId } = extractPlacementIds(params);
+    if (!(pageId && impId)) {
+      return false;
+    }
+    const sizes = bid.mediaTypes?.banner?.sizes;
+    return isArray(sizes) && isArray(sizes[0]) && isNumber(sizes[0][0]) && isNumber(sizes[0][1]);
   },
 
   buildRequests: function(validBidRequests, bidderRequest) {
@@ -29,9 +40,19 @@ export const spec = {
       page = bidderRequest.refererInfo.page;
     }
 
+    let timeout = null;
+    if (bidderRequest) {
+      timeout = bidderRequest.timeout;
+    }
+
     return validBidRequests.map((bidRequest) => {
       const { params } = bidRequest;
-      const { pageId, impId, targetRef, withCredentials = true } = params;
+      const { targetRef, withCredentials = true } = params;
+      const sizes = bidRequest.mediaTypes.banner.sizes;
+      const size = sizes[0];
+      const [ w, h ] = size;
+
+      const { pageId, impId } = extractPlacementIds(params);
 
       const queryParams = {
         'imp-id': impId,
@@ -43,24 +64,23 @@ export const spec = {
         queryParams['tcf-consent'] = consentString;
       }
 
-      const floorInfo = bidRequest.getFloor ? bidRequest.getFloor({
-        currency: DEFAULT_CURRENCY
-      }) : {};
-      const bidfloor = floorInfo.floor;
-      const bidfloorcur = floorInfo.currency;
-
       const imp = {
         id: impId,
-        bidfloor,
-        bidfloorcur,
-      };
-      const bannerParams = deepAccess(bidRequest, 'mediaTypes.banner');
-      if (bannerParams) {
-        const [ w, h ] = bannerParams.sizes[0];
-        imp.banner = {
+        banner: {
+          format: sizes,
           w,
           h,
-        };
+        }
+      };
+
+      if (bidRequest.getFloor) {
+        const floorInfo = bidRequest.getFloor({
+          currency: DEFAULT_CURRENCY,
+          size
+        });
+
+        imp.bidfloor = floorInfo.floor;
+        imp.bidfloorcur = floorInfo.currency;
       }
 
       const queryParamsString = formatQS(queryParams);
@@ -74,6 +94,7 @@ export const spec = {
             ref_url: referrer,
             page_url: page,
           },
+          tmax: timeout,
         },
         options: {
           withCredentials,
@@ -102,6 +123,7 @@ export const spec = {
         width: rtbBid.w,
         height: rtbBid.h,
         creativeId: rtbBid.adid,
+        nurl: rtbBid.nurl,
 
         netRevenue: true,
         ttl: DEFAULT_TTL,
@@ -118,13 +140,57 @@ export const spec = {
   },
 
   onBidWon: function (bid) {
-    const nurl = bid['nurl'];
-
+    let nurl = bid['nurl'];
     if (!nurl) {
       return;
     }
+
+    const cpm = deepAccess(bid, 'adserverTargeting.hb_pb') || '';
+    const curr = (bid.hasOwnProperty('originalCurrency') && bid.hasOwnProperty('originalCpm'))
+      ? bid.originalCurrency
+      : bid.currency;
+
+    nurl = nurl
+      .replace(/\${AUCTION_PRICE}/, cpm)
+      .replace(/\${AUCTION_CURRENCY}/, curr)
+    ;
+
     triggerPixel(nurl);
   }
 }
 
+function extractPlacementIds(bidRequestParams) {
+  const { placementId } = bidRequestParams;
+  const result = { pageId: null, impId: null };
+
+  let pageId, impId;
+  if (placementId) {
+    /*
+     * Possible formats
+     * R-I-123456-2
+     * R-123456-1
+     * 123456-789
+     */
+    const num = placementId.lastIndexOf('-');
+    if (num === -1) {
+      return result;
+    }
+    const num2 = placementId.lastIndexOf('-', num - 1);
+    pageId = placementId.slice(num2 + 1, num);
+    impId = placementId.slice(num + 1);
+  } else {
+    pageId = bidRequestParams.pageId;
+    impId = bidRequestParams.impId;
+  }
+
+  if (!parseInt(pageId, 10) || !parseInt(impId, 10)) {
+    return result;
+  }
+
+  result.pageId = pageId;
+  result.impId = impId;
+
+  return result;
+}
+
 registerBidder(spec);

package/modules/yandexBidAdapter.md

@@ -12,10 +12,11 @@ Yandex Bidder Adapter for Prebid.js.
 
 # Parameters
 
-| Name          | Scope    | Description             | Example   | Type      |
-|---------------|----------|-------------------------|-----------|-----------|
-| `pageId`      | required | Page ID                 | `123`     | `Integer` |
-| `impId`       | required | Block ID                | `1`       | `Integer` |
+| Name          | Required?                                  | Description | Example | Type      |
+|---------------|--------------------------------------------|-------------|---------|-----------|
+| `placementId` | Yes                                        | Block ID    | `123-1` | `String`  |
+| `pageId`      | No<br>Deprecated. Please use `placementId` | Page ID     | `123`   | `Integer` |
+| `impId`       | No<br>Deprecated. Please use `placementId` | Imp ID      | `1`     | `Integer` |
 
 # Test Parameters
 
@@ -24,15 +25,14 @@ var adUnits = [{
   code: 'banner-1',
   mediaTypes: {
     banner: {
-      sizes: [[240, 400]],
+      sizes: [[240, 400], [300, 600]],
     }
   },
   bids: [{
     {
       bidder: 'yandex',
       params: {
-        pageId: 346580,
-        impId: 143,
+        placementId: '346580-1'
       },
     }
   }]

package/modules/yieldlabBidAdapter.js

@@ -41,6 +41,7 @@ export const spec = {
 
     const adslotIds = []
     const adslotSizes = [];
+    const adslotFloors = [];
     const timestamp = Date.now()
     const query = {
       ts: timestamp,
@@ -77,7 +78,7 @@ export const spec = {
       }
       const floor = getBidFloor(bid, sizes)
       if (floor) {
-        query.floor = floor;
+        adslotFloors.push(bid.params.adslotId + ':' + floor);
       }
     })
 
@@ -99,6 +100,11 @@ export const spec = {
     if (adslotSizes.length > 0) {
       query.sizes = adslotSizes.join(',')
     }
+
+    if (adslotFloors.length > 0) {
+      query.floor = adslotFloors.join(',')
+    }
+
     const queryString = createQueryString(query)
 
     return {
@@ -463,7 +469,7 @@ function extractSizes(bid) {
  *
  * @param {Object} bid
  * @param {string[]} sizes
- * @returns The floor CPM of a matched rule based on the rule selection process (mediaType, size and currency),
+ * @returns The floor CPM in cents of a matched rule based on the rule selection process (mediaType, size and currency),
  *          using the getFloor() inputs. Multi sizes and unsupported media types will default to '*'
  */
 function getBidFloor(bid, sizes) {
@@ -475,10 +481,10 @@ function getBidFloor(bid, sizes) {
   const floor = bid.getFloor({
     currency: CURRENCY_CODE,
     mediaType: mediaType !== undefined && spec.supportedMediaTypes.includes(mediaType) ? mediaType : '*',
-    size: sizes.length !== 1 ? '*' : extractSizes(sizes)
+    size: sizes.length !== 1 ? '*' : sizes[0].split(DIMENSION_SIGN)
   });
   if (floor.currency === CURRENCY_CODE) {
-    return floor.floor;
+    return (floor.floor * 100).toFixed(0);
   }
   return undefined;
 }