prebid.js 6.2.0 → 6.6.0

package/modules/adkernelBidAdapter.js

@@ -1,6 +1,6 @@
 import {
   isStr, isArray, isPlainObject, deepSetValue, isNumber, deepAccess, getAdUnitSizes, parseGPTSingleSizeArrayToRtbSize,
-  cleanObj, contains, getDNT, parseUrl, createTrackPixelHtml, _each, isArrayOfNums
+  cleanObj, contains, getDNT, parseUrl, createTrackPixelHtml, _each, isArrayOfNums, mergeDeep, isEmpty, inIframe
 } from '../src/utils.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
@@ -77,7 +77,8 @@ export const spec = {
     {code: 'unibots'},
     {code: 'catapultx'},
     {code: 'ergadx'},
-    {code: 'turktelekom'}
+    {code: 'turktelekom'},
+    {code: 'felixads'}
   ],
   supportedMediaTypes: [BANNER, VIDEO, NATIVE],
 
@@ -103,17 +104,16 @@ export const spec = {
    * @returns {ServerRequest[]}
    */
   buildRequests: function (bidRequests, bidderRequest) {
-    let impDispatch = dispatchImps(bidRequests, bidderRequest.refererInfo);
+    let impGroups = groupImpressionsByHostZone(bidRequests, bidderRequest.refererInfo);
     let requests = [];
     let schain = bidRequests[0].schain;
-    Object.keys(impDispatch).forEach(host => {
-      Object.keys(impDispatch[host]).forEach(zoneId => {
-        const request = buildRtbRequest(impDispatch[host][zoneId], bidderRequest, schain);
-        requests.push({
-          method: 'POST',
-          url: `https://${host}/hb?zone=${zoneId}&v=${VERSION}`,
-          data: JSON.stringify(request)
-        });
+    _each(impGroups, impGroup => {
+      let {host, zoneId, imps} = impGroup;
+      const request = buildRtbRequest(imps, bidderRequest, schain);
+      requests.push({
+        method: 'POST',
+        url: `https://${host}/hb?zone=${zoneId}&v=${VERSION}`,
+        data: JSON.stringify(request)
       });
     });
     return requests;
@@ -209,17 +209,19 @@ registerBidder(spec);
  * @param bidRequests {BidRequest[]}
  * @param refererInfo {refererInfo}
  */
-function dispatchImps(bidRequests, refererInfo) {
+function groupImpressionsByHostZone(bidRequests, refererInfo) {
   let secure = (refererInfo && refererInfo.referer.indexOf('https:') === 0);
-  return bidRequests.map(bidRequest => buildImp(bidRequest, secure))
-    .reduce((acc, curr, index) => {
-      let bidRequest = bidRequests[index];
-      let {zoneId, host} = bidRequest.params;
-      acc[host] = acc[host] || {};
-      acc[host][zoneId] = acc[host][zoneId] || [];
-      acc[host][zoneId].push(curr);
-      return acc;
-    }, {});
+  return Object.values(
+    bidRequests.map(bidRequest => buildImp(bidRequest, secure))
+      .reduce((acc, curr, index) => {
+        let bidRequest = bidRequests[index];
+        let {zoneId, host} = bidRequest.params;
+        let key = `${host}_${zoneId}`;
+        acc[key] = acc[key] || {host: host, zoneId: zoneId, imps: []};
+        acc[key].imps.push(curr);
+        return acc;
+      }, {})
+  );
 }
 
 function getBidFloor(bid, mediaType, sizes) {
@@ -365,57 +367,142 @@ function getAllowedSyncMethod(bidderCode) {
 }
 
 /**
- * Builds complete rtb request
- * @param imps {Object} Collection of rtb impressions
- * @param bidderRequest {BidderRequest}
- * @param schain {Object=} Supply chain config
- * @return {Object} Complete rtb request
+ * Create device object from fpd and host-collected data
+ * @param fpd {Object}
+ * @returns {{device: Object}}
  */
-function buildRtbRequest(imps, bidderRequest, schain) {
-  let {bidderCode, gdprConsent, auctionId, refererInfo, timeout, uspConsent} = bidderRequest;
-  let coppa = config.getConfig('coppa');
-  let req = {
-    'id': auctionId,
-    'imp': imps,
-    'site': createSite(refererInfo),
-    'at': 1,
-    'device': {
-      'ip': 'caller',
-      'ipv6': 'caller',
-      'ua': 'caller',
-      'js': 1,
-      'language': getLanguage()
-    },
-    'tmax': parseInt(timeout)
-  };
+function makeDevice(fpd) {
+  let device = mergeDeep({
+    'ip': 'caller',
+    'ipv6': 'caller',
+    'ua': 'caller',
+    'js': 1,
+    'language': getLanguage()
+  }, fpd.device || {});
   if (getDNT()) {
-    req.device.dnt = 1;
+    device.dnt = 1;
+  }
+  return {device: device};
+}
+
+/**
+ * Create site or app description object
+ * @param bidderRequest {BidderRequest}
+ * @param fpd {Object}
+ * @returns {{site: Object}|{app: Object}}
+ */
+function makeSiteOrApp(bidderRequest, fpd) {
+  let {refererInfo} = bidderRequest;
+  let appConfig = config.getConfig('app');
+  if (isEmpty(appConfig)) {
+    return {site: createSite(refererInfo, fpd)}
+  } else {
+    return {app: appConfig};
   }
+}
+
+/**
+ * Create user description object
+ * @param bidderRequest {BidderRequest}
+ * @param fpd {Object}
+ * @returns {{user: Object} | undefined}
+ */
+function makeUser(bidderRequest, fpd) {
+  let {gdprConsent} = bidderRequest;
+  let user = fpd.user || {};
+  if (gdprConsent && gdprConsent.consentString !== undefined) {
+    deepSetValue(user, 'ext.consent', gdprConsent.consentString);
+  }
+  let eids = getExtendedUserIds(bidderRequest);
+  if (eids) {
+    deepSetValue(user, 'ext.eids', eids);
+  }
+  if (!isEmpty(user)) { return {user: user}; }
+}
+
+/**
+ * Create privacy regulations object
+ * @param bidderRequest {BidderRequest}
+ * @returns {{regs: Object} | undefined}
+ */
+function makeRegulations(bidderRequest) {
+  let {gdprConsent, uspConsent} = bidderRequest;
+  let regs = {};
   if (gdprConsent) {
     if (gdprConsent.gdprApplies !== undefined) {
-      deepSetValue(req, 'regs.ext.gdpr', ~~gdprConsent.gdprApplies);
-    }
-    if (gdprConsent.consentString !== undefined) {
-      deepSetValue(req, 'user.ext.consent', gdprConsent.consentString);
+      deepSetValue(regs, 'regs.ext.gdpr', ~~gdprConsent.gdprApplies);
     }
   }
   if (uspConsent) {
-    deepSetValue(req, 'regs.ext.us_privacy', uspConsent);
+    deepSetValue(regs, 'regs.ext.us_privacy', uspConsent);
+  }
+  if (config.getConfig('coppa')) {
+    deepSetValue(regs, 'regs.coppa', 1);
   }
-  if (coppa) {
-    deepSetValue(req, 'regs.coppa', 1);
+  if (!isEmpty(regs)) {
+    return regs;
   }
+}
+
+/**
+ * Create top-level request object
+ * @param bidderRequest {BidderRequest}
+ * @param imps {Object} Impressions
+ * @param fpd {Object} First party data
+ * @returns
+ */
+function makeBaseRequest(bidderRequest, imps, fpd) {
+  let {auctionId, timeout} = bidderRequest;
+  let request = {
+    'id': auctionId,
+    'imp': imps,
+    'at': 1,
+    'tmax': parseInt(timeout)
+  };
+  if (!isEmpty(fpd.bcat)) {
+    request.bcat = fpd.bcat;
+  }
+  if (!isEmpty(fpd.badv)) {
+    request.badv = fpd.badv;
+  }
+  return request;
+}
+
+/**
+ * Initialize sync capabilities
+ * @param bidderRequest {BidderRequest}
+ */
+function makeSyncInfo(bidderRequest) {
+  let {bidderCode} = bidderRequest;
   let syncMethod = getAllowedSyncMethod(bidderCode);
   if (syncMethod) {
-    deepSetValue(req, 'ext.adk_usersync', syncMethod);
+    let res = {};
+    deepSetValue(res, 'ext.adk_usersync', syncMethod);
+    return res;
   }
+}
+
+/**
+ * Builds complete rtb request
+ * @param imps {Object} Collection of rtb impressions
+ * @param bidderRequest {BidderRequest}
+ * @param schain {Object=} Supply chain config
+ * @return {Object} Complete rtb request
+ */
+function buildRtbRequest(imps, bidderRequest, schain) {
+  let fpd = config.getConfig('ortb2') || {};
+
+  let req = mergeDeep(
+    makeBaseRequest(bidderRequest, imps, fpd),
+    makeDevice(fpd),
+    makeSiteOrApp(bidderRequest, fpd),
+    makeUser(bidderRequest, fpd),
+    makeRegulations(bidderRequest),
+    makeSyncInfo(bidderRequest)
+  );
   if (schain) {
     deepSetValue(req, 'source.ext.schain', schain);
   }
-  let eids = getExtendedUserIds(bidderRequest);
-  if (eids) {
-    deepSetValue(req, 'user.ext.eids', eids);
-  }
   return req;
 }
 
@@ -431,18 +518,17 @@ function getLanguage() {
 /**
  * Creates site description object
  */
-function createSite(refInfo) {
+function createSite(refInfo, fpd) {
   let url = parseUrl(refInfo.referer);
   let site = {
     'domain': url.hostname,
     'page': `${url.protocol}://${url.hostname}${url.pathname}`
   };
-  if (self === top && document.referrer) {
+  mergeDeep(site, fpd.site);
+  if (!inIframe() && document.referrer) {
     site.ref = document.referrer;
-  }
-  let keywords = document.getElementsByTagName('meta')['keywords'];
-  if (keywords && keywords.content) {
-    site.keywords = keywords.content;
+  } else {
+    delete site.ref;
   }
   return site;
 }

package/modules/adlooxAdServerVideo.js

@@ -9,7 +9,7 @@
 import { registerVideoSupport } from '../src/adServerManager.js';
 import { command as analyticsCommand, COMMAND } from './adlooxAnalyticsAdapter.js';
 import { ajax } from '../src/ajax.js';
-import { EVENTS } from '../src/constants.json';
+import CONSTANTS from '../src/constants.json';
 import { targeting } from '../src/targeting.js';
 import { logInfo, isFn, logError, isPlainObject, isStr, isBoolean, deepSetValue, deepClone, timestamp, logWarn } from '../src/utils.js';
 
@@ -74,7 +74,7 @@ function track(options, callback) {
   bid.ext.adloox.video.adserver = false;
 
   analyticsCommand(COMMAND.TRACK, {
-    eventType: EVENTS.BID_WON,
+    eventType: CONSTANTS.EVENTS.BID_WON,
     args: bid
   });
 }

package/modules/adlooxAnalyticsAdapter.js

@@ -9,7 +9,7 @@ import adapter from '../src/AnalyticsAdapter.js';
 import { loadExternalScript } from '../src/adloader.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { AUCTION_COMPLETED } from '../src/auction.js';
-import { EVENTS } from '../src/constants.json';
+import CONSTANTS from '../src/constants.json';
 import find from 'core-js-pure/features/array/find.js';
 import {
   deepAccess, logInfo, isPlainObject, logError, isStr, isNumber, getGptSlotInfoForAdUnitCode,
@@ -199,9 +199,9 @@ analyticsAdapter.url = function(url, args, bid) {
   return url + a2qs(args);
 }
 
-analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
+analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = function(auctionDetails) {
   if (!(auctionDetails.auctionStatus == AUCTION_COMPLETED && auctionDetails.bidsReceived.length > 0)) return;
-  analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = NOOP;
+  analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = NOOP;
 
   logMessage(MODULE, 'preloading verification JS');
 
@@ -214,7 +214,7 @@ analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
   insertElement(link);
 }
 
-analyticsAdapter[`handle_${EVENTS.BID_WON}`] = function(bid) {
+analyticsAdapter[`handle_${CONSTANTS.EVENTS.BID_WON}`] = function(bid) {
   if (deepAccess(bid, 'ext.adloox.video.adserver')) {
     logMessage(MODULE, `measuring '${bid.mediaType}' ad unit code '${bid.adUnitCode}' via Ad Server module`);
     return;

package/modules/admanBidAdapter.js

@@ -1,10 +1,11 @@
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
 import { isFn, deepAccess, logMessage } from '../src/utils.js';
+import {config} from '../src/config.js';
 
 const BIDDER_CODE = 'adman';
 const AD_URL = 'https://pub.admanmedia.com/?c=o&m=multi';
-const URL_SYNC = 'https://pub.admanmedia.com/?c=o&m=sync';
+const URL_SYNC = 'https://pub.admanmedia.com';
 
 function isBidResponseValid(bid) {
   if (!bid.requestId || !bid.cpm || !bid.creativeId ||
@@ -108,6 +109,7 @@ export const spec = {
       }
       if (bid.userId) {
         getUserId(placement.eids, bid.userId.uid2 && bid.userId.uid2.id, 'uidapi.com');
+        getUserId(placement.eids, bid.userId.lotamePanoramaId, 'lotame.com');
       }
       if (traff === VIDEO) {
         placement.playerSize = bid.mediaTypes[VIDEO].playerSize;
@@ -151,19 +153,24 @@ export const spec = {
   },
 
   getUserSyncs: (syncOptions, serverResponses, gdprConsent, uspConsent) => {
-    let syncUrl = URL_SYNC
+    let syncType = syncOptions.iframeEnabled ? 'iframe' : 'image';
+    let syncUrl = URL_SYNC + `/${syncType}?pbjs=1`;
     if (gdprConsent && gdprConsent.consentString) {
       if (typeof gdprConsent.gdprApplies === 'boolean') {
         syncUrl += `&gdpr=${Number(gdprConsent.gdprApplies)}&gdpr_consent=${gdprConsent.consentString}`;
       } else {
-        syncUrl += `&gdpr==0&gdpr_consent=${gdprConsent.consentString}`;
+        syncUrl += `&gdpr=0&gdpr_consent=${gdprConsent.consentString}`;
       }
     }
     if (uspConsent && uspConsent.consentString) {
       syncUrl += `&ccpa_consent=${uspConsent.consentString}`;
     }
+
+    const coppa = config.getConfig('coppa') ? 1 : 0;
+    syncUrl += `&coppa=${coppa}`;
+
     return [{
-      type: 'image',
+      type: syncType,
       url: syncUrl
     }];
   }

package/modules/admixerBidAdapter.js

@@ -4,7 +4,7 @@ import {config} from '../src/config.js';
 import {BANNER, VIDEO, NATIVE} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'admixer';
-const ALIASES = ['go2net', 'adblender', 'adsyield'];
+const ALIASES = ['go2net', 'adblender', 'adsyield', 'futureads'];
 const ENDPOINT_URL = 'https://inv-nets.admixer.net/prebid.1.2.aspx';
 export const spec = {
   code: BIDDER_CODE,

package/modules/adnuntiusBidAdapter.js

@@ -56,6 +56,8 @@ export const spec = {
     const requests = [];
     const request = [];
     const ortb2 = config.getConfig('ortb2');
+    const bidderConfig = config.getConfig();
+
     const adnMeta = handleMeta()
     const usi = getUsi(adnMeta, ortb2, bidderRequest)
     const segments = getSegmentsFromOrtb(ortb2);
@@ -68,7 +70,7 @@ export const spec = {
     if (gdprApplies !== undefined) request.push('consentString=' + consentString);
     if (segments.length > 0) request.push('segments=' + segments.join(','));
     if (usi) request.push('userId=' + usi);
-
+    if (bidderConfig.useCookie === false) request.push('noCookies=true')
     for (var i = 0; i < validBidRequests.length; i++) {
       const bid = validBidRequests[i]
       const network = bid.params.network || 'network';

package/modules/adomikAnalyticsAdapter.js

@@ -14,6 +14,8 @@ const bidWon = CONSTANTS.EVENTS.BID_WON;
 const bidTimeout = CONSTANTS.EVENTS.BID_TIMEOUT;
 const ua = navigator.userAgent;
 
+var _sampled = true;
+
 let adomikAdapter = Object.assign(adapter({}),
   {
     // Track every event needed
@@ -76,9 +78,12 @@ adomikAdapter.sendTypedEvent = function() {
   const groupedTypedEvents = adomikAdapter.buildTypedEvents();
 
   const bulkEvents = {
+    testId: adomikAdapter.currentContext.testId,
+    testValue: adomikAdapter.currentContext.testValue,
     uid: adomikAdapter.currentContext.uid,
     ahbaid: adomikAdapter.currentContext.id,
     hostname: window.location.hostname,
+    sampling: adomikAdapter.currentContext.sampling,
     eventsByPlacementCode: groupedTypedEvents.map(function(typedEventsByType) {
       let sizes = [];
       const eventKeys = ['request', 'response', 'winner'];
@@ -126,6 +131,8 @@ adomikAdapter.sendTypedEvent = function() {
 };
 
 adomikAdapter.sendWonEvent = function (wonEvent) {
+  let keyValues = { testId: adomikAdapter.currentContext.testId, testValue: adomikAdapter.currentContext.testValue }
+  wonEvent = {...wonEvent, ...keyValues}
   const stringWonEvent = JSON.stringify(wonEvent)
   logInfo('Won event sent to adomik prebid analytic ' + stringWonEvent);
 
@@ -199,17 +206,28 @@ adomikAdapter.adapterEnableAnalytics = adomikAdapter.enableAnalytics;
 
 adomikAdapter.enableAnalytics = function (config) {
   adomikAdapter.currentContext = {};
-
   const initOptions = config.options;
-  if (initOptions) {
-    adomikAdapter.currentContext = {
-      uid: initOptions.id,
-      url: initOptions.url,
-      id: '',
-      timeouted: false,
+
+  _sampled = typeof config === 'undefined' ||
+             typeof config.sampling === 'undefined' ||
+             Math.random() < parseFloat(config.sampling);
+
+  if (_sampled) {
+    if (initOptions) {
+      adomikAdapter.currentContext = {
+        uid: initOptions.id,
+        url: initOptions.url,
+        testId: initOptions.testId,
+        testValue: initOptions.testValue,
+        id: '',
+        timeouted: false,
+        sampling: config.sampling
+      }
+      logInfo('Adomik Analytics enabled with config', initOptions);
+      adomikAdapter.adapterEnableAnalytics(config);
     }
-    logInfo('Adomik Analytics enabled with config', initOptions);
-    adomikAdapter.adapterEnableAnalytics(config);
+  } else {
+    logInfo('Adomik Analytics ignored for sampling', config.sampling);
   }
 };
 

package/modules/adqueryIdSystem.js

@@ -0,0 +1,103 @@
+/**
+ * This module adds Adquery QID to the User ID module
+ * The {@link module:modules/userId} module is required
+ * @module modules/adqueryIdSystem
+ * @requires module:modules/userId
+ */
+
+import {ajax} from '../src/ajax.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {submodule} from '../src/hook.js';
+import * as utils from '../src/utils.js';
+
+const MODULE_NAME = 'qid';
+const AU_GVLID = 902;
+
+export const storage = getStorageManager(AU_GVLID, 'qid');
+
+/**
+ * Param or default.
+ * @param {String} param
+ * @param {String} defaultVal
+ */
+function paramOrDefault(param, defaultVal, arg) {
+  if (utils.isFn(param)) {
+    return param(arg);
+  } else if (utils.isStr(param)) {
+    return param;
+  }
+  return defaultVal;
+}
+
+/** @type {Submodule} */
+export const adqueryIdSubmodule = {
+  /**
+   * used to link submodule with config
+   * @type {string}
+   */
+  name: MODULE_NAME,
+
+  /**
+   * IAB TCF Vendor ID
+   * @type {string}
+   */
+  gvlid: AU_GVLID,
+
+  /**
+   * decode the stored id value for passing to bid requests
+   * @function
+   * @param {{value:string}} value
+   * @returns {{qid:Object}}
+   */
+  decode(value) {
+    let qid = storage.getDataFromLocalStorage('qid');
+    if (utils.isStr(qid)) {
+      return {qid: qid};
+    }
+    return (value && typeof value['qid'] === 'string') ? { 'qid': value['qid'] } : undefined;
+  },
+  /**
+   * performs action to obtain id and return a value in the callback's response argument
+   * @function
+   * @param {SubmoduleConfig} [config]
+   * @returns {IdResponse|undefined}
+   */
+  getId(config) {
+    if (!utils.isPlainObject(config.params)) {
+      config.params = {};
+    }
+    const url = paramOrDefault(config.params.url,
+      `https://bidder.adquery.io/prebid/qid`,
+      config.params.urlArg);
+
+    const resp = function (callback) {
+      let qid = storage.getDataFromLocalStorage('qid');
+      if (utils.isStr(qid)) {
+        const responseObj = {qid: qid};
+        callback(responseObj);
+      } else {
+        const callbacks = {
+          success: response => {
+            let responseObj;
+            if (response) {
+              try {
+                responseObj = JSON.parse(response);
+              } catch (error) {
+                utils.logError(error);
+              }
+            }
+            callback(responseObj);
+          },
+          error: error => {
+            utils.logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+            callback();
+          }
+        };
+        ajax(url, callbacks, undefined, {method: 'GET'});
+      }
+    };
+    return {callback: resp};
+  }
+};
+
+submodule('userId', adqueryIdSubmodule);

package/modules/adqueryIdSystem.md

@@ -0,0 +1,35 @@
+# Adquery QID
+
+Adquery QID Module. For assistance setting up your module please contact us at [prebid@adquery.io](prebid@adquery.io).
+
+### Prebid Params
+
+Individual params may be set for the Adquery ID Submodule. At least one identifier must be set in the params.
+
+```
+pbjs.setConfig({
+    usersync: {
+        userIds: [{
+            name: 'qid',
+            storage: {
+                name: 'qid',
+                type: 'html5'
+            }
+        }]
+    }
+});
+```
+## Parameter Descriptions for the `usersync` Configuration Section
+The below parameters apply only to the Adquery User ID Module integration.
+
+| Param under usersync.userIds[] | Scope | Type | Description | Example |
+| --- | --- | --- | --- | --- |
+| name | Required | String | ID value for the Adquery ID module - `"qid"` | `"qid"` |
+| storage | Required | Object | The publisher must specify the local storage in which to store the results of the call to get the user ID. | |
+| storage.type | Required | String | This is where the results of the user ID will be stored. The recommended method is `localStorage` by specifying `html5`. | `"html5"` |
+| storage.name | Required | String | The name of the html5 local storage where the user ID will be stored. | `"qid"` |
+| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. | `365` |
+| value | Optional | Object | Used only if the page has a separate mechanism for storing the Adquery ID. The value is an object containing the values to be sent to the adapters. In this scenario, no URL is called and nothing is added to local storage | `{"qid": "2abf9f001fcd81241b67"}` |
+| params | Optional | Object | Used to store params for the id system |
+| params.url | Optional | String | Set an alternate GET url for qid with this parameter |
+| params.urlArg | Optional | Object | Optional url parameter for params.url |