prebid.js 9.4.1 → 9.6.0

package/modules/dspxBidAdapter.js

@@ -1,4 +1,5 @@
-import {deepAccess, getBidIdParameter, isFn, logError, logMessage, logWarn} from '../src/utils.js';
+import {deepAccess, getBidIdParameter, isFn, logError, logMessage, logWarn, isEmptyStr, isArray} from '../src/utils.js';
+
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {Renderer} from '../src/Renderer.js';
@@ -7,7 +8,6 @@ import {includes} from '../src/polyfill.js';
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
  */
-
 const BIDDER_CODE = 'dspx';
 const ENDPOINT_URL = 'https://buyer.dspx.tv/request/';
 const ENDPOINT_URL_DEV = 'https://dcbuyer.dspx.tv/request/';
@@ -63,24 +63,18 @@ export const spec = {
         rnd: rnd,
         ref: referrer,
         bid_id: bidId,
-        pbver: '$prebid.version$'
+        pbver: '$prebid.version$',
       };
 
+      payload.pfilter = {};
       if (params.pfilter !== undefined) {
         payload.pfilter = params.pfilter;
       }
 
       if (bidderRequest && bidderRequest.gdprConsent) {
-        if (payload.pfilter !== undefined) {
-          if (!payload.pfilter.gdpr_consent) {
-            payload.pfilter.gdpr_consent = bidderRequest.gdprConsent.consentString;
-            payload.pfilter.gdpr = bidderRequest.gdprConsent.gdprApplies;
-          }
-        } else {
-          payload.pfilter = {
-            'gdpr_consent': bidderRequest.gdprConsent.consentString,
-            'gdpr': bidderRequest.gdprConsent.gdprApplies
-          };
+        if (!payload.pfilter.gdpr_consent) {
+          payload.pfilter.gdpr_consent = bidderRequest.gdprConsent.consentString;
+          payload.pfilter.gdpr = bidderRequest.gdprConsent.gdprApplies;
         }
       }
 
@@ -94,48 +88,10 @@ export const spec = {
         payload.prebidDevMode = 1;
       }
 
-      // fill userId params
-      if (bidRequest.userId) {
-        if (bidRequest.userId.netId) {
-          payload.did_netid = bidRequest.userId.netId;
-        }
-        if (bidRequest.userId.id5id) {
-          payload.did_id5 = bidRequest.userId.id5id.uid || '0';
-          if (bidRequest.userId.id5id.ext.linkType !== undefined) {
-            payload.did_id5_linktype = bidRequest.userId.id5id.ext.linkType;
-          }
-        }
-        let uId2 = deepAccess(bidRequest, 'userId.uid2.id');
-        if (uId2) {
-          payload.did_uid2 = uId2;
-        }
-        let sharedId = deepAccess(bidRequest, 'userId.sharedid.id');
-        if (sharedId) {
-          payload.did_sharedid = sharedId;
-        }
-        let pubcId = deepAccess(bidRequest, 'userId.pubcid');
-        if (pubcId) {
-          payload.did_pubcid = pubcId;
-        }
-        let crumbsPubcid = deepAccess(bidRequest, 'crumbs.pubcid');
-        if (crumbsPubcid) {
-          payload.did_cpubcid = crumbsPubcid;
-        }
-      }
-
-      if (bidRequest.schain) {
-        payload.schain = bidRequest.schain;
-      }
-
-      if (payload.pfilter === undefined || !payload.pfilter.floorprice) {
+      if (!payload.pfilter.floorprice) {
         let bidFloor = getBidFloor(bidRequest);
         if (bidFloor > 0) {
-          if (payload.pfilter !== undefined) {
-            payload.pfilter.floorprice = bidFloor;
-          } else {
-            payload.pfilter = { 'floorprice': bidFloor };
-          }
-          // payload.bidFloor = bidFloor;
+          payload.pfilter.floorprice = bidFloor;
         }
       }
 
@@ -146,6 +102,7 @@ export const spec = {
         payload.pbcode = pbcode;
       }
 
+      // media types
       payload.media_types = convertMediaInfoForRequest(mediaTypesInfo);
       if (mediaTypesInfo[VIDEO] !== undefined) {
         payload.vctx = getVideoContext(bidRequest);
@@ -159,6 +116,33 @@ export const spec = {
           .forEach(key => payload.vpl[key] = videoParams[key]);
       }
 
+      // iab content
+      let content = deepAccess(bidderRequest, 'ortb2.site.content');
+      if (content) {
+        let stringContent = siteContentToString(content);
+        if (stringContent) {
+          payload.pfilter.iab_content = stringContent;
+        }
+      }
+
+      // Google Topics
+      const segments = extractUserSegments(bidderRequest);
+      if (segments) {
+        assignDefinedValues(payload, {
+          segtx: segments.segtax,
+          segcl: segments.segclass,
+          segs: segments.segments
+        });
+      }
+
+      // schain
+      if (bidRequest.schain) {
+        payload.schain = bidRequest.schain;
+      }
+
+      // fill userId params
+      fillUsersIds(bidRequest, payload);
+
       return {
         method: 'GET',
         url: endpoint,
@@ -257,6 +241,74 @@ export const spec = {
   }
 }
 
+/**
+ * Adds userIds to payload
+ *
+ * @param bidRequest
+ * @param payload
+ */
+function fillUsersIds(bidRequest, payload) {
+  if (bidRequest.hasOwnProperty('userId')) {
+    let didMapping = {
+      did_netid: 'userId.netId',
+      did_id5: 'userId.id5id.uid',
+      did_id5_linktype: 'userId.id5id.ext.linkType',
+      did_uid2: 'userId.uid2',
+      did_sharedid: 'userId.sharedid',
+      did_pubcid: 'userId.pubcid',
+      did_uqid: 'userId.utiq',
+      did_cruid: 'userId.criteoid',
+      did_euid: 'userId.euid',
+      // did_tdid: 'unifiedId',
+      did_tdid: 'userId.tdid',
+      did_ppuid: function() {
+        let path = 'userId.pubProvidedId';
+        let value = deepAccess(bidRequest, path);
+        if (isArray(value)) {
+          for (const rec of value) {
+            if (rec.uids && rec.uids.length > 0) {
+              for (let i = 0; i < rec.uids.length; i++) {
+                if ('id' in rec.uids[i] && deepAccess(rec.uids[i], 'ext.stype') === 'ppuid') {
+                  return (rec.uids[i].atype ?? '') + ':' + rec.source + ':' + rec.uids[i].id;
+                }
+              }
+            }
+          }
+        }
+        return undefined;
+      },
+      did_cpubcid: 'crumbs.pubcid'
+    };
+    for (let paramName in didMapping) {
+      let path = didMapping[paramName];
+
+      // handle function
+      if (typeof path == 'function') {
+        let value = path(paramName);
+        if (value) {
+          payload[paramName] = value;
+        }
+        continue;
+      }
+      // direct access
+      let value = deepAccess(bidRequest, path);
+      if (typeof value == 'string' || typeof value == 'number') {
+        payload[paramName] = value;
+      } else if (typeof value == 'object') {
+        // trying to find string ID value
+        if (typeof deepAccess(bidRequest, path + '.id') == 'string') {
+          payload[paramName] = deepAccess(bidRequest, path + '.id');
+        } else {
+          if (Object.keys(value).length > 0) {
+            logError(`DSPx: WARNING: fillUserIds had to use first key in user object to get value for bid.userId key: ${path}.`);
+            payload[paramName] = value[Object.keys(value)[0]];
+          }
+        }
+      }
+    }
+  }
+}
+
 function appendToUrl(url, what) {
   if (!what) {
     return url;
@@ -276,7 +328,7 @@ function objectToQueryString(obj, prefix) {
         : encodeURIComponent(k) + '=' + encodeURIComponent(v));
     }
   }
-  return str.join('&');
+  return str.filter(n => n).join('&');
 }
 
 /**
@@ -508,4 +560,74 @@ function createOutstreamEmbedCode(bid) {
   return fragment;
 }
 
+/**
+ * Convert site.content to string
+ * @param content
+ */
+function siteContentToString(content) {
+  if (!content) {
+    return '';
+  }
+  let stringKeys = ['id', 'title', 'series', 'season', 'artist', 'genre', 'isrc', 'url', 'keywords'];
+  let intKeys = ['episode', 'context', 'livestream'];
+  let arrKeys = ['cat'];
+  let retArr = [];
+  arrKeys.forEach(k => {
+    let val = deepAccess(content, k);
+    if (val && Array.isArray(val)) {
+      retArr.push(k + ':' + val.join('|'));
+    }
+  });
+  intKeys.forEach(k => {
+    let val = deepAccess(content, k);
+    if (val && typeof val === 'number') {
+      retArr.push(k + ':' + val);
+    }
+  });
+  stringKeys.forEach(k => {
+    let val = deepAccess(content, k);
+    if (val && typeof val === 'string') {
+      retArr.push(k + ':' + encodeURIComponent(val));
+    }
+  });
+  return retArr.join(',');
+}
+
+/**
+ * Assigns multiple values to the specified keys on an object if the values are not undefined.
+ * @param {Object} target - The object to which the values will be assigned.
+ * @param {Object} values - An object containing key-value pairs to be assigned.
+ */
+function assignDefinedValues(target, values) {
+  for (const key in values) {
+    if (values[key] !== undefined) {
+      target[key] = values[key];
+    }
+  }
+}
+
+/**
+ * Extracts user segments/topics from the bid request object
+ * @param {Object} bid - The bid request object
+ * @returns {{segclass: *, segtax: *, segments: *}|undefined} - User segments/topics or undefined if not found
+ */
+function extractUserSegments(bid) {
+  const userData = deepAccess(bid, 'ortb2.user.data') || [];
+  for (const dataObj of userData) {
+    if (dataObj.segment && isArray(dataObj.segment) && dataObj.segment.length > 0) {
+      const segments = dataObj.segment
+        .filter(seg => seg.id && !isEmptyStr(seg.id) && isFinite(seg.id))
+        .map(seg => Number(seg.id));
+      if (segments.length > 0) {
+        return {
+          segtax: deepAccess(dataObj, 'ext.segtax'),
+          segclass: deepAccess(dataObj, 'ext.segclass'),
+          segments: segments.join(',')
+        };
+      }
+    }
+  }
+  return undefined;
+}
+
 registerBidder(spec);

package/modules/eightPodAnalyticsAdapter.js

@@ -1,4 +1,4 @@
-import {logError, logInfo} from '../src/utils.js';
+import {logError, logInfo, logMessage} from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import { EVENTS } from '../src/constants.js';
@@ -9,13 +9,11 @@ import {getStorageManager} from '../src/storageManager.js';
 const analyticsType = 'endpoint';
 const MODULE_NAME = `eightPod`;
 const MODULE = `${MODULE_NAME}AnalyticProvider`;
-let interval;
 
 /**
  * Custom tracking server that gets internal events from EightPod's ad unit
  */
 const trackerUrl = 'https://demo.8pod.com/tracker/track';
-
 export const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: MODULE_NAME})
 
 const {
@@ -23,12 +21,12 @@ const {
 } = EVENTS;
 
 export let queue = [];
-export let context;
+let context = {};
 
 /**
  * Create eightPod Analytic adapter
  */
-let eightPodAnalytics = Object.assign(adapter({ analyticsType }), {
+let eightPodAnalytics = Object.assign(adapter({url: trackerUrl, analyticsType}), {
   /**
    * Execute on bid won - setup basic settings, save context about EightPod's bid. We will send it with our events later
    */
@@ -36,45 +34,47 @@ let eightPodAnalytics = Object.assign(adapter({ analyticsType }), {
     switch (eventType) {
       case BID_WON:
         if (args.bidder === 'eightPod') {
+          context[args.adUnitCode] = makeContext(args);
+
           eightPodAnalytics.setupPage(args);
-          context = makeContext(args);
           break;
         }
     }
   },
 
   /**
-   * Execute on bid won - subscribe on events from adUnit
+   * Execute on bid won upload events from local storage
    */
   setupPage() {
-    eightPodAnalytics.eventSubscribe();
-    queue = getEventFromLocalStorage();
+    queue = this.getEventFromLocalStorage();
   },
+
   /**
    * Subscribe on internal ad unit tracking events
    */
   eventSubscribe() {
     window.addEventListener('message', async (event) => {
-      const data = event?.data;
+      const data = event.data;
 
-      if (!data?.detail?.name) {
-        return;
-      }
+      const frameElement = event.source?.frameElement;
+      const parentElement = frameElement?.parentElement;
+      const adUnitCode = parentElement?.id;
 
-      trackEvent(data);
+      trackEvent(data, adUnitCode);
     });
 
-    // Send queue of event every 10 seconds
-    if (!interval) {
-      interval = setInterval(sendEvents, 10_000);
-    }
+    setInterval(sendEvents, 10_000);
   },
   resetQueue() {
     queue = [];
   },
   getContext() {
     return context;
-  }
+  },
+  resetContext() {
+    context = {};
+  },
+  getEventFromLocalStorage,
 });
 
 /**
@@ -84,8 +84,8 @@ function makeContext(args) {
   const params = args?.params?.[0];
   return {
     bidId: args.seatBidId,
-    variantId: args.creativeId || 'variantId',
-    campaignId: 'campaignId',
+    variantId: args.creativeId || '',
+    campaignId: args.cid || '',
     publisherId: params.publisherId,
     placementId: params.placementId,
   };
@@ -94,12 +94,13 @@ function makeContext(args) {
 /**
  * Create event, add context and push it to queue
  */
-export function trackEvent(event) {
+export function trackEvent(event, adUnitCode) {
   if (!event.detail) {
     return;
   }
+
   const fullEvent = {
-    context: eightPodAnalytics.getContext(),
+    context: eightPodAnalytics.getContext()[adUnitCode],
     eventType: event.detail.type,
     eventClass: 'adunit',
     timestamp: new Date().getTime(),
@@ -107,6 +108,7 @@ export function trackEvent(event) {
     payload: event.detail.payload
   };
 
+  logMessage(fullEvent);
   addEvent(fullEvent);
 }
 
@@ -158,7 +160,7 @@ function sendEvents() {
  * Send event to our custom tracking server
  */
 function sendEventsApi(eventList, callbacks) {
-  ajax(trackerUrl, callbacks, JSON.stringify(eventList));
+  ajax(trackerUrl, callbacks, JSON.stringify(eventList), {keepalive: true});
 }
 
 /**
@@ -173,21 +175,13 @@ eightPodAnalytics.originEnableAnalytics = eightPodAnalytics.enableAnalytics;
 eightPodAnalytics.eventsStorage = [];
 
 // override enableAnalytics so we can get access to the config passed in from the page
+// Subscribe on events from adUnit
 eightPodAnalytics.enableAnalytics = function (config) {
   eightPodAnalytics.originEnableAnalytics(config);
   logInfo(MODULE, 'init', config);
+  eightPodAnalytics.eventSubscribe();
 };
 
-eightPodAnalytics.disableAnalytics = (function (orig) {
-  return function (...args) {
-    if (interval) {
-      clearInterval(interval);
-      interval = null;
-    }
-    return orig.apply(this, args);
-  };
-})(eightPodAnalytics.disableAnalytics);
-
 /**
  * Register Analytics Adapter
  */

package/modules/eightPodBidAdapter.js

@@ -4,7 +4,7 @@ import { BANNER } from '../src/mediaTypes.js'
 import * as utils from '../src/utils.js'
 
 export const BIDDER_CODE = 'eightPod'
-const url = 'https://demo.8pod.com/bidder/rtb/eightpod_exchange/bid?trace=true';
+const url = 'https://demo.8pod.com/bidder/rtb/eightpod_exchange/bid';
 
 export const spec = {
   code: BIDDER_CODE,
@@ -49,8 +49,9 @@ function isBidRequestValid(bidRequest) {
 function buildRequests(bids, bidderRequest) {
   let bannerBids = bids.filter((bid) => isBannerBid(bid))
   let requests = bannerBids.length
-    ? [createRequest(bannerBids, bidderRequest, BANNER)]
+    ? createRequest(bannerBids, bidderRequest, BANNER)
     : []
+
   return requests
 }
 
@@ -61,8 +62,10 @@ function bidResponse(buildBidResponse, bid, context) {
 
   bidResponse.height = context?.imp?.banner?.format?.[0].h;
   bidResponse.width = context?.imp?.banner?.format?.[0].w;
+  bidResponse.cid = bid.cid;
 
   bidResponse.burl = replacePriceInUrl(bid.burl, bidResponse.originalCpm || bidResponse.cpm);
+
   return bidResponse;
 }
 
@@ -119,64 +122,75 @@ export function getPageKeywords(win = window) {
 }
 
 function createRequest(bidRequests, bidderRequest, mediaType) {
-  const data = converter.toORTB({
-    bidRequests,
-    bidderRequest,
-    context: { mediaType },
-  });
-
-  data.adSlotPositionOnScreen = 'ABOVE_THE_FOLD';
-  data.at = 1;
-
-  const params = getBidderParams(bidRequests);
-
-  data.device = {
-    ...data.device,
-    model: parseUserAgent().device,
-    os: parseUserAgent().platform,
-    osv: parseUserAgent().version,
-    geo: {
-      country: params.country || 'GRB'
-    },
-    language: params.language || data.device.language,
-  }
-  data.site = {
-    ...data.site,
-    keywords: getPageKeywords(window),
-  }
-  data.imp = [
-    {
-      ...data.imp?.[0],
-      pmp: params.dealId
-        ? {
-          ...data.pmp,
-          deals: [
-            {
-              bidfloor: 0.5,
-              at: 2,
-              id: params.dealId,
-            },
-          ],
-          private_auction: 1,
-        }
-        : data.pmp,
+  const requests = bidRequests.map((bidRequest) => {
+    const data = converter.toORTB({
+      bidRequests: [bidRequest],
+      bidderRequest,
+      context: { mediaType },
+    });
+
+    data.adSlotPositionOnScreen = 'ABOVE_THE_FOLD';
+    data.at = 1;
+
+    const userId =
+      utils.deepAccess(bidRequest, 'userId.unifiedId.id') ||
+      utils.deepAccess(bidRequest, 'userId.id5id.uid') ||
+      utils.deepAccess(bidRequest, 'userId.idl_env');
+
+    const params = getBidderParams(bidRequest);
+    data.device = {
+      ...data.device,
+      devicetype: 4,
+      geo: {
+        country: params.country || 'GRB'
+      },
+      language: params.language || data.device.language,
+    }
+    data.site = {
+      ...data.site,
+      keywords: getPageKeywords(window),
+      publisher: {
+        id: params.publisherId
+      }
+    }
+    data.imp = [
+      {
+        ...data.imp?.[0],
+        secure: 1,
+        pmp: params.dealId
+          ? {
+            ...data.pmp,
+            deals: [
+              {
+                id: params.dealId,
+              },
+            ],
+            private_auction: 1,
+          }
+          : data.pmp,
+      }
+    ]
+    data.adSlotPlacementId = params.placementId;
+
+    if (userId) {
+      data.user = {
+        id: userId
+      }
     }
-  ]
-  data.adSlotPlacementId = params.placementId;
 
-  const req = {
-    method: 'POST',
-    url,
-    data
-  }
-  return req
-}
+    const req = {
+      method: 'POST',
+      url: url && params.trace ? url + '?trace=true' : url,
+      options: { withCredentials: false },
+      data
+    }
+    return req
+  })
 
-function getBidderParams(bidRequests) {
-  const bid = bidRequests.find(bid => {
-    return bid.bidder === BIDDER_CODE
-  });
+  return requests;
+}
 
+function getBidderParams(bid) {
   return bid?.params ? bid.params : undefined;
 }
 
@@ -189,5 +203,47 @@ function isBannerBid(bid) {
 }
 
 function interpretResponse(resp, req) {
-  return converter.fromORTB({ request: req.data, response: resp.body })
+  const impressionId = resp.body.seatbid[0].bid[0].impid;
+  const bidResponses = converter.fromORTB({ request: req.data, response: resp.body });
+  const ad = bidResponses[0].ad;
+  const trackingTag = `<script src="https://cdn.doubleverify.com/dvtp_src.js?ctx=818052&cmp=APAC_Cert_20&sid=se_a551&plc=240411845&adsrv=0&btreg=ad-unit-container&auevent=${impressionId}&btadsrv=&crt=01&tagtype=&dvtagver=6.1.src" type="text/javascript"></script>
+        <script type="text/javascript">
+            (function() {
+                /** CONFIGURATION START **/
+                var _sf_async_config = window._sf_async_config = (window._sf_async_config || {});
+                _sf_async_config.uid = 67171;
+                _sf_async_config.domain = 'demo.8pod.com';
+                _sf_async_config.flickerControl = false;
+                _sf_async_config.useCanonical = true;
+                _sf_async_config.useCanonicalDomain = true;
+                _sf_async_config.sections = '';
+                _sf_async_config.authors = '';
+                /** CONFIGURATION END **/
+                function loadChartbeat() {
+                    var e = document.createElement('script');
+                    var n = document.getElementsByTagName('script')[0];
+                    e.type = 'text/javascript';
+                    e.async = true;
+                    e.src = '//static.chartbeat.com/js/chartbeat.js';
+                    n.parentNode.insertBefore(e, n);
+                }
+                loadChartbeat();
+            })();
+        </script>
+        <script async src="//static.chartbeat.com/js/chartbeat_mab.js"></script>
+
+        <script type="text/javascript">
+            var utag_data = {
+            }
+        </script>
+        <script type="text/javascript">
+            (function(a,b,c,d){
+                a='https://tags.tiqcdn.com/utag/sales-richard-coghlan/8pod/prod/utag.js';
+                b=document;c='script';d=b.createElement(c);d.src=a;d.type='text/java'+c;d.async=true;
+                a=b.getElementsByTagName(c)[0];a.parentNode.insertBefore(d,a);
+            })();
+        </script>`
+
+  bidResponses[0].ad = ad.replace('</head>', trackingTag + '</head>');
+  return bidResponses;
 }