prebid.js 9.4.0 → 9.5.0

package/modules/anonymisedRtdProvider.js

@@ -9,10 +9,13 @@ import {getStorageManager} from '../src/storageManager.js';
 import {submodule} from '../src/hook.js';
 import {isPlainObject, mergeDeep, logMessage, logError} from '../src/utils.js';
 import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
-
+/**
+ * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
+ */
 export function createRtdProvider(moduleName) {
   const MODULE_NAME = 'realTimeData';
   const SUBMODULE_NAME = moduleName;
+  const GVLID = 1116;
 
   const storage = getStorageManager({ moduleType: MODULE_TYPE_RTD, moduleName: SUBMODULE_NAME });
   /**
@@ -106,6 +109,7 @@ export function createRtdProvider(moduleName) {
   /** @type {RtdSubmodule} */
   const rtdSubmodule = {
     name: SUBMODULE_NAME,
+    gvlid: GVLID,
     getBidRequestData: getRealTimeData,
     init: init
   };

package/modules/anonymisedRtdProvider.md

@@ -8,7 +8,7 @@ Anonymised’s Real-time Data Provider automatically obtains segment IDs from th
  - Build the anonymisedRtd module into the Prebid.js package with:
 
  ```bash
- gulp build --modules=anonymisedRtdProvider,...
+ gulp build --modules=rtdModule,anonymisedRtdProvider,...
  ```
 
  - Use `setConfig` to instruct Prebid.js to initilaize the anonymisedRtdProvider module, as specified below.

package/modules/apacdexBidAdapter.js

@@ -1,7 +1,7 @@
 import { deepAccess, isPlainObject, isArray, replaceAuctionPrice, isFn, logError, deepClone } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 import {parseDomain} from '../src/refererDetection.js';
 const BIDDER_CODE = 'apacdex';
 const ENDPOINT = 'https://useast.quantumdex.io/auction/pbjs'

package/modules/appnexusBidAdapter.js

@@ -15,7 +15,8 @@ import {
   logError,
   logInfo,
   logMessage,
-  logWarn
+  logWarn,
+  mergeDeep
 } from '../src/utils.js';
 import {Renderer} from '../src/Renderer.js';
 import {config} from '../src/config.js';
@@ -25,7 +26,7 @@ import {find, includes} from '../src/polyfill.js';
 import {INSTREAM, OUTSTREAM} from '../src/video.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {bidderSettings} from '../src/bidderSettings.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 import {APPNEXUS_CATEGORY_MAPPING} from '../libraries/categoryTranslationMapping/index.js';
 import {
@@ -103,6 +104,28 @@ const VIEWABILITY_URL_START = /\/\/cdn\.adnxs\.com\/v|\/\/cdn\.adnxs\-simple\.co
 const VIEWABILITY_FILE_NAME = 'trk.js';
 const GVLID = 32;
 const storage = getStorageManager({bidderCode: BIDDER_CODE});
+// ORTB2 device types according to the OpenRTB specification
+const ORTB2_DEVICE_TYPE = {
+  MOBILE_TABLET: 1,
+  PERSONAL_COMPUTER: 2,
+  CONNECTED_TV: 3,
+  PHONE: 4,
+  TABLET: 5,
+  CONNECTED_DEVICE: 6,
+  SET_TOP_BOX: 7,
+  OOH_DEVICE: 8
+};
+// Map of ORTB2 device types to AppNexus device types
+const ORTB2_DEVICE_TYPE_MAP = new Map([
+  [ORTB2_DEVICE_TYPE.MOBILE_TABLET, 'Mobile/Tablet - General'],
+  [ORTB2_DEVICE_TYPE.PERSONAL_COMPUTER, 'Personal Computer'],
+  [ORTB2_DEVICE_TYPE.CONNECTED_TV, 'Connected TV'],
+  [ORTB2_DEVICE_TYPE.PHONE, 'Phone'],
+  [ORTB2_DEVICE_TYPE.TABLET, 'Tablet'],
+  [ORTB2_DEVICE_TYPE.CONNECTED_DEVICE, 'Connected Device'],
+  [ORTB2_DEVICE_TYPE.SET_TOP_BOX, 'Set Top Box'],
+  [ORTB2_DEVICE_TYPE.OOH_DEVICE, 'OOH Device'],
+]);
 
 export const spec = {
   code: BIDDER_CODE,
@@ -247,6 +270,12 @@ export const spec = {
       payload.app = appIdObj;
     }
 
+    // if present, convert and merge device object from ortb2 into `payload.device`
+    if (bidderRequest?.ortb2?.device) {
+      payload.device = payload.device || {};
+      mergeDeep(payload.device, convertORTB2DeviceDataToAppNexusDeviceObject(bidderRequest.ortb2.device));
+    }
+
     // grab the ortb2 keyword data (if it exists) and convert from the comma list string format to object format
     let ortb2 = deepClone(bidderRequest && bidderRequest.ortb2);
 
@@ -1196,4 +1225,29 @@ function getBidFloor(bid) {
   return null;
 }
 
+// Convert device data to a format that AppNexus expects
+function convertORTB2DeviceDataToAppNexusDeviceObject(ortb2DeviceData) {
+  const _device = {
+    useragent: ortb2DeviceData.ua,
+    devicetype: ORTB2_DEVICE_TYPE_MAP.get(ortb2DeviceData.devicetype),
+    make: ortb2DeviceData.make,
+    model: ortb2DeviceData.model,
+    os: ortb2DeviceData.os,
+    os_version: ortb2DeviceData.osv,
+    w: ortb2DeviceData.w,
+    h: ortb2DeviceData.h,
+    ppi: ortb2DeviceData.ppi,
+    pxratio: ortb2DeviceData.pxratio,
+  };
+
+  // filter out any empty values and return the object
+  return Object.keys(_device)
+    .reduce((r, key) => {
+      if (_device[key]) {
+        r[key] = _device[key];
+      }
+      return r;
+    }, {});
+}
+
 registerBidder(spec);

package/modules/automatadAnalyticsAdapter.js

@@ -18,6 +18,8 @@ var isLoggingEnabled; var queuePointer = 0; var retryCount = 0; var timer = null
 
 const prettyLog = (level, text, isGroup = false, cb = () => {}) => {
   if (self.isLoggingEnabled === undefined) {
+    // TODO FIX THIS RULES VIOLATION
+    // eslint-disable-next-line prebid/no-global
     if (window.localStorage.getItem('__aggLoggingEnabled')) {
       self.isLoggingEnabled = true
     } else {

package/modules/azerionedgeRtdProvider.js

@@ -19,6 +19,8 @@ const REAL_TIME_MODULE = 'realTimeData';
 const SUBREAL_TIME_MODULE = 'azerionedge';
 export const STORAGE_KEY = 'ht-pa-v1-a';
 
+const IMPROVEDIGITAL_GVLID = '253';
+
 export const storage = getStorageManager({
   moduleType: MODULE_TYPE_RTD,
   moduleName: SUBREAL_TIME_MODULE,
@@ -42,14 +44,21 @@ function getScriptURL(config) {
  * Attach script tag to DOM
  *
  * @param {Object} config
+ * @param {Object} userConsent
  *
  * @return {void}
  */
-export function attachScript(config) {
+export function attachScript(config, userConsent) {
   const script = getScriptURL(config);
   loadExternalScript(script, SUBREAL_TIME_MODULE, () => {
     if (typeof window.azerionPublisherAudiences === 'function') {
-      window.azerionPublisherAudiences(config.params?.process || {});
+      const publisherConfig = config.params?.process || {};
+      window.azerionPublisherAudiences({
+        ...publisherConfig,
+        gdprApplies: userConsent?.gdpr?.gdprApplies,
+        gdprConsent: userConsent?.gdpr?.consentString,
+        uspConsent: userConsent?.usp,
+      });
     }
   });
 }
@@ -106,7 +115,7 @@ export function setAudiencesToBidders(reqBidsConfigObj, config, audiences) {
  * @return {boolean}
  */
 function init(config, userConsent) {
-  attachScript(config);
+  attachScript(config, userConsent);
   return true;
 }
 
@@ -138,6 +147,7 @@ export const azerionedgeSubmodule = {
   name: SUBREAL_TIME_MODULE,
   init: init,
   getBidRequestData: getBidRequestData,
+  gvlid: IMPROVEDIGITAL_GVLID,
 };
 
 submodule(REAL_TIME_MODULE, azerionedgeSubmodule);

package/modules/azerionedgeRtdProvider.md

@@ -79,23 +79,6 @@ provided to the module when the user gives the relevant permissions on the publi
 As Prebid.js utilizes TCF vendor consent for the RTD module to load, the module needs to be labeled
 within the Vendor Exceptions.
 
-### Instructions
-
-If the Prebid GDPR enforcement is enabled, the module should be labeled
-as exception, as shown below:
-
-```js
-[
-  {
-    purpose: 'storage',
-    enforcePurpose: true,
-    enforceVendor: true,
-    vendorExceptions: ["azerionedge"]
-  },
-  ...
-]
-```
-
 ## Testing
 
 To view an example:

package/modules/bridBidAdapter.js

@@ -1,7 +1,7 @@
-import {createTrackPixelHtml, _each, deepAccess, getDefinedParams, parseGPTSingleSizeArrayToRtbSize} from '../src/utils.js';
+import {_each, deepAccess, getDefinedParams, parseGPTSingleSizeArrayToRtbSize} from '../src/utils.js';
 import {VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
-import {getRefererInfo} from '../src/refererDetection.js';
+import {getAd, getSiteObj} from '../libraries/targetVideoUtils/bidderUtils.js'
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -180,50 +180,50 @@ export const spec = {
 
 }
 
-/**
- * Helper function to get ad
- *
- * @param {object} bid The bid.
- * @return {object} ad object.
- */
-function getAd(bid) {
-  let ad, adUrl, vastXml, vastUrl;
-
-  switch (deepAccess(bid, 'ext.prebid.type')) {
-    case VIDEO:
-      if (bid.adm.substr(0, 4) === 'http') {
-        vastUrl = bid.adm;
-      } else {
-        vastXml = bid.adm;
-      };
-      break;
-    default:
-      if (bid.adm && bid.nurl) {
-        ad = bid.adm;
-        ad += createTrackPixelHtml(decodeURIComponent(bid.nurl));
-      } else if (bid.adm) {
-        ad = bid.adm;
-      } else if (bid.nurl) {
-        adUrl = bid.nurl;
-      };
-  }
-
-  return {ad, adUrl, vastXml, vastUrl};
-}
-
-/**
- * Helper function to get site object
- *
- * @return {object} siteObj.
- */
-function getSiteObj() {
-  const refInfo = (getRefererInfo && getRefererInfo()) || {};
-
-  return {
-    page: refInfo.page,
-    ref: refInfo.ref,
-    domain: refInfo.domain
-  };
-}
+// /**
+//  * Helper function to get ad
+//  *
+//  * @param {object} bid The bid.
+//  * @return {object} ad object.
+//  */
+// function getAd(bid) {
+//   let ad, adUrl, vastXml, vastUrl;
+
+//   switch (deepAccess(bid, 'ext.prebid.type')) {
+//     case VIDEO:
+//       if (bid.adm.substr(0, 4) === 'http') {
+//         vastUrl = bid.adm;
+//       } else {
+//         vastXml = bid.adm;
+//       };
+//       break;
+//     default:
+//       if (bid.adm && bid.nurl) {
+//         ad = bid.adm;
+//         ad += createTrackPixelHtml(decodeURIComponent(bid.nurl));
+//       } else if (bid.adm) {
+//         ad = bid.adm;
+//       } else if (bid.nurl) {
+//         adUrl = bid.nurl;
+//       };
+//   }
+
+//   return {ad, adUrl, vastXml, vastUrl};
+// }
+
+// /**
+//  * Helper function to get site object
+//  *
+//  * @return {object} siteObj.
+//  */
+// function getSiteObj() {
+//   const refInfo = (getRefererInfo && getRefererInfo()) || {};
+
+//   return {
+//     page: refInfo.page,
+//     ref: refInfo.ref,
+//     domain: refInfo.domain
+//   };
+// }
 
 registerBidder(spec);

package/modules/cleanioRtdProvider.js

@@ -43,6 +43,7 @@ let preloadStatus = 0;
  * @param {string} scriptURL The script URL to preload
  */
 function pageInitStepPreloadScript(scriptURL) {
+  // TODO: this bypasses adLoader
   const linkElement = document.createElement('link');
   linkElement.rel = 'preload';
   linkElement.as = 'script';

package/modules/concertBidAdapter.js

@@ -1,7 +1,7 @@
 import { logWarn, logMessage, debugTurnedOn, generateUUID, deepAccess } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
-import { hasPurpose1Consent } from '../src/utils/gpdr.js';
+import { hasPurpose1Consent } from '../src/utils/gdpr.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest

package/modules/connatixBidAdapter.js

@@ -11,7 +11,9 @@ import {
 } from '../src/utils.js';
 
 import {
+  ADPOD,
   BANNER,
+  VIDEO,
 } from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'connatix';
@@ -41,10 +43,28 @@ export function getBidFloor(bid) {
   }
 }
 
+export function validateBanner(mediaTypes) {
+  if (!mediaTypes[BANNER]) {
+    return true;
+  }
+
+  const banner = deepAccess(mediaTypes, BANNER, {});
+  return (Boolean(banner.sizes) && isArray(mediaTypes[BANNER].sizes) && mediaTypes[BANNER].sizes.length > 0);
+}
+
+export function validateVideo(mediaTypes) {
+  const video = mediaTypes[VIDEO];
+  if (!video) {
+    return true;
+  }
+
+  return video.context !== ADPOD;
+}
+
 export const spec = {
   code: BIDDER_CODE,
   gvlid: 143,
-  supportedMediaTypes: [BANNER],
+  supportedMediaTypes: [BANNER, VIDEO],
 
   /*
    * Validate the bid request.
@@ -57,17 +77,24 @@ export const spec = {
     const params = deepAccess(bid, 'params', {});
     const bidder = deepAccess(bid, 'bidder');
 
-    const banner = deepAccess(mediaTypes, BANNER, {});
-
     const hasBidId = Boolean(bidId);
     const isValidBidder = (bidder === BIDDER_CODE);
-    const isValidSize = (Boolean(banner.sizes) && isArray(mediaTypes[BANNER].sizes) && mediaTypes[BANNER].sizes.length > 0);
-    const hasSizes = mediaTypes[BANNER] ? isValidSize : false;
+    const hasMediaTypes = Boolean(mediaTypes) && (Boolean(mediaTypes[BANNER]) || Boolean(mediaTypes[VIDEO]));
+    const isValidBanner = validateBanner(mediaTypes);
+    const isValidVideo = validateVideo(mediaTypes);
     const hasRequiredBidParams = Boolean(params.placementId);
 
-    const isValid = isValidBidder && hasBidId && hasSizes && hasRequiredBidParams;
+    const isValid = isValidBidder && hasBidId && hasMediaTypes && isValidBanner && isValidVideo && hasRequiredBidParams;
     if (!isValid) {
-      logError(`Invalid bid request: isValidBidder: ${isValidBidder} hasBidId: ${hasBidId}, hasSizes: ${hasSizes}, hasRequiredBidParams: ${hasRequiredBidParams}`);
+      logError(
+        `Invalid bid request: 
+          isValidBidder: ${isValidBidder}, 
+          hasBidId: ${hasBidId}, 
+          hasMediaTypes: ${hasMediaTypes}, 
+          isValidBanner: ${isValidBanner}, 
+          isValidVideo: ${isValidVideo}, 
+          hasRequiredBidParams: ${hasRequiredBidParams}`
+      );
     }
     return isValid;
   },
@@ -129,12 +156,13 @@ export const spec = {
       cpm: bidResponse.Cpm,
       ttl: bidResponse.Ttl || DEFAULT_MAX_TTL,
       currency: 'USD',
-      mediaType: BANNER,
+      mediaType: bidResponse.VastXml ? VIDEO : BANNER,
       netRevenue: true,
       width: bidResponse.Width,
       height: bidResponse.Height,
       creativeId: bidResponse.CreativeId,
       ad: bidResponse.Ad,
+      vastXml: bidResponse.VastXml,
       referrer: referrer,
     }));
   },

package/modules/connectIdSystem.js

@@ -313,11 +313,13 @@ export const connectIdSubmodule = {
 
   /**
    * Utility function that returns a boolean flag indicating if the user
-   * has opeted out via the Yahoo easy-opt-out mechanism.
+   * has opted out via the Yahoo easy-opt-out mechanism.
    * @returns {Boolean}
    */
   userHasOptedOut() {
     try {
+      // TODO FIX THIS RULES VIOLATION
+      // eslint-disable-next-line
       return localStorage.getItem(OVERRIDE_OPT_OUT_KEY) === '1';
     } catch {
       return false;

package/modules/contxtfulRtdProvider.js

@@ -17,12 +17,19 @@ import {
   isArray,
 } from '../src/utils.js';
 import { loadExternalScript } from '../src/adloader.js';
+import { getStorageManager } from '../src/storageManager.js';
+import { MODULE_TYPE_RTD } from '../src/activities/modules.js';
 
 const MODULE_NAME = 'contxtful';
 const MODULE = `${MODULE_NAME}RtdProvider`;
 
 const CONTXTFUL_RECEPTIVITY_DOMAIN = 'api.receptivity.io';
 
+const storageManager = getStorageManager({
+  moduleType: MODULE_TYPE_RTD,
+  moduleName: MODULE_NAME
+});
+
 let rxApi = null;
 let isFirstBidRequestCall = true;
 
@@ -35,8 +42,19 @@ function getRxEngineReceptivity(requester) {
   return rxApi?.receptivity(requester);
 }
 
+function getItemFromSessionStorage(key) {
+  let value = null;
+  try {
+    // Use the Storage Manager
+    value = storageManager.getDataFromSessionStorage(key, null);
+  } catch (error) {
+  }
+
+  return value;
+}
+
 function loadSessionReceptivity(requester) {
-  let sessionStorageValue = sessionStorage.getItem(requester);
+  let sessionStorageValue = getItemFromSessionStorage(requester);
   if (!sessionStorageValue) {
     return null;
   }
@@ -54,7 +72,7 @@ function loadSessionReceptivity(requester) {
   } catch {
     return null;
   }
-};
+}
 
 /**
  * Prepare a receptivity batch

package/modules/contxtfulRtdProvider.md

@@ -63,6 +63,7 @@ pbjs.setConfig({
   }
 });
 ```
+
 ## Parameters
 
 | Name                | Type     | Scope    | Description                                |

package/modules/craftBidAdapter.js

@@ -4,7 +4,7 @@ import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {find, includes} from '../src/polyfill.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {ajax} from '../src/ajax.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 import {convertOrtbRequestToProprietaryNative} from '../src/native.js';
 import {getANKeywordParam} from '../libraries/appnexusUtils/anKeywords.js';
 

package/modules/criteoBidAdapter.js

@@ -3,7 +3,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {getRefererInfo} from '../src/refererDetection.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 import {Renderer} from '../src/Renderer.js';
 import {OUTSTREAM} from '../src/video.js';
 import {ajax} from '../src/ajax.js';

package/modules/cwireBidAdapter.js

@@ -2,7 +2,7 @@ import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {BANNER} from '../src/mediaTypes.js';
 import {generateUUID, getParameterByName, isNumber, logError, logInfo} from '../src/utils.js';
-import {hasPurpose1Consent} from '../src/utils/gpdr.js';
+import {hasPurpose1Consent} from '../src/utils/gdpr.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
@@ -224,6 +224,8 @@ export const spec = {
         bid: bid
       }
     }
+    // TODO FIX THIS RULES VIOLATION
+    // eslint-disable-next-line prebid/no-member
     navigator.sendBeacon(EVENT_ENDPOINT, JSON.stringify(event))
   },
 
@@ -236,6 +238,8 @@ export const spec = {
         bidderRequest: bidderRequest
       }
     }
+    // TODO FIX THIS RULES VIOLATION
+    // eslint-disable-next-line prebid/no-member
     navigator.sendBeacon(EVENT_ENDPOINT, JSON.stringify(event))
   },