Inskin Bid Adapter - New Feature (prebid#4011)

* Add support for different publisher payment models. * Add Inskin integration example. * Append pubcpm to impression tracker. * Added unit tests for pubCMP vs clearPrice.
gamoshi · Nov 28, 2019 · 7ba15a2 · 7ba15a2
1 parent ddae48c
commit 7ba15a2
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 1 deletion.
diff --git a/integrationExamples/gpt/inskin_example.html b/integrationExamples/gpt/inskin_example.html
@@ -0,0 +1,102 @@
+<!--
+  This page calls a single bidder for a single ad slot. It can be considered a "hello world" example for using
+  Prebid with the Google Publisher Tag.
+  It also makes a good test page for new adapter PR submissions. Simply set your server's Bid Params object in the
+  bids array inside the adUnits, and it will use your adapter to load an ad.
+  NOTE that many ad servers won't send back an ad if the URL is localhost... so you might need to
+  set an alias in your /etc/hosts file so that you can load this page from a different domain.
+-->
+
+<html>
+  <head>
+      <script>
+        var PREBID_TIMEOUT = 3300;
+
+        var adUnits = [{
+          code: 'div-gpt-ad-1460505748561-0',
+          mediaTypes: {
+            banner: {
+              sizes: [[300, 250]],
+            }
+          },
+          // Replace this object to test a new Adapter!
+          bids: [{
+            bidder: 'inskin',
+            params: {
+              networkId: '9874',
+              siteId: '983808'
+            }
+          }]
+
+        }];
+
+        var pbjs = pbjs || {};
+        pbjs.que = pbjs.que || [];
+
+      </script>
+
+      <script type="text/javascript" src="../../build/dev/prebid.js" async></script>
+      <script>
+        var googletag = googletag || {};
+        googletag.cmd = googletag.cmd || [];
+        googletag.cmd.push(function() {
+          googletag.pubads().disableInitialLoad();
+        });
+
+        pbjs.que.push(function() {
+          pbjs.addAdUnits(adUnits);
+          pbjs.requestBids({
+            bidsBackHandler: sendAdserverRequest
+          });
+        });
+
+        function sendAdserverRequest() {
+          if (pbjs.adserverRequestSent) return;
+          pbjs.adserverRequestSent = true;
+          googletag.cmd.push(function() {
+            pbjs.que.push(function() {
+              pbjs.setTargetingForGPTAsync();
+              googletag.pubads().refresh();
+            });
+          });
+        }
+
+        setTimeout(function() {
+          sendAdserverRequest();
+        }, PREBID_TIMEOUT);
+
+      </script>
+
+      <script>
+        (function () {
+          var gads = document.createElement('script');
+          gads.async = true;
+          gads.type = 'text/javascript';
+          var useSSL = 'https:' == document.location.protocol;
+          gads.src = (useSSL ? 'https:' : 'http:') +
+            '//www.googletagservices.com/tag/js/gpt.js';
+          var node = document.getElementsByTagName('script')[0];
+          node.parentNode.insertBefore(gads, node);
+        })();
+      </script>
+
+      <script>
+        googletag.cmd.push(function () {
+          googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads());
+
+          googletag.pubads().enableSingleRequest();
+          googletag.enableServices();
+        });
+      </script>
+  </head>
+
+  <body>
+  <h2>Prebid.js Test</h2>
+  <h5>Div-1</h5>
+  <div id='div-gpt-ad-1460505748561-0'>
+      <script type='text/javascript'>
+        googletag.cmd.push(function() { googletag.display('div-gpt-ad-1460505748561-0'); });
+      </script>
+  </div>
+  </body>
+  </html>
diff --git a/modules/inskinBidAdapter.js b/modules/inskinBidAdapter.js
@@ -116,9 +116,15 @@ export const spec = {
 
       if (serverResponse) {
         const decision = serverResponse.decisions && serverResponse.decisions[bidId];
-        const price = decision && decision.pricing && decision.pricing.clearPrice;
+        const data = decision && decision.contents && decision.contents[0] && decision.contents[0].data;
+        const pubCPM = data && data.customData && data.customData.pubCPM;
+        const clearPrice = decision && decision.pricing && decision.pricing.clearPrice;
+        const price = pubCPM || clearPrice;
 
         if (decision && price) {
+          decision.impressionUrl += ('&property:pubcpm=' + price);
+          bidObj.price = price;
+
           bid.requestId = bidId;
           bid.cpm = price;
           bid.width = decision.width;
@@ -149,6 +155,7 @@ export const spec = {
         const id = 'ism_tag_' + Math.floor((Math.random() * 10e16));
         window[id] = {
           bidId: e.data.bidId,
+          bidPrice: bidsMap[e.data.bidId].price,
           serverResponse
         };
         const script = document.createElement('script');

diff --git a/test/spec/modules/inskinBidAdapter_spec.js b/test/spec/modules/inskinBidAdapter_spec.js
@@ -82,6 +82,9 @@ const RESPONSE = {
           'type': 'html',
           'body': '<html></html>',
           'data': {
+            'customData': {
+              'pubCPM': 1
+            },
             'height': 90,
             'width': 728,
             'imageUrl': 'https://static.adzerk.net/Advertisers/b0ab77db8a7848c8b78931aed022a5ef.gif',
@@ -241,6 +244,13 @@ describe('InSkin BidAdapter', function () {
       });
     });
 
+    it('cpm is correctly set', function () {
+      let bids = spec.interpretResponse(RESPONSE, REQUEST);
+
+      expect(bids[0].cpm).to.equal(0.5);
+      expect(bids[1].cpm).to.equal(1);
+    });
+
     it('handles nobid responses', function () {
       let EMPTY_RESP = Object.assign({}, RESPONSE, {'body': {'decisions': null}})
       let bids = spec.interpretResponse(EMPTY_RESP, REQUEST);