GumGum Bid Adapter: adds meta field to bidresponse (#6478)

* adds meta field to bidresponse * adds meta mediatype and advertiserdomain default
prebid · Mar 27, 2021 · 11b2dd2 · 11b2dd2
1 parent aa2463e
commit 11b2dd2
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 27 deletions.
diff --git a/modules/gumgumBidAdapter.js b/modules/gumgumBidAdapter.js
@@ -388,6 +388,10 @@ function interpretResponse (serverResponse, bidRequest) {
     },
     pag: {
       pvid: 0
+    },
+    meta: {
+      adomain: [],
+      mediaType: ''
     }
   }
   const {
@@ -401,14 +405,22 @@ function interpretResponse (serverResponse, bidRequest) {
     pag: {
       pvid
     },
-    jcsi
+    jcsi,
+    meta: {
+      adomain: advertiserDomains,
+      mediaType: type
+    }
   } = Object.assign(defaultResponse, serverResponseBody)
   let data = bidRequest.data || {}
   let product = data.pi
   let mediaType = (product === 6 || product === 7) ? VIDEO : BANNER
   let isTestUnit = (product === 3 && data.si === 9)
   let sizes = utils.parseSizesInput(bidRequest.sizes)
   let [width, height] = sizes[0].split('x')
+  let metaData = {
+    advertiserDomains: advertiserDomains || [],
+    mediaType: type || mediaType
+  }
 
   // return 1x1 when breakout expected
   if ((product === 2 || product === 5) && includes(sizes, '1x1')) {
@@ -437,7 +449,8 @@ function interpretResponse (serverResponse, bidRequest) {
       netRevenue: true,
       requestId: bidRequest.id,
       ttl: TIME_TO_LIVE,
-      width
+      width,
+      meta: metaData
     })
   }
   return bidResponses

diff --git a/test/spec/modules/gumgumBidAdapter_spec.js b/test/spec/modules/gumgumBidAdapter_spec.js
@@ -461,37 +461,40 @@ describe('gumgumAdapter', function () {
   })
 
   describe('interpretResponse', function () {
-    let serverResponse = {
-      'ad': {
-        'id': 29593,
-        'width': 300,
-        'height': 250,
-        'ipd': 2000,
-        'markup': '<html><h3>I am an ad</h3></html>',
-        'ii': true,
-        'du': null,
-        'price': 0,
-        'zi': 0,
-        'impurl': 'http://g2.gumgum.com/ad/view',
-        'clsurl': 'http://g2.gumgum.com/ad/close'
+    const metaData = { adomain: ['advertiser.com'], mediaType: BANNER }
+    const serverResponse = {
+      ad: {
+        id: 29593,
+        width: 300,
+        height: 250,
+        ipd: 2000,
+        markup: '<html><h3>I am an ad</h3></html>',
+        ii: true,
+        du: null,
+        price: 0,
+        zi: 0,
+        impurl: 'http://g2.gumgum.com/ad/view',
+        clsurl: 'http://g2.gumgum.com/ad/close'
       },
-      'pag': {
-        't': 'ggumtest',
-        'pvid': 'aa8bbb65-427f-4689-8cee-e3eed0b89eec',
-        'css': 'html { overflow-y: auto }',
-        'js': 'console.log("environment", env);'
+      pag: {
+        t: 'ggumtest',
+        pvid: 'aa8bbb65-427f-4689-8cee-e3eed0b89eec',
+        css: 'html { overflow-y: auto }',
+        js: 'console.log("environment", env);'
       },
-      'jcsi': { t: 0, rq: 8 },
-      'thms': 10000
+      jcsi: { t: 0, rq: 8 },
+      thms: 10000,
+      meta: metaData
     }
-    let bidRequest = {
+    const bidRequest = {
       id: 12345,
       sizes: [[300, 250], [1, 1]],
       url: ENDPOINT,
       method: 'GET',
       pi: 3
     }
-    let expectedResponse = {
+    const expectedMetaData = { advertiserDomains: ['advertiser.com'], mediaType: BANNER };
+    const expectedResponse = {
       ad: '<html><h3>I am an ad</h3></html>',
       cpm: 0,
       creativeId: 29593,
@@ -501,19 +504,42 @@ describe('gumgumAdapter', function () {
       requestId: 12345,
       width: '300',
       mediaType: BANNER,
-      ttl: 60
+      ttl: 60,
+      meta: expectedMetaData
     };
 
     it('should get correct bid response', function () {
       expect(spec.interpretResponse({ body: serverResponse }, bidRequest)).to.deep.equal([expectedResponse]);
     });
 
+    it('should set a default value for advertiserDomains if adomain is not found', function () {
+      const meta = { ...metaData };
+      delete meta.adomain;
+
+      const response = { ...serverResponse, meta };
+      const expectedMeta = { ...expectedMetaData, advertiserDomains: [] };
+      const expected = { ...expectedResponse, meta: expectedMeta };
+
+      expect(spec.interpretResponse({ body: response }, bidRequest)).to.deep.equal([expected]);
+    });
+
+    it('should set a default value for meta.mediaType if mediaType is not found in the response', function () {
+      const meta = { ...metaData };
+      delete meta.mediaType;
+      const response = { ...serverResponse, meta };
+      const expected = { ...expectedResponse };
+
+      expect(spec.interpretResponse({ body: response }, bidRequest)).to.deep.equal([expected]);
+    });
+
     it('should pass correct currency if found in bid response', function () {
       const cur = 'EURO';
-      let response = Object.assign({}, serverResponse);
-      let expected = Object.assign({}, expectedResponse);
+      const response = { ...serverResponse };
       response.ad.cur = cur;
+
+      const expected = { ...expectedResponse };
       expected.currency = cur;
+
       expect(spec.interpretResponse({ body: response }, bidRequest)).to.deep.equal([expected]);
     });