TheMediaGrid Bid Adapter: fill user.id from fpd cookie

modules/gridBidAdapter.js

@@ -3,15 +3,16 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { Renderer } from '../src/Renderer.js';
 import { VIDEO, BANNER } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
+import { getStorageManager } from '../src/storageManager.js';
 
 const BIDDER_CODE = 'grid';
 const ENDPOINT_URL = 'https://grid.bidswitch.net/hbjson';
 const SYNC_URL = 'https://x.bidswitch.net/sync?ssp=themediagrid';
 const TIME_TO_LIVE = 360;
+const USER_ID_KEY = 'tmguid';
+const GVLID = 686;
 const RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js';
-
-let hasSynced = false;
-
+export const storage = getStorageManager(GVLID, BIDDER_CODE);
 const LOG_ERROR_MESS = {
   noAuid: 'Bid from response has no auid parameter - ',
   noAdm: 'Bid from response has no adm parameter - ',
@@ -23,6 +24,9 @@ const LOG_ERROR_MESS = {
   hasEmptySeatbidArray: 'Response has empty seatbid array',
   hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - '
 };
+
+let hasSynced = false;
+
 export const spec = {
   code: BIDDER_CODE,
   supportedMediaTypes: [ BANNER, VIDEO ],
@@ -50,7 +54,6 @@ export const spec = {
     let jwpseg = null;
     let content = null;
     let schain = null;
-    let userId = null;
     let userIdAsEids = null;
     let user = null;
     let userExt = null;
@@ -70,9 +73,6 @@ export const spec = {
       if (!schain) {
         schain = bid.schain;
       }
-      if (!userId) {
-        userId = bid.userId;
-      }
       if (!userIdAsEids) {
         userIdAsEids = bid.userIdAsEids;
       }
@@ -99,6 +99,8 @@ export const spec = {
         impObj.ext.data = ortb2Imp.ext.data;
         if (impObj.ext.data.adserver && impObj.ext.data.adserver.adslot) {
           impObj.ext.gpid = impObj.ext.data.adserver.adslot;
+        } else {
+          impObj.ext.gpid = ortb2Imp.ext.data.pbadslot;
         }
       }
       if (!utils.isEmpty(keywords)) {
@@ -184,6 +186,13 @@ export const spec = {
       user.ext = userExt;
     }
 
+    const fpdUserId = getUserIdFromFPDStorage();
+
+    if (fpdUserId) {
+      user = user || {};
+      user.id = fpdUserId;
+    }
+
     if (user) {
       request.user = user;
     }
@@ -427,6 +436,20 @@ function createBannerRequest(bid, mediaType) {
   return result;
 }
 
+function makeNewUserIdInFPDStorage() {
+  if (config.getConfig('localStorageWriteAllowed')) {
+    const value = utils.generateUUID().replace(/-/g, '');
+
+    storage.setDataInLocalStorage(USER_ID_KEY, value);
+    return value;
+  }
+  return null;
+}
+
+function getUserIdFromFPDStorage() {
+  return storage.getDataFromLocalStorage(USER_ID_KEY) || makeNewUserIdInFPDStorage();
+}
+
 function reformatKeywords(pageKeywords) {
   const formatedPageKeywords = {};
   Object.keys(pageKeywords).forEach((name) => {

modules/gridBidAdapter.md

@@ -9,6 +9,17 @@ Maintainer: grid-tech@themediagrid.com
 Module that connects to Grid demand source to fetch bids.
 Grid bid adapter supports Banner and Video (instream and outstream).
 
+#Bidder Config
+You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `grid`
+```
+pbjs.setBidderConfig({
+        bidders: ["grid"],
+        config: {
+            localStorageWriteAllowed: true
+        }
+      })
+```
+
 # Test Parameters
 ```
     var adUnits = [

test/spec/modules/gridBidAdapter_spec.js

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { spec, resetUserSync, getSyncUrl } from 'modules/gridBidAdapter.js';
+import { spec, resetUserSync, getSyncUrl, storage } from 'modules/gridBidAdapter.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import { config } from 'src/config.js';
 
@@ -119,6 +119,10 @@ describe('TheMediaGrid Adapter', function () {
     ];
 
     it('should attach valid params to the tag', function () {
+      const fpdUserIdVal = '0b0f84a1-1596-4165-9742-2e1a7dfac57f';
+      const getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage').callsFake(
+        arg => arg === 'tmguid' ? fpdUserIdVal : null);
+
       const request = spec.buildRequests([bidRequests[0]], bidderRequest);
       expect(request.data).to.be.an('string');
       const payload = parseRequest(request.data);
@@ -132,6 +136,9 @@ describe('TheMediaGrid Adapter', function () {
           'tid': bidderRequest.auctionId,
           'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
         },
+        'user': {
+          'id': fpdUserIdVal
+        },
         'imp': [{
           'id': bidRequests[0].bidId,
           'tagid': bidRequests[0].params.uid,
@@ -144,9 +151,15 @@ describe('TheMediaGrid Adapter', function () {
           }
         }]
       });
+
+      getDataFromLocalStorageStub.restore();
     });
 
     it('make possible to process request without mediaTypes', function () {
+      const fpdUserIdVal = '0b0f84a1-1596-4165-9742-2e1a7dfac57f';
+      const getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage').callsFake(
+        arg => arg === 'tmguid' ? fpdUserIdVal : null);
+
       const request = spec.buildRequests([bidRequests[0], bidRequests[1]], bidderRequest);
       expect(request.data).to.be.an('string');
       const payload = parseRequest(request.data);
@@ -160,6 +173,9 @@ describe('TheMediaGrid Adapter', function () {
           'tid': bidderRequest.auctionId,
           'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
         },
+        'user': {
+          'id': fpdUserIdVal
+        },
         'imp': [{
           'id': bidRequests[0].bidId,
           'tagid': bidRequests[0].params.uid,
@@ -181,9 +197,15 @@ describe('TheMediaGrid Adapter', function () {
           }
         }]
       });
+
+      getDataFromLocalStorageStub.restore();
     });
 
     it('should attach valid params to the video tag', function () {
+      const fpdUserIdVal = '0b0f84a1-1596-4165-9742-2e1a7dfac57f';
+      const getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage').callsFake(
+        arg => arg === 'tmguid' ? fpdUserIdVal : null);
+
       const request = spec.buildRequests(bidRequests.slice(0, 3), bidderRequest);
       expect(request.data).to.be.an('string');
       const payload = parseRequest(request.data);
@@ -197,6 +219,9 @@ describe('TheMediaGrid Adapter', function () {
           'tid': bidderRequest.auctionId,
           'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
         },
+        'user': {
+          'id': fpdUserIdVal
+        },
         'imp': [{
           'id': bidRequests[0].bidId,
           'tagid': bidRequests[0].params.uid,
@@ -227,9 +252,15 @@ describe('TheMediaGrid Adapter', function () {
           }
         }]
       });
+
+      getDataFromLocalStorageStub.restore();
     });
 
     it('should support mixed mediaTypes', function () {
+      const fpdUserIdVal = '0b0f84a1-1596-4165-9742-2e1a7dfac57f';
+      const getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage').callsFake(
+        arg => arg === 'tmguid' ? fpdUserIdVal : null);
+
       const request = spec.buildRequests(bidRequests, bidderRequest);
       expect(request.data).to.be.an('string');
       const payload = parseRequest(request.data);
@@ -243,6 +274,9 @@ describe('TheMediaGrid Adapter', function () {
           'tid': bidderRequest.auctionId,
           'ext': {'wrapper': 'Prebid_js', 'wrapper_version': '$prebid.version$'}
         },
+        'user': {
+          'id': fpdUserIdVal
+        },
         'imp': [{
           'id': bidRequests[0].bidId,
           'tagid': bidRequests[0].params.uid,
@@ -287,6 +321,8 @@ describe('TheMediaGrid Adapter', function () {
           }
         }]
       });
+
+      getDataFromLocalStorageStub.restore();
     });
 
     it('if gdprConsent is present payload must have gdpr params', function () {
@@ -544,6 +580,7 @@ describe('TheMediaGrid Adapter', function () {
         divid: bidRequests[2].adUnitCode
       });
     });
+
     describe('floorModule', function () {
       const floorTestData = {
         'currency': 'USD',