prebid.js 8.4.0 → 8.5.0

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 = `http://${SSMAS_SERVER}/ortb`;
+const SYNC_URL = `http://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/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/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'
+        };
+      }
+    },
   }
 };