prebid.js 8.4.0 → 8.6.0

package/modules/imdsBidAdapter.js

@@ -1,6 +1,6 @@
 'use strict';
 
-import {deepAccess, deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn} from '../src/utils.js';
+import {deepAccess, deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn, mergeDeep} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {includes} from '../src/polyfill.js';
@@ -8,7 +8,8 @@ import {config} from '../src/config.js';
 
 const BID_SCHEME = 'https://';
 const BID_DOMAIN = 'technoratimedia.com';
-const USER_SYNC_HOST = 'https://ad-cdn.technoratimedia.com';
+const USER_SYNC_IFRAME_URL = 'https://ad-cdn.technoratimedia.com/html/usersync.html';
+const USER_SYNC_PIXEL_URL = 'https://sync.technoratimedia.com/services';
 const VIDEO_PARAMS = [ 'minduration', 'maxduration', 'startdelay', 'placement', 'linearity', 'mimes', 'protocols', 'api' ];
 const BLOCKED_AD_SIZES = [
   '1x1',
@@ -38,11 +39,11 @@ export const spec = {
       return;
     }
     const refererInfo = bidderRequest.refererInfo;
-    const openRtbBidRequest = {
+    // start with some defaults, overridden by anything set in ortb2, if provided.
+    const openRtbBidRequest = mergeDeep({
       id: bidderRequest.bidderRequestId,
       site: {
-        // TODO: does the fallback make sense here?
-        domain: refererInfo.domain || location.hostname,
+        domain: refererInfo.domain,
         page: refererInfo.page,
         ref: refererInfo.ref
       },
@@ -50,7 +51,7 @@ export const spec = {
         ua: navigator.userAgent
       },
       imp: []
-    };
+    }, bidderRequest.ortb2 || {});
 
     const tmax = bidderRequest.timeout;
     if (tmax) {
@@ -101,9 +102,17 @@ export const spec = {
       }
     });
 
-    // CCPA
-    if (bidderRequest.uspConsent) {
-      deepSetValue(openRtbBidRequest, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+    // Move us_privacy from regs.ext to regs if there isn't already a us_privacy in regs
+    if (openRtbBidRequest.regs?.ext?.us_privacy && !openRtbBidRequest.regs?.us_privacy) {
+      deepSetValue(openRtbBidRequest, 'regs.us_privacy', openRtbBidRequest.regs.ext.us_privacy);
+    }
+
+    // Remove regs.ext.us_privacy
+    if (openRtbBidRequest.regs?.ext?.us_privacy) {
+      delete openRtbBidRequest.regs.ext.us_privacy;
+      if (Object.keys(openRtbBidRequest.regs.ext).length < 1) {
+        delete openRtbBidRequest.regs.ext;
+      }
     }
 
     // User ID
@@ -117,7 +126,7 @@ export const spec = {
     if (openRtbBidRequest.imp.length && seatId) {
       return {
         method: 'POST',
-        url: `${BID_SCHEME}${seatId}.${BID_DOMAIN}/openrtb/bids/${seatId}?src=$$REPO_AND_VERSION$$`,
+        url: `${BID_SCHEME}${seatId}.${BID_DOMAIN}/openrtb/bids/${seatId}?src=pbjs%2F$prebid.version$`,
         data: openRtbBidRequest,
         options: {
           contentType: 'application/json',
@@ -294,16 +303,31 @@ export const spec = {
     }
     return bids;
   },
-  getUserSyncs: function (syncOptions, serverResponses) {
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) {
     const syncs = [];
+    const queryParams = ['src=pbjs%2F$prebid.version$'];
+    if (gdprConsent) {
+      queryParams.push(`gdpr=${Number(gdprConsent.gdprApplies && 1)}&consent=${encodeURIComponent(gdprConsent.consentString || '')}`);
+    }
+    if (uspConsent) {
+      queryParams.push('us_privacy=' + encodeURIComponent(uspConsent));
+    }
+    if (gppConsent) {
+      queryParams.push('gpp=' + encodeURIComponent(gppConsent.gppString || '') + '&gppsid=' + encodeURIComponent((gppConsent.applicableSections || []).join(',')));
+    }
+
     if (syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: `${USER_SYNC_HOST}/html/usersync.html?src=$$REPO_AND_VERSION$$`
+        url: `${USER_SYNC_IFRAME_URL}?${queryParams.join('&')}`
+      });
+    } else if (syncOptions.pixelEnabled) {
+      syncs.push({
+        type: 'pixel',
+        url: `${USER_SYNC_PIXEL_URL}?srv=cs&${queryParams.join('&')}`
       });
-    } else {
-      logWarn('IMDS: Please enable iframe based user sync.');
     }
+
     return syncs;
   }
 };

package/modules/imuIdSystem.js

@@ -160,6 +160,16 @@ export const imuIdSubmodule = {
         imppid: localData.ppid
       }
     };
+  },
+  eids: {
+    'imppid': {
+      source: 'ppid.intimatemerger.com',
+      atype: 1
+    },
+    'imuid': {
+      source: 'intimatemerger.com',
+      atype: 1
+    },
   }
 };
 

package/modules/intentIqIdSystem.js

@@ -193,6 +193,12 @@ export const intentIqIdSubmodule = {
       }
     };
     return { callback: resp };
+  },
+  eids: {
+    'intentIqId': {
+      source: 'intentiq.com',
+      atype: 1
+    },
   }
 };
 

package/modules/invibesBidAdapter.js

@@ -1,4 +1,4 @@
-import { logInfo } from '../src/utils.js';
+import {logInfo} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
 
@@ -9,7 +9,7 @@ const CONSTANTS = {
   SYNC_ENDPOINT: 'https://k.r66net.com/GetUserSync',
   TIME_TO_LIVE: 300,
   DEFAULT_CURRENCY: 'EUR',
-  PREBID_VERSION: 9,
+  PREBID_VERSION: 10,
   METHOD: 'GET',
   INVIBES_VENDOR_ID: 436,
   USERID_PROVIDERS: ['pubcid', 'pubProvidedId', 'uid2', 'zeotapIdPlus', 'id5id'],
@@ -116,7 +116,7 @@ function buildRequest(bidRequests, bidderRequest) {
     bidParamsJson.userId = userIdModel;
   }
   let data = {
-    location: getDocumentLocation(topWin),
+    location: getDocumentLocation(bidderRequest),
     videoAdHtmlId: generateRandomId(),
     showFallback: currentQueryStringParams['advs'] === '0',
     ivbsCampIdsLocal: readFromLocalStorage('IvbsCampIdsLocal'),
@@ -371,8 +371,8 @@ function generateRandomId() {
   return (Math.round(Math.random() * 1e12)).toString(36).substring(0, 10);
 }
 
-function getDocumentLocation(topWin) {
-  return topWin.location.href.substring(0, 300).split(/[?#]/)[0];
+function getDocumentLocation(bidderRequest) {
+  return bidderRequest.refererInfo.page.substring(0, 300);
 }
 
 function getUserIds(bidUserId) {

package/modules/ixBidAdapter.js

@@ -736,6 +736,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
 
     const isLastAdUnit = adUnitIndex === impKeys.length - 1;
 
+    r = addDeviceInfo(r);
     r = deduplicateImpExtFields(r);
     r = removeSiteIDs(r);
 
@@ -2056,4 +2057,19 @@ function getFormatCount(imp) {
   return formatCount;
 }
 
+/**
+ * Adds device.w / device.h info
+ * @param {object} r
+ * @returns object
+ */
+export function addDeviceInfo(r) {
+  if (r.device == undefined) {
+    r.device = {};
+  }
+  r.device.h = window.screen.height;
+  r.device.w = window.screen.width;
+
+  return r;
+}
+
 registerBidder(spec);

package/modules/justIdSystem.js

@@ -91,6 +91,12 @@ export const justIdSubmodule = {
         }
       }
     };
+  },
+  eids: {
+    'justId': {
+      source: 'justtag.com',
+      atype: 1
+    },
   }
 };
 

package/modules/kinessoIdSystem.js

@@ -233,8 +233,13 @@ export const kinessoIdSubmodule = {
     const payloadString = JSON.stringify(kinessoIdPayload);
     ajax(kinessoSyncUrl(accountId, consentData), syncId(knnsoId), payloadString, {method: 'POST', withCredentials: true});
     return {'id': knnsoId};
-  }
-
+  },
+  eids: {
+    'kpuid': {
+      source: 'kpuid.com',
+      atype: 3
+    },
+  },
 };
 
 // Register submodule for userId

package/modules/liveIntentIdSystem.js

@@ -242,6 +242,59 @@ export const liveIntentIdSubmodule = {
     }
 
     return { callback: result };
+  },
+  eids: {
+    'lipb': {
+      getValue: function(data) {
+        return data.lipbid;
+      },
+      source: 'liveintent.com',
+      atype: 3,
+      getEidExt: function(data) {
+        if (Array.isArray(data.segments) && data.segments.length) {
+          return {
+            segments: data.segments
+          };
+        }
+      }
+    },
+    'bidswitch': {
+      source: 'bidswitch.net',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+    'medianet': {
+      source: 'media.net',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+    'magnite': {
+      source: 'rubiconproject.com',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+
   }
 };
 

package/modules/lotamePanoramaIdSystem.js

@@ -368,6 +368,12 @@ export const lotamePanoramaIdSubmodule = {
 
     return { callback: resolveIdFunction };
   },
+  eids: {
+    lotamePanoramaId: {
+      source: 'crwdcntrl.net',
+      atype: 1,
+    },
+  },
 };
 
 submodule('userId', lotamePanoramaIdSubmodule);

package/modules/merkleIdSystem.js

@@ -196,6 +196,30 @@ export const merkleIdSubmodule = {
 
     logInfo('User ID - merkleId not refreshed');
     return {id: storedId};
+  },
+  eids: {
+    'merkleId': {
+      atype: 3,
+      getSource: function(data) {
+        if (data?.ext?.ssp) {
+          return `${data.ext.ssp}.merkleinc.com`
+        }
+        return 'merkleinc.com'
+      },
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.keyID) {
+          return {
+            keyID: data.keyID
+          }
+        }
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
   }
 
 };

package/modules/mwOpenLinkIdSystem.js

@@ -137,6 +137,12 @@ export const mwOpenLinkIdSubModule = {
     const submoduleConfigParams = (submoduleConfig && submoduleConfig.params) || {};
     if (!isValidConfig(submoduleConfigParams)) return undefined;
     return setID(submoduleConfigParams);
+  },
+  eids: {
+    'mwOpenLinkId': {
+      source: 'mediawallahscript.com',
+      atype: 1
+    },
   }
 };
 

package/modules/naveggIdSystem.js

@@ -107,6 +107,12 @@ export const naveggIdSubmodule = {
       }
     }
     return undefined;
+  },
+  eids: {
+    'naveggId': {
+      source: 'navegg.com',
+      atype: 1
+    },
   }
 };
 submodule('userId', naveggIdSubmodule);

package/modules/netIdSystem.js

@@ -34,6 +34,12 @@ export const netIdSubmodule = {
   getId(config) {
     /* currently not possible */
     return {};
+  },
+  eids: {
+    'netId': {
+      source: 'netid.de',
+      atype: 1
+    },
   }
 };
 

package/modules/newspassid.md

@@ -0,0 +1,76 @@
+---
+Module Name: NewspassId Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: techsupport@newspassid.com
+layout: bidder
+title: Newspass ID
+description: LMC Newspass ID Prebid JS Bidder Adapter
+biddercode: newspassid
+gdpr_supported: false
+gvl_id: none
+usp_supported: true
+coppa_supported: false
+schain_supported: true
+dchain_supported: false
+userIds: criteo, id5Id, tdid, identityLink, liveIntentId, parrableId, pubCommonId, lotamePanoramaId, sharedId, fabrickId
+media_types: banner
+safeframes_ok: true
+deals_supported: true
+floors_supported: false
+fpd_supported: false
+pbjs: true
+pbs: false
+prebid_member: false
+multiformat_supported: will-bid-on-any
+---
+
+### Description
+
+LMC Newspass ID Prebid JS Bidder Adapter that connects to the NewspassId demand source(s).
+
+The Newspass bid adapter supports Banner mediaTypes ONLY.
+This is intended for USA audiences only, and does not support GDPR
+
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+
+| Name      | Scope    | Description               | Example    | Type     |
+|-----------|----------|---------------------------|------------|----------|
+| `siteId`    | required | The site ID.  		   | `"NPID0000001"` | `string` |
+| `publisherId`    | required | The publisher ID.  | `"4204204201"` | `string` |
+| `placementId`    | required | The placement ID.  | `"0420420421"` | `string` |
+| `customData`     | optional | publisher key-values used for targeting | `[{"settings":{},"targeting":{"key1": "value1", "key2": "value2"}}], ` | `array` |
+ 
+### Test Parameters
+
+
+A test ad unit that will consistently return test creatives:
+
+```
+
+//Banner adUnit
+
+adUnits = [{
+                    code: 'id-of-your-banner-div',
+			        mediaTypes: {
+			          banner: {
+			            sizes: [[300, 250], [300,600]]
+			          }
+			        },
+                    bids: [{
+                        bidder: 'newspassid',
+                        params: {
+                            publisherId: 'NEWSPASS0001', /* an ID to identify the publisher account  - required */
+                            siteId: '4204204201', /* An ID used to identify a site within a publisher account - required */
+                            placementId: '8000000015', /* an ID used to identify the piece of inventory - required - for appnexus test use 13144370. */
+							customData: [{"settings": {}, "targeting": {"key": "value", "key2": ["value1", "value2"]}}],/* optional array with 'targeting' placeholder for passing publisher specific key-values for targeting. */                            
+                        }
+                    }]
+                }];
+```
+
+### Note:
+
+Please contact us at techsupport@newspassid.com for any assistance testing your implementation before going live into production.

package/modules/newspassidBidAdapter.js

@@ -1,15 +1,24 @@
-import {contains, deepAccess, deepSetValue, isArray, logError, logInfo, logWarn, parseUrl} from '../src/utils.js';
-import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {BANNER, NATIVE} from '../src/mediaTypes.js';
+import {
+  logInfo,
+  logError,
+  deepAccess,
+  logWarn,
+  deepSetValue,
+  isArray,
+  contains,
+  parseUrl,
+  generateUUID
+} from '../src/utils.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, NATIVE } from '../src/mediaTypes.js';
 import {config} from '../src/config.js';
 import {getPriceBucketString} from '../src/cpmBucketManager.js';
 import {getRefererInfo} from '../src/refererDetection.js';
-
 const BIDDER_CODE = 'newspassid';
 const ORIGIN = 'https://bidder.newspassid.com' // applies only to auction & cookie
 const AUCTIONURI = '/openrtb2/auction';
 const NEWSPASSCOOKIESYNC = '/static/load-cookie.html';
-const NEWSPASSVERSION = '1.0.1';
+const NEWSPASSVERSION = '1.1.4';
 export const spec = {
   version: NEWSPASSVERSION,
   code: BIDDER_CODE,
@@ -155,7 +164,7 @@ export const spec = {
       let placementId = placementIdOverrideFromGetParam || this.getPlacementId(npBidRequest); // prefer to use a valid override param, else the bidRequest placement Id
       obj.id = npBidRequest.bidId; // this causes an error if we change it to something else, even if you update the bidRequest object: "WARNING: Bidder newspass made bid for unknown request ID: mb7953.859498327448. Ignoring."
       obj.tagid = placementId;
-      let parsed = parseUrl(getRefererInfo().page);
+      let parsed = parseUrl(this.getRefererInfo().page);
       obj.secure = parsed.protocol === 'https' ? 1 : 0;
       let arrBannerSizes = [];
       if (!npBidRequest.hasOwnProperty('mediaTypes')) {
@@ -189,7 +198,6 @@ export const spec = {
       deepSetValue(obj, 'ext.prebid', {'storedrequest': {'id': placementId}});
       obj.ext['newspassid'] = {};
       obj.ext['newspassid'].adUnitCode = npBidRequest.adUnitCode; // eg. 'mpu'
-      obj.ext['newspassid'].transactionId = npBidRequest.transactionId; // this is the transactionId PER adUnit, common across bidders for this unit
       if (npBidRequest.params.hasOwnProperty('customData')) {
         obj.ext['newspassid'].customData = npBidRequest.params.customData;
       }
@@ -216,6 +224,10 @@ export const spec = {
       if (!schain && deepAccess(npBidRequest, 'schain')) {
         schain = npBidRequest.schain;
       }
+      let gpid = deepAccess(npBidRequest, 'ortb2Imp.ext.gpid');
+      if (gpid) {
+        deepSetValue(obj, 'ext.gpid', gpid);
+      }
       return obj;
     });
     let extObj = {};
@@ -240,7 +252,7 @@ export const spec = {
     let userExtEids = deepAccess(validBidRequests, '0.userIdAsEids', []); // generate the UserIDs in the correct format for UserId module
     npRequest.site = {
       'publisher': {'id': htmlParams.publisherId},
-      'page': getRefererInfo().page,
+      'page': this.getRefererInfo().page,
       'id': htmlParams.siteId
     };
     npRequest.test = config.getConfig('debug') ? 1 : 0;
@@ -259,12 +271,9 @@ export const spec = {
     }
     if (singleRequest) {
       logInfo('buildRequests starting to generate response for a single request');
-      // TODO: fix auctionId & transactionId leak: https://github.com/prebid/Prebid.js/issues/9781
-      npRequest.id = bidderRequest.auctionId; // Unique ID of the bid request, provided by the exchange.
-      npRequest.auctionId = bidderRequest.auctionId; // not sure if this should be here?
+      npRequest.id = generateUUID(); // Unique ID of the bid request, provided by the exchange. (REQUIRED)
       npRequest.imp = tosendtags;
       npRequest.ext = extObj;
-      deepSetValue(npRequest, 'source.tid', bidderRequest.auctionId);// RTB 2.5 : tid is Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
       deepSetValue(npRequest, 'user.ext.eids', userExtEids);
       var ret = {
         method: 'POST',
@@ -280,12 +289,9 @@ export const spec = {
     let arrRet = tosendtags.map(imp => {
       logInfo('buildRequests starting to generate non-single response, working on imp : ', imp);
       let npRequestSingle = Object.assign({}, npRequest);
-      imp.ext['newspassid'].pageAuctionId = bidderRequest['auctionId']; // make a note in the ext object of what the original auctionId was, in the bidderRequest object
-      npRequestSingle.id = imp.ext['newspassid'].transactionId; // Unique ID of the bid request, provided by the exchange.
-      npRequestSingle.auctionId = imp.ext['newspassid'].transactionId; // not sure if this should be here?
+      npRequestSingle.id = generateUUID();
       npRequestSingle.imp = [imp];
       npRequestSingle.ext = extObj;
-      deepSetValue(npRequestSingle, 'source.tid', bidderRequest.auctionId);// RTB 2.5 : tid is Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
       deepSetValue(npRequestSingle, 'user.ext.eids', userExtEids);
       logInfo('buildRequests RequestSingle (for non-single) = ', npRequestSingle);
       return {
@@ -305,6 +311,7 @@ export const spec = {
     logInfo(`interpretResponse time: ${startTime}. buildRequests done -> interpretResponse start was ${startTime - this.propertyBag.buildRequestsEnd}ms`);
     logInfo(`serverResponse, request`, JSON.parse(JSON.stringify(serverResponse)), JSON.parse(JSON.stringify(request)));
     serverResponse = serverResponse.body || {};
+    let aucId = serverResponse.id; // this will be correct for single requests and non-single
     if (!serverResponse.hasOwnProperty('seatbid')) {
       return [];
     }
@@ -351,7 +358,7 @@ export const spec = {
           logInfo(`newspassid.enhancedAdserverTargeting is set to false, no per-bid keys will be sent to adserver.`);
         }
         let {seat: winningSeat, bid: winningBid} = this.getWinnerForRequestBid(thisBid.bidId, serverResponse.seatbid);
-        adserverTargeting['np_auc_id'] = String(request.bidderRequest.auctionId);
+        adserverTargeting['np_auc_id'] = String(aucId);
         adserverTargeting['np_winner'] = String(winningSeat);
         adserverTargeting['np_bid'] = 'true';
         if (enhancedAdserverTargeting) {
@@ -490,10 +497,29 @@ export const spec = {
     return null;
   },
   getGetParametersAsObject() {
-    let parsed = parseUrl(getRefererInfo().page);
+    let parsed = parseUrl(this.getRefererInfo().location); // was getRefererInfo().page but this is not backwards compatible
     logInfo('getGetParametersAsObject found:', parsed.search);
     return parsed.search;
   },
+  getRefererInfo() {
+    if (getRefererInfo().hasOwnProperty('location')) {
+      logInfo('FOUND location on getRefererInfo OK (prebid >= 7); will use getRefererInfo for location & page');
+      return getRefererInfo();
+    } else {
+      logInfo('DID NOT FIND location on getRefererInfo (prebid < 7); will use legacy code that ALWAYS worked reliably to get location & page ;-)');
+      try {
+        return {
+          page: top.location.href,
+          location: top.location.href
+        };
+      } catch (e) {
+        return {
+          page: window.location.href,
+          location: window.location.href
+        };
+      }
+    }
+  },
   blockTheRequest() {
     let npRequest = config.getConfig('newspassid.np_request');
     if (typeof npRequest == 'boolean' && !npRequest) {

package/modules/novatiqIdSystem.js

@@ -259,6 +259,18 @@ export const novatiqIdSubmodule = {
       srcId = configParams.sourceid;
     }
     return srcId;
+  },
+  eids: {
+    'novatiq': {
+      getValue: function(data) {
+        if (data.snowflake.id === undefined) {
+          return data.snowflake;
+        }
+
+        return data.snowflake.id;
+      },
+      source: 'novatiq.com',
+    },
   }
 };
 submodule('userId', novatiqIdSubmodule);

package/modules/oneKeyIdSystem.js

@@ -72,6 +72,32 @@ export const oneKeyIdSubmodule = {
     return {
       callback: getIdsAndPreferences
     };
+  },
+  eids: {
+    'oneKeyData': {
+      getValue: function(data) {
+        if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
+          return data.identifiers[0].value;
+        }
+      },
+      source: 'paf',
+      atype: 1,
+      getEidExt: function(data) {
+        if (data && data.preferences) {
+          return {preferences: data.preferences};
+        }
+      },
+      getUidExt: function(data) {
+        if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
+          const id = data.identifiers[0];
+          return {
+            version: id.version,
+            type: id.type,
+            source: id.source
+          };
+        }
+      }
+    }
   }
 };