prebid.js 8.3.0 → 8.5.0

package/modules/parrableIdSystem.js

@@ -7,7 +7,17 @@
 
 // ci trigger: 1
 
-import {contains, deepClone, inIframe, isEmpty, isPlainObject, logError, logWarn, timestamp} from '../src/utils.js';
+import {
+  contains,
+  deepClone,
+  inIframe,
+  isEmpty,
+  isPlainObject,
+  logError,
+  logWarn,
+  pick,
+  timestamp
+} from '../src/utils.js';
 import {find} from '../src/polyfill.js';
 import {ajax} from '../src/ajax.js';
 import {submodule} from '../src/hook.js';
@@ -368,7 +378,33 @@ export const parrableIdSubmodule = {
   getId(config, gdprConsentData, currentStoredId) {
     const configParams = (config && config.params) || {};
     return fetchId(configParams, gdprConsentData);
-  }
+  },
+  eids: {
+    'parrableId': {
+      source: 'parrable.com',
+      atype: 1,
+      getValue: function(parrableId) {
+        if (parrableId.eid) {
+          return parrableId.eid;
+        }
+        if (parrableId.ccpaOptout) {
+          // If the EID was suppressed due to a non consenting ccpa optout then
+          // we still wish to provide this as a reason to the adapters
+          return '';
+        }
+        return null;
+      },
+      getUidExt: function(parrableId) {
+        const extendedData = pick(parrableId, [
+          'ibaOptout',
+          'ccpaOptout'
+        ]);
+        if (Object.keys(extendedData).length) {
+          return extendedData;
+        }
+      }
+    },
+  },
 };
 
 submodule('userId', parrableIdSubmodule);

package/modules/publinkIdSystem.js

@@ -140,6 +140,12 @@ export const publinkIdSubmodule = {
     if (!storedId) {
       return {callback: makeCallback(config, consentData)};
     }
-  }
+  },
+  eids: {
+    'publinkId': {
+      source: 'epsilon.com',
+      atype: 3
+    },
+  },
 };
 submodule('userId', publinkIdSubmodule);

package/modules/pubmaticBidAdapter.js

@@ -1194,6 +1194,15 @@ export const spec = {
       deepSetValue(payload, 'regs.ext.us_privacy', bidderRequest.uspConsent);
     }
 
+    // Attaching GPP Consent Params
+    if (bidderRequest?.gppConsent?.gppString) {
+      deepSetValue(payload, 'regs.gpp', bidderRequest.gppConsent.gppString);
+      deepSetValue(payload, 'regs.gpp_sid', bidderRequest.gppConsent.applicableSections);
+    } else if (bidderRequest?.ortb2?.regs?.gpp) {
+      deepSetValue(payload, 'regs.gpp', bidderRequest.ortb2.regs.gpp);
+      deepSetValue(payload, 'regs.gpp_sid', bidderRequest.ortb2.regs.gpp_sid);
+    }
+
     // coppa compliance
     if (config.getConfig('coppa') === true) {
       deepSetValue(payload, 'regs.coppa', 1);
@@ -1352,7 +1361,7 @@ export const spec = {
   /**
    * Register User Sync.
    */
-  getUserSyncs: (syncOptions, responses, gdprConsent, uspConsent) => {
+  getUserSyncs: (syncOptions, responses, gdprConsent, uspConsent, gppConsent) => {
     let syncurl = '' + publisherId;
 
     // Attaching GDPR Consent Params in UserSync url
@@ -1366,6 +1375,12 @@ export const spec = {
       syncurl += '&us_privacy=' + encodeURIComponent(uspConsent);
     }
 
+    // GPP Consent
+    if (gppConsent?.gppString && gppConsent?.applicableSections?.length) {
+      syncurl += '&gpp=' + encodeURIComponent(gppConsent.gppString);
+      syncurl += '&gpp_sid=' + encodeURIComponent(gppConsent?.applicableSections?.join(','));
+    }
+
     // coppa compliance
     if (config.getConfig('coppa') === true) {
       syncurl += '&coppa=1';

package/modules/pulsepointBidAdapter.js

@@ -1,21 +1,9 @@
-import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
-/* eslint dot-notation:0, quote-props:0 */
-import {convertTypes, deepAccess, isArray, isFn, logError} from '../src/utils.js';
+import { ortbConverter } from '../libraries/ortbConverter/converter.js';
+import {convertTypes, isArray} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {Renderer} from '../src/Renderer.js';
 
-const NATIVE_DEFAULTS = {
-  TITLE_LEN: 100,
-  DESCR_LEN: 200,
-  SPONSORED_BY_LEN: 50,
-  IMG_MIN: 150,
-  ICON_MIN: 50,
-};
-
-const DEFAULT_BID_TTL = 20;
 const DEFAULT_CURRENCY = 'USD';
-const DEFAULT_NET_REVENUE = true;
-const KNOWN_PARAMS = ['cp', 'ct', 'cf', 'video', 'battr', 'bcat', 'badv', 'bidfloor'];
+const KNOWN_PARAMS = ['cp', 'ct', 'cf', 'battr', 'deals'];
 const DEFAULT_TMAX = 500;
 
 /**
@@ -41,33 +29,21 @@ export const spec = {
   ),
 
   buildRequests: (bidRequests, bidderRequest) => {
-    // convert Native ORTB definition to old-style prebid native definition
-    bidRequests = convertOrtbRequestToProprietaryNative(bidRequests);
-
-    const request = {
-      id: bidRequests[0].bidderRequestId,
-      imp: bidRequests.map(slot => impression(slot)),
-      site: site(bidRequests, bidderRequest),
-      app: app(bidRequests),
-      device: device(),
-      bcat: deepAccess(bidderRequest.ortb2Imp, 'bcat') || bidRequests[0].params.bcat,
-      badv: bidRequests[0].params.badv,
-      user: user(bidRequests[0], bidderRequest),
-      regs: regs(bidderRequest),
-      source: source(bidRequests[0].schain),
-      tmax: bidderRequest.timeout || DEFAULT_TMAX,
-    };
+    const data = converter.toORTB({bidRequests, bidderRequest});
     return {
       method: 'POST',
       url: 'https://bid.contextweb.com/header/ortb?src=prebid',
-      data: request,
+      data,
       bidderRequest
     };
   },
 
-  interpretResponse: (response, request) => (
-    bidResponseAvailable(request, response)
-  ),
+  interpretResponse: (response, request) => {
+    if (response.body) {
+      return converter.fromORTB({response: response.body, request: request.data}).bids;
+    }
+    return [];
+  },
 
   getUserSyncs: syncOptions => {
     if (syncOptions.iframeEnabled) {
@@ -82,7 +58,7 @@ export const spec = {
       }];
     }
   },
-  transformBidParams: function(params, isOpenRtb) {
+  transformBidParams: function(params) {
     return convertTypes({
       'cf': 'string',
       'cp': 'number',
@@ -91,124 +67,61 @@ export const spec = {
   }
 };
 
-/**
- * Callback for bids, after the call to PulsePoint completes.
- */
-function bidResponseAvailable(request, response) {
-  const idToImpMap = {};
-  const idToBidMap = {};
-  const idToSlotConfig = {};
-  const bidResponse = response.body;
-  // extract the request bids and the response bids, keyed by impr-id
-  const ortbRequest = request.data;
-  ortbRequest.imp.forEach(imp => {
-    idToImpMap[imp.id] = imp;
-  });
-  if (bidResponse) {
-    bidResponse.seatbid.forEach(seatBid => seatBid.bid.forEach(bid => {
-      idToBidMap[bid.impid] = bid;
-    }));
-  }
-  if (request.bidderRequest && request.bidderRequest.bids) {
-    request.bidderRequest.bids.forEach(bid => {
-      idToSlotConfig[bid.bidId] = bid;
-    });
-  }
-  const bids = [];
-  Object.keys(idToImpMap).forEach(id => {
-    if (idToBidMap[id]) {
-      const bid = {
-        requestId: id,
-        cpm: idToBidMap[id].price,
-        creative_id: idToBidMap[id].crid,
-        creativeId: idToBidMap[id].crid,
-        adId: id,
-        ttl: idToBidMap[id].exp || DEFAULT_BID_TTL,
-        netRevenue: DEFAULT_NET_REVENUE,
-        currency: bidResponse.cur || DEFAULT_CURRENCY,
-        meta: { advertiserDomains: idToBidMap[id].adomain || [] }
-      };
-      if (idToImpMap[id].video) {
-        // for outstream, a renderer is specified
-        if (idToSlotConfig[id] && deepAccess(idToSlotConfig[id], 'mediaTypes.video.context') === 'outstream') {
-          bid.renderer = outstreamRenderer(deepAccess(idToSlotConfig[id], 'renderer.options'), deepAccess(idToBidMap[id], 'ext.outstream'));
+const converter = ortbConverter({
+  context: {
+    netRevenue: true,
+    ttl: 300,
+    currency: 'USD'
+  },
+
+  imp(buildImp, bidRequest, context) {
+    const imp = buildImp(bidRequest, context);
+    // tagid
+    imp.tagid = bidRequest.params.ct.toString();
+    // unknown params
+    const unknownParams = slotUnknownParams(bidRequest);
+    if (imp.ext || unknownParams) {
+      imp.ext = Object.assign({}, imp.ext, unknownParams);
+    }
+    // battr
+    if (bidRequest.params.battr) {
+      ['banner', 'video', 'audio', 'native'].forEach(k => {
+        if (imp[k]) {
+          imp[k].battr = bidRequest.params.battr;
         }
-        bid.vastXml = idToBidMap[id].adm;
-        bid.mediaType = 'video';
-        bid.width = idToBidMap[id].w;
-        bid.height = idToBidMap[id].h;
-      } else if (idToImpMap[id].banner) {
-        bid.ad = idToBidMap[id].adm;
-        bid.width = idToBidMap[id].w || idToImpMap[id].banner.w;
-        bid.height = idToBidMap[id].h || idToImpMap[id].banner.h;
-      } else if (idToImpMap[id]['native']) {
-        bid['native'] = nativeResponse(idToImpMap[id], idToBidMap[id]);
-        bid.mediaType = 'native';
-      }
-      bids.push(bid);
+      });
     }
-  });
-  return bids;
-}
-
-/**
- * Produces an OpenRTBImpression from a slot config.
- */
-function impression(slot) {
-  var firstPartyData = slot.ortb2Imp?.ext || {};
-  var ext = Object.assign({}, firstPartyData, slotUnknownParams(slot));
-  return {
-    id: slot.bidId,
-    banner: banner(slot),
-    'native': nativeImpression(slot),
-    tagid: slot.params.ct.toString(),
-    video: video(slot),
-    bidfloor: bidFloor(slot),
-    ext: Object.keys(ext).length > 0 ? ext : null,
-  };
-}
-
-/**
- * Produces an OpenRTB Banner object for the slot given.
- */
-function banner(slot) {
-  const sizes = parseSizes(slot);
-  const size = adSize(slot, sizes);
-  return (slot.mediaTypes && slot.mediaTypes.banner) ? {
-    w: size[0],
-    h: size[1],
-    battr: slot.params.battr,
-    format: sizes
-  } : null;
-}
+    // deals
+    if (bidRequest.params.deals && isArray(bidRequest.params.deals)) {
+      imp.pmp = {
+        private_auction: 0,
+        deals: bidRequest.params.deals
+      };
+    }
+    return imp;
+  },
 
-/**
- * Produce openrtb format objects based on the sizes configured for the slot.
- */
-function parseSizes(slot) {
-  const sizes = deepAccess(slot, 'mediaTypes.banner.sizes');
-  if (sizes && isArray(sizes)) {
-    return sizes.filter(sz => isArray(sz) && sz.length === 2).map(sz => ({
-      w: sz[0],
-      h: sz[1]
-    }));
-  }
-  return null;
-}
+  request(buildRequest, imps, bidderRequest, context) {
+    const request = buildRequest(imps, bidderRequest, context);
+    // publisher id
+    const siteOrApp = request.site || request.app;
+    const pubId = context.bidRequests && context.bidRequests.length > 0 ? context.bidRequests[0].params.cp : '0';
+    if (siteOrApp) {
+      siteOrApp.publisher = Object.assign({}, siteOrApp.publisher, {
+        id: pubId.toString()
+      });
+    }
+    // tmax
+    request.tmax = request.tmax || DEFAULT_TMAX;
+    return request;
+  },
 
-/**
- * Produces an OpenRTB Video object for the slot given
- */
-function video(slot) {
-  if (slot.params.video) {
-    return Object.assign({},
-      slot.params.video, // previously supported as bidder param
-      slot.mediaTypes && slot.mediaTypes.video ? slot.mediaTypes.video : {}, // params on mediaTypes.video
-      {battr: slot.params.battr}
-    );
-  }
-  return null;
-}
+  bidResponse(buildBidResponse, bid, context) {
+    const bidResponse = buildBidResponse(bid, context);
+    bidResponse.cur = bidResponse.cur || DEFAULT_CURRENCY;
+    return bidResponse;
+  },
+});
 
 /**
  * Unknown params are captured and sent on ext
@@ -225,278 +138,4 @@ function slotUnknownParams(slot) {
   return Object.keys(ext).length > 0 ? { prebid: ext } : null;
 }
 
-/**
- * Sets up the renderer on the bid, for outstream bid responses.
- */
-function outstreamRenderer(rendererOptions, outstreamExtOptions) {
-  const renderer = Renderer.install({
-    url: outstreamExtOptions.rendererUrl,
-    config: {
-      defaultOptions: outstreamExtOptions.config,
-      rendererOptions,
-      type: outstreamExtOptions.type
-    },
-    loaded: false,
-  });
-  renderer.setRender((bid) => {
-    bid.renderer.push(() => {
-      const config = bid.renderer.getConfig();
-      new window.PulsePointOutstreamRenderer().render({
-        adUnitCode: bid.adUnitCode,
-        vastXml: bid.vastXml,
-        type: config.type,
-        defaultOptions: config.defaultOptions,
-        rendererOptions
-      });
-    });
-  });
-  return renderer;
-}
-
-/**
- * Produces an OpenRTB Native object for the slot given.
- */
-function nativeImpression(slot) {
-  if (slot.nativeParams) {
-    const assets = [];
-    addAsset(assets, titleAsset(assets.length + 1, slot.nativeParams.title, NATIVE_DEFAULTS.TITLE_LEN));
-    addAsset(assets, dataAsset(assets.length + 1, slot.nativeParams.body, 2, NATIVE_DEFAULTS.DESCR_LEN));
-    addAsset(assets, dataAsset(assets.length + 1, slot.nativeParams.sponsoredBy, 1, NATIVE_DEFAULTS.SPONSORED_BY_LEN));
-    addAsset(assets, imageAsset(assets.length + 1, slot.nativeParams.icon, 1, NATIVE_DEFAULTS.ICON_MIN, NATIVE_DEFAULTS.ICON_MIN));
-    addAsset(assets, imageAsset(assets.length + 1, slot.nativeParams.image, 3, NATIVE_DEFAULTS.IMG_MIN, NATIVE_DEFAULTS.IMG_MIN));
-    return {
-      request: JSON.stringify({ assets }),
-      ver: '1.1',
-      battr: slot.params.battr,
-    };
-  }
-  return null;
-}
-
-/**
- * Helper method to add an asset to the assets list.
- */
-function addAsset(assets, asset) {
-  if (asset) {
-    assets.push(asset);
-  }
-}
-
-/**
- * Produces a Native Title asset for the configuration given.
- */
-function titleAsset(id, params, defaultLen) {
-  if (params) {
-    return {
-      id,
-      required: params.required ? 1 : 0,
-      title: {
-        len: params.len || defaultLen,
-      },
-    };
-  }
-  return null;
-}
-
-/**
- * Produces a Native Image asset for the configuration given.
- */
-function imageAsset(id, params, type, defaultMinWidth, defaultMinHeight) {
-  return params ? {
-    id,
-    required: params.required ? 1 : 0,
-    img: {
-      type,
-      wmin: params.wmin || defaultMinWidth,
-      hmin: params.hmin || defaultMinHeight,
-    }
-  } : null;
-}
-
-/**
- * Produces a Native Data asset for the configuration given.
- */
-function dataAsset(id, params, type, defaultLen) {
-  return params ? {
-    id,
-    required: params.required ? 1 : 0,
-    data: {
-      type,
-      len: params.len || defaultLen,
-    }
-  } : null;
-}
-
-/**
- * Produces an OpenRTB site object.
- */
-function site(bidRequests, bidderRequest) {
-  const pubId = bidRequests && bidRequests.length > 0 ? bidRequests[0].params.cp : '0';
-  const appParams = bidRequests[0].params.app;
-  if (!appParams) {
-    // use the first party data if available, and override only publisher/ref/page properties
-    var firstPartyData = bidderRequest?.ortb2?.site || {};
-    return Object.assign({}, firstPartyData, {
-      publisher: {
-        id: pubId.toString(),
-      },
-      // TODO: does the fallback make sense here?
-      ref: bidderRequest?.refererInfo?.ref || window.document.referrer,
-      page: bidderRequest?.refererInfo?.page || ''
-    });
-  }
-  return null;
-}
-
-/**
- * Produces an OpenRTB App object.
- */
-function app(bidderRequest) {
-  const pubId = bidderRequest && bidderRequest.length > 0 ? bidderRequest[0].params.cp : '0';
-  const appParams = bidderRequest[0].params.app;
-  if (appParams) {
-    return {
-      publisher: {
-        id: pubId.toString(),
-      },
-      bundle: appParams.bundle,
-      storeurl: appParams.storeUrl,
-      domain: appParams.domain,
-    }
-  }
-  return null;
-}
-
-/**
- * Produces an OpenRTB Device object.
- */
-function device() {
-  return {
-    ua: navigator.userAgent,
-    language: (navigator.language || navigator.browserLanguage || navigator.userLanguage || navigator.systemLanguage),
-  };
-}
-
-/**
- * Safely parses the input given. Returns null on
- * parsing failure.
- */
-function parse(rawResponse) {
-  try {
-    if (rawResponse) {
-      return JSON.parse(rawResponse);
-    }
-  } catch (ex) {
-    logError('pulsepointLite.safeParse', 'ERROR', ex);
-  }
-  return null;
-}
-
-/**
- * Determines the AdSize for the slot.
- */
-function adSize(slot, sizes) {
-  if (slot.params.cf) {
-    const size = slot.params.cf.toUpperCase().split('X');
-    const width = parseInt(slot.params.cw || size[0], 10);
-    const height = parseInt(slot.params.ch || size[1], 10);
-    return [width, height];
-  } else if (sizes && sizes.length > 0) {
-    return [sizes[0].w, sizes[0].h];
-  }
-  return [1, 1];
-}
-
-/**
- * Handles the user level attributes and produces
- * an openrtb User object.
- */
-function user(bidRequest, bidderRequest) {
-  var user = bidderRequest?.ortb2?.user || { ext: {} };
-  var ext = user.ext;
-  if (bidderRequest) {
-    if (bidderRequest.gdprConsent) {
-      ext.consent = bidderRequest.gdprConsent.consentString;
-    }
-  }
-  if (bidRequest) {
-    let eids = bidRequest.userIdAsEids;
-    if (eids) {
-      ext.eids = eids;
-    }
-  }
-  return user;
-}
-
-/**
- * Produces the regulations ortb object
- */
-function regs(bidderRequest) {
-  if (bidderRequest.gdprConsent || bidderRequest.uspConsent) {
-    var ext = {};
-    // GDPR applies attribute (actual consent value is in user object)
-    if (bidderRequest.gdprConsent) {
-      ext.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
-    }
-    // CCPA
-    if (bidderRequest.uspConsent) {
-      ext.us_privacy = bidderRequest.uspConsent;
-    }
-    return { ext };
-  }
-  return null;
-}
-
-/**
- * Creates source object with supply chain
- */
-function source(schain) {
-  if (schain) {
-    return {
-      ext: { schain }
-    };
-  }
-  return null;
-}
-
-/**
- * Parses the native response from the Bid given.
- */
-function nativeResponse(imp, bid) {
-  if (imp['native']) {
-    const nativeAd = parse(bid.adm);
-    const keys = {};
-    if (nativeAd && nativeAd['native'] && nativeAd['native'].assets) {
-      nativeAd['native'].assets.forEach(asset => {
-        keys.title = asset.title ? asset.title.text : keys.title;
-        keys.body = asset.data && asset.data.type === 2 ? asset.data.value : keys.body;
-        keys.sponsoredBy = asset.data && asset.data.type === 1 ? asset.data.value : keys.sponsoredBy;
-        keys.image = asset.img && asset.img.type === 3 ? asset.img.url : keys.image;
-        keys.icon = asset.img && asset.img.type === 1 ? asset.img.url : keys.icon;
-      });
-      if (nativeAd['native'].link) {
-        keys.clickUrl = encodeURIComponent(nativeAd['native'].link.url);
-      }
-      keys.impressionTrackers = nativeAd['native'].imptrackers;
-      return keys;
-    }
-  }
-  return null;
-}
-
-function bidFloor(slot) {
-  let floor = slot.params.bidfloor;
-  if (isFn(slot.getFloor)) {
-    const floorData = slot.getFloor({
-      mediaType: slot.mediaTypes.banner ? 'banner' : slot.mediaTypes.video ? 'video' : 'Native',
-      size: '*',
-      currency: DEFAULT_CURRENCY,
-    });
-    if (floorData && floorData.floor) {
-      floor = floorData.floor;
-    }
-  }
-  return floor;
-}
-
 registerBidder(spec);