Integration test page for adapters (#1182)

* Added a hello world example page for testing new adapter submissions. * Added a line to the README which (hopefully) will point adapter PRs to the new test page. * Updated the github PR template.
prebid · Jun 9, 2017 · b680317 · b680317
1 parent f17ec54
commit b680317
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 1 deletion.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -26,6 +26,9 @@ Thank you for your pull request. Please make sure this PR is scoped to one chang
   }
 }
 ```
+
+Be sure to test the integration with your adserver using the [Hello World](/integrationExamples/gpt/hello_world.html) sample page.
+
 - contact email of the adapter’s maintainer
 - [ ] official adapter submission
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,6 +31,8 @@ Before a Pull Request will be considered for merge:
 - All new and existing tests must pass
 - Added or modified code must have greater than 80% coverage
 
+If you are submitting an adapter, you can also use the [Hello World](integrationExamples/gpt/hello_world.html) example page to test integration with your server.
+
 ### Test Guidelines
 When you are adding code to Prebid.js, or modifying code that isn't covered by an existing test, test the code according to these guidelines:
 

diff --git a/integrationExamples/gpt/.gitignore b/integrationExamples/gpt/.gitignore
diff --git a/integrationExamples/gpt/hello_world.html b/integrationExamples/gpt/hello_world.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 = 700;
+
+      var adUnits = [{
+        code: 'div-gpt-ad-1460505748561-0',
+        sizes: [[300, 250], [300,600]],
+
+        // Replace this object to test a new Adapter!
+        bids: [{
+          bidder: 'appnexus',
+          params: {
+            placementId: '10433394'
+          }
+        }]
+
+      }];
+
+      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>
-Original file line number
+Diff line change
@@ Expand Up @@
       }
     }
     ```
+    Be sure to test the integration with your adserver using the [Hello World](/integrationExamples/gpt/hello_world.html) sample page.
     - contact email of the adapter’s maintainer
     - [ ] official adapter submission
@@ Expand Down @@