Prebid 7: Remove FLOC id submodule

integrationExamples/gpt/userId_example.html

@@ -239,14 +239,7 @@
             {
               "name": "uid2"
             }
-            ,{
-                name: "flocId",
-                params: {
-                  // Default sharedid.org token : "A3dHTSoNUMjjERBLlrvJSelNnwWUCwVQhZ5tNQ+sll7y+LkPPVZXtB77u2y7CweRIxiYaGwGXNlW1/dFp8VMEgIAAAB+eyJvcmlnaW4iOiJodHRwczovL3NoYXJlZGlkLm9yZzo0NDMiLCJmZWF0dXJlIjoiSW50ZXJlc3RDb2hvcnRBUEkiLCJleHBpcnkiOjE2MjYyMjA3OTksImlzU3ViZG9tYWluIjp0cnVlLCJpc1RoaXJkUGFydHkiOnRydWV9"
-                  // To get new token, register https://developer.chrome.com/origintrials/#/trials/active for Federated Learning of Cohorts
-                  token: "A3dHTSoNUMjjERBLlrvJSelNnwWUCwVQhZ5tNQ+sll7y+LkPPVZXtB77u2y7CweRIxiYaGwGXNlW1/dFp8VMEgIAAAB+eyJvcmlnaW4iOiJodHRwczovL3NoYXJlZGlkLm9yZzo0NDMiLCJmZWF0dXJlIjoiSW50ZXJlc3RDb2hvcnRBUEkiLCJleHBpcnkiOjE2MjYyMjA3OTksImlzU3ViZG9tYWluIjp0cnVlLCJpc1RoaXJkUGFydHkiOnRydWV9"
-                }
-              },
+            ,
             {
               "name": "imuid",
               "params": {

modules/.submodules.json

@@ -11,7 +11,6 @@
     "deepintentDpesIdSystem",
     "dmdIdSystem",
     "fabrickIdSystem",
-    "flocIdSystem",
     "hadronIdSystem",
     "haloIdSystem",
     "id5IdSystem",

modules/appnexusBidAdapter.js

@@ -292,7 +292,6 @@ export const spec = {
     if (bidRequests[0].userId) {
       let eids = [];
 
-      addUserId(eids, deepAccess(bidRequests[0], `userId.flocId.id`), 'chrome.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.criteoId`), 'criteo.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.netId`), 'netid.de', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.idl_env`), 'liveramp.com', null);

modules/goldbachBidAdapter.js

@@ -267,7 +267,6 @@ export const spec = {
     if (bidRequests[0].userId) {
       let eids = [];
 
-      addUserId(eids, deepAccess(bidRequests[0], `userId.flocId.id`), 'chrome.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.criteoId`), 'criteo.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.netId`), 'netid.de', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.idl_env`), 'liveramp.com', null);

modules/ixBidAdapter.js

@@ -86,7 +86,6 @@ const PROVIDERS = [
   'connectid',
   'tapadId',
   'quantcastId',
-  'flocId',
   'pubProvidedId'
 ];
 const REQUIRED_VIDEO_PARAMS = ['mimes', 'minduration', 'maxduration']; // note: protocol/protocols is also reqd
@@ -449,11 +448,10 @@ function getBidRequest(id, impressions, validBidRequests) {
  * From the userIdAsEids array, filter for the ones our adserver can use, and modify them
  * for our purposes, e.g. add rtiPartner
  * @param {array} allEids userIdAsEids passed in by prebid
- * @param {object} flocId flocId passed in by prebid
  * @return {object} contains toSend (eids to send to the adserver) and seenSources (used to filter
  *                  identity info from IX Library)
  */
-function getEidInfo(allEids, flocData) {
+function getEidInfo(allEids) {
   let toSend = [];
   let seenSources = {};
   if (isArray(allEids)) {
@@ -471,16 +469,6 @@ function getEidInfo(allEids, flocData) {
     }
   }
 
-  const isValidFlocId = flocData && flocData.id && flocData.version;
-  if (isValidFlocId) {
-    const flocEid = {
-      'source': 'chrome.com',
-      'uids': [{ 'id': flocData.id, 'ext': { 'rtiPartner': 'flocId', 'ver': flocData.version } }]
-    };
-    toSend.push(flocEid);
-    seenSources['chrome.com'] = true;
-  }
-
   return { toSend, seenSources };
 }
 
@@ -498,7 +486,7 @@ function buildRequest(validBidRequests, bidderRequest, impressions, version) {
   // Always use secure HTTPS protocol.
   let baseUrl = SECURE_BID_URL;
   // Get ids from Prebid User ID Modules
-  let eidInfo = getEidInfo(deepAccess(validBidRequests, '0.userIdAsEids'), deepAccess(validBidRequests, '0.userId.flocId'));
+  let eidInfo = getEidInfo(deepAccess(validBidRequests, '0.userIdAsEids'));
   let userEids = eidInfo.toSend;
   const pageUrl = getPageUrl() || deepAccess(bidderRequest, 'refererInfo.referer');
 

modules/mediafuseBidAdapter.js

@@ -249,7 +249,6 @@ export const spec = {
     if (bidRequests[0].userId) {
       let eids = [];
 
-      addUserId(eids, deepAccess(bidRequests[0], `userId.flocId.id`), 'chrome.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.criteoId`), 'criteo.com', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.netId`), 'netid.de', null);
       addUserId(eids, deepAccess(bidRequests[0], `userId.idl_env`), 'liveramp.com', null);

modules/openxBidAdapter.js

@@ -44,7 +44,6 @@ export const USER_ID_CODE_TO_QUERY_ARG = {
   tapadId: 'tapadid', // Tapad Id
   tdid: 'ttduuid', // The Trade Desk Unified ID
   uid2: 'uid2', // Unified ID 2.0
-  flocId: 'floc', // Chrome FLoC,
   admixerId: 'admixerid', // AdMixer ID
   deepintentId: 'deepintentid', // DeepIntent ID
   dmdId: 'dmdid', // DMD Marketing Corp ID
@@ -350,9 +349,6 @@ function appendUserIdsToQueryParams(queryParams, userIds) {
         case 'merkleId':
           queryParams[key] = userIdObjectOrValue.id;
           break;
-        case 'flocId':
-          queryParams[key] = userIdObjectOrValue.id;
-          break;
         case 'uid2':
           queryParams[key] = userIdObjectOrValue.id;
           break;

modules/pixfutureBidAdapter.js

@@ -101,7 +101,6 @@ export const spec = {
       if (validBidRequests[0].userId) {
         let eids = [];
 
-        addUserId(eids, deepAccess(validBidRequests[0], `userId.flocId.id`), 'chrome.com', null);
         addUserId(eids, deepAccess(validBidRequests[0], `userId.criteoId`), 'criteo.com', null);
         addUserId(eids, deepAccess(validBidRequests[0], `userId.unifiedId`), 'thetradedesk.com', null);
         addUserId(eids, deepAccess(validBidRequests[0], `userId.id5Id`), 'id5.io', null);

modules/pubmaticBidAdapter.js

@@ -112,10 +112,6 @@ const dealChannelValues = {
   6: 'PMPG'
 };
 
-const FLOC_FORMAT = {
-  'EID': 1,
-  'SEGMENT': 2
-}
 // BB stands for Blue BillyWig
 const BB_RENDERER = {
   bootstrapPlayer: function(bid) {
@@ -800,67 +796,8 @@ function _addFloorFromFloorModule(impObj, bid) {
   logInfo(LOG_WARN_PREFIX, 'new impObj.bidfloor value:', impObj.bidfloor);
 }
 
-function _getFlocId(validBidRequests, flocFormat) {
-  var flocIdObject = null;
-  var flocId = deepAccess(validBidRequests, '0.userId.flocId');
-  if (flocId && flocId.id) {
-    switch (flocFormat) {
-      case FLOC_FORMAT.SEGMENT:
-        flocIdObject = {
-          id: 'FLOC',
-          name: 'FLOC',
-          ext: {
-            ver: flocId.version
-          },
-          segment: [{
-            id: flocId.id,
-            name: 'chrome.com',
-            value: flocId.id.toString()
-          }]
-        }
-        break;
-      case FLOC_FORMAT.EID:
-      default:
-        flocIdObject = {
-          source: 'chrome.com',
-          uids: [
-            {
-              atype: 1,
-              id: flocId.id,
-              ext: {
-                ver: flocId.version
-              }
-            },
-          ]
-        }
-        break;
-    }
-  }
-  return flocIdObject;
-}
-
-function _handleFlocId(payload, validBidRequests) {
-  var flocObject = _getFlocId(validBidRequests, FLOC_FORMAT.SEGMENT);
-  if (flocObject) {
-    if (!payload.user) {
-      payload.user = {};
-    }
-    if (!payload.user.data) {
-      payload.user.data = [];
-    }
-    payload.user.data.push(flocObject);
-  }
-}
-
 function _handleEids(payload, validBidRequests) {
   let bidUserIdAsEids = deepAccess(validBidRequests, '0.userIdAsEids');
-  let flocObject = _getFlocId(validBidRequests, FLOC_FORMAT.EID);
-  if (flocObject) {
-    if (!bidUserIdAsEids) {
-      bidUserIdAsEids = [];
-    }
-    bidUserIdAsEids.push(flocObject);
-  }
   if (isArray(bidUserIdAsEids) && bidUserIdAsEids.length > 0) {
     deepSetValue(payload, 'user.eids', bidUserIdAsEids);
   }
@@ -1206,7 +1143,6 @@ export const spec = {
 
     _handleEids(payload, validBidRequests);
 
-    _handleFlocId(payload, validBidRequests);
     // First Party Data
     const commonFpd = config.getConfig('ortb2') || {};
     if (commonFpd.site) {

modules/sharethroughBidAdapter.js

@@ -245,16 +245,6 @@ function getBidRequestFloor(bid) {
 
 function userIdAsEids(bidRequest) {
   const eids = createEidsArray(deepAccess(bidRequest, 'userId')) || [];
-
-  const flocData = deepAccess(bidRequest, 'userId.flocId');
-  const isFlocIdValid = flocData && flocData.id && flocData.version;
-  if (isFlocIdValid) {
-    eids.push({
-      source: 'chrome.com',
-      uids: [{ id: flocData.id, atype: 1, ext: { ver: flocData.version } }],
-    });
-  }
-
   return eids;
 }
 

modules/teadsBidAdapter.js

@@ -54,7 +54,6 @@ export const spec = {
       data: bids,
       deviceWidth: screen.width,
       hb_version: '$prebid.version$',
-      ...getFLoCParameters(deepAccess(validBidRequests, '0.userId.flocId')),
       ...getUnifiedId2Parameter(deepAccess(validBidRequests, '0.userId.uid2')),
       ...getFirstPartyTeadsIdParameter()
     };
@@ -237,20 +236,6 @@ function _validateId(id) {
   return (parseInt(id) > 0);
 }
 
-/**
- * Get FLoC parameters to be sent in the bid request.
- * @param `{id: string, version: string} | undefined` optionalFlocId FLoC user ID object available if "flocIdSystem" module is enabled.
- * @returns `{} | {cohortId: string} | {cohortVersion: string} | {cohortId: string, cohortVersion: string}`
- */
-function getFLoCParameters(optionalFlocId) {
-  if (!optionalFlocId) {
-    return {};
-  }
-  const cohortId = optionalFlocId.id ? { cohortId: optionalFlocId.id } : {};
-  const cohortVersion = optionalFlocId.version ? { cohortVersion: optionalFlocId.version } : {};
-  return { ...cohortId, ...cohortVersion };
-}
-
 /**
  * Get unified ID v2 parameter to be sent in bid request.
  * @param `{id: string} | undefined` optionalUid2 uid2 user ID object available if "uid2IdSystem" module is enabled.