prebid.js 8.4.0 → 8.6.0

package/modules/appnexusBidAdapter.js

@@ -788,7 +788,7 @@ function bidToTag(bid) {
     tag.keywords = auKeywords;
   }
 
-  let gpid = deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
+  let gpid = deepAccess(bid, 'ortb2Imp.ext.gpid') || deepAccess(bid, 'ortb2Imp.ext.data.pbadslot');
   if (gpid) {
     tag.gpid = gpid;
   }

package/modules/beachfrontBidAdapter.js

@@ -7,14 +7,15 @@ import {
   isFn,
   logWarn,
   parseSizesInput,
-  parseUrl
+  parseUrl,
+  formatQS
 } from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {Renderer} from '../src/Renderer.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {find, includes} from '../src/polyfill.js';
 
-const ADAPTER_VERSION = '1.19';
+const ADAPTER_VERSION = '1.20';
 const ADAPTER_NAME = 'BFIO_PREBID';
 const OUTSTREAM = 'outstream';
 const CURRENCY = 'USD';
@@ -22,6 +23,8 @@ const CURRENCY = 'USD';
 export const VIDEO_ENDPOINT = 'https://reachms.bfmio.com/bid.json?exchange_id=';
 export const BANNER_ENDPOINT = 'https://display.bfmio.com/prebid_display';
 export const OUTSTREAM_SRC = 'https://player-cdn.beachfrontmedia.com/playerapi/loader/outstream.js';
+export const SYNC_IFRAME_ENDPOINT = 'https://sync.bfmio.com/sync_iframe';
+export const SYNC_IMAGE_ENDPOINT = 'https://sync.bfmio.com/syncb';
 
 export const VIDEO_TARGETING = ['mimes', 'playbackmethod', 'maxduration', 'placement', 'skip', 'skipmin', 'skipafter'];
 export const DEFAULT_MIMES = ['video/mp4', 'application/javascript'];
@@ -152,11 +155,22 @@ export const spec = {
     }
   },
 
-  getUserSyncs(syncOptions, serverResponses = [], gdprConsent = {}, uspConsent = '') {
-    let syncs = [];
+  getUserSyncs(syncOptions, serverResponses = [], gdprConsent = {}, uspConsent = '', gppConsent = {}) {
     let { gdprApplies, consentString = '' } = gdprConsent;
+    let { gppString = '', applicableSections = [] } = gppConsent;
     let bannerResponse = find(serverResponses, (res) => isArray(res.body));
 
+    let syncs = [];
+    let params = {
+      id: appId,
+      gdpr: gdprApplies ? 1 : 0,
+      gc: consentString,
+      gce: 1,
+      us_privacy: uspConsent,
+      gpp: gppString,
+      gpp_sid: Array.isArray(applicableSections) ? applicableSections.join(',') : ''
+    };
+
     if (bannerResponse) {
       if (syncOptions.iframeEnabled) {
         bannerResponse.body
@@ -171,12 +185,12 @@ export const spec = {
     } else if (syncOptions.iframeEnabled) {
       syncs.push({
         type: 'iframe',
-        url: `https://sync.bfmio.com/sync_iframe?ifg=1&id=${appId}&gdpr=${gdprApplies ? 1 : 0}&gc=${consentString}&gce=1&us_privacy=${uspConsent}`
+        url: `${SYNC_IFRAME_ENDPOINT}?ifg=1&${formatQS(params)}`
       });
     } else if (syncOptions.pixelEnabled) {
       syncs.push({
         type: 'image',
-        url: `https://sync.bfmio.com/syncb?pid=144&id=${appId}&gdpr=${gdprApplies ? 1 : 0}&gc=${consentString}&gce=1&us_privacy=${uspConsent}`
+        url: `${SYNC_IMAGE_ENDPOINT}?pid=144&${formatQS(params)}`
       });
     }
 
@@ -404,6 +418,12 @@ function createVideoRequestData(bid, bidderRequest) {
     deepSetValue(payload, 'user.ext.consent', consentString);
   }
 
+  if (bidderRequest && bidderRequest.gppConsent) {
+    let { gppString, applicableSections } = bidderRequest.gppConsent;
+    deepSetValue(payload, 'regs.gpp', gppString);
+    deepSetValue(payload, 'regs.gpp_sid', applicableSections);
+  }
+
   if (bid.schain) {
     deepSetValue(payload, 'source.ext.schain', bid.schain);
   }
@@ -459,6 +479,12 @@ function createBannerRequestData(bids, bidderRequest) {
     payload.gdprConsent = consentString;
   }
 
+  if (bidderRequest && bidderRequest.gppConsent) {
+    let { gppString, applicableSections } = bidderRequest.gppConsent;
+    payload.gpp = gppString;
+    payload.gppSid = applicableSections;
+  }
+
   if (bids[0] && bids[0].schain) {
     payload.schain = bids[0].schain;
   }

package/modules/britepoolIdSystem.js

@@ -136,6 +136,12 @@ export const britepoolIdSubmodule = {
       }
     }
     return valueObj;
+  },
+  eids: {
+    'britepoolid': {
+      source: 'britepool.com',
+      atype: 3
+    },
   }
 };
 

package/modules/connectIdSystem.js

@@ -294,6 +294,12 @@ export const connectIdSubmodule = {
    */
   getAjaxFn() {
     return ajax;
+  },
+  eids: {
+    'connectId': {
+      source: 'yahoo.com',
+      atype: 3
+    },
   }
 };
 

package/modules/consentManagementGpp.js

@@ -71,11 +71,20 @@ export function lookupIabConsent({onSuccess, onError}, mkClient = cmpClient) {
     : 'Detected GPP CMP is outside the current iframe where Prebid.js is located, calling it now...';
   logInfo(startupMsg);
 
+  let versionMismatch = false;
+
   cmp({
     command: 'addEventListener',
     callback: function (evt) {
-      if (evt) {
+      if (evt && !versionMismatch) {
         logInfo(`Received a ${(cmp.isDirect ? 'direct' : 'postmsg')} response from GPP CMP for event`, evt);
+        const cmpVer = evt?.pingData?.gppVersion;
+        if (cmpVer != null && cmpVer !== '1.0') {
+          logWarn(`Unsupported GPP CMP version: ${cmpVer}. Continuing auction without consent`);
+          versionMismatch = true;
+          onSuccess(storeConsentData());
+          return;
+        }
         if (evt.eventName === 'sectionChange' || evt.pingData.cmpStatus === 'loaded') {
           cmp({command: 'getGPPData'}).then((gppData) => {
             logInfo(`Received a ${cmp.isDirect ? 'direct' : 'postmsg'} response from GPP CMP for getGPPData`, gppData);

package/modules/consumableBidAdapter.js

@@ -65,6 +65,11 @@ export const spec = {
       };
     }
 
+    if (bidderRequest && bidderRequest.gppConsent && bidderRequest.gppConsent.gppString) {
+      data.gpp = bidderRequest.gppConsent.gppString;
+      data.gpp_sid = bidderRequest.gppConsent.applicableSections;
+    }
+
     if (bidderRequest && bidderRequest.uspConsent) {
       data.ccpa = bidderRequest.uspConsent;
     }
@@ -180,7 +185,7 @@ export const spec = {
     return bidResponses;
   },
 
-  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) {
     let syncUrl = 'https://sync.serverbid.com/ss/' + siteId + '.html';
 
     if (syncOptions.iframeEnabled) {
@@ -191,6 +196,9 @@ export const spec = {
           syncUrl = appendUrlParam(syncUrl, `gdpr=0&gdpr_consent=${gdprConsent.consentString}`);
         }
       }
+      if (gppConsent && gppConsent.gppString) {
+        syncUrl = appendUrlParam(syncUrl, `gpp=${gppConsent.gppString}&gpp_sid=${gppConsent.applicableSections}`);
+      }
 
       if (uspConsent && uspConsent.consentString) {
         syncUrl = appendUrlParam(syncUrl, `us_privacy=${uspConsent.consentString}`);

package/modules/criteoBidAdapter.js

@@ -10,6 +10,7 @@ import { getRefererInfo } from '../src/refererDetection.js';
 import { hasPurpose1Consent } from '../src/utils/gpdr.js';
 import { Renderer } from '../src/Renderer.js';
 import { OUTSTREAM } from '../src/video.js';
+import { ajax } from '../src/ajax.js';
 
 const GVLID = 91;
 export const ADAPTER_VERSION = 36;
@@ -306,6 +307,23 @@ export const spec = {
       adapter.handleSetTargeting(bid);
     }
   },
+
+  /**
+   * @param {BidRequest[]} bidRequests
+   */
+  onDataDeletionRequest: (bidRequests) => {
+    const id = readFromAllStorages(BUNDLE_COOKIE_NAME);
+    if (id) {
+      deleteFromAllStorages(BUNDLE_COOKIE_NAME);
+    }
+    ajax('https://privacy.criteo.com/api/privacy/datadeletionrequest',
+      null,
+      JSON.stringify({ publisherUserId: id }),
+      {
+        contentType: 'application/json',
+        method: 'POST'
+      });
+  }
 };
 
 function readFromAllStorages(name) {

package/modules/criteoIdSystem.js

@@ -216,6 +216,12 @@ export const criteoIdSubmodule = {
       id: localData.bidId ? { criteoId: localData.bidId } : undefined,
       callback: result
     }
+  },
+  eids: {
+    'criteoId': {
+      source: 'criteo.com',
+      atype: 1
+    },
   }
 };
 

package/modules/cwireBidAdapter.js

@@ -2,6 +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';
 
 // ------------------------------------
 const BIDDER_CODE = 'cwire';
@@ -230,5 +231,23 @@ export const spec = {
     navigator.sendBeacon(EVENT_ENDPOINT, JSON.stringify(event))
   },
 
+  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
+    logInfo('Collecting user-syncs: ', JSON.stringify({syncOptions, gdprConsent, uspConsent, serverResponses}));
+
+    const syncs = []
+    if (hasPurpose1Consent(gdprConsent)) {
+      logInfo('GDPR purpose 1 consent was given, adding user-syncs')
+      let type = (syncOptions.pixelEnabled) ? 'image' : null ?? (syncOptions.iframeEnabled) ? 'iframe' : null
+      if (type) {
+        syncs.push({
+          type: type,
+          url: 'https://ib.adnxs.com/getuid?https://prebid.cwi.re/v1/cookiesync?xandrId=$UID'
+        })
+      }
+    }
+    logInfo('Collected user-syncs: ', JSON.stringify({syncs}))
+    return syncs
+  }
+
 };
 registerBidder(spec);

package/modules/czechAdIdSystem.js

@@ -42,6 +42,12 @@ export const czechAdIdSubmodule = {
   getId () {
     const id = readId()
     return id ? { id: id } : undefined
+  },
+  eids: {
+    'czechAdId': {
+      source: 'czechadid.cz',
+      atype: 1
+    },
   }
 }
 

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/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/growthCodeAnalyticsAdapter.js

@@ -30,8 +30,8 @@ let bidRequestTimeout = 0;
 let analyticsType = 'endpoint';
 
 let growthCodeAnalyticsAdapter = Object.assign(adapter({url: url, analyticsType}), {
-  track({eventType, eventData}) {
-    eventData = eventData ? JSON.parse(JSON.stringify(eventData)) : {};
+  track({eventType, args}) {
+    let eventData = args ? JSON.parse(JSON.stringify(args)) : {};
     let data = {};
     if (!trackEvents.includes(eventType)) return;
     switch (eventType) {
@@ -98,6 +98,11 @@ let growthCodeAnalyticsAdapter = Object.assign(adapter({url: url, analyticsType}
         break;
       }
 
+      case CONSTANTS.EVENTS.NO_BID: {
+        data = eventData
+        break;
+      }
+
       default:
         return;
     }

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);