TheMediaGrid & TrustX bid adapters: reformat first party data

modules/gridBidAdapter.js

@@ -25,6 +25,8 @@ const LOG_ERROR_MESS = {
   hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - '
 };
 
+const modulesToFix = ['permutive.com'];
+
 let hasSynced = false;
 
 export const spec = {
@@ -171,9 +173,7 @@ export const spec = {
       user = {
         data: [{
           name: 'iow_labs_pub_data',
-          segment: jwpseg.map((seg) => {
-            return {name: 'jwpseg', value: seg};
-          })
+          segment: segmentProcessing(jwpseg, 'jwpseg'),
         }]
       };
     }
@@ -183,7 +183,9 @@ export const spec = {
       if (!user) {
         user = { data: [] };
       }
-      user = mergeDeep(user, { data: ortb2UserData });
+      user = mergeDeep(user, {
+        data: ortb2UserData.map((ortb2Data) => ortb2Data && modulesToFix.includes(ortb2Data.name) ? fixRTDDataFormat(ortb2Data) : ortb2Data)
+      });
     }
 
     if (gdprConsent && gdprConsent.consentString) {
@@ -489,6 +491,33 @@ function getUserIdFromFPDStorage() {
   return storage.getDataFromLocalStorage(USER_ID_KEY) || makeNewUserIdInFPDStorage();
 }
 
+function segmentProcessing(segment, forceSegName) {
+  return segment
+    .map((seg) => {
+      const value = seg && (seg.value || seg.id || seg);
+      if (typeof value === 'string' || typeof value === 'number') {
+        return {
+          value: value.toString(),
+          ...(forceSegName && { name: forceSegName }),
+          ...(seg.name && { name: seg.name }),
+        };
+      }
+      return null;
+    })
+    .filter((seg) => !!seg);
+}
+
+function fixRTDDataFormat(data) {
+  const { name, segment } = data || {};
+  if (name && segment && segment.length) {
+    return {
+      name,
+      segment: segmentProcessing(segment),
+    };
+  }
+  return data;
+}
+
 function reformatKeywords(pageKeywords) {
   const formatedPageKeywords = {};
   Object.keys(pageKeywords).forEach((name) => {

modules/gridBidAdapter.md

@@ -13,19 +13,23 @@ Grid bid adapter supports Banner and Video (instream and outstream).
 You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `grid`
 ```
 pbjs.setBidderConfig({
-        bidders: ["grid"],
-        config: {
-            localStorageWriteAllowed: true
-        }
-      })
+    bidders: ["grid"],
+    config: {
+        localStorageWriteAllowed: true
+    }
+})
 ```
 
 # Test Parameters
 ```
     var adUnits = [
            {
                code: 'test-div',
-               sizes: [[300, 250]],
+               mediaTypes: {
+                   banner: {
+                       sizes: [[300, 250], [300,600]],
+                   }
+               },
                bids: [
                    {
                        bidder: "grid",
@@ -37,15 +41,19 @@ pbjs.setBidderConfig({
                ]
            },{
                code: 'test-div',
-               sizes: [[728, 90]],
                bids: [
                    {
                        bidder: "grid",
                        params: {
                            uid: 2,
                            keywords: {
-                               brandsafety: ['disaster'],
-                               topic: ['stress', 'fear']
+                               site: {
+                                  publisher: [{
+                                    name: 'someKeywordsName',
+                                    brandsafety: ['disaster'],
+                                    topic: ['stress', 'fear']
+                                  }]
+                                }
                            }
                        }
                    }
@@ -54,7 +62,12 @@ pbjs.setBidderConfig({
            {
                code: 'test-div',
                sizes: [[728, 90]],
-               mediaTypes: { video: {} },
+               mediaTypes: {
+                   video: {
+                       playerSize: [1280, 720],
+                       context: 'instream'
+                   }
+               },
                bids: [
                    {
                        bidder: "grid",

modules/trustxBidAdapter.js

@@ -1,4 +1,4 @@
-import { isEmpty, deepAccess, logError, logWarn, parseGPTSingleSizeArrayToRtbSize } from '../src/utils.js';
+import {isEmpty, deepAccess, logError, logWarn, parseGPTSingleSizeArrayToRtbSize, mergeDeep} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
@@ -21,6 +21,9 @@ const LOG_ERROR_MESS = {
   hasEmptySeatbidArray: 'Response has empty seatbid array',
   hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - '
 };
+
+const modulesToFix = ['permutive.com'];
+
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [ BANNER, VIDEO ],
@@ -173,16 +176,25 @@ export const spec = {
       request.site.content = content;
     }
 
-    const userData = [];
-    addSegments('iow_labs_pub_data', 'jwpseg', jwpseg, userData);
-    addSegments('permutive', 'p_standard', permutiveseg, userData, 'permutive.com');
-
-    if (userData.length) {
+    if (jwpseg && jwpseg.length) {
       user = {
-        data: userData
+        data: [{
+          name: 'iow_labs_pub_data',
+          segment: segmentProcessing(jwpseg, 'jwpseg'),
+        }]
       };
     }
 
+    const ortb2UserData = config.getConfig('ortb2.user.data');
+    if (ortb2UserData && ortb2UserData.length) {
+      if (!user) {
+        user = { data: [] };
+      }
+      user = mergeDeep(user, {
+        data: ortb2UserData.map((ortb2Data) => ortb2Data && modulesToFix.includes(ortb2Data.name) ? fixRTDDataFormat(ortb2Data) : ortb2Data)
+      });
+    }
+
     if (gdprConsent && gdprConsent.consentString) {
       userExt = {consent: gdprConsent.consentString};
     }
@@ -431,34 +443,31 @@ function createBannerRequest(bid, mediaType) {
   return result;
 }
 
-function addSegments(name, segName, segments, data, bidConfigName) {
-  if (segments && segments.length) {
-    data.push({
-      name: name,
-      segment: segments
-        .map((seg) => seg && (seg.id || seg))
-        .filter((seg) => seg && (typeof seg === 'string' || typeof seg === 'number'))
-        .map((seg) => ({ name: segName, value: seg.toString() }))
-    });
-  } else if (bidConfigName) {
-    const configData = config.getConfig('ortb2.user.data');
-    let segData = null;
-    configData && configData.some(({name, segment}) => {
-      if (name === bidConfigName) {
-        segData = segment;
-        return true;
+function segmentProcessing(segment, forceSegName) {
+  return segment
+    .map((seg) => {
+      const value = seg && (seg.value || seg.id || seg);
+      if (typeof value === 'string' || typeof value === 'number') {
+        return {
+          value: value.toString(),
+          ...(forceSegName && { name: forceSegName }),
+          ...(seg.name && { name: seg.name }),
+        };
       }
-    });
-    if (segData && segData.length) {
-      data.push({
-        name: name,
-        segment: segData
-          .map((seg) => seg && (seg.id || seg))
-          .filter((seg) => seg && (typeof seg === 'string' || typeof seg === 'number'))
-          .map((seg) => ({ name: segName, value: seg.toString() }))
-      });
-    }
+      return null;
+    })
+    .filter((seg) => !!seg);
+}
+
+function fixRTDDataFormat(data) {
+  const { name, segment } = data || {};
+  if (name && segment && segment.length) {
+    return {
+      name,
+      segment: segmentProcessing(segment),
+    };
   }
+  return data;
 }
 
 function reformatKeywords(pageKeywords) {

test/spec/modules/gridBidAdapter_spec.js

@@ -546,6 +546,41 @@ describe('TheMediaGrid Adapter', function () {
       getConfigStub.restore();
     });
 
+    it('shold have user.data filled from config ortb2.user.data', function () {
+      const userData = [
+        {
+          name: 'someName',
+          segment: [1, 2, { anyKey: 'anyVal' }, 'segVal', { id: 'segId' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          name: 'permutive.com',
+          segment: [1, 2, 'segVal', { id: 'segId' }, { anyKey: 'anyVal' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          someKey: 'another data'
+        }
+      ];
+
+      const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+        arg => arg === 'ortb2.user.data' ? userData : null);
+      const request = spec.buildRequests([bidRequests[0]], bidderRequest);
+      const payload = parseRequest(request.data);
+      expect(payload.user.data).to.deep.equal([
+        {
+          name: 'someName',
+          segment: [1, 2, { anyKey: 'anyVal' }, 'segVal', { id: 'segId' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          name: 'permutive.com',
+          segment: [{ value: '1' }, { value: '2' }, { value: 'segVal' }, { value: 'segId' }, { value: 'segValue' }, { value: 'segId2', name: 'segName' }]
+        },
+        {
+          someKey: 'another data'
+        }
+      ]);
+      getConfigStub.restore();
+    });
+
     it('shold be right tmax when timeout in config is less then timeout in bidderRequest', function() {
       const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
         arg => arg === 'bidderTimeout' ? 2000 : null);

test/spec/modules/trustxBidAdapter_spec.js

@@ -401,30 +401,39 @@ describe('TrustXAdapter', function () {
       expect(payload.site.content).to.deep.equal(jsContent);
     });
 
-    it('if segment is present in permutive targeting, payload must have right params', function () {
-      const permSegments = [{id: 'test_perm_1'}, {id: 'test_perm_2'}];
-      const bidRequestsWithPermutiveTargeting = bidRequests.map((bid) => {
-        return Object.assign({
-          rtd: {
-            p_standard: {
-              targeting: {
-                segments: permSegments
-              }
-            }
-          }
-        }, bid);
-      });
-      const request = spec.buildRequests(bidRequestsWithPermutiveTargeting, bidderRequest);
-      expect(request.data).to.be.an('string');
+    it('shold have user.data filled from config ortb2.user.data', function () {
+      const userData = [
+        {
+          name: 'someName',
+          segment: [1, 2, { anyKey: 'anyVal' }, 'segVal', { id: 'segId' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          name: 'permutive.com',
+          segment: [1, 2, 'segVal', { id: 'segId' }, { anyKey: 'anyVal' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          someKey: 'another data'
+        }
+      ];
+
+      const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+        arg => arg === 'ortb2.user.data' ? userData : null);
+      const request = spec.buildRequests([bidRequests[0]], bidderRequest);
       const payload = parseRequest(request.data);
-      expect(payload).to.have.property('user');
-      expect(payload.user.data).to.deep.equal([{
-        name: 'permutive',
-        segment: [
-          {name: 'p_standard', value: permSegments[0].id},
-          {name: 'p_standard', value: permSegments[1].id}
-        ]
-      }]);
+      expect(payload.user.data).to.deep.equal([
+        {
+          name: 'someName',
+          segment: [1, 2, { anyKey: 'anyVal' }, 'segVal', { id: 'segId' }, { value: 'segValue' }, { id: 'segId2', name: 'segName' }]
+        },
+        {
+          name: 'permutive.com',
+          segment: [{ value: '1' }, { value: '2' }, { value: 'segVal' }, { value: 'segId' }, { value: 'segValue' }, { value: 'segId2', name: 'segName' }]
+        },
+        {
+          someKey: 'another data'
+        }
+      ]);
+      getConfigStub.restore();
     });
 
     it('should contain the keyword values if it present in ortb2.(site/user)', function () {