prebid.js 10.2.0 → 10.4.0

package/modules/eightPodBidAdapter.js

@@ -159,14 +159,14 @@ function createRequest(bidRequests, bidderRequest, mediaType) {
         secure: 1,
         pmp: params.dealId
           ? {
-            ...data.pmp,
-            deals: [
-              {
-                id: params.dealId,
-              },
-            ],
-            private_auction: 1,
-          }
+              ...data.pmp,
+              deals: [
+                {
+                  id: params.dealId,
+                },
+              ],
+              private_auction: 1,
+            }
           : data.pmp,
       }
     ]

package/modules/genericAnalyticsAdapter.ts

@@ -8,72 +8,72 @@ import type {AnyFunction} from "../src/types/functions";
 type EventMapping = {[E in keyof Events]?: (payload: Events[E][0]) => any};
 
 type BaseOptions = {
-    /**
-     * Number of events to collect into a single call to `handler` or `url`.
-     * Defaults to 1
-     */
-    batchSize?: number;
-    /**
-     * Time (in milliseconds) to wait before calling handler or url with an incomplete batch
-     * (when fewer than batchSize events have been collected).
-     * Defaults to 100
-     */
-    batchDelay?: number;
-    /**
-     * Global vendor list ID to use for the purpose of GDPR purpose 7 enforcement
-     */
-    gvlid?: number;
-    /**
-     * Map from event name to a custom format function. When provided, only events in this map will be collected,
-     * using the data returned by their corresponding function.
-     */
-    events?: EventMapping;
+  /**
+   * Number of events to collect into a single call to `handler` or `url`.
+   * Defaults to 1
+   */
+  batchSize?: number;
+  /**
+   * Time (in milliseconds) to wait before calling handler or url with an incomplete batch
+   * (when fewer than batchSize events have been collected).
+   * Defaults to 100
+   */
+  batchDelay?: number;
+  /**
+   * Global vendor list ID to use for the purpose of GDPR purpose 7 enforcement
+   */
+  gvlid?: number;
+  /**
+   * Map from event name to a custom format function. When provided, only events in this map will be collected,
+   * using the data returned by their corresponding function.
+   */
+  events?: EventMapping;
 }
 
 type Payloads<M extends EventMapping> = {
-    [H in keyof M]: M[H] extends AnyFunction ? ReturnType<M[H]> : never
+  [H in keyof M]: M[H] extends AnyFunction ? ReturnType<M[H]> : never
 }[keyof M];
 
 type CustomHandlersOptions<M extends EventMapping> = BaseOptions & {
-    /**
-     * Custom handler function.
-     * @param data an array of length `batchSize` containing event data as returned by the functions in `events`.
-     */
-    handler: (data: Payloads<M>[]) => void;
-    events: M;
-    url?: undefined;
-    method?: undefined;
+  /**
+   * Custom handler function.
+   * @param data an array of length `batchSize` containing event data as returned by the functions in `events`.
+   */
+  handler: (data: Payloads<M>[]) => void;
+  events: M;
+  url?: undefined;
+  method?: undefined;
 }
 
 type BasicHandlerOptions = BaseOptions & {
-    /**
-     * Custom handler function.
-     * @param data an array of length `batchSize` containing the event payloads.
-     */
-    handler: (data: (Events[keyof Events][0])[]) => void;
-    events?: undefined;
-    url?: undefined;
-    method?: undefined;
+  /**
+   * Custom handler function.
+   * @param data an array of length `batchSize` containing the event payloads.
+   */
+  handler: (data: (Events[keyof Events][0])[]) => void;
+  events?: undefined;
+  url?: undefined;
+  method?: undefined;
 }
 
 type UrlOptions = BaseOptions & {
-    /**
-     * Data collection URL
-     */
-    url: string;
-    /**
-     * HTTP method used to call `url`. Defaults to 'POST'
-     */
-    method?: string;
-    handler?: undefined;
+  /**
+   * Data collection URL
+   */
+  url: string;
+  /**
+   * HTTP method used to call `url`. Defaults to 'POST'
+   */
+  method?: string;
+  handler?: undefined;
 }
 
 declare module '../libraries/analyticsAdapter/AnalyticsAdapter' {
-    interface AnalyticsProviderConfig {
-        generic: {
-            options: DefaultOptions & (UrlOptions | BasicHandlerOptions | CustomHandlersOptions<EventMapping>)
-        }
+  interface AnalyticsProviderConfig {
+    generic: {
+      options: DefaultOptions & (UrlOptions | BasicHandlerOptions | CustomHandlersOptions<EventMapping>)
     }
+  }
 }
 
 const DEFAULTS = {

package/modules/geolocationRtdProvider.ts

@@ -11,65 +11,65 @@ let permissionsAvailable = true;
 let geolocation;
 
 declare module './rtdModule/spec' {
-    interface ProviderConfig {
-        geolocation: {
-            params?: {
-                /**
-                 * If true, request geolocation permissions from the browser.
-                 */
-                requestPermission?: boolean;
-            }
-        }
+  interface ProviderConfig {
+    geolocation: {
+      params?: {
+        /**
+         * If true, request geolocation permissions from the browser.
+         */
+        requestPermission?: boolean;
+      }
     }
+  }
 }
 
 export const geolocationSubmodule: RtdProviderSpec<'geolocation'> = {
   name: 'geolocation',
   gvlid: VENDORLESS_GVLID as any,
   getBidRequestData(requestBidsObject, onDone, providerConfig) {
-      let done = false;
-      if (!permissionsAvailable) {
-          logWarn('permission for geolocation receiving was denied');
-          return complete()
-      }
-      if (!isActivityAllowed(ACTIVITY_TRANSMIT_PRECISE_GEO, activityParams(MODULE_TYPE_RTD, 'geolocation'))) {
-          logWarn('permission for geolocation receiving was denied by CMP');
-          return complete()
-      }
-      const requestPermission = deepAccess(providerConfig, 'params.requestPermission') === true;
-      navigator.permissions.query({
-          name: 'geolocation',
-      }).then(permission => {
-          if (permission.state !== 'granted' && !requestPermission) return complete();
-          navigator.geolocation.getCurrentPosition(geo => {
-              geolocation = geo;
-              complete();
-          });
+    let done = false;
+    if (!permissionsAvailable) {
+      logWarn('permission for geolocation receiving was denied');
+      return complete()
+    }
+    if (!isActivityAllowed(ACTIVITY_TRANSMIT_PRECISE_GEO, activityParams(MODULE_TYPE_RTD, 'geolocation'))) {
+      logWarn('permission for geolocation receiving was denied by CMP');
+      return complete()
+    }
+    const requestPermission = deepAccess(providerConfig, 'params.requestPermission') === true;
+    navigator.permissions.query({
+      name: 'geolocation',
+    }).then(permission => {
+      if (permission.state !== 'granted' && !requestPermission) return complete();
+      navigator.geolocation.getCurrentPosition(geo => {
+        geolocation = geo;
+        complete();
       });
-      function complete() {
-          if (done) return;
-          done = true;
-          if (geolocation) {
-              deepSetValue(requestBidsObject, 'ortb2Fragments.global.device.geo', {
-                  lat: geolocation.coords.latitude,
-                  lon: geolocation.coords.longitude,
-                  lastfix: Math.round((timestamp() - geolocation.timestamp) / 1000),
-                  type: 1
-              });
-              logInfo('geolocation was successfully received ', requestBidsObject.ortb2Fragments.global.device.geo)
-          }
-          onDone();
+    });
+    function complete() {
+      if (done) return;
+      done = true;
+      if (geolocation) {
+        deepSetValue(requestBidsObject, 'ortb2Fragments.global.device.geo', {
+          lat: geolocation.coords.latitude,
+          lon: geolocation.coords.longitude,
+          lastfix: Math.round((timestamp() - geolocation.timestamp) / 1000),
+          type: 1
+        });
+        logInfo('geolocation was successfully received ', requestBidsObject.ortb2Fragments.global.device.geo)
       }
+      onDone();
+    }
   },
   init() {
-      geolocation = void 0;
-      if (!isFn(navigator?.permissions?.query) || !isFn(navigator?.geolocation?.getCurrentPosition || !navigator?.permissions?.query)) {
-          logError('geolocation is not defined');
-          permissionsAvailable = false;
-      } else {
-          permissionsAvailable = true;
-      }
-      return permissionsAvailable;
+    geolocation = void 0;
+    if (!isFn(navigator?.permissions?.query) || !isFn(navigator?.geolocation?.getCurrentPosition || !navigator?.permissions?.query)) {
+      logError('geolocation is not defined');
+      permissionsAvailable = false;
+    } else {
+      permissionsAvailable = true;
+    }
+    return permissionsAvailable;
   }
 };
 

package/modules/getintentBidAdapter.js

@@ -1,4 +1,4 @@
-import {getBidIdParameter, isFn, isInteger} from '../src/utils.js';
+import {getBidIdParameter, isFn, isInteger, logError} from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 
 /**
@@ -211,7 +211,9 @@ function produceSize (sizes) {
     if (Array.isArray(s) && s.length === 2 && isInteger(s[0]) && isInteger(s[1])) {
       return s.join('x');
     } else {
-      throw "Malformed parameter 'sizes'";
+      const msg = "Malformed parameter 'sizes'";
+      logError(msg);
+      return undefined;
     }
   }
   if (Array.isArray(sizes) && Array.isArray(sizes[0])) {

package/modules/gmosspBidAdapter.js

@@ -94,7 +94,7 @@ export const spec = {
    * @param {Array} requests
    * @return {Array} An array of bids which were nested inside the server.
    */
- interpretResponse: function (bidderResponse, requests) {
+  interpretResponse: function (bidderResponse, requests) {
     const res = bidderResponse.body;
 
     if (isEmpty(res)) {

package/modules/gppControl_usstates.ts

@@ -30,21 +30,21 @@ const FIELDS = {
  * additionally, elements within them can be moved around using the `move` argument.
  */
 export function normalizer({nullify = [], move = {}, fn}: {
-    /**
-     * list of fields to force to null
-     */
-    nullify?: string[];
-    /**
-     * Map from list field name to an index remapping for elements within that field (using 1 as the first index).
-     * For example, {SensitiveDataProcessing: {1: 2, 2: [1, 3]}} means "rearrange SensitiveDataProcessing by moving
-     * the first element to the second position, and the second element to both the first and third position."
-     */
-    move?: { [name: string]: { [position: number]: number | number[] } };
-    /**
-     * an optional function to run once all the processing described above is complete;
-     * it's passed two arguments, the original (state) data, and its normalized (usnat) version.
-     */
-    fn?: (original, normalized) => any;
+  /**
+   * list of fields to force to null
+   */
+  nullify?: string[];
+  /**
+   * Map from list field name to an index remapping for elements within that field (using 1 as the first index).
+   * For example, {SensitiveDataProcessing: {1: 2, 2: [1, 3]}} means "rearrange SensitiveDataProcessing by moving
+   * the first element to the second position, and the second element to both the first and third position."
+   */
+  move?: { [name: string]: { [position: number]: number | number[] } };
+  /**
+   * an optional function to run once all the processing described above is complete;
+   * it's passed two arguments, the original (state) data, and its normalized (usnat) version.
+   */
+  fn?: (original, normalized) => any;
 }, fields = FIELDS) {
   move = Object.fromEntries(Object.entries(move).map(([k, map]) => [k,
     Object.fromEntries(Object.entries(map)
@@ -172,33 +172,33 @@ export const getSections = (() => {
 const handles = [];
 
 declare module './consentManagementGpp' {
-    interface GPPConfig {
-        mspa?: {
-            /**
-             * GPP SIDs that should be covered by activity restrictions. Defaults to all US state SIDs.
-             */
-            sids?: number[];
-            /**
-             * Map from section ID to per-section configuration options
-             */
-            sections?: {
-              [sid: number]: {
-                  /**
-                   * GPP API name to use for the section. Defaults to the names listed in the GPP spec:
-                   * https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/Section%20Information.md#section-ids
-                   * This option would only be used if your CMP has named their sections in a non-standard way.y
-                   */
-                  name?: string;
-                  /**
-                   * Normalize the flags for this section as if it were the number provided.
-                   * Cfr https://docs.prebid.org/features/mspa-usnat.html#interpreting-usnat-strings
-                   * Each section defaults to its own ID.
-                   */
-                  normalizeAs?: number;
-              }
-            }
+  interface GPPConfig {
+    mspa?: {
+      /**
+       * GPP SIDs that should be covered by activity restrictions. Defaults to all US state SIDs.
+       */
+      sids?: number[];
+      /**
+       * Map from section ID to per-section configuration options
+       */
+      sections?: {
+        [sid: number]: {
+          /**
+           * GPP API name to use for the section. Defaults to the names listed in the GPP spec:
+           * https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/Section%20Information.md#section-ids
+           * This option would only be used if your CMP has named their sections in a non-standard way.y
+           */
+          name?: string;
+          /**
+           * Normalize the flags for this section as if it were the number provided.
+           * Cfr https://docs.prebid.org/features/mspa-usnat.html#interpreting-usnat-strings
+           * Each section defaults to its own ID.
+           */
+          normalizeAs?: number;
         }
+      }
     }
+  }
 }
 
 config.getConfig('consentManagement', (cfg) => {

package/modules/gptPreAuction.ts

@@ -13,9 +13,9 @@ import {
   pick,
   uniques
 } from '../src/utils.js';
-import type {SlotMatchingFn} from "../src/targeting.ts";
-import type {AdUnitCode} from "../src/types/common.d.ts";
-import type {AdUnit} from "../src/adUnits.ts";
+import type {SlotMatchingFn} from '../src/targeting.ts';
+import type {AdUnitCode} from '../src/types/common.d.ts';
+import type {AdUnit} from '../src/adUnits.ts';
 
 const MODULE_NAME = 'GPT Pre-Auction';
 export let _currentConfig: any = {};
@@ -80,7 +80,7 @@ export const appendGptSlots = adUnits => {
 
   const adUnitPaths = {};
 
-  window.googletag.pubads().getSlots().forEach(slot => {
+  window.googletag.pubads().getSlots().forEach((slot: googletag.Slot) => {
     const matchingAdUnitCode = Object.keys(adUnitMap).find(customGptSlotMatching
       ? customGptSlotMatching(slot)
       : isAdUnitCodeMatchingSlot(slot));
@@ -116,7 +116,7 @@ const defaultPreAuction = (adUnit, adServerAdSlot, adUnitPath) => {
   }
 
   // find all GPT slots with this name
-  var gptSlots = window.googletag.pubads().getSlots().filter(slot => slot.getAdUnitPath() === adUnitPath);
+  var gptSlots = window.googletag.pubads().getSlots().filter((slot: googletag.Slot) => slot.getAdUnitPath() === adUnitPath);
 
   if (gptSlots.length === 0) {
     return; // should never happen
@@ -169,38 +169,38 @@ const setPpsConfigFromTargetingSet = (next, targetingSet) => {
 };
 
 type GPTPreAuctionConfig = {
-    /**
-     * allows turning off of module. Default value is true
-     */
-    enabled?: boolean;
-    /**
-     * If true, use default behavior for determining GPID and PbAdSlot. Defaults to false.
-     */
-    useDefaultPreAuction?: boolean;
-    customGptSlotMatching?: SlotMatchingFn;
-    /**
-     * @param adUnitCode Ad unit code
-     * @param adServerAdSlot The value of that ad unit's `ortb2Imp.ext.data.adserver.adslot`
-     * @returns pbadslot for the ad unit
-     */
-    customPbAdSlot?: (adUnitCode: AdUnitCode, adServerAdSlot: string) => string;
-    /**
-     * @param adUnit An ad unit object
-     * @param adServerAdSlot The value of that ad unit's `ortb2Imp.ext.data.adserver.adslot`
-     * @param gptAdUnitPath GPT ad unit path for the slot matching the PBJS ad unit
-     * @returns GPID for the ad unit
-     */
-    customPreAuction?: (adUnit: AdUnit, adServerAdSlot: string, gptAdUnitPath: string) => string;
-    /**
-     * Removes extra network IDs when Multiple Customer Management is active. Default is false.
-     */
-    mcmEnabled?: boolean;
+  /**
+   * allows turning off of module. Default value is true
+   */
+  enabled?: boolean;
+  /**
+   * If true, use default behavior for determining GPID and PbAdSlot. Defaults to false.
+   */
+  useDefaultPreAuction?: boolean;
+  customGptSlotMatching?: SlotMatchingFn;
+  /**
+   * @param adUnitCode Ad unit code
+   * @param adServerAdSlot The value of that ad unit's `ortb2Imp.ext.data.adserver.adslot`
+   * @returns pbadslot for the ad unit
+   */
+  customPbAdSlot?: (adUnitCode: AdUnitCode, adServerAdSlot: string) => string;
+  /**
+   * @param adUnit An ad unit object
+   * @param adServerAdSlot The value of that ad unit's `ortb2Imp.ext.data.adserver.adslot`
+   * @param gptAdUnitPath GPT ad unit path for the slot matching the PBJS ad unit
+   * @returns GPID for the ad unit
+   */
+  customPreAuction?: (adUnit: AdUnit, adServerAdSlot: string, gptAdUnitPath: string) => string;
+  /**
+   * Removes extra network IDs when Multiple Customer Management is active. Default is false.
+   */
+  mcmEnabled?: boolean;
 }
 
 declare module '../src/config' {
-    interface Config {
-        gptPreAuction?: GPTPreAuctionConfig;
-    }
+  interface Config {
+    gptPreAuction?: GPTPreAuctionConfig;
+  }
 }
 
 const handleSetGptConfig = moduleConfig => {

package/modules/iasRtdProvider.js

@@ -5,6 +5,7 @@ import {getGlobal} from '../src/prebidGlobal.js';
 import {getAdUnitSizes} from '../libraries/sizeUtils/sizeUtils.js';
 import {getGptSlotInfoForAdUnitCode} from '../libraries/gptUtils/gptUtils.js';
 
+import { mergeDeep } from '../src/utils.js';
 /**
  * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
  */
@@ -201,21 +202,103 @@ function isValidHttpUrl(string) {
   return url.protocol === 'http:' || url.protocol === 'https:';
 }
 
-export function getApiCallback() {
+/**
+ * Maps data using IAS_KEY_MAPPINGS
+ * @param {Object} data - The data to map
+ * @return {Object} The mapped data
+ */
+function mapIasData(data) {
+  const mappedData = {};
+
+  Object.entries(data).forEach(([key, value]) => {
+    if (IAS_KEY_MAPPINGS.hasOwnProperty(key)) {
+      mappedData[IAS_KEY_MAPPINGS[key]] = value;
+    }
+  });
+
+  return mappedData;
+}
+
+/**
+ * Inject brand safety data into ortb2Fragments
+ * @param {Object} brandSafetyData - The brand safety data
+ * @param {Object} ortb2Fragments - The ortb2 fragments object
+ */
+export function injectBrandSafetyData(brandSafetyData, ortb2Fragments, adUnits) {
+  if (!brandSafetyData || !ortb2Fragments?.global) return;
+
+  // Map the brand safety data
+  const mappedData = mapIasData(brandSafetyData);
+  if (Object.keys(mappedData).length === 0) return;
+
+  // Add to site.ext.data
+  mergeDeep(ortb2Fragments.global, { site: { ext: { data: mappedData } } });
+  // for nonstandard modules to use
+  mergeDeep(ortb2Fragments.global, { site: { ext: { data: { 'ias-brand-safety': mappedData } } } });
+}
+
+/**
+ * Inject slot-specific data into adUnits
+ * @param {Object} impressionData - The slots data
+ * @param {boolean} fraudData - The fraud data - boolean string value
+ * @param {Array} adUnits - The ad units array
+ */
+export function injectImpressionData(impressionData, fraudData, adUnits) {
+  if (!impressionData || !adUnits?.length) return;
+
+  adUnits.forEach(adUnit => {
+    const impressionDataForAdUnit = impressionData[adUnit.code];
+    if (!impressionDataForAdUnit) return;
+
+    const mappedImpressionData = mapIasData(impressionDataForAdUnit);
+    const mappedFraudData = mapIasData({ "fr": fraudData });
+
+    if (Object.keys(mappedImpressionData).length > 0) {
+      mergeDeep(adUnit, { ortb2Imp: { ext: { data: mappedImpressionData } } });
+    }
+    mergeDeep(adUnit, { ortb2Imp: { ext: { data: mappedFraudData } } });
+  });
+}
+
+/**
+ * Creates a callback for the IAS API response
+ * @param {Object} reqBidsConfigObj - The bid request config object
+ * @return {Object} The callback object
+ */
+export function getApiCallback(reqBidsConfigObj, callback) {
   return {
     success: function (response, req) {
       if (req.status === 200) {
         try {
           parseResponse(response);
+          const data = iasTargeting;
+          if (!data) {
+            utils.logInfo('IAS RTD: No data after parsing response');
+            callback();
+            return;
+          }
+
+          // 1. Inject page-level brand safety data
+          injectBrandSafetyData(data.brandSafety, reqBidsConfigObj.ortb2Fragments, reqBidsConfigObj.adUnits);
+
+          // 2. Inject impression-specific data
+          injectImpressionData(data.slots, data.fr, reqBidsConfigObj.adUnits);
+
+          callback();
         } catch (e) {
-          utils.logError('Unable to parse IAS response.', e);
+          utils.logError('Unable to parse IAS response', e);
+          callback();
         }
+      } else {
+        utils.logInfo('IAS RTD: Non-200 status code:', req.status);
+        callback();
       }
     },
     error: function () {
       utils.logError('failed to retrieve IAS data');
+      callback();
     }
-  }
+  };
 }
 
 function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
@@ -229,11 +312,10 @@ function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
   const queryString = constructQueryString(pubId, adUnits, pageUrl, adUnitPath);
   ajax(
     `${IAS_HOST}?${queryString}`,
-    getApiCallback(),
+    getApiCallback(reqBidsConfigObj, callback),
     undefined,
     { method: 'GET' }
   );
-  callback()
 }
 
 /** @type {RtdSubmodule} */

package/modules/intentIqAnalyticsAdapter.js

@@ -195,15 +195,15 @@ function bidWon(args, isReportExternal) {
 
 function parseReportingMethod(reportMethod) {
   if (typeof reportMethod === 'string') {
-      switch (reportMethod.toUpperCase()) {
-          case 'GET':
-              return 'GET';
-          case 'POST':
-              return 'POST';
-          default:
-              return 'GET';
-      }
+    switch (reportMethod.toUpperCase()) {
+      case 'GET':
+        return 'GET';
+      case 'POST':
+        return 'POST';
+      default:
+        return 'GET';
     }
+  }
   return 'GET';
 }
 

package/modules/intentIqIdSystem.js

@@ -140,8 +140,8 @@ function appendPartnersFirstParty (url, configParams) {
 
   if (partnerClientIdType === -1) return url;
   if (partnerClientId !== '') {
-      url = url + '&pcid=' + partnerClientId;
-      url = url + '&idtype=' + partnerClientIdType;
+    url = url + '&pcid=' + partnerClientId;
+    url = url + '&idtype=' + partnerClientIdType;
   }
   return url;
 }