prebid.js 8.3.0 → 8.5.0

package/modules/dacIdSystem.js

@@ -170,6 +170,12 @@ export const dacIdSystemSubmodule = {
     }
 
     return fetchAoneId(configParams.oid, cookie.fuuid);
+  },
+  eids: {
+    'dacId': {
+      source: 'impact-ad.jp',
+      atype: 1
+    },
   }
 };
 

package/modules/deepintentDpesIdSystem.js

@@ -39,8 +39,13 @@ export const deepintentDpesSubmodule = {
    */
   getId(config, consentData, cacheIdObj) {
     return cacheIdObj;
-  }
-
+  },
+  eids: {
+    'deepintentId': {
+      source: 'deepintent.com',
+      atype: 3
+    },
+  },
 };
 
 submodule('userId', deepintentDpesSubmodule);

package/modules/dmdIdSystem.js

@@ -85,6 +85,12 @@ export const dmdIdSubmodule = {
       };
       return { callback: resp };
     }
+  },
+  eids: {
+    'dmdId': {
+      source: 'hcn.health',
+      atype: 3
+    },
   }
 };
 

package/modules/euidIdSystem.js

@@ -103,6 +103,15 @@ export const euidIdSubmodule = {
     _logInfo(`EUID getId returned`, result);
     return result;
   },
+  eids: {
+    'euid': {
+      source: 'euid.eu',
+      atype: 3,
+      getValue: function(data) {
+        return data.id;
+      }
+    },
+  },
 };
 
 function decodeImpl(value) {

package/modules/fabrickIdSystem.js

@@ -117,6 +117,12 @@ export const fabrickIdSubmodule = {
     } catch (e) {
       logError(`fabrickIdSystem encountered an error`, e);
     }
+  },
+  eids: {
+    'fabrickId': {
+      source: 'neustar.biz',
+      atype: 1
+    },
   }
 };
 

package/modules/ftrackIdSystem.js

@@ -221,6 +221,22 @@ export const ftrackIdSubmodule = {
     if (usPrivacyVersion == 1 && usPrivacyOptOutSale === 'Y') consentValue = false;
 
     return consentValue;
+  },
+  eids: {
+    'ftrackId': {
+      source: 'flashtalking.com',
+      atype: 1,
+      getValue: function(data) {
+        let value = '';
+        if (data && data.ext && data.ext.DeviceID) {
+          value = data.ext.DeviceID;
+        }
+        return value;
+      },
+      getUidExt: function(data) {
+        return data && data.ext;
+      }
+    },
   }
 };
 

package/modules/gdprEnforcement.js

@@ -24,18 +24,19 @@ import {
 import {registerActivityControl} from '../src/activities/rules.js';
 import {
   ACTIVITY_ACCESS_DEVICE,
-  ACTIVITY_ENRICH_EIDS,
+  ACTIVITY_ENRICH_EIDS, ACTIVITY_ENRICH_UFPD,
   ACTIVITY_FETCH_BIDS,
   ACTIVITY_REPORT_ANALYTICS,
-  ACTIVITY_SYNC_USER
+  ACTIVITY_SYNC_USER, ACTIVITY_TRANSMIT_UFPD
 } from '../src/activities/activities.js';
 
 export const STRICT_STORAGE_ENFORCEMENT = 'strictStorageEnforcement';
 
 const TCF2 = {
-  'purpose1': {id: 1, name: 'storage'},
-  'purpose2': {id: 2, name: 'basicAds'},
-  'purpose7': {id: 7, name: 'measurement'}
+  purpose1: {id: 1, name: 'storage'},
+  purpose2: {id: 2, name: 'basicAds'},
+  purpose4: {id: 4, name: 'personalizedAds'},
+  purpose7: {id: 7, name: 'measurement'},
 };
 
 /*
@@ -55,6 +56,7 @@ const DEFAULT_RULES = [{
 
 export let purpose1Rule;
 export let purpose2Rule;
+export let purpose4Rule;
 export let purpose7Rule;
 
 export let enforcementRules;
@@ -62,6 +64,7 @@ export let enforcementRules;
 const storageBlocked = new Set();
 const biddersBlocked = new Set();
 const analyticsBlocked = new Set();
+const ufpdBlocked = new Set();
 
 let hooksAdded = false;
 let strictStorageEnforcement = false;
@@ -232,6 +235,8 @@ export const fetchBidsRule = ((rule) => {
 
 export const reportAnalyticsRule = gdprRule(7, () => purpose7Rule, analyticsBlocked, (params) => getGvlidFromAnalyticsAdapter(params[ACTIVITY_PARAM_COMPONENT_NAME], params[ACTIVITY_PARAM_ANL_CONFIG]));
 
+export const ufpdRule = gdprRule(4, () => purpose4Rule, ufpdBlocked);
+
 /**
  * Compiles the TCF2.0 enforcement results into an object, which is emitted as an event payload to "tcf2Enforcement" event.
  */
@@ -243,27 +248,20 @@ function emitTCF2FinalResults() {
   const tcf2FinalResults = {
     storageBlocked: formatSet(storageBlocked),
     biddersBlocked: formatSet(biddersBlocked),
-    analyticsBlocked: formatSet(analyticsBlocked)
+    analyticsBlocked: formatSet(analyticsBlocked),
+    ufpdBlocked: formatSet(ufpdBlocked),
   };
 
   events.emit(CONSTANTS.EVENTS.TCF2_ENFORCEMENT, tcf2FinalResults);
-  [storageBlocked, biddersBlocked, analyticsBlocked].forEach(el => el.clear());
+  [storageBlocked, biddersBlocked, analyticsBlocked, ufpdBlocked].forEach(el => el.clear());
 }
 
 events.on(CONSTANTS.EVENTS.AUCTION_END, emitTCF2FinalResults);
 
-/*
-  Set of callback functions used to detect presence of a TCF rule, passed as the second argument to find().
-*/
-const hasPurpose1 = (rule) => {
-  return rule.purpose === TCF2.purpose1.name;
-};
-const hasPurpose2 = (rule) => {
-  return rule.purpose === TCF2.purpose2.name;
-};
-const hasPurpose7 = (rule) => {
-  return rule.purpose === TCF2.purpose7.name;
-};
+function hasPurpose(purposeNo) {
+  const pname = TCF2[`purpose${purposeNo}`].name;
+  return (rule) => rule.purpose === pname;
+}
 
 /**
  * A configuration function that initializes some module variables, as well as adds hooks
@@ -279,9 +277,10 @@ export function setEnforcementConfig(config) {
   }
   strictStorageEnforcement = !!deepAccess(config, STRICT_STORAGE_ENFORCEMENT);
 
-  purpose1Rule = find(enforcementRules, hasPurpose1);
-  purpose2Rule = find(enforcementRules, hasPurpose2);
-  purpose7Rule = find(enforcementRules, hasPurpose7);
+  purpose1Rule = find(enforcementRules, hasPurpose(1));
+  purpose2Rule = find(enforcementRules, hasPurpose(2));
+  purpose4Rule = find(enforcementRules, hasPurpose(4))
+  purpose7Rule = find(enforcementRules, hasPurpose(7));
 
   if (!purpose1Rule) {
     purpose1Rule = DEFAULT_RULES[0];
@@ -301,6 +300,12 @@ export function setEnforcementConfig(config) {
     if (purpose2Rule) {
       RULE_HANDLES.push(registerActivityControl(ACTIVITY_FETCH_BIDS, RULE_NAME, fetchBidsRule));
     }
+    if (purpose4Rule) {
+      RULE_HANDLES.push(
+        registerActivityControl(ACTIVITY_TRANSMIT_UFPD, RULE_NAME, ufpdRule),
+        registerActivityControl(ACTIVITY_ENRICH_UFPD, RULE_NAME, ufpdRule)
+      );
+    }
     if (purpose7Rule) {
       RULE_HANDLES.push(registerActivityControl(ACTIVITY_REPORT_ANALYTICS, RULE_NAME, reportAnalyticsRule));
     }

package/modules/geolocationRtdProvider.js

@@ -0,0 +1,65 @@
+import {submodule} from '../src/hook.js';
+import {isFn, logError, deepAccess, deepSetValue, logInfo, logWarn} from '../src/utils.js';
+import { ACTIVITY_TRANSMIT_PRECISE_GEO } from '../src/activities/activities.js';
+import { MODULE_TYPE_RTD } from '../src/activities/modules.js';
+import { isActivityAllowed } from '../src/activities/rules.js';
+import { activityParams } from '../src/activities/activityParams.js';
+
+let permissionsAvailable = true;
+let geolocation;
+function getGeolocationData(requestBidsObject, onDone, providerConfig, userConsent) {
+  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;
+  const waitForIt = providerConfig.waitForIt;
+  navigator.permissions.query({
+    name: 'geolocation',
+  }).then(permission => {
+    if (permission.state !== 'granted' && !requestPermission) return complete();
+    navigator.geolocation.getCurrentPosition(geo => {
+      geolocation = geo;
+      complete();
+    });
+  });
+  if (!waitForIt) 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: geolocation.timestamp,
+        type: 1
+      });
+      logInfo('geolocation was successfully received ', requestBidsObject.ortb2Fragments.global.device.geo)
+    }
+    onDone();
+  }
+}
+function init(moduleConfig) {
+  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;
+}
+export const geolocationSubmodule = {
+  name: 'geolocation',
+  getBidRequestData: getGeolocationData,
+  init: init,
+};
+function registerSubModule() {
+  submodule('realTimeData', geolocationSubmodule);
+}
+registerSubModule();

package/modules/gravitoIdSystem.js

@@ -53,6 +53,12 @@ export const gravitoIdSystemSubmodule = {
     }
     return undefined;
   },
+  eids: {
+    'gravitompId': {
+      source: 'gravito.net',
+      atype: 1
+    },
+  }
 }
 
 submodule('userId', gravitoIdSystemSubmodule);

package/modules/greenbidsRtdProvider.js

@@ -4,7 +4,7 @@ import { submodule } from '../src/hook.js';
 
 const MODULE_NAME = 'greenbidsRtdProvider';
 const MODULE_VERSION = '1.0.0';
-const ENDPOINT = 'https://europe-west1-greenbids-357713.cloudfunctions.net/partner-selection';
+const ENDPOINT = 'https://t.greenbids.ai';
 
 const auctionInfo = {};
 const rtdOptions = {};

package/modules/gridBidAdapter.js

@@ -9,6 +9,7 @@ import {
   isNumber,
   isStr
 } from '../src/utils.js';
+import { ajax } from '../src/ajax.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
@@ -17,6 +18,7 @@ import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'grid';
 const ENDPOINT_URL = 'https://grid.bidswitch.net/hbjson';
+const USP_DELETE_DATA_HANDLER = 'https://media.grid.bidswitch.net/uspapi_delete'
 
 const SYNC_URL = 'https://x.bidswitch.net/sync?ssp=themediagrid';
 const TIME_TO_LIVE = 360;
@@ -462,6 +464,23 @@ export const spec = {
         url: syncUrl + params
       };
     }
+  },
+
+  ajaxCall: function(url, cb, data, options) {
+    return ajax(url, cb, data, options);
+  },
+
+  onDataDeletionRequest: function(data) {
+    const uids = [];
+    const aliases = [spec.code, ...spec.aliases.map((alias) => alias.code || alias)];
+    data.forEach(({ bids }) => bids && bids.forEach(({ bidder, params }) => {
+      if (aliases.includes(bidder) && params && params.uid) {
+        uids.push(params.uid);
+      }
+    }));
+    if (uids.length) {
+      spec.ajaxCall(USP_DELETE_DATA_HANDLER, () => {}, JSON.stringify({ uids }), {contentType: 'application/json', method: 'POST'});
+    }
   }
 };
 

package/modules/growthCodeIdSystem.js

@@ -5,7 +5,7 @@
  * @requires module:modules/userId
  */
 
-import {logError, logInfo, tryAppendQueryString} from '../src/utils.js';
+import {logError, logInfo, pick, tryAppendQueryString} from '../src/utils.js';
 import {ajax} from '../src/ajax.js';
 import { submodule } from '../src/hook.js'
 import {getStorageManager} from '../src/storageManager.js';
@@ -166,6 +166,25 @@ export const growthCodeIdSubmodule = {
       }
     };
     return { callback: resp };
+  },
+  eids: {
+    'growthCodeId': {
+      getValue: function(data) {
+        return data.gc_id
+      },
+      source: 'growthcode.io',
+      atype: 1,
+      getUidExt: function(data) {
+        const extendedData = pick(data, [
+          'h1',
+          'h2',
+          'h3',
+        ]);
+        if (Object.keys(extendedData).length) {
+          return extendedData;
+        }
+      }
+    },
   }
 };
 

package/modules/hadronIdSystem.js

@@ -110,6 +110,12 @@ export const hadronIdSubmodule = {
       ajax(url, callbacks, undefined, {method: 'GET'});
     };
     return {callback: resp};
+  },
+  eids: {
+    'hadronId': {
+      source: 'audigent.com',
+      atype: 1
+    },
   }
 };
 

package/modules/id5IdSystem.js

@@ -108,7 +108,7 @@ export const id5IdSubmodule = {
    * @returns {IdResponse|undefined}
    */
   getId(submoduleConfig, consentData, cacheIdObj) {
-    if (!hasRequiredConfig(submoduleConfig)) {
+    if (!validateConfig(submoduleConfig)) {
       return undefined;
     }
 
@@ -142,19 +142,31 @@ export const id5IdSubmodule = {
    * @return {(IdResponse|function(callback:function))} A response object that contains id and/or callback.
    */
   extendId(config, consentData, cacheIdObj) {
-    hasRequiredConfig(config);
-
     if (!hasWriteConsentToLocalStorage(consentData)) {
       logInfo(LOG_PREFIX + 'No consent given for ID5 local storage writing, skipping nb increment.')
       return cacheIdObj;
     }
 
-    const partnerId = (config && config.params && config.params.partner) || 0;
+    const partnerId = validateConfig(config) ? config.params.partner : 0;
     incrementNb(partnerId);
 
     logInfo(LOG_PREFIX + 'using cached ID', cacheIdObj);
     return cacheIdObj;
-  }
+  },
+  eids: {
+    'id5id': {
+      getValue: function(data) {
+        return data.uid
+      },
+      source: 'id5-sync.com',
+      atype: 1,
+      getUidExt: function(data) {
+        if (data.ext) {
+          return data.ext;
+        }
+      }
+    },
+  },
 };
 
 class IdFetchFlow {
@@ -293,9 +305,23 @@ class IdFetchFlow {
   }
 }
 
-function hasRequiredConfig(config) {
-  if (!config || !config.params || !config.params.partner || typeof config.params.partner !== 'number') {
-    logError(LOG_PREFIX + 'partner required to be defined as a number');
+function validateConfig(config) {
+  if (!config || !config.params || !config.params.partner) {
+    logError(LOG_PREFIX + 'partner required to be defined');
+    return false;
+  }
+
+  const partner = config.params.partner
+  if (typeof partner === 'string' || partner instanceof String) {
+    let parsedPartnerId = parseInt(partner);
+    if (isNaN(parsedPartnerId) || parsedPartnerId < 0) {
+      logError(LOG_PREFIX + 'partner required to be a number or a String parsable to a positive integer');
+      return false;
+    } else {
+      config.params.partner = parsedPartnerId;
+    }
+  } else if (typeof partner !== 'number') {
+    logError(LOG_PREFIX + 'partner required to be a number or a String parsable to a positive integer');
     return false;
   }
 

package/modules/identityLinkIdSystem.js

@@ -79,6 +79,12 @@ export const identityLinkSubmodule = {
     };
 
     return { callback: resp };
+  },
+  eids: {
+    'idl_env': {
+      source: 'liveramp.com',
+      atype: 3
+    },
   }
 };
 // return envelope from third party endpoint

package/modules/idxIdSystem.js

@@ -57,6 +57,12 @@ export const idxIdSubmodule = {
       }
     }
     return undefined;
+  },
+  eids: {
+    'idx': {
+      source: 'idx.lat',
+      atype: 1
+    },
   }
 };
 submodule('userId', idxIdSubmodule);

package/modules/imdsBidAdapter.js

@@ -1,6 +1,6 @@
 'use strict';
 
-import {deepAccess, deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn} from '../src/utils.js';
+import {deepAccess, deepSetValue, getAdUnitSizes, isFn, isPlainObject, logWarn, mergeDeep} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {includes} from '../src/polyfill.js';
@@ -8,7 +8,8 @@ import {config} from '../src/config.js';
 
 const BID_SCHEME = 'https://';
 const BID_DOMAIN = 'technoratimedia.com';
-const USER_SYNC_HOST = 'https://ad-cdn.technoratimedia.com';
+const USER_SYNC_IFRAME_URL = 'https://ad-cdn.technoratimedia.com/html/usersync.html';
+const USER_SYNC_PIXEL_URL = 'https://sync.technoratimedia.com/services';
 const VIDEO_PARAMS = [ 'minduration', 'maxduration', 'startdelay', 'placement', 'linearity', 'mimes', 'protocols', 'api' ];
 const BLOCKED_AD_SIZES = [
   '1x1',
@@ -38,11 +39,11 @@ export const spec = {
       return;
     }
     const refererInfo = bidderRequest.refererInfo;
-    const openRtbBidRequest = {
+    // start with some defaults, overridden by anything set in ortb2, if provided.
+    const openRtbBidRequest = mergeDeep({
       id: bidderRequest.bidderRequestId,
       site: {
-        // TODO: does the fallback make sense here?
-        domain: refererInfo.domain || location.hostname,
+        domain: refererInfo.domain,
         page: refererInfo.page,
         ref: refererInfo.ref
       },
@@ -50,7 +51,7 @@ export const spec = {
         ua: navigator.userAgent
       },
       imp: []
-    };
+    }, bidderRequest.ortb2 || {});
 
     const tmax = bidderRequest.timeout;
     if (tmax) {
@@ -101,9 +102,17 @@ export const spec = {
       }
     });
 
-    // CCPA
-    if (bidderRequest.uspConsent) {
-      deepSetValue(openRtbBidRequest, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+    // Move us_privacy from regs.ext to regs if there isn't already a us_privacy in regs
+    if (openRtbBidRequest.regs?.ext?.us_privacy && !openRtbBidRequest.regs?.us_privacy) {
+      deepSetValue(openRtbBidRequest, 'regs.us_privacy', openRtbBidRequest.regs.ext.us_privacy);
+    }
+
+    // Remove regs.ext.us_privacy
+    if (openRtbBidRequest.regs?.ext?.us_privacy) {
+      delete openRtbBidRequest.regs.ext.us_privacy;
+      if (Object.keys(openRtbBidRequest.regs.ext).length < 1) {
+        delete openRtbBidRequest.regs.ext;
+      }
     }
 
     // User ID
@@ -117,7 +126,7 @@ export const spec = {
     if (openRtbBidRequest.imp.length && seatId) {
       return {
         method: 'POST',
-        url: `${BID_SCHEME}${seatId}.${BID_DOMAIN}/openrtb/bids/${seatId}?src=$$REPO_AND_VERSION$$`,
+        url: `${BID_SCHEME}${seatId}.${BID_DOMAIN}/openrtb/bids/${seatId}?src=pbjs%2F$prebid.version$`,
         data: openRtbBidRequest,
         options: {
           contentType: 'application/json',
@@ -294,16 +303,31 @@ export const spec = {
     }
     return bids;
   },
-  getUserSyncs: function (syncOptions, serverResponses) {
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) {
     const syncs = [];
+    const queryParams = ['src=pbjs%2F$prebid.version$'];
+    if (gdprConsent) {
+      queryParams.push(`gdpr=${Number(gdprConsent.gdprApplies && 1)}&consent=${encodeURIComponent(gdprConsent.consentString || '')}`);
+    }
+    if (uspConsent) {
+      queryParams.push('us_privacy=' + encodeURIComponent(uspConsent));
+    }
+    if (gppConsent) {
+      queryParams.push('gpp=' + encodeURIComponent(gppConsent.gppString || '') + '&gppsid=' + encodeURIComponent((gppConsent.applicableSections || []).join(',')));
+    }
+
     if (syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: `${USER_SYNC_HOST}/html/usersync.html?src=$$REPO_AND_VERSION$$`
+        url: `${USER_SYNC_IFRAME_URL}?${queryParams.join('&')}`
+      });
+    } else if (syncOptions.pixelEnabled) {
+      syncs.push({
+        type: 'pixel',
+        url: `${USER_SYNC_PIXEL_URL}?srv=cs&${queryParams.join('&')}`
       });
-    } else {
-      logWarn('IMDS: Please enable iframe based user sync.');
     }
+
     return syncs;
   }
 };

package/modules/imuIdSystem.js

@@ -160,6 +160,16 @@ export const imuIdSubmodule = {
         imppid: localData.ppid
       }
     };
+  },
+  eids: {
+    'imppid': {
+      source: 'ppid.intimatemerger.com',
+      atype: 1
+    },
+    'imuid': {
+      source: 'intimatemerger.com',
+      atype: 1
+    },
   }
 };
 

package/modules/intentIqIdSystem.js

@@ -193,6 +193,12 @@ export const intentIqIdSubmodule = {
       }
     };
     return { callback: resp };
+  },
+  eids: {
+    'intentIqId': {
+      source: 'intentiq.com',
+      atype: 1
+    },
   }
 };
 

package/modules/invibesBidAdapter.js

@@ -1,4 +1,4 @@
-import { logInfo } from '../src/utils.js';
+import {logInfo} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
 
@@ -9,7 +9,7 @@ const CONSTANTS = {
   SYNC_ENDPOINT: 'https://k.r66net.com/GetUserSync',
   TIME_TO_LIVE: 300,
   DEFAULT_CURRENCY: 'EUR',
-  PREBID_VERSION: 9,
+  PREBID_VERSION: 10,
   METHOD: 'GET',
   INVIBES_VENDOR_ID: 436,
   USERID_PROVIDERS: ['pubcid', 'pubProvidedId', 'uid2', 'zeotapIdPlus', 'id5id'],
@@ -116,7 +116,7 @@ function buildRequest(bidRequests, bidderRequest) {
     bidParamsJson.userId = userIdModel;
   }
   let data = {
-    location: getDocumentLocation(topWin),
+    location: getDocumentLocation(bidderRequest),
     videoAdHtmlId: generateRandomId(),
     showFallback: currentQueryStringParams['advs'] === '0',
     ivbsCampIdsLocal: readFromLocalStorage('IvbsCampIdsLocal'),
@@ -371,8 +371,8 @@ function generateRandomId() {
   return (Math.round(Math.random() * 1e12)).toString(36).substring(0, 10);
 }
 
-function getDocumentLocation(topWin) {
-  return topWin.location.href.substring(0, 300).split(/[?#]/)[0];
+function getDocumentLocation(bidderRequest) {
+  return bidderRequest.refererInfo.page.substring(0, 300);
 }
 
 function getUserIds(bidUserId) {