Added keywords parameter to TheMediaGrid Bid Adapter

modules/gridBidAdapter.js

@@ -2,6 +2,7 @@ import * as utils from '../src/utils.js';
 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';
 
 const BIDDER_CODE = 'grid';
 const ENDPOINT_URL = 'https://grid.bidswitch.net/hb';
@@ -47,6 +48,7 @@ export const spec = {
     const slotsMapByUid = {};
     const sizeMap = {};
     const bids = validBidRequests || [];
+    let pageKeywords = null;
     let reqId;
 
     bids.forEach(bid => {
@@ -55,6 +57,10 @@ export const spec = {
       auids.push(uid);
       const sizesId = utils.parseSizesInput(bid.sizes);
 
+      if (!pageKeywords && !utils.isEmpty(bid.params.keywords)) {
+        pageKeywords = utils.transformBidderParamKeywords(bid.params.keywords);
+      }
+
       const addedSizes = {};
       sizesId.forEach((sizeId) => {
         addedSizes[sizeId] = true;
@@ -94,6 +100,19 @@ export const spec = {
       });
     });
 
+    const configKeywords = utils.transformBidderParamKeywords({
+      'user': utils.deepAccess(config.getConfig('fpd.user'), 'keywords') || null,
+      'context': utils.deepAccess(config.getConfig('fpd.context'), 'keywords') || null
+    });
+
+    if (configKeywords.length) {
+      pageKeywords = (pageKeywords || []).concat(configKeywords);
+    }
+
+    if (pageKeywords && pageKeywords.length > 0) {
+      pageKeywords.forEach(deleteValues);
+    }
+
     const payload = {
       auids: auids.join(','),
       sizes: utils.getKeys(sizeMap).join(','),
@@ -102,6 +121,10 @@ export const spec = {
       wrapperVersion: '$prebid.version$'
     };
 
+    if (pageKeywords) {
+      payload.keywords = JSON.stringify(pageKeywords);
+    }
+
     if (bidderRequest) {
       if (bidderRequest.refererInfo && bidderRequest.refererInfo.referer) {
         payload.u = bidderRequest.refererInfo.referer;
@@ -180,6 +203,16 @@ export const spec = {
   }
 };
 
+function isPopulatedArray(arr) {
+  return !!(utils.isArray(arr) && arr.length > 0);
+}
+
+function deleteValues(keyPairObj) {
+  if (isPopulatedArray(keyPairObj.value) && keyPairObj.value[0] === '') {
+    delete keyPairObj.value;
+  }
+}
+
 function _getBidFromResponse(respItem) {
   if (!respItem) {
     utils.logError(LOG_ERROR_MESS.emptySeatbid);

modules/gridBidAdapter.md

@@ -32,7 +32,11 @@ Grid bid adapter supports Banner and Video (instream and outstream).
                        bidder: "grid",
                        params: {
                            uid: 2,
-                           priceType: 'gross'
+                           priceType: 'gross',
+                           keywords: {
+                               brandsafety: ['disaster'],
+                               topic: ['stress', 'fear']
+                           }
                        }
                    }
                ]
@@ -51,4 +55,4 @@ Grid bid adapter supports Banner and Video (instream and outstream).
                ]
           }
        ];
-```
+```

test/spec/modules/gridBidAdapter_spec.js

@@ -1,6 +1,7 @@
 import { expect } from 'chai';
 import { spec, resetUserSync, getSyncUrl } from 'modules/gridBidAdapter.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
 
 describe('TheMediaGrid Adapter', function () {
   const adapter = newBidder(spec);
@@ -165,6 +166,100 @@ describe('TheMediaGrid Adapter', function () {
       const payload = parseRequest(request.data);
       expect(payload).to.have.property('us_privacy', '1YNN');
     });
+
+    it('should convert keyword params to proper form and attaches to request', function () {
+      const bidRequestWithKeywords = [].concat(bidRequests);
+      bidRequestWithKeywords[1] = Object.assign({},
+        bidRequests[1],
+        {
+          params: {
+            uid: '1',
+            keywords: {
+              single: 'val',
+              singleArr: ['val'],
+              singleArrNum: [3],
+              multiValMixed: ['value1', 2, 'value3'],
+              singleValNum: 123,
+              emptyStr: '',
+              emptyArr: [''],
+              badValue: {'foo': 'bar'} // should be dropped
+            }
+          }
+        }
+      );
+
+      const request = spec.buildRequests(bidRequestWithKeywords, bidderRequest);
+      expect(request.data).to.be.an('string');
+      const payload = parseRequest(request.data);
+      expect(payload.keywords).to.be.an('string');
+      payload.keywords = JSON.parse(payload.keywords);
+
+      expect(payload.keywords).to.deep.equal([{
+        'key': 'single',
+        'value': ['val']
+      }, {
+        'key': 'singleArr',
+        'value': ['val']
+      }, {
+        'key': 'singleArrNum',
+        'value': ['3']
+      }, {
+        'key': 'multiValMixed',
+        'value': ['value1', '2', 'value3']
+      }, {
+        'key': 'singleValNum',
+        'value': ['123']
+      }, {
+        'key': 'emptyStr'
+      }, {
+        'key': 'emptyArr'
+      }]);
+    });
+
+    it('should mix keyword param with keywords from config', function () {
+      const getConfigStub = sinon.stub(config, 'getConfig').callsFake(
+        arg => arg === 'fpd.user' ? {'keywords': ['a', 'b']} : arg === 'fpd.context' ? {'keywords': ['any words']} : null);
+
+      const bidRequestWithKeywords = [].concat(bidRequests);
+      bidRequestWithKeywords[1] = Object.assign({},
+        bidRequests[1],
+        {
+          params: {
+            uid: '1',
+            keywords: {
+              single: 'val',
+              singleArr: ['val'],
+              multiValMixed: ['value1', 2, 'value3']
+            }
+          }
+        }
+      );
+
+      const request = spec.buildRequests(bidRequestWithKeywords, bidderRequest);
+      expect(request.data).to.be.an('string');
+      const payload = parseRequest(request.data);
+      expect(payload.keywords).to.be.an('string');
+      payload.keywords = JSON.parse(payload.keywords);
+
+      expect(payload.keywords).to.deep.equal([{
+        'key': 'single',
+        'value': ['val']
+      }, {
+        'key': 'singleArr',
+        'value': ['val']
+      }, {
+        'key': 'multiValMixed',
+        'value': ['value1', '2', 'value3']
+      }, {
+        'key': 'user',
+        'value': ['a', 'b']
+      }, {
+        'key': 'context',
+        'value': ['any words']
+      }]);
+
+      getConfigStub.restore();
+    });
   });
 
   describe('interpretResponse', function () {