prebid.js 5.14.0 → 5.18.0

package/modules/h12mediaBidAdapter.js

@@ -1,4 +1,4 @@
-import * as utils from '../src/utils.js';
+import { inIframe, logError, logMessage, deepAccess } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 const BIDDER_CODE = 'h12media';
 const DEFAULT_URL = 'https://bidder.h12-media.com/prebid/';
@@ -15,7 +15,7 @@ export const spec = {
   },
 
   buildRequests: function(validBidRequests, bidderRequest) {
-    const isiframe = utils.inIframe();
+    const isiframe = inIframe();
     const screenSize = getClientDimensions();
     const docSize = getDocumentDimensions();
 
@@ -24,7 +24,7 @@ export const spec = {
       const requestUrl = bidderParams.endpointdom || DEFAULT_URL;
       let pubsubid = bidderParams.pubsubid || '';
       if (pubsubid && pubsubid.length > 32) {
-        utils.logError('Bidder param \'pubsubid\' should be not more than 32 chars.');
+        logError('Bidder param \'pubsubid\' should be not more than 32 chars.');
         pubsubid = '';
       }
       const pubcontainerid = bidderParams.pubcontainerid;
@@ -57,7 +57,7 @@ export const spec = {
       try {
         windowTop = window.top;
       } catch (e) {
-        utils.logMessage(e);
+        logMessage(e);
         windowTop = window;
       }
 
@@ -66,11 +66,11 @@ export const spec = {
         url: requestUrl,
         options: {withCredentials: true},
         data: {
-          gdpr: !!utils.deepAccess(bidderRequest, 'gdprConsent.gdprApplies', false),
-          gdpr_cs: utils.deepAccess(bidderRequest, 'gdprConsent.consentString', ''),
-          usp: !!utils.deepAccess(bidderRequest, 'uspConsent', false),
-          usp_cs: utils.deepAccess(bidderRequest, 'uspConsent', ''),
-          topLevelUrl: utils.deepAccess(bidderRequest, 'refererInfo.referer', ''),
+          gdpr: !!deepAccess(bidderRequest, 'gdprConsent.gdprApplies', false),
+          gdpr_cs: deepAccess(bidderRequest, 'gdprConsent.consentString', ''),
+          usp: !!deepAccess(bidderRequest, 'uspConsent', false),
+          usp_cs: deepAccess(bidderRequest, 'uspConsent', ''),
+          topLevelUrl: deepAccess(bidderRequest, 'refererInfo.referer', ''),
           refererUrl: windowTop.document.referrer,
           isiframe,
           version: '$prebid.version$',
@@ -122,14 +122,14 @@ export const spec = {
       }
       return bidResponses;
     } catch (err) {
-      utils.logError(err);
+      logError(err);
     }
   },
 
   getUserSyncs: function(syncOptions, serverResponses, gdprConsent, usPrivacy) {
     const syncs = [];
-    const uspApplies = !!utils.deepAccess(usPrivacy, 'uspConsent', false);
-    const uspString = utils.deepAccess(usPrivacy, 'uspConsent', '');
+    const uspApplies = !!deepAccess(usPrivacy, 'uspConsent', false);
+    const uspString = deepAccess(usPrivacy, 'uspConsent', '');
     gdprConsent = gdprConsent || {
       gdprApplies: false, consentString: '',
     };

package/modules/haloIdSystem.js

@@ -8,7 +8,7 @@
 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';
+import { isFn, isStr, isPlainObject, logError } from '../src/utils.js';
 
 const MODULE_NAME = 'haloId';
 const AU_GVLID = 561;
@@ -21,9 +21,9 @@ export const storage = getStorageManager(AU_GVLID, 'halo');
  * @param {String} defaultVal
  */
 function paramOrDefault(param, defaultVal, arg) {
-  if (utils.isFn(param)) {
+  if (isFn(param)) {
     return param(arg);
-  } else if (utils.isStr(param)) {
+  } else if (isStr(param)) {
     return param;
   }
   return defaultVal;
@@ -44,7 +44,7 @@ export const haloIdSubmodule = {
    */
   decode(value) {
     let haloId = storage.getDataFromLocalStorage('auHaloId');
-    if (utils.isStr(haloId)) {
+    if (isStr(haloId)) {
       return {haloId: haloId};
     }
     return (value && typeof value['haloId'] === 'string') ? { 'haloId': value['haloId'] } : undefined;
@@ -56,7 +56,7 @@ export const haloIdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(config) {
-    if (!utils.isPlainObject(config.params)) {
+    if (!isPlainObject(config.params)) {
       config.params = {};
     }
     const url = paramOrDefault(config.params.url,
@@ -65,7 +65,7 @@ export const haloIdSubmodule = {
 
     const resp = function (callback) {
       let haloId = storage.getDataFromLocalStorage('auHaloId');
-      if (utils.isStr(haloId)) {
+      if (isStr(haloId)) {
         const responseObj = {haloId: haloId};
         callback(responseObj);
       } else {
@@ -76,13 +76,13 @@ export const haloIdSubmodule = {
               try {
                 responseObj = JSON.parse(response);
               } catch (error) {
-                utils.logError(error);
+                logError(error);
               }
             }
             callback(responseObj);
           },
           error: error => {
-            utils.logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
+            logError(`${MODULE_NAME}: ID fetch encountered an error`, error);
             callback();
           }
         };

package/modules/hybridBidAdapter.js

@@ -1,4 +1,4 @@
-import * as utils from '../src/utils.js'
+import { _map, logWarn, deepAccess, isArray } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js'
 import { auctionManager } from '../src/auctionManager.js'
 import { BANNER, VIDEO } from '../src/mediaTypes.js'
@@ -21,7 +21,7 @@ const placementTypes = {
 };
 
 function buildBidRequests(validBidRequests) {
-  return utils._map(validBidRequests, function(validBidRequest) {
+  return _map(validBidRequests, function(validBidRequest) {
     const params = validBidRequest.params;
     const bidRequest = {
       bidId: validBidRequest.bidId,
@@ -63,7 +63,7 @@ const createRenderer = (bid) => {
   try {
     renderer.setRender(outstreamRender);
   } catch (err) {
-    utils.logWarn('Prebid Error calling setRender on renderer', err);
+    logWarn('Prebid Error calling setRender on renderer', err);
   }
 
   return renderer;
@@ -143,8 +143,8 @@ function hasVideoMandatoryParams(mediaTypes) {
   const isHasVideoContext = !!mediaTypes.video && (mediaTypes.video.context === 'instream' || mediaTypes.video.context === 'outstream');
 
   const isPlayerSize =
-    !!utils.deepAccess(mediaTypes, 'video.playerSize') &&
-    utils.isArray(utils.deepAccess(mediaTypes, 'video.playerSize'));
+    !!deepAccess(mediaTypes, 'video.playerSize') &&
+    isArray(deepAccess(mediaTypes, 'video.playerSize'));
 
   return isHasVideoContext && isPlayerSize;
 }
@@ -237,8 +237,8 @@ export const spec = {
     let bidRequests = JSON.parse(bidRequest.data).bidRequests;
     const serverBody = serverResponse.body;
 
-    if (serverBody && serverBody.bids && utils.isArray(serverBody.bids)) {
-      return utils._map(serverBody.bids, function(bid) {
+    if (serverBody && serverBody.bids && isArray(serverBody.bids)) {
+      return _map(serverBody.bids, function(bid) {
         let rawBid = find(bidRequests, function (item) {
           return item.bidId === bid.bidId;
         });

package/modules/iasRtdProvider.js

@@ -1,13 +1,18 @@
 import { submodule } from '../src/hook.js';
-import { getGlobal } from '../src/prebidGlobal.js';
 import * as utils from '../src/utils.js';
-import { ajaxBuilder } from '../src/ajax.js';
+import { ajax } from '../src/ajax.js';
+import { getGlobal } from '../src/prebidGlobal.js';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
 const SUBMODULE_NAME = 'ias';
-
-let bidResponses = {};
+const IAS_HOST = 'https://pixel.adsafeprotected.com/services/pub';
+export let iasTargeting = {};
+const BRAND_SAFETY_OBJECT_FIELD_NAME = 'brandSafety';
+const FRAUD_FIELD_NAME = 'fr';
+const SLOTS_OBJECT_FIELD_NAME = 'slots';
+const CUSTOM_FIELD_NAME = 'custom';
+const IAS_KW = 'ias-kw';
 
 /**
  * Module init
@@ -16,6 +21,11 @@ let bidResponses = {};
  * @return {boolean}
  */
 export function init(config, userConsent) {
+  const params = config.params;
+  if (!params || !params.pubId) {
+    utils.logError('missing pubId param for IAS provider');
+    return false;
+  }
   return true;
 }
 
@@ -31,11 +41,12 @@ function stringifySlotSizes(sizes) {
   return result;
 }
 
-function stringifySlot(bidRequest, adUnitPath) {
+function stringifySlot(bidRequest) {
   const sizes = utils.getAdUnitSizes(bidRequest);
   const id = bidRequest.code;
   const ss = stringifySlotSizes(sizes);
-  const p = bidRequest.code;
+  const adSlot = utils.getGptSlotInfoForAdUnitCode(bidRequest.code);
+  const p = utils.isEmpty(adSlot) ? bidRequest.code : adSlot.gptSlot;
   const slot = { id, ss, p };
   const keyValues = utils.getKeys(slot).map(function (key) {
     return [key, slot[key]].join(':');
@@ -51,35 +62,29 @@ function stringifyScreenSize() {
   return [(window.screen && window.screen.width) || -1, (window.screen && window.screen.height) || -1].join('.');
 }
 
-function getPageLevelKeywords(response) {
+function formatTargetingData(adUnit) {
   let result = {};
-  if (response.brandSafety) {
-    shallowMerge(result, response.brandSafety);
+  if (iasTargeting[BRAND_SAFETY_OBJECT_FIELD_NAME]) {
+    utils.mergeDeep(result, iasTargeting[BRAND_SAFETY_OBJECT_FIELD_NAME]);
+  }
+  if (iasTargeting[FRAUD_FIELD_NAME]) {
+    result[FRAUD_FIELD_NAME] = iasTargeting[FRAUD_FIELD_NAME];
+  }
+  if (iasTargeting[CUSTOM_FIELD_NAME] && IAS_KW in iasTargeting[CUSTOM_FIELD_NAME]) {
+    result[IAS_KW] = iasTargeting[CUSTOM_FIELD_NAME][IAS_KW];
+  }
+  if (iasTargeting[SLOTS_OBJECT_FIELD_NAME] && adUnit in iasTargeting[SLOTS_OBJECT_FIELD_NAME]) {
+    utils.mergeDeep(result, iasTargeting[SLOTS_OBJECT_FIELD_NAME][adUnit]);
   }
-  result.fr = response.fr;
-  result.custom = response.custom;
   return result;
 }
 
-function shallowMerge(dest, src) {
-  utils.getKeys(src).reduce((dest, srcKey) => {
-    dest[srcKey] = src[srcKey];
-    return dest;
-  }, dest);
-}
-
-function getBidRequestData(reqBidsConfigObj, callback, config) {
-  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
-  let isFinish = false;
-
-  const IAS_HOST = 'https://pixel.adsafeprotected.com/services/pub';
-  const { pubId, adUnitPath } = config.params;
-  const anId = pubId;
+function constructQueryString(anId, adUnits) {
   let queries = [];
   queries.push(['anId', anId]);
 
   queries = queries.concat(adUnits.reduce(function (acc, request) {
-    acc.push(['slot', stringifySlot(request, adUnitPath)]);
+    acc.push(['slot', stringifySlot(request)]);
     return acc;
   }, []));
 
@@ -87,58 +92,69 @@ function getBidRequestData(reqBidsConfigObj, callback, config) {
   queries.push(['sr', stringifyScreenSize()]);
   queries.push(['url', encodeURIComponent(window.location.href)]);
 
-  const queryString = encodeURI(queries.map(qs => qs.join('=')).join('&'));
-
-  const ajax = ajaxBuilder();
-
-  ajax(`${IAS_HOST}?${queryString}`, {
-    success: function (response, request) {
-      if (!isFinish) {
-        if (request.status === 200) {
-          const iasResponse = JSON.parse(response);
-          const commonBidResponse = {};
-          shallowMerge(commonBidResponse, getPageLevelKeywords(iasResponse));
-          commonBidResponse.slots = iasResponse.slots;
-          bidResponses = commonBidResponse;
-          adUnits.forEach(adUnit => {
-            adUnit.bids.forEach(bid => {
-              const rtd = bid.rtd || {};
-              const iasRtd = {};
-              iasRtd[SUBMODULE_NAME] = Object.assign({}, rtd[SUBMODULE_NAME], bidResponses);
-              bid.rtd = Object.assign({}, rtd, iasRtd);
-            });
-          });
-        }
-        isFinish = true;
-      }
-      callback();
-    },
-    error: function () {
-      utils.logError('failed to retrieve targeting information');
-      callback();
-    }
-  });
+  return encodeURI(queries.map(qs => qs.join('=')).join('&'));
+}
+
+function parseResponse(result) {
+  let iasResponse = {};
+  try {
+    iasResponse = JSON.parse(result);
+  } catch (err) {
+    utils.logError('error', err);
+  }
+  iasTargeting = iasResponse;
 }
 
 function getTargetingData(adUnits, config, userConsent) {
   const targeting = {};
-  Object.keys(bidResponses).forEach(key => bidResponses[key] === undefined ? delete bidResponses[key] : {});
   try {
-    adUnits.forEach(function(adUnit) {
-      targeting[adUnit] = bidResponses;
-    });
+    if (!utils.isEmpty(iasTargeting)) {
+      adUnits.forEach(function (adUnit) {
+        targeting[adUnit] = formatTargetingData(adUnit);
+      });
+    }
   } catch (err) {
     utils.logError('error', err);
   }
+  utils.logInfo('IAS targeting', targeting);
   return targeting;
 }
 
+export function getApiCallback() {
+  return {
+    success: function (response, req) {
+      if (req.status === 200) {
+        try {
+          parseResponse(response);
+        } catch (e) {
+          utils.logError('Unable to parse IAS response.', e);
+        }
+      }
+    },
+    error: function () {
+      utils.logError('failed to retrieve IAS data');
+    }
+  }
+}
+
+function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
+  const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
+  const { pubId } = config.params;
+  const queryString = constructQueryString(pubId, adUnits);
+  ajax(
+    `${IAS_HOST}?${queryString}`,
+    getApiCallback(),
+    undefined,
+    { method: 'GET' }
+  );
+}
+
 /** @type {RtdSubmodule} */
 export const iasSubModule = {
   name: SUBMODULE_NAME,
   init: init,
-  getBidRequestData: getBidRequestData,
-  getTargetingData: getTargetingData
+  getTargetingData: getTargetingData,
+  getBidRequestData: getBidRequestData
 };
 
 submodule(MODULE_NAME, iasSubModule);

package/modules/id5IdSystem.js

@@ -5,7 +5,7 @@
  * @requires module:modules/userId
  */
 
-import * as utils from '../src/utils.js'
+import { deepAccess, logInfo, deepSetValue, logError, isEmpty, isEmptyStr, logWarn } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
 import { getRefererInfo } from '../src/refererDetection.js';
@@ -67,25 +67,25 @@ export const id5IdSubmodule = {
       }
     };
 
-    const abTestingResult = utils.deepAccess(value, 'ab_testing.result');
+    const abTestingResult = deepAccess(value, 'ab_testing.result');
     switch (abTestingResult) {
       case 'control':
         // A/B Testing is enabled and user is in the Control Group
-        utils.logInfo(LOG_PREFIX + 'A/B Testing - user is in the Control Group: ID5 ID is NOT exposed');
-        utils.deepSetValue(responseObj, 'id5id.ext.abTestingControlGroup', true);
+        logInfo(LOG_PREFIX + 'A/B Testing - user is in the Control Group: ID5 ID is NOT exposed');
+        deepSetValue(responseObj, 'id5id.ext.abTestingControlGroup', true);
         break;
       case 'error':
         // A/B Testing is enabled, but configured improperly, so skip A/B testing
-        utils.logError(LOG_PREFIX + 'A/B Testing ERROR! controlGroupPct must be a number >= 0 and <= 1');
+        logError(LOG_PREFIX + 'A/B Testing ERROR! controlGroupPct must be a number >= 0 and <= 1');
         break;
       case 'normal':
         // A/B Testing is enabled but user is not in the Control Group, so ID5 ID is shared
-        utils.logInfo(LOG_PREFIX + 'A/B Testing - user is NOT in the Control Group');
-        utils.deepSetValue(responseObj, 'id5id.ext.abTestingControlGroup', false);
+        logInfo(LOG_PREFIX + 'A/B Testing - user is NOT in the Control Group');
+        deepSetValue(responseObj, 'id5id.ext.abTestingControlGroup', false);
         break;
     }
 
-    utils.logInfo(LOG_PREFIX + 'Decoded ID', responseObj);
+    logInfo(LOG_PREFIX + 'Decoded ID', responseObj);
 
     return responseObj;
   },
@@ -120,19 +120,19 @@ export const id5IdSubmodule = {
     };
 
     // pass in optional data, but only if populated
-    if (hasGdpr && typeof consentData.consentString !== 'undefined' && !utils.isEmpty(consentData.consentString) && !utils.isEmptyStr(consentData.consentString)) {
+    if (hasGdpr && typeof consentData.consentString !== 'undefined' && !isEmpty(consentData.consentString) && !isEmptyStr(consentData.consentString)) {
       data.gdpr_consent = consentData.consentString;
     }
-    if (typeof usp !== 'undefined' && !utils.isEmpty(usp) && !utils.isEmptyStr(usp)) {
+    if (typeof usp !== 'undefined' && !isEmpty(usp) && !isEmptyStr(usp)) {
       data.us_privacy = usp;
     }
-    if (typeof signature !== 'undefined' && !utils.isEmptyStr(signature)) {
+    if (typeof signature !== 'undefined' && !isEmptyStr(signature)) {
       data.s = signature;
     }
-    if (typeof config.params.pd !== 'undefined' && !utils.isEmptyStr(config.params.pd)) {
+    if (typeof config.params.pd !== 'undefined' && !isEmptyStr(config.params.pd)) {
       data.pd = config.params.pd;
     }
-    if (typeof config.params.provider !== 'undefined' && !utils.isEmptyStr(config.params.provider)) {
+    if (typeof config.params.provider !== 'undefined' && !isEmptyStr(config.params.provider)) {
       data.provider = config.params.provider;
     }
 
@@ -151,7 +151,7 @@ export const id5IdSubmodule = {
           if (response) {
             try {
               responseObj = JSON.parse(response);
-              utils.logInfo(LOG_PREFIX + 'response received from the server', responseObj);
+              logInfo(LOG_PREFIX + 'response received from the server', responseObj);
 
               resetNb(config.params.partner);
 
@@ -165,17 +165,17 @@ export const id5IdSubmodule = {
                 removeLegacyCookies(config.params.partner);
               }
             } catch (error) {
-              utils.logError(LOG_PREFIX + error);
+              logError(LOG_PREFIX + error);
             }
           }
           callback(responseObj);
         },
         error: error => {
-          utils.logError(LOG_PREFIX + 'getId fetch encountered an error', error);
+          logError(LOG_PREFIX + 'getId fetch encountered an error', error);
           callback();
         }
       };
-      utils.logInfo(LOG_PREFIX + 'requesting an ID from the server', data);
+      logInfo(LOG_PREFIX + 'requesting an ID from the server', data);
       ajax(url, callbacks, JSON.stringify(data), { method: 'POST', withCredentials: true });
     };
     return { callback: resp };
@@ -198,29 +198,29 @@ export const id5IdSubmodule = {
     const partnerId = (config && config.params && config.params.partner) || 0;
     incrementNb(partnerId);
 
-    utils.logInfo(LOG_PREFIX + 'using cached ID', cacheIdObj);
+    logInfo(LOG_PREFIX + 'using cached ID', cacheIdObj);
     return cacheIdObj;
   }
 };
 
 function hasRequiredConfig(config) {
   if (!config || !config.params || !config.params.partner || typeof config.params.partner !== 'number') {
-    utils.logError(LOG_PREFIX + 'partner required to be defined as a number');
+    logError(LOG_PREFIX + 'partner required to be defined as a number');
     return false;
   }
 
   if (!config.storage || !config.storage.type || !config.storage.name) {
-    utils.logError(LOG_PREFIX + 'storage required to be set');
+    logError(LOG_PREFIX + 'storage required to be set');
     return false;
   }
 
   // in a future release, we may return false if storage type or name are not set as required
   if (config.storage.type !== LOCAL_STORAGE) {
-    utils.logWarn(LOG_PREFIX + `storage type recommended to be '${LOCAL_STORAGE}'. In a future release this may become a strict requirement`);
+    logWarn(LOG_PREFIX + `storage type recommended to be '${LOCAL_STORAGE}'. In a future release this may become a strict requirement`);
   }
   // in a future release, we may return false if storage type or name are not set as required
   if (config.storage.name !== ID5_STORAGE_NAME) {
-    utils.logWarn(LOG_PREFIX + `storage name recommended to be '${ID5_STORAGE_NAME}'. In a future release this may become a strict requirement`);
+    logWarn(LOG_PREFIX + `storage name recommended to be '${ID5_STORAGE_NAME}'. In a future release this may become a strict requirement`);
   }
 
   return true;
@@ -265,7 +265,7 @@ function getLegacyCookieSignature() {
  * @param {integer} partnerId
  */
 function removeLegacyCookies(partnerId) {
-  utils.logInfo(LOG_PREFIX + 'removing legacy cookies');
+  logInfo(LOG_PREFIX + 'removing legacy cookies');
   LEGACY_COOKIE_NAMES.forEach(function(cookie) {
     storage.setCookie(`${cookie}`, ' ', expDaysStr(-1));
     storage.setCookie(`${cookie}_nb`, ' ', expDaysStr(-1));
@@ -313,7 +313,7 @@ export function storeInLocalStorage(key, value, expDays) {
  * @returns {Object} an object which always contains at least the property "enabled"
  */
 function getAbTestingConfig(config) {
-  return utils.deepAccess(config, 'params.abTesting', { enabled: false });
+  return deepAccess(config, 'params.abTesting', { enabled: false });
 }
 
 submodule('userId', id5IdSubmodule);