prebid.js 7.2.0 → 7.3.0

package/modules/fpdModule/index.js

@@ -7,13 +7,14 @@ import { module, getHook } from '../../src/hook.js';
 
 let submodules = [];
 
-/**
- * enable submodule in User ID
- */
 export function registerSubmodules(submodule) {
   submodules.push(submodule);
 }
 
+export function reset() {
+  submodules.length = 0;
+}
+
 export function processFpd({global = {}, bidder = {}} = {}) {
   let modConf = config.getConfig('firstPartyData') || {};
 
@@ -26,8 +27,8 @@ export function processFpd({global = {}, bidder = {}} = {}) {
   return {global, bidder};
 }
 
-function startAuctionHook(fn, req) {
-  Object.assign(req, processFpd({global: req.ortb2, bidder: req.bidderOrtb2}));
+export function startAuctionHook(fn, req) {
+  Object.assign(req.ortb2Fragments, processFpd(req.ortb2Fragments));
   fn.call(this, req);
 }
 

package/modules/gumgumBidAdapter.js

@@ -370,6 +370,8 @@ function buildRequests(validBidRequests, bidderRequest) {
         data.pi = 5;
       } else if (mediaTypes.video) {
         data.pi = mediaTypes.video.linearity === 2 ? 6 : 7; // invideo : video
+      } else if (params.product && params.product.toLowerCase() === 'skin') {
+        data.pi = 8;
       }
     } else { // legacy params
       data = { ...data, ...handleLegacyParams(params, sizes) }

package/modules/gumgumBidAdapter.md

@@ -10,7 +10,7 @@ Maintainer: engineering@gumgum.com
 
 GumGum adapter for Prebid.js
 Please note that both video and in-video products require a mediaType of video. 
-In-screen and slot products should have a mediaType of banner.
+In-screen, slot, and skin products should have a mediaType of banner.
 
 # Test Parameters
 ```
@@ -50,6 +50,24 @@ var adUnits = [
         }
       }
     ]
+  },{
+    code: 'skin-placement',
+    sizes: [[300, 50]],
+    mediaTypes: {
+        banner: {
+          sizes: [[1, 1]],
+        }
+    },
+    bids: [
+      {
+        bidder: 'gumgum',
+        params: {
+          zone: 'dc9d6be1', // GumGum Zone ID given to the client
+          product: 'skin',
+          bidfloor: 0.03 // CPM bid floor
+        }
+      }
+    ]
   },{
     code: 'video-placement',
     sizes: [[300, 50]],

package/modules/lassoBidAdapter.js

@@ -0,0 +1,133 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER } from '../src/mediaTypes.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { ajax } from '../src/ajax.js';
+import { config } from '../src/config.js';
+
+const BIDDER_CODE = 'lasso';
+const ENDPOINT_URL = 'https://trc.lhmos.com/prebid';
+const GET_IUD_URL = 'https://secure.adnxs.com/getuid?';
+const COOKIE_NAME = 'aim-xr';
+const storage = getStorageManager({bidderCode: BIDDER_CODE});
+
+export const spec = {
+  code: BIDDER_CODE,
+  isBidRequestValid: function(bid) {
+    return !!(bid.params && bid.params.adUnitId);
+  },
+
+  buildRequests: function(validBidRequests, bidderRequest) {
+    if (validBidRequests.length === 0) {
+      return [];
+    }
+
+    let aimXR = '';
+    if (storage.cookiesAreEnabled) {
+      aimXR = storage.getCookie(COOKIE_NAME, undefined);
+    }
+
+    return validBidRequests.map(bidRequest => {
+      let sizes = []
+      if (bidRequest.mediaTypes && bidRequest.mediaTypes[BANNER] && bidRequest.mediaTypes[BANNER].sizes) {
+        sizes = bidRequest.mediaTypes[BANNER].sizes;
+      }
+
+      const payload = {
+        auctionStart: bidderRequest.auctionStart,
+        url: encodeURIComponent(window.location.href),
+        bidderRequestId: bidRequest.bidderRequestId,
+        adUnitCode: bidRequest.adUnitCode,
+        auctionId: bidRequest.auctionId,
+        bidId: bidRequest.bidId,
+        transactionId: bidRequest.transactionId,
+        device: JSON.stringify(getDeviceData()),
+        sizes,
+        aimXR,
+        uid: '$UID',
+        params: JSON.stringify(bidRequest.params),
+        crumbs: JSON.stringify(bidRequest.crumbs),
+        prebidVersion: '$prebid.version$',
+        version: 1,
+        coppa: config.getConfig('coppa') == true ? 1 : 0,
+        ccpa: bidderRequest.uspConsent || undefined
+      }
+
+      return {
+        method: 'GET',
+        url: getBidRequestUrl(aimXR),
+        data: payload,
+        options: {
+          withCredentials: false
+        },
+      };
+    });
+  },
+
+  interpretResponse: function(serverResponse) {
+    const response = serverResponse && serverResponse.body;
+    const bidResponses = [];
+
+    if (!response) {
+      return bidResponses;
+    }
+
+    const bidResponse = {
+      requestId: response.bidid,
+      cpm: response.bid.price,
+      currency: response.cur,
+      width: response.bid.w,
+      height: response.bid.h,
+      creativeId: response.bid.crid,
+      netRevenue: response.netRevenue,
+      ttl: response.ttl,
+      ad: response.bid.ad,
+      mediaType: response.bid.mediaType,
+      meta: {
+        secondaryCatIds: response.bid.cat,
+        advertiserDomains: response.bid.advertiserDomains,
+        advertiserName: response.meta.advertiserName,
+        mediaType: response.bid.mediaType
+      }
+    };
+    bidResponses.push(bidResponse);
+    return bidResponses;
+  },
+
+  onTimeout: function(timeoutData) {
+    if (timeoutData === null) {
+      return;
+    }
+    ajax(ENDPOINT_URL + '/timeout', null, JSON.stringify(timeoutData), {
+      method: 'POST',
+      withCredentials: false
+    });
+  },
+
+  onBidWon: function(bid) {
+    ajax(ENDPOINT_URL + '/won', null, JSON.stringify(bid), {
+      method: 'POST',
+      withCredentials: false
+    });
+  },
+
+  supportedMediaTypes: [BANNER]
+}
+
+function getBidRequestUrl(aimXR) {
+  if (!aimXR) {
+    return GET_IUD_URL + ENDPOINT_URL + '/request';
+  }
+  return ENDPOINT_URL + '/request'
+}
+
+function getDeviceData() {
+  const win = window.top;
+  return {
+    ua: navigator.userAgent,
+    width: win.innerWidth || win.document.documentElement.clientWidth || win.document.body.clientWidth,
+    height: win.innerHeight || win.document.documentElement.clientHeight || win.document.body.clientHeight,
+    browserLanguage: navigator.language,
+  }
+}
+
+registerBidder(spec);

package/modules/lassoBidAdapter.md

@@ -0,0 +1,29 @@
+# Overview
+
+**Module Name**: Lasso Bidder Adapter  
+**Module Type**: Bidder Adapter  
+**Maintainer**: headerbidding@lassomarketing.io
+
+# Description
+
+Connects to Lasso demand source to fetch bids.
+Only banner format supported.
+
+# Test Parameters
+
+```
+var adUnits = [{
+   code: 'banner-ad-unit',
+   mediaTypes: {
+      banner: {
+          sizes: [[300, 250]],
+      }
+   },
+   bids: [{
+     bidder: 'lasso',
+     params: {
+       adUnitId: '0'
+     }
+   }]
+}];
+```

package/modules/medianetBidAdapter.js

@@ -56,13 +56,15 @@ function getTopWindowReferrer() {
   }
 }
 
-function siteDetails(site) {
+function siteDetails(site, bidderRequest) {
+  const urlData = bidderRequest.refererInfo;
   site = site || {};
   let siteData = {
-    domain: site.domain || mnData.urlData.domain,
-    page: site.page || mnData.urlData.page,
+    domain: site.domain || urlData.domain,
+    page: site.page || urlData.page,
     ref: site.ref || getTopWindowReferrer(),
-    isTop: site.isTop || mnData.urlData.isTop
+    topMostLocation: urlData.topmostLocation,
+    isTop: site.isTop || urlData.reachedTop
   };
 
   return Object.assign(siteData, getPageMeta());
@@ -187,6 +189,7 @@ function slotParams(bidRequest) {
   // check with Media.net Account manager for  bid floor and crid parameters
   let params = {
     id: bidRequest.bidId,
+    transactionId: bidRequest.transactionId,
     ext: {
       dfp_id: bidRequest.adUnitCode,
       display_count: bidRequest.bidRequestsCount
@@ -320,10 +323,11 @@ function getBidderURL(cid) {
 
 function generatePayload(bidRequests, bidderRequests) {
   return {
-    site: siteDetails(bidRequests[0].params.site),
+    site: siteDetails(bidRequests[0].params.site, bidderRequests),
     ext: extParams(bidRequests[0], bidderRequests),
     id: bidRequests[0].auctionId,
     imp: bidRequests.map(request => slotParams(request)),
+    ortb2: bidderRequests.ortb2,
     tmax: bidderRequests.timeout || config.getConfig('bidderTimeout')
   }
 }

package/modules/nativoBidAdapter.js

@@ -16,7 +16,7 @@ const SUPPORTED_AD_TYPES = [BANNER]
  * Keep track of bid data by keys
  * @returns {Object} - Map of bid data that can be referenced by multiple keys
  */
-const BidDataMap = () => {
+export const BidDataMap = () => {
   const referenceMap = {}
   const bids = []
 
@@ -25,7 +25,7 @@ const BidDataMap = () => {
    * @param {String} key - The key to store the index reference
    * @param {Integer} index - The index value of the bidData
    */
-  function adKeyReference(key, index) {
+  function addKeyReference(key, index) {
     if (!referenceMap.hasOwnProperty(key)) {
       referenceMap[key] = index
     }
@@ -42,12 +42,12 @@ const BidDataMap = () => {
 
     if (Array.isArray(keys)) {
       keys.forEach((key) => {
-        adKeyReference(String(key), index)
+        addKeyReference(String(key), index)
       })
       return
     }
 
-    adKeyReference(String(keys), index)
+    addKeyReference(String(keys), index)
   }
 
   /**
@@ -132,8 +132,9 @@ export const spec = {
    */
   buildRequests: function (validBidRequests, bidderRequest) {
     const placementIds = new Set()
-    let placementId, pageUrl
     const bidDataMap = BidDataMap()
+    const placementSizes = { length: 0 }
+    let placementId, pageUrl
     validBidRequests.forEach((request) => {
       pageUrl = deepAccess(
         request,
@@ -142,15 +143,21 @@ export const spec = {
       )
       placementId = deepAccess(request, 'params.placementId')
 
-      if (placementId) {
+      const bidDataKeys = [request.adUnitCode]
+
+      if (placementId && !placementIds.has(placementId)) {
         placementIds.add(placementId)
+        bidDataKeys.push(placementId)
+
+        placementSizes[placementId] = request.sizes
+        placementSizes.length++
       }
 
       const bidData = {
         bidId: request.bidId,
         size: getLargestSize(request.sizes),
       }
-      bidDataMap.addBidData(bidData, [placementId, request.adUnitCode])
+      bidDataMap.addBidData(bidData, bidDataKeys)
     })
     bidRequestMap[bidderRequest.bidderRequestId] = bidDataMap
 
@@ -199,6 +206,11 @@ export const spec = {
       params.unshift({ key: 'ntv_ctf', value: Array.from(campaignsToFilter).join(',') })
     }
 
+    // Placement Sizes
+    if (placementSizes.length) {
+      params.unshift({ key: 'ntv_pas', value: btoa(JSON.stringify(placementSizes)) })
+    }
+
     // Add placement IDs
     if (placementIds.size > 0) {
       // Convert Set to Array (IE 11 Safe)

package/modules/riseBidAdapter.js

@@ -287,6 +287,7 @@ function generateBidParameters(bid, bidderRequest) {
     floorPrice: Math.max(getFloor(bid, mediaType), params.floorPrice),
     bidId: getBidIdParameter('bidId', bid),
     bidderRequestId: getBidIdParameter('bidderRequestId', bid),
+    loop: getBidIdParameter('bidderRequestsCount', bid),
     transactionId: getBidIdParameter('transactionId', bid),
   };
 

package/modules/sonobiBidAdapter.js

@@ -56,15 +56,23 @@ export const spec = {
    */
   buildRequests: (validBidRequests, bidderRequest) => {
     const bids = validBidRequests.map(bid => {
+      let mediaType;
+
+      if (deepAccess(bid, 'mediaTypes.video')) {
+        mediaType = 'video';
+      } else if (deepAccess(bid, 'mediaTypes.banner')) {
+        mediaType = 'display';
+      }
+
       let slotIdentifier = _validateSlot(bid);
       if (/^[\/]?[\d]+[[\/].+[\/]?]?$/.test(slotIdentifier)) {
         slotIdentifier = slotIdentifier.charAt(0) === '/' ? slotIdentifier : '/' + slotIdentifier;
         return {
-          [`${slotIdentifier}|${bid.bidId}`]: `${_validateSize(bid)}${_validateFloor(bid)}${_validateGPID(bid)}`
+          [`${slotIdentifier}|${bid.bidId}`]: `${_validateSize(bid)}|${_validateFloor(bid)}${_validateGPID(bid)}${_validateMediaType(mediaType)}`
         }
       } else if (/^[0-9a-fA-F]{20}$/.test(slotIdentifier) && slotIdentifier.length === 20) {
         return {
-          [bid.bidId]: `${slotIdentifier}|${_validateSize(bid)}${_validateFloor(bid)}${_validateGPID(bid)}`
+          [bid.bidId]: `${slotIdentifier}|${_validateSize(bid)}|${_validateFloor(bid)}${_validateGPID(bid)}${_validateMediaType(mediaType)}`
         }
       } else {
         logError(`The ad unit code or Sonobi Placement id for slot ${bid.bidId} is invalid`);
@@ -273,7 +281,7 @@ export const spec = {
           });
         });
       }
-    } catch (e) {}
+    } catch (e) { }
     return syncs;
   }
 };
@@ -286,7 +294,7 @@ function _findBidderRequest(bidderRequests, bidId) {
   }
 }
 
-function _validateSize (bid) {
+function _validateSize(bid) {
   if (deepAccess(bid, 'mediaTypes.video')) {
     return ''; // Video bids arent allowed to override sizes via the trinity request
   }
@@ -304,18 +312,18 @@ function _validateSize (bid) {
   }
 }
 
-function _validateSlot (bid) {
+function _validateSlot(bid) {
   if (bid.params.ad_unit) {
     return bid.params.ad_unit;
   }
   return bid.params.placement_id;
 }
 
-function _validateFloor (bid) {
+function _validateFloor(bid) {
   const floor = getBidFloor(bid);
 
   if (floor) {
-    return `|f=${floor}`;
+    return `f=${floor},`;
   }
   return '';
 }
@@ -324,11 +332,22 @@ function _validateGPID(bid) {
   const gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot') || deepAccess(getGptSlotInfoForAdUnitCode(bid.adUnitCode), 'gptSlot') || bid.params.ad_unit;
 
   if (gpid) {
-    return `|gpid=${gpid}`
+    return `gpid=${gpid},`
   }
   return ''
 }
 
+function _validateMediaType(mediaType) {
+  let mediaTypeValidation = '';
+  if (mediaType === 'video') {
+    mediaTypeValidation = 'c=v,';
+  } else if (mediaType === 'display') {
+    mediaTypeValidation = 'c=d,';
+  }
+
+  return mediaTypeValidation;
+}
+
 const _creative = (mediaType, referer) => (sbiDc, sbiAid) => {
   if (mediaType === 'video' || mediaType === 'outstream') {
     return _videoCreative(sbiDc, sbiAid, referer)
@@ -341,7 +360,7 @@ function _videoCreative(sbiDc, sbiAid, referer) {
   return `https://${sbiDc}apex.go.sonobi.com/vast.xml?vid=${sbiAid}&ref=${encodeURIComponent(referer)}`
 }
 
-function _getBidIdFromTrinityKey (key) {
+function _getBidIdFromTrinityKey(key) {
   return key.split('|').slice(-1)[0]
 }
 

package/modules/sovrnBidAdapter.js

@@ -1,16 +1,20 @@
 import {
   _each,
-  deepAccess,
-  deepSetValue,
   getBidIdParameter,
-  getUniqueIdentifierStr,
   isArray,
-  isInteger,
+  getUniqueIdentifierStr,
+  deepSetValue,
   logError,
+  deepAccess,
+  isInteger,
   logWarn
 } from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {ADPOD, BANNER, VIDEO} from '../src/mediaTypes.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js'
+import {
+  ADPOD,
+  BANNER,
+  VIDEO
+} from '../src/mediaTypes.js'
 import {createEidsArray} from './userId/eids.js';
 
 const ORTB_VIDEO_PARAMS = {
@@ -83,7 +87,6 @@ export const spec = {
       let iv;
       let schain;
       let eids;
-      let tpid = []
       let criteoId;
 
       _each(bidReqs, function (bid) {
@@ -94,7 +97,6 @@ export const spec = {
               if (id.source === 'criteo.com') {
                 criteoId = id.uids[0].id
               }
-              tpid.push({source: id.source, uid: id.uids[0].id})
             }
           })
         }
@@ -175,7 +177,6 @@ export const spec = {
 
       if (eids) {
         deepSetValue(sovrnBidReq, 'user.ext.eids', eids)
-        deepSetValue(sovrnBidReq, 'user.ext.tpid', tpid)
         if (criteoId) {
           deepSetValue(sovrnBidReq, 'user.ext.prebid_criteoid', criteoId)
         }
@@ -276,11 +277,16 @@ export const spec = {
 
 function _buildVideoRequestObj(bid) {
   const videoObj = {}
+  const bidSizes = deepAccess(bid, 'sizes')
   const videoAdUnitParams = deepAccess(bid, 'mediaTypes.video', {})
   const videoBidderParams = deepAccess(bid, 'params.video', {})
   const computedParams = {}
 
-  if (Array.isArray(videoAdUnitParams.playerSize)) {
+  if (bidSizes) {
+    const sizes = (Array.isArray(bidSizes[0])) ? bidSizes[0] : bidSizes
+    computedParams.w = sizes[0]
+    computedParams.h = sizes[1]
+  } else if (Array.isArray(videoAdUnitParams.playerSize)) {
     const sizes = (Array.isArray(videoAdUnitParams.playerSize[0])) ? videoAdUnitParams.playerSize[0] : videoAdUnitParams.playerSize
     computedParams.w = sizes[0]
     computedParams.h = sizes[1]

package/modules/tncIdSystem.js

@@ -0,0 +1,63 @@
+import { submodule } from '../src/hook.js';
+import { logInfo } from '../src/utils.js';
+import { loadExternalScript } from '../src/adloader.js';
+
+const MODULE_NAME = 'tncId';
+let url = null;
+
+const waitTNCScript = (tncNS) => {
+  return new Promise((resolve, reject) => {
+    var tnc = window[tncNS];
+    if (!tnc) reject(new Error('No TNC Object'));
+    if (tnc.tncid) resolve(tnc.tncid);
+    tnc.ready(() => {
+      tnc = window[tncNS];
+      if (tnc.tncid) resolve(tnc.tncid);
+      else tnc.on('data-sent', () => resolve(tnc.tncid));
+    });
+  });
+}
+
+const loadRemoteScript = () => {
+  return new Promise((resolve) => {
+    loadExternalScript(url, MODULE_NAME, resolve);
+  })
+}
+
+const tncCallback = function (cb) {
+  let tncNS = '__tnc';
+  let promiseArray = [];
+  if (!window[tncNS]) {
+    tncNS = '__tncPbjs';
+    promiseArray.push(loadRemoteScript());
+  }
+
+  return Promise.all(promiseArray).then(() => waitTNCScript(tncNS)).then(cb).catch(() => cb());
+}
+
+export const tncidSubModule = {
+  name: MODULE_NAME,
+  decode(id) {
+    return {
+      tncid: id
+    };
+  },
+  gvlid: 750,
+  getId(config, consentData) {
+    const gdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
+    const consentString = gdpr ? consentData.consentString : '';
+
+    if (gdpr && !consentString) {
+      logInfo('Consent string is required for TNCID module');
+      return;
+    }
+
+    if (config.params && config.params.url) { url = config.params.url; }
+
+    return {
+      callback: function (cb) { return tncCallback(cb); }
+    }
+  }
+}
+
+submodule('userId', tncidSubModule)

package/modules/tncIdSystem.md

@@ -0,0 +1,33 @@
+# TNCID UserID Module
+
+### Prebid Configuration
+
+First, make sure to add the TNCID submodule to your Prebid.js package with: 
+
+```
+gulp build --modules=tncIdSystem,userId
+```
+
+### TNCIDIdSystem module Configuration
+
+You can configure this submodule in your `userSync.userIds[]` configuration:
+
+```javascript
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'tncId',
+            params: {
+              url: 'https://js.tncid.app/remote.min.js' //Optional
+            }
+        }],
+        syncDelay: 5000
+    }
+});
+```
+#### Configuration Params
+
+| Param Name | Required | Type | Description |
+| --- | --- | --- | --- |
+| name | Required | String | ID value for the TNCID module: `"tncId"` |
+| params.url | Optional | String | Provide TNC fallback script URL, this script is loaded if there is no TNC script on page |

package/modules/userId/eids.js

@@ -307,11 +307,23 @@ export const USER_IDS_CONFIG = {
     }
   },
 
+  // tncId
+  'tncid': {
+    source: 'thenewco.it',
+    atype: 3
+  },
+
   // Gravito MP ID
   'gravitompId': {
     source: 'gravito.net',
     atype: 1
   },
+
+  // cpexId
+  'cpexId': {
+    source: 'czechadid.cz',
+    atype: 1
+  }
 };
 
 // this function will create an eid object for the given UserId sub-module

package/modules/userId/eids.md

@@ -232,6 +232,13 @@ userIdAsEids = [
               id: 'some-random-id-value',
               atype: 3
          }]
+    },
+    {
+        source: 'thenewco.it',
+        uids: [{
+            id: 'some-random-id-value',
+            atype: 3
+        }]
     }
 ]
 ```

package/modules/userId/userId.md

@@ -356,3 +356,20 @@ pbjs.setConfig({
     }
 });
 ```
+```
+
+Example showing how to configure a `params` object to pass directly to bid adapters
+
+```
+pbjs.setConfig({
+    userSync: {
+        userIds: [{
+            name: 'tncId',
+            params: {
+              providerId: "c8549079-f149-4529-a34b-3fa91ef257d1"
+            }
+        }],
+        syncDelay: 5000
+    }
+});
+```