prebid.js 7.16.0 → 7.17.0

package/modules/1plusXRtdProvider.js

@@ -57,16 +57,39 @@ export const extractConfig = (moduleConfig, reqBidsConfigObj) => {
   return { customerId, timeout, bidders };
 }
 
+export const extractConsent = ({ gdpr }) => {
+  if (!gdpr) {
+    return null
+  }
+  const { gdprApplies, consentString } = gdpr
+  if (!(gdprApplies == '0' || gdprApplies == '1')) {
+    throw 'TCF Consent: gdprApplies has wrong format'
+  }
+  if (!(typeof consentString === 'string')) {
+    throw 'TCF Consent: consentString is not string'
+  }
+  const result = {
+    'gdpr_applies': gdprApplies,
+    'consent_string': consentString
+  }
+  return result
+}
 /**
  * Gets the URL of Profile Api from which targeting data will be fetched
  * @param {Object} config
  * @param {string} config.customerId
  * @returns {string} URL to access 1plusX Profile API
  */
-const getPapiUrl = ({ customerId }) => {
+export const getPapiUrl = (customerId, consent) => {
   // https://[yourClientId].profiles.tagger.opecloud.com/[VERSION]/targeting?url=
   const currentUrl = encodeURIComponent(window.location.href);
-  const papiUrl = `https://${customerId}.profiles.tagger.opecloud.com/${PAPI_VERSION}/targeting?url=${currentUrl}`;
+  var papiUrl = `https://${customerId}.profiles.tagger.opecloud.com/${PAPI_VERSION}/targeting?url=${currentUrl}`;
+  if (consent) {
+    Object.entries(consent).forEach(([key, value]) => {
+      papiUrl += `&${key}=${value}`
+    })
+  }
+
   return papiUrl;
 }
 
@@ -216,14 +239,14 @@ const init = (config, userConsent) => {
  * @param {Object} reqBidsConfigObj Bid request configuration object
  * @param {Function} callback Called on completion
  * @param {Object} moduleConfig Configuration for 1plusX RTD module
- * @param {boolean} userConsent
+ * @param {Object} userConsent
  */
 const getBidRequestData = (reqBidsConfigObj, callback, moduleConfig, userConsent) => {
   try {
     // Get the required config
     const { customerId, bidders } = extractConfig(moduleConfig, reqBidsConfigObj);
     // Get PAPI URL
-    const papiUrl = getPapiUrl({ customerId })
+    const papiUrl = getPapiUrl(customerId, extractConsent(userConsent) || {})
     // Call PAPI
     getTargetingDataFromPapi(papiUrl)
       .then((papiResponse) => {
@@ -231,9 +254,6 @@ const getBidRequestData = (reqBidsConfigObj, callback, moduleConfig, userConsent
         setTargetingDataToConfig(papiResponse, { bidders });
         callback();
       })
-      .catch((error) => {
-        throw error;
-      })
   } catch (error) {
     logError(LOG_PREFIX, error);
     callback();

package/modules/adagioBidAdapter.js

@@ -532,7 +532,12 @@ function _parseNativeBidResponse(bid) {
           native.impressionTrackers.push(tracker.url);
           break;
         case 2:
-          native.javascriptTrackers = `<script src=\"${tracker.url}\"></script>`;
+          const script = `<script async src=\"${tracker.url}\"></script>`;
+          if (!native.javascriptTrackers) {
+            native.javascriptTrackers = script;
+          } else {
+            native.javascriptTrackers += `\n${script}`;
+          }
           break;
       }
     });
@@ -623,7 +628,16 @@ export function setExtraParam(bid, paramName) {
 
   const detected = adgGlobalConf[paramName] || deepAccess(ortb2Conf, `site.ext.data.${paramName}`, null);
   if (detected) {
-    bid.params[paramName] = detected;
+    // First Party Data can be an array.
+    // As we consider that params detected from FPD are fallbacks, we just keep the 1st value.
+    if (Array.isArray(detected)) {
+      if (detected.length) {
+        bid.params[paramName] = detected[0].toString();
+      }
+      return;
+    }
+
+    bid.params[paramName] = detected.toString();
   }
 }
 

package/modules/adagioBidAdapter.md

@@ -10,7 +10,7 @@ Connects to Adagio demand source to fetch bids.
 
 ## Configuration
 
-Adagio require several params. These params must be set at Prebid.js global config level or at adUnit level.
+Adagio require several params. These params must be set at Prebid.js BidderConfig config level or at adUnit level.
 
 Below, the list of Adagio params and where they can be set.
 
@@ -58,6 +58,16 @@ pbjs.setConfig({
 });
 ```
 
+#### Note on FPD support
+
+Adagio will use FPD data as fallback for the params below:
+- pagetype
+- environment
+- category
+- subcategory
+
+If the FPD value is an array, the 1st value of this array will be used.
+
 ### adUnit configuration
 
 ```javascript

package/modules/appnexusBidAdapter.js

@@ -250,10 +250,10 @@ export const spec = {
     // need to convert the string values into array of strings, to properly merge values with other existing keys later
     Object.keys(anAuctionKeywords).forEach(k => { if (isStr(anAuctionKeywords[k]) || isNumber(anAuctionKeywords[k])) anAuctionKeywords[k] = [anAuctionKeywords[k]] });
     // combine all sources of keywords (converted from string comma list to object format) into one object (that combines the values for shared keys)
-    let mergedAuctionKeywrds = mergeDeep({}, anAuctionKeywords, ...ortb2KeywordsObjList);
+    let mergedAuctionKeywords = mergeDeep({}, anAuctionKeywords, ...ortb2KeywordsObjList);
 
     // convert to final format used by adserver
-    let auctionKeywords = transformBidderParamKeywords(mergedAuctionKeywrds);
+    let auctionKeywords = transformBidderParamKeywords(mergedAuctionKeywords);
     if (auctionKeywords.length > 0) {
       auctionKeywords.forEach(deleteValues);
       payload.keywords = auctionKeywords;
@@ -1202,28 +1202,30 @@ function convertKeywordsToString(keywords) {
 function convertStringToKeywordsObj(keyStr) {
   let result = {};
 
-  // will split based on commas and will eat white space before/after the comma
-  let keywordList = keyStr.split(/\s*(?:,)\s*/);
-  keywordList.forEach(kw => {
-    // if = exists, then split
-    if (kw.indexOf('=') !== -1) {
-      let kwPair = kw.split('=');
-      let key = kwPair[0];
-      let val = kwPair[1];
-
-      // then check for existing key in result > if so add value to the array > if not, add new key and create value array
-      if (result.hasOwnProperty(key)) {
-        result[key].push(val);
+  if (isStr(keyStr) && keyStr !== '') {
+    // will split based on commas and will eat white space before/after the comma
+    let keywordList = keyStr.split(/\s*(?:,)\s*/);
+    keywordList.forEach(kw => {
+      // if = exists, then split
+      if (kw.indexOf('=') !== -1) {
+        let kwPair = kw.split('=');
+        let key = kwPair[0];
+        let val = kwPair[1];
+
+        // then check for existing key in result > if so add value to the array > if not, add new key and create value array
+        if (result.hasOwnProperty(key)) {
+          result[key].push(val);
+        } else {
+          result[key] = [val];
+        }
       } else {
-        result[key] = [val];
-      }
-    } else {
-      // make a key with '' value; if key already exists > don't add
-      if (!result.hasOwnProperty(kw)) {
-        result[kw] = [''];
+        // make a key with '' value; if key already exists > don't add
+        if (!result.hasOwnProperty(kw)) {
+          result[kw] = [''];
+        }
       }
-    }
-  });
+    });
+  }
 
   return result;
 }

package/modules/carodaBidAdapter.js

@@ -0,0 +1,217 @@
+// jshint esversion: 6, es3: false, node: true
+'use strict'
+
+import { registerBidder } from '../src/adapters/bidderFactory.js';
+import { BANNER, VIDEO } from '../src/mediaTypes.js';
+import {
+  deepAccess,
+  deepSetValue,
+  logError,
+  mergeDeep,
+  parseSizesInput
+} from '../src/utils.js';
+import { config } from '../src/config.js';
+
+const { getConfig } = config;
+
+const BIDDER_CODE = 'caroda';
+const GVLID = 954;
+
+// some state info is required to synchronize with Caroda ad server
+const topUsableWindow = getTopUsableWindow();
+
+export const spec = {
+  code: BIDDER_CODE,
+  gvlid: GVLID,
+  supportedMediaTypes: [BANNER, VIDEO],
+  isBidRequestValid: bid => {
+    const params = bid.params || {};
+    const { ctok, placementId, priceType } = params;
+    return typeof ctok === 'string' && (
+      typeof placementId === 'string' ||
+      typeof placementId === 'undefined'
+    ) && (
+      typeof priceType === 'undefined' ||
+      priceType === 'gross' ||
+      priceType === 'net'
+    );
+  },
+  buildRequests: (validBidRequests, bidderRequest) => {
+    topUsableWindow.carodaPageViewId = topUsableWindow.carodaPageViewId || Math.floor(Math.random() * 1e9);
+    const pageViewId = topUsableWindow.carodaPageViewId;
+    const ortbCommon = getORTBCommon(bidderRequest);
+    const priceType =
+      getFirstWithKey(validBidRequests, 'params.priceType') ||
+      'net';
+    const test = getFirstWithKey(validBidRequests, 'params.test');
+    const currency = getConfig('currency.adServerCurrency');
+    const eids = getFirstWithKey(validBidRequests, 'userIdAsEids');
+    const schain = getFirstWithKey(validBidRequests, 'schain');
+    const request = {
+      auctionId: bidderRequest.auctionId,
+      currency,
+      hb_version: '$prebid.version$',
+      ...ortbCommon,
+      price_type: priceType
+    };
+    if (test) {
+      request.test = 1;
+    }
+    if (schain) {
+      request.schain = schain;
+    }
+    if (config.getConfig('coppa')) {
+      deepSetValue(request, 'privacy.coppa', 1);
+    }
+    if (deepAccess(bidderRequest, 'gdprConsent.gdprApplies') !== undefined) {
+      deepSetValue(
+        request,
+        'privacy.gdpr_consent',
+        bidderRequest.gdprConsent.consentString
+      );
+      deepSetValue(
+        request,
+        'privacy.gdpr',
+        bidderRequest.gdprConsent.gdprApplies & 1
+      );
+    }
+    if (bidderRequest.uspConsent) {
+      deepSetValue(request, 'privacy.us_privacy', bidderRequest.uspConsent);
+    }
+    if (eids) {
+      deepSetValue(request, 'user.eids', eids);
+    }
+    return getImps(validBidRequests, request).map(imp => ({
+      method: 'POST',
+      url: 'https://prebid.caroda.io/api/hb?entry_id=' + pageViewId,
+      data: JSON.stringify(imp)
+    }));
+  },
+  interpretResponse: (serverResponse) => {
+    if (!serverResponse.body) {
+      return;
+    }
+    const { ok, error } = serverResponse.body
+    if (error) {
+      logError(BIDDER_CODE, ': server caught', error.message);
+      return;
+    }
+    try {
+      return JSON.parse(ok.value)
+        .map((bid) => {
+          const ret = {
+            requestId: bid.bid_id,
+            cpm: bid.cpm,
+            creativeId: bid.creative_id,
+            ttl: 300,
+            netRevenue: true,
+            currency: bid.currency,
+            width: bid.w,
+            height: bid.h,
+            meta: {
+              advertiserDomains: bid.adomain || []
+            },
+            ad: bid.ad,
+            placementId: bid.placement_id
+          }
+          if (bid.adserver_targeting) {
+            ret.adserverTargeting = bid.adserver_targeting
+          }
+          return ret
+        })
+        .filter(Boolean);
+    } catch (e) {
+      logError(BIDDER_CODE, ': caught', e);
+    }
+  }
+}
+
+registerBidder(spec)
+
+function getFirstWithKey (collection, key) {
+  for (let i = 0, result; i < collection.length; i++) {
+    result = deepAccess(collection[i], key);
+    if (result) {
+      return result;
+    }
+  }
+}
+
+function getTopUsableWindow () {
+  let res = window;
+  try {
+    while (window.top !== res && res.parent.location.href.length) {
+      res = res.parent;
+    }
+  } catch (e) {}
+  return res;
+}
+
+function getORTBCommon (bidderRequest) {
+  let app, site;
+  const commonFpd = bidderRequest.ortb2 || {};
+  let { user } = commonFpd;
+  if (typeof getConfig('app') === 'object') {
+    app = getConfig('app') || {}
+    if (commonFpd.app) {
+      mergeDeep(app, commonFpd.app);
+    }
+  } else {
+    site = getConfig('site') || {};
+    if (commonFpd.site) {
+      mergeDeep(site, commonFpd.site);
+    }
+    if (!site.page) {
+      site.page = bidderRequest.refererInfo.page;
+    }
+  }
+  const device = getConfig('device') || {};
+  device.w = device.w || window.innerWidth;
+  device.h = device.h || window.innerHeight;
+  device.ua = device.ua || navigator.userAgent;
+  return {
+    app,
+    site,
+    user,
+    device
+  };
+}
+
+function getImps (validBidRequests, common) {
+  return validBidRequests.map((bid) => {
+    const floorInfo = bid.getFloor
+      ? bid.getFloor({ currency: common.currency || 'EUR' })
+      : {};
+    const bidfloor = floorInfo.floor;
+    const bidfloorcur = floorInfo.currency;
+    const { ctok, placementId } = bid.params;
+    const imp = {
+      bid_id: bid.bidId,
+      ctok,
+      bidfloor,
+      bidfloorcur,
+      ...common
+    };
+    const bannerParams = deepAccess(bid, 'mediaTypes.banner');
+    if (bannerParams && bannerParams.sizes) {
+      const sizes = parseSizesInput(bannerParams.sizes);
+      const format = sizes.map(size => {
+        const [width, height] = size.split('x');
+        const w = parseInt(width, 10);
+        const h = parseInt(height, 10);
+        return { w, h };
+      });
+      imp.banner = {
+        format
+      };
+    }
+    if (placementId) {
+      imp.placement_id = placementId;
+    }
+    const videoParams = deepAccess(bid, 'mediaTypes.video');
+    if (videoParams) {
+      imp.video = videoParams;
+    }
+    return imp;
+  })
+}

package/modules/carodaBidAdapter.md

@@ -0,0 +1,43 @@
+# Overview
+
+Module Name: Caroda Adapter
+Module Type: Bidder Adapter
+Maintainer: dev@caroda.io
+
+# Description
+
+Module that connects to Caroda demand sources to fetch bids.
+Banner and video formats are supported. 
+Use `caroda` as bidder.
+
+# Test Parameters
+```
+    var adUnits = [{
+        code: '/19968336/prebid_banner_example_1',
+        mediaTypes: {
+            banner: {
+                sizes: [[ 300, 250 ]]
+            }
+        }
+        bids: [{
+            bidder: 'caroda',
+            params: {
+                ctok: '230ce9490c5434354'
+            }
+        }]
+    }, {
+        code: '/19968336/prebid_video_example_1',
+        mediaTypes: {
+            video: {
+                context: 'outstream',
+                mimes: ['video/mp4']
+            }
+        }
+        bids: [{
+            bidder: 'caroda',
+            params: {
+                ctok: '230ce9490c5434354'
+            }
+        }]
+    }];
+```

package/modules/improvedigitalBidAdapter.js

@@ -25,6 +25,7 @@ const BIDDER_CODE = 'improvedigital';
 const CREATIVE_TTL = 300;
 
 const AD_SERVER_URL = 'https://ad.360yield.com/pb';
+const BASIC_ADS_URL = 'https://ad.360yield-basic.com/pb';
 const EXTEND_URL = 'https://pbs.360yield.com/openrtb2/auction';
 const IFRAME_SYNC_URL = 'https://hb.360yield.com/prebid-universal-creative/load-cookie.html';
 
@@ -282,9 +283,10 @@ const ID_REQUEST = {
       if (transactionId) {
         deepSetValue(request, 'source.tid', transactionId);
       }
+      const adServerUrl = hasPurpose1Consent(bidderRequest?.gdprConsent) ? AD_SERVER_URL : BASIC_ADS_URL;
       return {
         method: 'POST',
-        url: extendMode ? EXTEND_URL : AD_SERVER_URL,
+        url: extendMode ? EXTEND_URL : adServerUrl,
         data: JSON.stringify(request),
         bidderRequest
       }

package/modules/ixBidAdapter.js

@@ -13,7 +13,6 @@ import {
   logError,
   logWarn,
   mergeDeep,
-  parseGPTSingleSizeArray,
   parseQueryStringParameters
 } from '../src/utils.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
@@ -127,10 +126,6 @@ function bidToBannerImp(bid) {
   if (impSize) {
     imp.banner.w = impSize[0];
     imp.banner.h = impSize[1];
-    // populate sid with size if not id
-    if (!deepAccess(imp, 'ext.sid')) {
-      imp.ext.sid = parseGPTSingleSizeArray(impSize);
-    }
   }
 
   imp.banner.topframe = inIframe() ? 0 : 1;
@@ -197,9 +192,6 @@ function bidToVideoImp(bid) {
     if (impSize) {
       imp.video.w = impSize[0];
       imp.video.h = impSize[1];
-      if (!(deepAccess(imp, 'ext.sid'))) {
-        imp.ext.sid = parseGPTSingleSizeArray(impSize);
-      }
     } else {
       logWarn('IX Bid Adapter: Video size is missing in [mediaTypes.video]');
       return {};
@@ -253,8 +245,8 @@ function bidToImp(bid) {
   imp.ext = {};
   imp.ext.siteID = bid.params.siteId.toString();
 
-  if (bid.params.hasOwnProperty('id') &&
-    (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
+  // populate imp level sid
+  if (bid.params.hasOwnProperty('id') && (typeof bid.params.id === 'string' || typeof bid.params.id === 'number')) {
     imp.ext.sid = String(bid.params.id);
   }
 
@@ -758,6 +750,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
     const gpid = impressions[transactionIds[adUnitIndex]].gpid;
     const dfpAdUnitCode = impressions[transactionIds[adUnitIndex]].dfp_ad_unit_code;
     const tid = impressions[transactionIds[adUnitIndex]].tid;
+    const sid = impressions[transactionIds[adUnitIndex]].sid
 
     if (impressionObjects.length && BANNER in impressionObjects[0]) {
       const { id, banner: { topframe } } = impressionObjects[0];
@@ -769,16 +762,24 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
         },
       };
 
+      // We add sid in imp.ext.sid therefore, remove from banner.format[].ext
+      for (let bannerFormat of _bannerImpression.banner.format) {
+        if (bannerFormat.ext != null && bannerFormat.ext.sid != null) {
+          delete bannerFormat.ext.sid;
+        }
+      }
+
       const position = impressions[transactionIds[adUnitIndex]].pos;
       if (isInteger(position)) {
         _bannerImpression.banner.pos = position;
       }
 
-      if (dfpAdUnitCode || gpid || tid) {
+      if (dfpAdUnitCode || gpid || tid || sid) {
         _bannerImpression.ext = {};
         _bannerImpression.ext.dfp_ad_unit_code = dfpAdUnitCode;
         _bannerImpression.ext.gpid = gpid;
         _bannerImpression.ext.tid = tid;
+        _bannerImpression.ext.sid = sid;
       }
 
       if ('bidfloor' in impressionObjects[0]) {
@@ -1040,6 +1041,11 @@ function createBannerImps(validBidRequest, missingBannerSizes, bannerImps) {
   bannerImps[validBidRequest.transactionId].tagId = deepAccess(validBidRequest, 'params.tagId');
   bannerImps[validBidRequest.transactionId].pos = deepAccess(validBidRequest, 'mediaTypes.banner.pos');
 
+  const sid = deepAccess(validBidRequest, 'params.id');
+  if (sid && (typeof sid === 'string' || typeof sid === 'number')) {
+    bannerImps[validBidRequest.transactionId].sid = String(sid);
+  }
+
   const adUnitCode = validBidRequest.adUnitCode;
   const divId = document.getElementById(adUnitCode) ? adUnitCode : getGptSlotInfoForAdUnitCode(adUnitCode).divId;
   bannerImps[validBidRequest.transactionId].adUnitCode = adUnitCode;
@@ -1094,7 +1100,6 @@ function updateMissingSizes(validBidRequest, missingBannerSizes, imp) {
  */
 function createMissingBannerImp(bid, imp, newSize) {
   const newImp = deepClone(imp);
-  newImp.ext.sid = parseGPTSingleSizeArray(newSize);
   newImp.banner.w = newSize[0];
   newImp.banner.h = newSize[1];
 

package/modules/mediagoBidAdapter.js

@@ -293,14 +293,19 @@ function getItems(validBidRequests, bidderRequest) {
  */
 function getParam(validBidRequests, bidderRequest) {
   const pubcid = utils.deepAccess(validBidRequests[0], 'crumbs.pubcid');
-  // console.log('wjh getParam', validBidRequests, bidderRequest);
+  const sharedid =
+    utils.deepAccess(validBidRequests[0], 'userId.sharedid.id') ||
+    utils.deepAccess(validBidRequests[0], 'userId.pubcid');
   let isMobile = isMobileAndTablet() ? 1 : 0;
   let isTest = 0;
   let auctionId = getProperty(bidderRequest, 'auctionId');
   let items = getItems(validBidRequests, bidderRequest);
 
-  const domain = document.domain;
-  const location = utils.deepAccess(bidderRequest, 'refererInfo.referer');
+  const domain =
+    utils.deepAccess(bidderRequest, 'refererInfo.domain') || document.domain;
+  const location = utils.deepAccess(bidderRequest, 'refererInfo.location');
+  const page = utils.deepAccess(bidderRequest, 'refererInfo.page');
+  const referer = utils.deepAccess(bidderRequest, 'refererInfo.ref');
 
   const timeout = bidderRequest.timeout || 2000;
 
@@ -323,14 +328,13 @@ function getParam(validBidRequests, bidderRequest) {
       },
       ext: {},
       user: {
-        buyeruid: getUserID(),
-        id: pubcid,
+        id: sharedid || pubcid || getUserID(),
       },
       site: {
         name: domain,
         domain: domain,
-        page: location,
-        ref: location,
+        page: page || location,
+        ref: referer,
         mobile: isMobile,
         cat: [], // todo
         publisher: {
@@ -454,9 +458,9 @@ export const spec = {
    * Register bidder specific code, which will execute when the adserver targeting has been set for a bid from this bidder
    * @param {Bid} The bid of which the targeting has been set
    */
-//   onSetTargeting: function (bid) {
-//     // console.log('onSetTargeting', bid);
-//     // Bidder specific code
-//   },
+  //   onSetTargeting: function (bid) {
+  //     // console.log('onSetTargeting', bid);
+  //     // Bidder specific code
+  //   },
 };
 registerBidder(spec);

package/modules/mediasquareBidAdapter.js

@@ -164,7 +164,7 @@ export const spec = {
     // fires a pixel to confirm a winning bid
     let params = {'pbjs': '$prebid.version$'};
     let endpoint = document.location.search.match(/msq_test=true/) ? BIDDER_URL_TEST : BIDDER_URL_PROD;
-    let paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId']
+    let paramsToSearchFor = ['cpm', 'size', 'mediaType', 'currency', 'creativeId', 'adUnitCode', 'timeToRespond', 'requestId', 'auctionId', 'originalCpm', 'originalCurrency'];
     if (bid.hasOwnProperty('mediasquare')) {
       if (bid['mediasquare'].hasOwnProperty('bidder')) { params['bidder'] = bid['mediasquare']['bidder']; }
       if (bid['mediasquare'].hasOwnProperty('code')) { params['code'] = bid['mediasquare']['code']; }

package/modules/rubiconAnalyticsAdapter.js

@@ -124,9 +124,9 @@ function formatSource(src) {
 }
 
 function getBillingPayload(event) {
-  // for now we are mapping all events to type "general", later we will expand support for specific types
   let billingEvent = deepClone(event);
-  billingEvent.type = 'general';
+  // Pass along type if is string and not empty else general
+  billingEvent.type = (typeof event.type === 'string' && event.type) || 'general';
   billingEvent.accountId = accountId;
   // mark as sent
   deepSetValue(cache.billing, `${event.vendor}.${event.billingId}`, true);