Convert id5id to an object to support passing additional data points to platforms

modules/adheseBidAdapter.js

@@ -150,8 +150,8 @@ function getAccount(validBidRequests) {
 }
 
 function getId5Id(validBidRequests) {
-  if (validBidRequests[0] && validBidRequests[0].userId && validBidRequests[0].userId.id5id) {
-    return validBidRequests[0].userId.id5id;
+  if (validBidRequests[0] && validBidRequests[0].userId && validBidRequests[0].userId.id5id && validBidRequests[0].userId.id5id.uid) {
+    return validBidRequests[0].userId.id5id.uid;
   }
 }
 

modules/adxcgBidAdapter.js

@@ -170,8 +170,8 @@ export const spec = {
       beaconParams.tdid = validBidRequests[0].userId.tdid;
     }
 
-    if (utils.isStr(utils.deepAccess(validBidRequests, '0.userId.id5id'))) {
-      beaconParams.id5id = validBidRequests[0].userId.id5id;
+    if (utils.isStr(utils.deepAccess(validBidRequests, '0.userId.id5id.uid'))) {
+      beaconParams.id5id = validBidRequests[0].userId.id5id.uid;
     }
 
     if (utils.isStr(utils.deepAccess(validBidRequests, '0.userId.idl_env'))) {

modules/avocetBidAdapter.js

@@ -77,8 +77,8 @@ export const spec = {
 
     // ID5 identifier
     let id5id;
-    if (bidRequests[0].userId && bidRequests[0].userId.id5id) {
-      id5id = bidRequests[0].userId.id5id;
+    if (bidRequests[0].userId && bidRequests[0].userId.id5id && bidRequests[0].userId.id5id.uid) {
+      id5id = bidRequests[0].userId.id5id.uid;
     }
 
     // Build the avocet ext object

modules/colossussspBidAdapter.js

@@ -102,7 +102,7 @@ export const spec = {
       if (bid.userId) {
         getUserId(placement.eids, bid.userId.britepoolid, 'britepool.com');
         getUserId(placement.eids, bid.userId.idl_env, 'identityLink');
-        getUserId(placement.eids, bid.userId.id5id, 'id5-sync.com')
+        getUserId(placement.eids, utils.deepAccess(bid, 'userId.id5id.uid'), 'id5-sync.com', utils.deepAccess(bid, 'userId.id5id.ext'));
         getUserId(placement.eids, bid.userId.tdid, 'adserver.org', {
           rtiPartner: 'TDID'
         });

modules/districtmDMXBidAdapter.js

@@ -106,7 +106,7 @@ export const spec = {
     let eids = [];
     if (bidRequest[0] && bidRequest[0].userId) {
       bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.idl_env`), 'liveramp.com', 1);
-      bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.id5id`), 'id5-sync.com', 1);
+      bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.id5id.uid`), 'id5-sync.com', 1);
       bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.pubcid`), 'pubcid.org', 1);
       bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.tdid`), 'adserver.org', 1);
       bindUserId(eids, utils.deepAccess(bidRequest[0], `userId.criteoId`), 'criteo.com', 1);

modules/gamoshiBidAdapter.js

@@ -157,7 +157,7 @@ export const spec = {
 
       let eids = [];
       if (bidRequest && bidRequest.userId) {
-        addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5-sync.com', 'ID5ID');
+        addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id.uid`), 'id5-sync.com', 'ID5ID');
         addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.tdid`), 'adserver.org', 'TDID');
       }
       if (eids.length > 0) {

modules/gridBidAdapter.js

@@ -431,8 +431,8 @@ function buildNewRequest(validBidRequests, bidderRequest) {
     if (userId.tdid) {
       userExt.unifiedid = userId.tdid;
     }
-    if (userId.id5id) {
-      userExt.id5id = userId.id5id;
+    if (userId.id5id && userId.id5id.uid) {
+      userExt.id5id = userId.id5id.uid;
     }
     if (userId.digitrustid && userId.digitrustid.data && userId.digitrustid.data.id) {
       userExt.digitrustid = userId.digitrustid.data.id;

modules/id5IdSystem.js

@@ -39,14 +39,27 @@ export const id5IdSubmodule = {
    * @returns {(Object|undefined)}
    */
   decode(value) {
+    let uid;
+    let linkType = 0;
+
     if (value && typeof value.ID5ID === 'string') {
       // don't lose our legacy value from cache
-      return { 'id5id': value.ID5ID };
+      uid = value.ID5ID;
     } else if (value && typeof value.universal_uid === 'string') {
-      return { 'id5id': value.universal_uid };
+      uid = value.universal_uid;
+      linkType = value.link_type || linkType;
     } else {
       return undefined;
     }
+
+    return {
+      'id5id': {
+        'uid': uid,
+        'ext': {
+          'linkType': linkType
+        }
+      }
+    };
   },
 
   /**

modules/livewrappedBidAdapter.js

@@ -277,7 +277,7 @@ function handleEids(bidRequests) {
   const bidRequest = bidRequests[0];
   if (bidRequest && bidRequest.userId) {
     AddExternalUserId(eids, utils.deepAccess(bidRequest, `userId.pubcid`), 'pubcommon', 1); // Also add this to eids
-    AddExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5-sync.com', 1);
+    AddExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id.uid`), 'id5-sync.com', 1);
   }
   if (eids.length > 0) {
     return {user: {ext: {eids}}};

modules/openxBidAdapter.js

@@ -281,6 +281,9 @@ function appendUserIdsToQueryParams(queryParams, userIds) {
         case 'parrableId':
           queryParams[key] = userIdObjectOrValue.eid;
           break;
+        case 'id5id':
+          queryParams[key] = userIdObjectOrValue.uid;
+          break;
         default:
           queryParams[key] = userIdObjectOrValue;
       }

modules/ozoneBidAdapter.js

@@ -539,7 +539,7 @@ export const spec = {
    */
   findAllUserIds(bidRequest) {
     var ret = {};
-    let searchKeysSingle = ['pubcid', 'tdid', 'id5id', 'parrableId', 'idl_env', 'digitrustid', 'criteortus'];
+    let searchKeysSingle = ['pubcid', 'tdid', 'parrableId', 'idl_env', 'digitrustid', 'criteortus'];
     if (bidRequest.hasOwnProperty('userId')) {
       for (let arrayId in searchKeysSingle) {
         let key = searchKeysSingle[arrayId];
@@ -551,6 +551,10 @@ export const spec = {
       if (lipbid) {
         ret['lipb'] = {'lipbid': lipbid};
       }
+      var id5id = utils.deepAccess(bidRequest.userId, 'id5id.uid');
+      if (id5id) {
+        ret['id5id'] = id5id;
+      }
     }
     if (!ret.hasOwnProperty('pubcid')) {
       var pubcid = utils.deepAccess(bidRequest, 'crumbs.pubcid');
@@ -675,7 +679,7 @@ export const spec = {
     if (bidRequest && bidRequest.userId) {
       this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.pubcid`), 'pubcid', 1);
       this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.pubcid`), 'pubcommon', 1);
-      this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5-sync.com', 1);
+      this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id.uid`), 'id5-sync.com', 1);
       this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.criteortus.${BIDDER_CODE}.userid`), 'criteortus', 1);
       this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.idl_env`), 'liveramp.com', 1);
       this.addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.lipb.lipbid`), 'liveintent.com', 1);

modules/pulsepointBidAdapter.js

@@ -420,7 +420,7 @@ function user(bidRequest, bidderRequest) {
       addExternalUserId(ext.eids, bidRequest.userId.britepoolid, 'britepool.com');
       addExternalUserId(ext.eids, bidRequest.userId.criteoId, 'criteo');
       addExternalUserId(ext.eids, bidRequest.userId.idl_env, 'identityLink');
-      addExternalUserId(ext.eids, bidRequest.userId.id5id, 'id5-sync.com');
+      addExternalUserId(ext.eids, utils.deepAccess(bidRequest, 'userId.id5id.uid'), 'id5-sync.com', utils.deepAccess(bidRequest, 'userId.id5id.ext'));
       addExternalUserId(ext.eids, utils.deepAccess(bidRequest, 'userId.parrableId.eid'), 'parrable.com');
       // liveintent
       if (bidRequest.userId.lipb && bidRequest.userId.lipb.lipbid) {

modules/richaudienceBidAdapter.js

@@ -201,7 +201,7 @@ function raiSetEids(bid) {
   let eids = [];
 
   if (bid && bid.userId) {
-    raiSetUserId(bid, eids, 'id5-sync.com', utils.deepAccess(bid, `userId.id5id`));
+    raiSetUserId(bid, eids, 'id5-sync.com', utils.deepAccess(bid, `userId.id5id.uid`));
     raiSetUserId(bid, eids, 'pubcommon', utils.deepAccess(bid, `userId.pubcid`));
     raiSetUserId(bid, eids, 'criteo.com', utils.deepAccess(bid, `userId.criteoId`));
     raiSetUserId(bid, eids, 'liveramp.com', utils.deepAccess(bid, `userId.idl_env`));

modules/spotxBidAdapter.js

@@ -228,14 +228,15 @@ export const spec = {
       }
 
       // ID5 fied
-      if (bid && bid.userId && bid.userId.id5id) {
+      if (utils.deepAccess(bid, 'userId.id5id.uid')) {
         userExt.eids = userExt.eids || [];
         userExt.eids.push(
           {
             source: 'id5-sync.com',
             uids: [{
-              id: bid.userId.id5id
-            }]
+              id: bid.userId.id5id.uid
+            }],
+            ext: bid.userId.id5id.ext || {}
           }
         )
       }

modules/userId/eids.js

@@ -30,8 +30,16 @@ const USER_IDS_CONFIG = {
 
   // id5Id
   'id5id': {
+    getValue: function(data) {
+      return data.uid
+    },
     source: 'id5-sync.com',
-    atype: 1
+    atype: 1,
+    getEidExt: function(data) {
+      if (data.ext) {
+        return data.ext;
+      }
+    }
   },
 
   // parrableId

modules/vidazooBidAdapter.js

@@ -117,6 +117,9 @@ function appendUserIdsToRequestPayload(payloadRef, userIds) {
         case 'parrableId':
           payloadRef[key] = userId.eid;
           break;
+        case 'id5id':
+          payloadRef[key] = userId.uid;
+          break;
         default:
           payloadRef[key] = userId;
       }

modules/visxBidAdapter.js

@@ -100,8 +100,8 @@ export const spec = {
       if (payloadUserId.tdid) {
         payload.tdid = payloadUserId.tdid;
       }
-      if (payloadUserId.id5id) {
-        payload.id5 = payloadUserId.id5id;
+      if (payloadUserId.id5id && payloadUserId.id5id.uid) {
+        payload.id5 = payloadUserId.id5id.uid;
       }
       if (payloadUserId.digitrustid && payloadUserId.digitrustid.data && payloadUserId.digitrustid.data.id) {
         payload.dtid = payloadUserId.digitrustid.data.id;

test/spec/modules/adheseBidAdapter_spec.js

@@ -116,7 +116,7 @@ describe('AdheseAdapter', function () {
     });
 
     it('should include id5 id as /x5 param', function () {
-      let req = spec.buildRequests([ bidWithParams({}, { 'id5id': 'ID5-1234567890' }) ], bidderRequest);
+      let req = spec.buildRequests([ bidWithParams({}, { 'id5id': { 'uid': 'ID5-1234567890' } }) ], bidderRequest);
 
       expect(JSON.parse(req.data).parameters).to.deep.include({ 'x5': [ 'ID5-1234567890' ] });
     });

test/spec/modules/adxcgBidAdapter_spec.js

@@ -281,7 +281,7 @@ describe('AdxcgAdapter', function () {
     let bid = deepClone([bidBanner]);
     let bidderRequests = {};
 
-    bid[0].userId = {id5id: 'id5idsample'};
+    bid[0].userId = {id5id: {uid: 'id5idsample'}};
 
     it('should send pubcid if available', function () {
       let request = spec.buildRequests(bid, bidderRequests);

test/spec/modules/amxBidAdapter_spec.js

@@ -224,7 +224,7 @@ describe('AmxBidAdapter', () => {
         britepoolid: 'sample-britepool',
         criteoId: 'sample-criteo',
         digitrustid: {data: {id: 'sample-digitrust'}},
-        id5id: 'sample-id5',
+        id5id: {uid: 'sample-id5'},
         idl_env: 'sample-liveramp',
         lipb: {lipbid: 'sample-liveintent'},
         netId: 'sample-netid',

test/spec/modules/avocetBidAdapter_spec.js

@@ -69,7 +69,9 @@ describe('Avocet adapter', function () {
               placement: '012345678901234567890123',
             },
             userId: {
-              id5id: 'test'
+              id5id: {
+                uid: 'test'
+              }
             }
           },
           {

test/spec/modules/colossussspBidAdapter_spec.js

@@ -108,7 +108,7 @@ describe('ColossussspAdapter', function () {
     bid.userId.britepoolid = 'britepoolid123';
     bid.userId.idl_env = 'idl_env123';
     bid.userId.tdid = 'tdid123';
-    bid.userId.id5id = 'id5id123'
+    bid.userId.id5id = { uid: 'id5id123' };
     let serverRequest = spec.buildRequests([bid], bidderRequest);
     it('Returns valid data if array of bids is valid', function () {
       let data = serverRequest.data;

test/spec/modules/districtmDmxBidAdapter_spec.js

@@ -103,7 +103,9 @@ const bidRequest = [{
         id: {}
       }
     },
-    id5id: {},
+    id5id: {
+      uid: ''
+    },
     pubcid: {},
     tdid: {},
     criteoId: {},

test/spec/modules/eids_spec.js

@@ -29,15 +29,39 @@ describe('eids array generation for known sub-modules', function() {
     });
   });
 
-  it('id5Id', function() {
-    const userId = {
-      id5id: 'some-random-id-value'
-    };
-    const newEids = createEidsArray(userId);
-    expect(newEids.length).to.equal(1);
-    expect(newEids[0]).to.deep.equal({
-      source: 'id5-sync.com',
-      uids: [{id: 'some-random-id-value', atype: 1}]
+  describe('id5Id', function() {
+    it('does not include an ext if not provided', function() {
+      const userId = {
+        id5id: {
+          uid: 'some-random-id-value'
+        }
+      };
+      const newEids = createEidsArray(userId);
+      expect(newEids.length).to.equal(1);
+      expect(newEids[0]).to.deep.equal({
+        source: 'id5-sync.com',
+        uids: [{ id: 'some-random-id-value', atype: 1 }]
+      });
+    });
+
+    it('includes ext if provided', function() {
+      const userId = {
+        id5id: {
+          uid: 'some-random-id-value',
+          ext: {
+            linkType: 0
+          }
+        }
+      };
+      const newEids = createEidsArray(userId);
+      expect(newEids.length).to.equal(1);
+      expect(newEids[0]).to.deep.equal({
+        source: 'id5-sync.com',
+        uids: [{ id: 'some-random-id-value', atype: 1 }],
+        ext: {
+          linkType: 0
+        }
+      });
     });
   });
 

test/spec/modules/gamoshiBidAdapter_spec.js

@@ -423,7 +423,7 @@ describe('GamoshiAdapter', () => {
     it('build request with ID5 Id', () => {
       const bidRequestClone = utils.deepClone(bidRequest);
       bidRequestClone.userId = {};
-      bidRequestClone.userId.id5id = 'id5-user-id';
+      bidRequestClone.userId.id5id = { uid: 'id5-user-id' };
       let request = spec.buildRequests([bidRequestClone], bidRequestClone)[0];
       expect(request.data.user.ext.eids).to.deep.equal([{
         'source': 'id5-sync.com',

test/spec/modules/gridBidAdapter_spec.js

@@ -536,7 +536,7 @@ describe('TheMediaGrid Adapter', function () {
       const bidRequestsWithUserIds = bidRequests.map((bid) => {
         return Object.assign({
           userId: {
-            id5id: 'id5id_1',
+            id5id: { uid: 'id5id_1' },
             tdid: 'tdid_1',
             digitrustid: {data: {id: 'DTID', keyv: 4, privacy: {optout: false}, producer: 'ABC', version: 2}},
             lipb: {lipbid: 'lipb_1'}