prebid.js 8.4.0 → 8.6.0

package/modules/sharedIdSystem.js

@@ -174,6 +174,12 @@ export const sharedIdSystemSubmodule = {
   },
 
   domainOverride: domainOverrideToRootDomain(storage, 'sharedId'),
+  eids: {
+    'pubcid': {
+      source: 'pubcid.org',
+      atype: 1
+    },
+  }
 };
 
 submodule('userId', sharedIdSystemSubmodule);

package/modules/silverpushBidAdapter.js

@@ -12,7 +12,7 @@ const bidderConfig = 'sp_pb_ortb';
 const bidderVersion = '1.0.0';
 const DEFAULT_CURRENCY = 'USD';
 
-export const REQUEST_URL = 'https://apac.chocolateplatform.com/bidder/?identifier=prebidchoc';
+export const REQUEST_URL = 'https://prebid.chocolateplatform.co/bidder/?identifier=prebidchoc';
 export const SP_OUTSTREAM_PLAYER_URL = 'https://xaido.sgp1.cdn.digitaloceanspaces.com/prebid/spoutstream.min.js';
 
 const VIDEO_ORTB_PARAMS = [
@@ -110,7 +110,7 @@ export const CONVERTER = ortbConverter({
       bidResponse.meta.paf.content_id = utils.deepAccess(bid, 'ext.paf.content_id');
     }
 
-    bidResponse = buildVideoVastResponse(bidResponse)
+    bidResponse = buildVideoVastResponse(bidResponse);
     bidResponse = buildVideoOutstreamResponse(bidResponse, context)
 
     return bidResponse;

package/modules/ssmasBidAdapter.js

@@ -0,0 +1,126 @@
+import { BANNER } from '../src/mediaTypes.js';
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { triggerPixel, deepSetValue } from '../src/utils.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+import {config} from '../src/config.js';
+
+export const SSMAS_CODE = 'ssmas';
+const SSMAS_SERVER = 'ads.ssmas.com';
+export const SSMAS_ENDPOINT = `https://${SSMAS_SERVER}/ortb`;
+const SYNC_URL = `https://sync.ssmas.com/user_sync`;
+export const SSMAS_REQUEST_METHOD = 'POST';
+const GDPR_VENDOR_ID = 1183;
+
+export const ssmasOrtbConverter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 300,
+    mediaType: BANNER,
+  },
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    deepSetValue(imp, 'ext.placementId', bidRequest.params.placementId);
+    return imp;
+  },
+});
+
+export const spec = {
+  code: SSMAS_CODE,
+  supportedMediaTypes: [BANNER],
+  gvlid: GDPR_VENDOR_ID,
+
+  isBidRequestValid: (bid) => {
+    return !!bid.params.placementId && !!bid.bidId && bid.bidder === SSMAS_CODE;
+  },
+
+  buildRequests: (bidRequests, bidderRequest) => {
+    const data = ssmasOrtbConverter.toORTB({ bidRequests, bidderRequest });
+
+    const options = {
+      contentType: 'application/json',
+      withCredentials: false,
+    };
+
+    data.imp && data.imp.forEach(imp => {
+      if (imp.ext && imp.ext.placementId) {
+        imp.tagId = imp.ext.placementId;
+      }
+    });
+
+    data.regs = data.regs || {};
+    data.regs.ext = data.regs.ext || {};
+
+    if (bidderRequest.gdprConsent) {
+      data.regs.ext.consent = bidderRequest.gdprConsent.consentString;
+      data.regs.ext.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+    }
+    if (bidderRequest.uspConsent) {
+      data.regs.ext.consent = bidderRequest.uspConsent.consentString;
+      data.regs.ext.ccpa = 1;
+    }
+    if (config.getConfig('coppa') === true) {
+      data.regs.coppa = 1;
+    }
+
+    return [
+      {
+        method: SSMAS_REQUEST_METHOD,
+        url: SSMAS_ENDPOINT,
+        data,
+        options,
+      },
+    ];
+  },
+
+  interpretResponse: (serverResponse, bidRequest) => {
+    const bids = ssmasOrtbConverter.fromORTB({
+      response: serverResponse.body,
+      request: bidRequest.data,
+    }).bids;
+
+    return bids.filter((bid) => {
+      return bid.cpm > 0;
+    });
+  },
+
+  onBidWon: (bid) => {
+    if (bid.burl) {
+      triggerPixel(bid.burl);
+    }
+  },
+
+  getUserSyncs: (
+    syncOptions,
+    serverResponses,
+    gdprConsent,
+    uspConsent
+  ) => {
+    const syncs = [];
+
+    let params = ['pbjs=1'];
+
+    if (gdprConsent) {
+      if (typeof gdprConsent.gdprApplies === 'boolean') {
+        params.push(`gdpr=${Boolean(gdprConsent.gdprApplies)}&gdpr_consent=${
+          gdprConsent.consentString
+        }`);
+      } else {
+        params.push(`gdpr_consent=${gdprConsent.consentString}`);
+      }
+    }
+
+    if (uspConsent && uspConsent.consentString) {
+      params.push(`ccpa_consent=${uspConsent.consentString}`);
+    }
+
+    if (syncOptions.pixelEnabled && serverResponses.length > 0) {
+      syncs.push({
+        type: 'image',
+        url: `${SYNC_URL}?${params.join('&')}`
+      });
+    }
+    return syncs;
+  },
+};
+
+registerBidder(spec);

package/modules/ssmasBidAdapter.md

@@ -0,0 +1,35 @@
+# Overview
+
+Module Name: SSMas Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: hzchen.work@gmail.com
+
+# Description
+
+Module that connects to Sem Seo & Mas header bidding endpoint to fetch bids.
+Supports Banner
+Supported currencies: EUR
+
+Required parameters:
+- placement id
+
+# Test Parameters
+```
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250]]
+        }
+      },
+      bids: [{
+         bidder: 'ssmas',
+         params: {
+            placementId: "10336"
+         }
+       }]
+   }
+];
+```

package/modules/sspBCBidAdapter.js

@@ -12,13 +12,14 @@ const SYNC_URL = 'https://ssp.wp.pl/bidder/usersync';
 const NOTIFY_URL = 'https://ssp.wp.pl/bidder/notify';
 const GVLID = 676;
 const TMAX = 450;
-const BIDDER_VERSION = '5.8';
+const BIDDER_VERSION = '5.9';
 const DEFAULT_CURRENCY = 'PLN';
 const W = window;
 const { navigator } = W;
 const oneCodeDetection = {};
 const adUnitsCalled = {};
 const adSizesCalled = {};
+const bidderRequestsMap = {};
 const pageView = {};
 var consentApiVersion;
 
@@ -93,19 +94,17 @@ const getNotificationPayload = bidData => {
     const bids = isArray(bidData) ? bidData : [bidData];
     if (bids.length > 0) {
       let result = {
-        requestId: undefined,
         siteId: [],
         slotId: [],
         tagid: [],
       }
       bids.forEach(bid => {
-        const { adUnitCode, auctionId, cpm, creativeId, meta, params: bidParams, requestId, timeout } = bid;
+        const { adUnitCode, cpm, creativeId, meta, mediaType, params: bidParams, bidderRequestId, requestId, timeout } = bid;
         const params = unpackParams(bidParams);
 
         // basic notification data
         const bidBasicData = {
-          // TODO: fix auctionId leak: https://github.com/prebid/Prebid.js/issues/9781
-          requestId: auctionId || result.requestId,
+          requestId: bidderRequestId || bidderRequestsMap[requestId],
           timeout: timeout || result.timeout,
           pvid: pageView.id,
         }
@@ -127,12 +126,14 @@ const getNotificationPayload = bidData => {
 
         if (cpm) {
           // non-empty bid data
+          const { advertiserDomains = [], networkName, pricepl } = meta;
           const bidNonEmptyData = {
             cpm,
-            cpmpl: meta && meta.pricepl,
+            cpmpl: pricepl,
             creativeId,
-            adomain: meta && meta.advertiserDomains && meta.advertiserDomains[0],
-            networkName: meta && meta.networkName,
+            adomain: advertiserDomains[0],
+            adtype: mediaType,
+            networkName,
           }
           result = { ...result, ...bidNonEmptyData }
         }
@@ -447,10 +448,15 @@ var mapVideo = (slot, videoFromBid) => {
 };
 
 const mapImpression = slot => {
-  const { adUnitCode, bidId, params = {}, ortb2Imp = {} } = slot;
+  const { adUnitCode, bidderRequestId, bidId, params = {}, ortb2Imp = {} } = slot;
   const { id, siteId, video } = params;
   const { ext = {} } = ortb2Imp;
 
+  /*
+    store bidId <-> bidderRequestId mapping for bidWon notification
+  */
+  bidderRequestsMap[bidId] = bidderRequestId;
+
   /*
      check max size for this imp, and check/store number this size was called (for current view)
      send this info as ext.pbsize
@@ -494,15 +500,20 @@ const isNativeAd = bid => {
   return bid.admNative || (bid.adm && bid.adm.match(xmlTester));
 }
 
-const parseNative = (nativeData) => {
+const parseNative = (nativeData, adUnitCode) => {
   const { link = {}, imptrackers: impressionTrackers, jstracker } = nativeData;
   const { url: clickUrl, clicktrackers: clickTrackers = [] } = link;
+  const macroReplacer = tracker => tracker.replace(new RegExp('%native_dom_id%', 'g'), adUnitCode);
+  let javascriptTrackers = isArray(jstracker) ? jstracker : jstracker && [jstracker];
+
+  // replace known macros in js trackers
+  javascriptTrackers = javascriptTrackers && javascriptTrackers.map(macroReplacer);
 
   const result = {
     clickUrl,
     clickTrackers,
     impressionTrackers,
-    javascriptTrackers: isArray(jstracker) ? jstracker : jstracker && [jstracker],
+    javascriptTrackers,
   };
 
   nativeData.assets.forEach(asset => {
@@ -627,6 +638,8 @@ const spec = {
     return true;
   },
   buildRequests(validBidRequests, bidderRequest) {
+    logWarn('DEBUG: buildRequests', bidderRequest.auctionId, bidderRequest.bidderRequestId);
+
     // convert Native ORTB definition to old-style prebid native definition
     validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);
 
@@ -644,7 +657,7 @@ const spec = {
     const ref = bidderRequest.refererInfo.ref;
 
     const payload = {
-      id: bidderRequest.auctionId,
+      id: bidderRequest.bidderRequestId,
       site: {
         id: siteId ? `${siteId}` : undefined,
         publisher: publisherId ? { id: publisherId } : undefined,
@@ -725,6 +738,7 @@ const spec = {
 
           if (bidRequest && site.id && !strIncludes(site.id, 'bidid')) {
             // found a matching request; add this bid
+            const { adUnitCode } = bidRequest;
 
             // store site data for future notification
             oneCodeDetection[bidId] = [site.id, site.slot];
@@ -760,7 +774,7 @@ const spec = {
               // check native object
               try {
                 const nativeData = serverBid.admNative || JSON.parse(serverBid.adm).native;
-                bid.native = parseNative(nativeData);
+                bid.native = parseNative(nativeData, adUnitCode);
                 bid.width = 1;
                 bid.height = 1;
               } catch (err) {
@@ -807,6 +821,15 @@ const spec = {
     }
   },
 
+  onBidViewable(bid) {
+    const payload = getNotificationPayload(bid);
+    if (payload) {
+      payload.event = 'bidViewable';
+      sendNotification(payload);
+      return payload;
+    }
+  },
+
   onBidWon(bid) {
     const payload = getNotificationPayload(bid);
     if (payload) {

package/modules/tapadIdSystem.js

@@ -56,6 +56,12 @@ export const tapadIdSubmodule = {
         );
       }
     }
+  },
+  eids: {
+    'tapadId': {
+      source: 'tapad.com',
+      atype: 1
+    },
   }
 }
 submodule('userId', tapadIdSubmodule);

package/modules/tappxBidAdapter.js

@@ -252,6 +252,7 @@ function buildOneRequest(validBidRequests, bidderRequest) {
   const BIDEXTRA = deepAccess(validBidRequests, 'params.ext');
   const bannerMediaType = deepAccess(validBidRequests, 'mediaTypes.banner');
   const videoMediaType = deepAccess(validBidRequests, 'mediaTypes.video');
+  const ORTB2 = deepAccess(validBidRequests, 'ortb2');
 
   // let requests = [];
   let payload = {};
@@ -410,6 +411,14 @@ function buildOneRequest(validBidRequests, bidderRequest) {
   let geo = {};
   geo.country = deepAccess(validBidRequests, 'params.geo.country');
   // < Device object
+  let configGeo = {};
+  configGeo.country = ORTB2?.device?.geo;
+
+  if (typeof configGeo.country !== 'undefined') {
+    device.geo = configGeo;
+  } else if (typeof geo.country !== 'undefined') {
+    device.geo = geo;
+  };
 
   // > GDPR
   let user = {};
@@ -491,7 +500,7 @@ function getLanguage() {
 
 function getOs() {
   let ua = navigator.userAgent;
-  if (ua.indexOf('Windows') != -1) { return 'Windows'; } else if (ua.indexOf('Mac OS X') != -1) { return 'macOS'; } else if (ua.match(/Android/)) { return 'Android'; } else if (ua.match(/(iPhone|iPod|iPad)/)) { return 'iOS'; } else if (ua.indexOf('Linux') != -1) { return 'Linux'; } else { return 'Unknown'; }
+  if (ua.match(/Android/)) { return 'Android'; } else if (ua.match(/(iPhone|iPod|iPad)/)) { return 'iOS'; } else if (ua.indexOf('Mac OS X') != -1) { return 'macOS'; } else if (ua.indexOf('Windows') != -1) { return 'Windows'; } else if (ua.indexOf('Linux') != -1) { return 'Linux'; } else { return 'Unknown'; }
 }
 
 function getVendor() {

package/modules/tappxBidAdapter.md

@@ -92,3 +92,20 @@ Ads sizes available: [300,250], [320,50], [320,480], [480,320], [728,90], [768,1
         }
     ];
 ```
+### Configuration
+
+Use `setConfig` to configure this submodule ortb2.device.geo, this will allow geolocation
+`Geo` object to bring First Party Information.
+
+```javascript
+var TIMEOUT = 1000;
+pbjs.setConfig({
+    ortb2:{
+        device:{
+            geo:{
+                country:'US'
+            }
+        }
+    }
+});
+```

package/modules/tncIdSystem.js

@@ -57,6 +57,12 @@ export const tncidSubModule = {
     return {
       callback: function (cb) { return tncCallback(cb); }
     }
+  },
+  eids: {
+    'tncid': {
+      source: 'thenewco.it',
+      atype: 3
+    },
   }
 }
 

package/modules/topicsFpdModule.js

@@ -1,18 +1,22 @@
-import {logError, logWarn, mergeDeep, isEmpty, safeJSONParse, logInfo, hasDeviceAccess} from '../src/utils.js';
+import {isEmpty, logError, logWarn, mergeDeep, safeJSONParse} from '../src/utils.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {submodule} from '../src/hook.js';
 import {GreedyPromise} from '../src/utils/promise.js';
 import {config} from '../src/config.js';
 import {getCoreStorageManager} from '../src/storageManager.js';
 import {includes} from '../src/polyfill.js';
-import {gdprDataHandler} from '../src/adapterManager.js';
+import {isActivityAllowed} from '../src/activities/rules.js';
+import {ACTIVITY_ENRICH_UFPD} from '../src/activities/activities.js';
+import {activityParams} from '../src/activities/activityParams.js';
+import {MODULE_TYPE_BIDDER} from '../src/activities/modules.js';
 
 const MODULE_NAME = 'topicsFpd';
 const DEFAULT_EXPIRATION_DAYS = 21;
-const TCF_REQUIRED_PURPOSES = ['1', '2', '3', '4'];
-let HAS_GDPR_CONSENT = true;
 let LOAD_TOPICS_INITIALISE = false;
-const HAS_DEVICE_ACCESS = hasDeviceAccess();
+
+export function reset() {
+  LOAD_TOPICS_INITIALISE = false;
+}
 
 const bidderIframeList = {
   maxTopicCaller: 2,
@@ -86,10 +90,14 @@ export function getTopicsData(name, topics, taxonomies = TAXONOMIES) {
     );
 }
 
+function isTopicsSupported(doc = document) {
+  return 'browsingTopics' in doc && doc.featurePolicy.allowsFeature('browsing-topics')
+}
+
 export function getTopics(doc = document) {
   let topics = null;
   try {
-    if ('browsingTopics' in doc && doc.featurePolicy.allowsFeature('browsing-topics')) {
+    if (isTopicsSupported(doc)) {
       topics = GreedyPromise.resolve(doc.browsingTopics());
     }
   } catch (e) {
@@ -126,19 +134,16 @@ export function processFpd(config, {global}, {data = topicsData} = {}) {
  */
 export function getCachedTopics() {
   let cachedTopicData = [];
-  if (!HAS_GDPR_CONSENT || !HAS_DEVICE_ACCESS) {
-    return cachedTopicData;
-  }
   const topics = config.getConfig('userSync.topics') || bidderIframeList;
   const bidderList = topics.bidders || [];
   let storedSegments = new Map(safeJSONParse(coreStorage.getDataFromLocalStorage(topicStorageName)));
   storedSegments && storedSegments.forEach((value, cachedBidder) => {
     // Check bidder exist in config for cached bidder data and then only retrieve the cached data
-    let bidderConfigObj = bidderList.find(({bidder}) => cachedBidder == bidder)
-    if (bidderConfigObj) {
+    let bidderConfigObj = bidderList.find(({bidder}) => cachedBidder === bidder)
+    if (bidderConfigObj && isActivityAllowed(ACTIVITY_ENRICH_UFPD, activityParams(MODULE_TYPE_BIDDER, cachedBidder))) {
       if (!isCachedDataExpired(value[lastUpdated], bidderConfigObj?.expiry || DEFAULT_EXPIRATION_DAYS)) {
         Object.keys(value).forEach((segData) => {
-          segData != lastUpdated && cachedTopicData.push(value[segData]);
+          segData !== lastUpdated && cachedTopicData.push(value[segData]);
         })
       } else {
         // delete the specific bidder map from the store and store the updated maps
@@ -204,55 +209,23 @@ function listenMessagesFromTopicIframe() {
   window.addEventListener('message', receiveMessage, false);
 }
 
-function checkTCFv2(vendorData, requiredPurposes = TCF_REQUIRED_PURPOSES) {
-  const {gdprApplies, purpose} = vendorData;
-  if (!gdprApplies || !purpose) {
-    return true;
-  }
-  return requiredPurposes.map((purposeNo) => {
-    const purposeConsent = purpose.consents ? purpose.consents[purposeNo] : false;
-    if (purposeConsent) {
-      return true;
-    }
-    return false;
-  }).reduce((a, b) => a && b, true);
-}
-
-export function hasGDPRConsent() {
-  // Check for GDPR consent for purpose 1,2,3,4 and return false if consent has not been given
-  const gdprConsent = gdprDataHandler.getConsentData();
-  const hasGdpr = (gdprConsent && typeof gdprConsent.gdprApplies === 'boolean' && gdprConsent.gdprApplies) ? 1 : 0;
-  const gdprConsentString = hasGdpr ? gdprConsent.consentString : '';
-  if (hasGdpr) {
-    if ((!gdprConsentString || gdprConsentString === '') || !gdprConsent.vendorData) {
-      return false;
-    }
-    return checkTCFv2(gdprConsent.vendorData);
-  }
-  return true;
-}
-
 /**
  * function to load the iframes of the bidder to load the topics data
  */
-function loadTopicsForBidders() {
-  HAS_GDPR_CONSENT = hasGDPRConsent();
-  if (!HAS_GDPR_CONSENT || !HAS_DEVICE_ACCESS) {
-    logInfo('Topics Module : Consent string is required to fetch the topics from third party domains.');
-    return;
-  }
+export function loadTopicsForBidders(doc = document) {
+  if (!isTopicsSupported(doc)) return;
   const topics = config.getConfig('userSync.topics') || bidderIframeList;
   if (topics) {
     listenMessagesFromTopicIframe();
     const randomBidders = getRandomBidders(topics.bidders || [], topics.maxTopicCaller || 1)
     randomBidders && randomBidders.forEach(({ bidder, iframeURL }) => {
       if (bidder && iframeURL) {
-        let ifrm = document.createElement('iframe');
+        let ifrm = doc.createElement('iframe');
         ifrm.name = 'ifrm_'.concat(bidder);
         ifrm.src = ''.concat(iframeURL, '?bidder=').concat(bidder);
         ifrm.style.display = 'none';
         setLoadedIframeURL(new URL(iframeURL).origin);
-        iframeURL && window.document.documentElement.appendChild(ifrm);
+        iframeURL && doc.documentElement.appendChild(ifrm);
       }
     })
   } else {

package/modules/tripleliftBidAdapter.js

@@ -189,6 +189,11 @@ function _buildPostBody(bidRequests, bidderRequest) {
   if (bidderRequest?.ortb2?.regs?.gpp) {
     data.regs = Object.assign({}, bidderRequest.ortb2.regs);
   }
+
+  if (bidderRequest?.ortb2) {
+    data.ext.ortb2 = Object.assign({}, bidderRequest.ortb2);
+  }
+
   return data;
 }
 

package/modules/uid2IdSystem.js

@@ -83,6 +83,20 @@ export const uid2IdSubmodule = {
     _logInfo(`UID2 getId returned`, result);
     return result;
   },
+  eids: {
+    'uid2': {
+      source: 'uidapi.com',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      },
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+  },
 };
 
 function decodeImpl(value) {

package/modules/unifiedIdSystem.js

@@ -67,6 +67,17 @@ export const unifiedIdSubmodule = {
       ajax(url, callbacks, undefined, {method: 'GET', withCredentials: true});
     };
     return {callback: resp};
+  },
+  eids: {
+    'tdid': {
+      source: 'adserver.org',
+      atype: 1,
+      getUidExt: function() {
+        return {
+          rtiPartner: 'TDID'
+        };
+      }
+    },
   }
 };