prebid.js 8.4.0 → 8.6.0

package/modules/userId/eids.js

@@ -1,450 +1,10 @@
-import { pick, isFn, isStr, isPlainObject, deepAccess } from '../../src/utils.js';
+import {deepAccess, isFn, isPlainObject, isStr} from '../../src/utils.js';
 
-// Each user-id sub-module is expected to mention respective config here
-export const USER_IDS_CONFIG = {
-
-  // key-name : {config}
-
-  // GrowthCode
-  '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;
-      }
-    }
-  },
-
-  // utiq
-  'utiq': {
-    source: 'utiq.com',
-    atype: 1,
-    getValue: function (data) {
-      return data;
-    },
-  },
-
-  // intentIqId
-  'intentIqId': {
-    source: 'intentiq.com',
-    atype: 1
-  },
-
-  // naveggId
-  'naveggId': {
-    source: 'navegg.com',
-    atype: 1
-  },
-
-  // pairId
-  'pairId': {
-    source: 'google.com',
-    atype: 571187
-  },
-
-  // justId
-  'justId': {
-    source: 'justtag.com',
-    atype: 1
-  },
-
-  // pubCommonId
-  'pubcid': {
-    source: 'pubcid.org',
-    atype: 1
-  },
-
-  // unifiedId
-  'tdid': {
-    source: 'adserver.org',
-    atype: 1,
-    getUidExt: function() {
-      return {
-        rtiPartner: 'TDID'
-      };
-    }
-  },
-
-  // id5Id
-  'id5id': {
-    getValue: function(data) {
-      return data.uid
-    },
-    source: 'id5-sync.com',
-    atype: 1,
-    getUidExt: function(data) {
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  // ftrack
-  '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;
-    }
-  },
-
-  // parrableId
-  'parrableId': {
-    source: 'parrable.com',
-    atype: 1,
-    getValue: function(parrableId) {
-      if (parrableId.eid) {
-        return parrableId.eid;
-      }
-      if (parrableId.ccpaOptout) {
-        // If the EID was suppressed due to a non consenting ccpa optout then
-        // we still wish to provide this as a reason to the adapters
-        return '';
-      }
-      return null;
-    },
-    getUidExt: function(parrableId) {
-      const extendedData = pick(parrableId, [
-        'ibaOptout',
-        'ccpaOptout'
-      ]);
-      if (Object.keys(extendedData).length) {
-        return extendedData;
-      }
-    }
-  },
-
-  // identityLink
-  'idl_env': {
-    source: 'liveramp.com',
-    atype: 3
-  },
-
-  // liveIntentId
-  'lipb': {
-    getValue: function(data) {
-      return data.lipbid;
-    },
-    source: 'liveintent.com',
-    atype: 3,
-    getEidExt: function(data) {
-      if (Array.isArray(data.segments) && data.segments.length) {
-        return {
-          segments: data.segments
-        };
-      }
-    }
-  },
-
-  // bidswitchId
-  'bidswitch': {
-    source: 'bidswitch.net',
-    atype: 3,
-    getValue: function(data) {
-      return data.id;
-    },
-    getUidExt: function(data) {
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  // medianetId
-  'medianet': {
-    source: 'media.net',
-    atype: 3,
-    getValue: function(data) {
-      return data.id;
-    },
-    getUidExt: function(data) {
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  // magnite
-  'magnite': {
-    source: 'rubiconproject.com',
-    atype: 3,
-    getValue: function(data) {
-      return data.id;
-    },
-    getUidExt: function(data) {
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  // britepoolId
-  'britepoolid': {
-    source: 'britepool.com',
-    atype: 3
-  },
-
-  // dmdId
-  'dmdId': {
-    source: 'hcn.health',
-    atype: 3
-  },
-
-  // lotamePanoramaId
-  lotamePanoramaId: {
-    source: 'crwdcntrl.net',
-    atype: 1,
-  },
-
-  // criteo
-  'criteoId': {
-    source: 'criteo.com',
-    atype: 1
-  },
-
-  // merkleId
-  'merkleId': {
-    atype: 3,
-    getSource: function(data) {
-      if (data?.ext?.ssp) {
-        return `${data.ext.ssp}.merkleinc.com`
-      }
-      return 'merkleinc.com'
-    },
-    getValue: function(data) {
-      return data.id;
-    },
-    getUidExt: function(data) {
-      if (data.keyID) {
-        return {
-          keyID: data.keyID
-        }
-      }
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  // NetId
-  'netId': {
-    source: 'netid.de',
-    atype: 1
-  },
-
-  // zeotapIdPlus
-  'IDP': {
-    source: 'zeotap.com',
-    atype: 1
-  },
-
-  // hadronId
-  'hadronId': {
-    source: 'audigent.com',
-    atype: 1
-  },
-
-  // quantcastId
-  'quantcastId': {
-    source: 'quantcast.com',
-    atype: 1
-  },
-
-  // IDx
-  'idx': {
-    source: 'idx.lat',
-    atype: 1
-  },
-
-  // Verizon Media ConnectID
-  'connectid': {
-    source: 'verizonmedia.com',
-    atype: 3
-  },
-
-  // Neustar Fabrick
-  'fabrickId': {
-    source: 'neustar.biz',
-    atype: 1
-  },
-
-  // MediaWallah OpenLink
-  'mwOpenLinkId': {
-    source: 'mediawallahscript.com',
-    atype: 1
-  },
-
-  'tapadId': {
-    source: 'tapad.com',
-    atype: 1
-  },
-
-  // Novatiq Snowflake
-  'novatiq': {
-    getValue: function(data) {
-      if (data.snowflake.id === undefined) {
-        return data.snowflake;
-      }
-
-      return data.snowflake.id;
-    },
-    source: 'novatiq.com',
-  },
-
-  'uid2': {
-    source: 'uidapi.com',
-    atype: 3,
-    getValue: function(data) {
-      return data.id;
-    },
-    getUidExt: function(data) {
-      if (data.ext) {
-        return data.ext;
-      }
-    }
-  },
-
-  'euid': {
-    source: 'euid.eu',
-    atype: 3,
-    getValue: function(data) {
-      return data.id;
-    }
-  },
-
-  'deepintentId': {
-    source: 'deepintent.com',
-    atype: 3
-  },
-
-  // Admixer Id
-  'admixerId': {
-    source: 'admixer.net',
-    atype: 3
-  },
-
-  // Adtelligent Id
-  'adtelligentId': {
-    source: 'adtelligent.com',
-    atype: 3
-  },
-
-  amxId: {
-    source: 'amxdt.net',
-    atype: 1,
-  },
-
-  'publinkId': {
-    source: 'epsilon.com',
-    atype: 3
-  },
-
-  'kpuid': {
-    source: 'kpuid.com',
-    atype: 3
-  },
-
-  'imppid': {
-    source: 'ppid.intimatemerger.com',
-    atype: 1
-  },
-
-  'imuid': {
-    source: 'intimatemerger.com',
-    atype: 1
-  },
-
-  // Yahoo ConnectID
-  'connectId': {
-    source: 'yahoo.com',
-    atype: 3
-  },
-
-  // Adquery ID
-  'qid': {
-    source: 'adquery.io',
-    atype: 1
-  },
-
-  // DAC ID
-  'dacId': {
-    source: 'impact-ad.jp',
-    atype: 1
-  },
-
-  // 33across ID
-  '33acrossId': {
-    source: '33across.com',
-    atype: 1,
-    getValue: function(data) {
-      return data.envelope;
-    }
-  },
-
-  // tncId
-  'tncid': {
-    source: 'thenewco.it',
-    atype: 3
-  },
-
-  // Gravito MP ID
-  'gravitompId': {
-    source: 'gravito.net',
-    atype: 1
-  },
-
-  // czechAdId
-  'czechAdId': {
-    source: 'czechadid.cz',
-    atype: 1
-  },
-
-  // OneKey Data
-  'oneKeyData': {
-    getValue: function(data) {
-      if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
-        return data.identifiers[0].value;
-      }
-    },
-    source: 'paf',
-    atype: 1,
-    getEidExt: function(data) {
-      if (data && data.preferences) {
-        return {preferences: data.preferences};
-      }
-    },
-    getUidExt: function(data) {
-      if (data && Array.isArray(data.identifiers) && data.identifiers[0]) {
-        const id = data.identifiers[0];
-        return {
-          version: id.version,
-          type: id.type,
-          source: id.source
-        };
-      }
-    }
-  }
-};
+export const EID_CONFIG = new Map();
 
 // this function will create an eid object for the given UserId sub-module
 function createEidObject(userIdData, subModuleKey) {
-  const conf = USER_IDS_CONFIG[subModuleKey];
+  const conf = EID_CONFIG.get(subModuleKey);
   if (conf && userIdData) {
     let eid = {};
     eid.source = isFn(conf['getSource']) ? conf['getSource'](userIdData) : conf['source'];
@@ -510,11 +70,12 @@ export function buildEidPermissions(submodules) {
   submodules.filter(i => isPlainObject(i.idObj) && Object.keys(i.idObj).length)
     .forEach(i => {
       Object.keys(i.idObj).forEach(key => {
+        const eidConf = EID_CONFIG.get(key) || {};
         if (deepAccess(i, 'config.bidders') && Array.isArray(i.config.bidders) &&
-          deepAccess(USER_IDS_CONFIG, key + '.source')) {
+          eidConf.source) {
           eidPermissions.push(
             {
-              source: USER_IDS_CONFIG[key].source,
+              source: eidConf.source,
               bidders: i.config.bidders
             }
           );

package/modules/userId/index.js

@@ -133,7 +133,7 @@ import {getGlobal} from '../../src/prebidGlobal.js';
 import adapterManager, {gdprDataHandler, gppDataHandler} from '../../src/adapterManager.js';
 import CONSTANTS from '../../src/constants.json';
 import {module, ready as hooksReady} from '../../src/hook.js';
-import {buildEidPermissions, createEidsArray, USER_IDS_CONFIG} from './eids.js';
+import {buildEidPermissions, createEidsArray, EID_CONFIG} from './eids.js';
 import {
   getCoreStorageManager,
   getStorageManager,
@@ -232,6 +232,7 @@ function submoduleMetrics(moduleName) {
 /** @param {Submodule[]} submodules */
 export function setSubmoduleRegistry(submodules) {
   submoduleRegistry = submodules;
+  updateEIDConfig(submodules);
 }
 
 function cookieSetter(submodule, storageMgr) {
@@ -465,7 +466,7 @@ function getSubmoduleId(submodules, sourceName) {
 
   const prioritisedIds = getPrioritizedCombinedSubmoduleIds(submodules);
   const eligibleIdName = Object.keys(prioritisedIds).find(idName => {
-    const config = USER_IDS_CONFIG[idName];
+    const config = EID_CONFIG.get(idName);
     return config?.source === sourceName || (isFn(config?.getSource) && config.getSource() === sourceName);
   });
 
@@ -487,32 +488,33 @@ function getCombinedSubmoduleIdsForBidder(submodules, bidder) {
   return getPrioritizedCombinedSubmoduleIds(eligibleSubmodules);
 }
 
+function collectByPriority(submodules, getIds, getName) {
+  return Object.fromEntries(Object.entries(submodules.reduce((carry, submod) => {
+    const ids = getIds(submod);
+    ids && Object.keys(ids).forEach(key => {
+      const maybeCurrentIdPriority = idPriority[key]?.indexOf(getName(submod));
+      const currentIdPriority = isNumber(maybeCurrentIdPriority) ? maybeCurrentIdPriority : -1;
+      const currentIdState = {priority: currentIdPriority, value: ids[key]};
+      if (carry[key]) {
+        const winnerIdState = currentIdState.priority > carry[key].priority ? currentIdState : carry[key];
+        carry[key] = winnerIdState;
+      } else {
+        carry[key] = currentIdState;
+      }
+    });
+    return carry;
+  }, {})).map(([k, v]) => [k, v.value]));
+}
+
 /**
  * @param {SubmoduleContainer[]} submodules
  */
 function getPrioritizedCombinedSubmoduleIds(submodules) {
-  const combinedIdStates = submodules
-    .filter(i => isPlainObject(i.idObj) && Object.keys(i.idObj).length)
-    .reduce((carry, i) => {
-      Object.keys(i.idObj).forEach(key => {
-        const maybeCurrentIdPriority = idPriority[key]?.indexOf(i.submodule.name);
-        const currentIdPriority = isNumber(maybeCurrentIdPriority) ? maybeCurrentIdPriority : -1;
-        const currentIdState = {priority: currentIdPriority, value: i.idObj[key]};
-        if (carry[key]) {
-          const winnerIdState = currentIdState.priority > carry[key].priority ? currentIdState : carry[key];
-          carry[key] = winnerIdState;
-        } else {
-          carry[key] = currentIdState;
-        }
-      });
-      return carry;
-    }, {});
-
-  const result = {};
-  Object.keys(combinedIdStates).forEach(key => {
-    result[key] = combinedIdStates[key].value
-  });
-  return result;
+  return collectByPriority(
+    submodules.filter(i => isPlainObject(i.idObj) && Object.keys(i.idObj).length),
+    (submod) => submod.idObj,
+    (submod) => submod.submodule.name
+  )
 }
 
 /**
@@ -997,10 +999,20 @@ function canUseStorage(submodule) {
   return false;
 }
 
+function updateEIDConfig(submodules) {
+  EID_CONFIG.clear();
+  Object.entries(collectByPriority(
+    submodules,
+    (mod) => mod.eids,
+    (mod) => mod.name
+  )).forEach(([id, conf]) => EID_CONFIG.set(id, conf));
+}
+
 /**
  * update submodules by validating against existing configs and storage types
  */
 function updateSubmodules() {
+  updateEIDConfig(submoduleRegistry);
   const configs = getValidSubmoduleConfigs(configRegistry, submoduleRegistry);
   if (!configs.length) {
     return;

package/modules/utiqSystem.js

@@ -124,6 +124,15 @@ export const utiqSubmodule = {
       return { callback: result };
     }
   },
+  eids: {
+    'utiq': {
+      source: 'utiq.com',
+      atype: 1,
+      getValue: function (data) {
+        return data;
+      },
+    },
+  }
 };
 
 submodule('userId', utiqSubmodule);

package/modules/verizonMediaIdSystem.js

@@ -99,6 +99,12 @@ export const verizonMediaIdSubmodule = {
    */
   getAjaxFn() {
     return ajax;
+  },
+  eids: {
+    'connectid': {
+      source: 'verizonmedia.com',
+      atype: 3
+    },
   }
 };
 

package/modules/viantOrtbBidAdapter.js

@@ -0,0 +1,113 @@
+import {registerBidder} from '../src/adapters/bidderFactory.js';
+import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js';
+import * as utils from '../src/utils.js';
+import {ortbConverter} from '../libraries/ortbConverter/converter.js'
+import {deepAccess, getBidIdParameter, logError} from '../src/utils.js';
+
+const BIDDER_CODE = 'viant';
+const ENDPOINT = 'https://bidders-us-east-1.adelphic.net/d/rtb/v25/prebid/bidder_test'
+
+const DEFAULT_BID_TTL = 300;
+const DEFAULT_CURRENCY = 'USD';
+const DEFAULT_NET_REVENUE = true;
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: function (bid) {
+    if (bid && typeof bid.params !== 'object') {
+      logError(BIDDER_CODE + ': params is not defined or is incorrect in the bidder settings.');
+      return false;
+    }
+    if (!getBidIdParameter('publisherId', bid.params)) {
+      logError(BIDDER_CODE + ': publisherId is not present in bidder params.');
+      return false;
+    }
+    const mediaTypesBanner = deepAccess(bid, 'mediaTypes.banner');
+    const mediaTypesVideo = deepAccess(bid, 'mediaTypes.video');
+    const mediaTypesNative = deepAccess(bid, 'mediaTypes.native');
+    if (!mediaTypesBanner && !mediaTypesVideo && !mediaTypesNative) {
+      utils.logWarn(BIDDER_CODE + ': one of mediaTypes.banner or mediaTypes.video or mediaTypes.native must be passed');
+      return false;
+    }
+    return true;
+  },
+
+  buildRequests,
+
+  interpretResponse(response, request) {
+    if (!response.body) {
+      response.body = {nbr: 0};
+    }
+    const bids = converter.fromORTB({request: request.data, response: response.body}).bids;
+    return bids;
+  },
+
+  /**
+   * Register bidder specific code, which will execute if a bid from this bidder won the auction
+   * @param {Bid} bid The bid that won the auction
+   */
+  onBidWon: function (bid) {
+    if (bid.burl) {
+      utils.triggerPixel(bid.burl);
+    } else if (bid.nurl) {
+      utils.triggerPixel(bid.nurl);
+    }
+  }
+}
+
+function buildRequests(bids, bidderRequest) {
+  let videoBids = bids.filter(bid => isVideoBid(bid));
+  let bannerBids = bids.filter(bid => isBannerBid(bid));
+  let nativeBids = bids.filter(bid => isNativeBid(bid));
+  let requests = bannerBids.length ? [createRequest(bannerBids, bidderRequest, BANNER)] : [];
+  videoBids.forEach(bid => {
+    requests.push(createRequest([bid], bidderRequest, VIDEO));
+  });
+  nativeBids.forEach(bid => {
+    requests.push(createRequest([bid], bidderRequest, NATIVE));
+  });
+  return requests;
+}
+
+function createRequest(bidRequests, bidderRequest, mediaType) {
+  const data = converter.toORTB({bidRequests, bidderRequest, context: {mediaType}});
+  if (bidderRequest.gdprConsent && typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') {
+    if (!data.regs) data.regs = {};
+    if (!data.regs.ext) data.regs.ext = {};
+    data.regs.ext.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+  }
+  if (bidderRequest.uspConsent) {
+    if (!data.regs) data.regs = {};
+    if (!data.regs.ext) data.regs.ext = {};
+    data.regs.ext.us_privacy = bidderRequest.uspConsent;
+  }
+  return {
+    method: 'POST',
+    url: ENDPOINT,
+    data: data
+  }
+}
+
+function isVideoBid(bid) {
+  return deepAccess(bid, 'mediaTypes.video');
+}
+
+function isBannerBid(bid) {
+  return deepAccess(bid, 'mediaTypes.banner');
+}
+
+function isNativeBid(bid) {
+  return deepAccess(bid, 'mediaTypes.native');
+}
+
+const converter = ortbConverter({
+  context: {
+    netRevenue: DEFAULT_NET_REVENUE,
+    ttl: DEFAULT_BID_TTL,
+    currency: DEFAULT_CURRENCY
+  }
+});
+
+registerBidder(spec);