Merge pull request #2 from 51Degrees/feature/51DegreesRtdProvider-rev…

…iew-comments

51d: addressing latest review comments

integrationExamples/gpt/51DegreesRtdProvider_example.html

@@ -84,7 +84,7 @@
             ];
 
             pbjs.setConfig({
-                debug: true,
+                debug: true, // use only for testing, remove in production
                 realTimeData: {
                     auctionDelay: 1000, // should be set lower in production use
                     dataProviders: [
@@ -177,6 +177,17 @@ <h3>div-banner-native-2</h3>
         </script>
     </div>
 
+    <div id="debug">
+        <h3>Testing/Debugging Guidance</h3>
+        <ol>
+            <li>Make sure you have <code>debug: true</code> under <code>pbjs.setConfig</code> in this example code (be sure to remove it for production!)
+            <li>Make sure you have replaced <code>&lt;YOUR RESOURCE KEY&gt;</code> in this example code with the one you have obtained 
+            from the <a href="https://configure.51degrees.com/tWrhNfY6" target="blank;">51Degrees Configurator Tool</a></li>
+            <li>Open DevTools Console in your browser and refresh the page</li>
+            <li>Observe the enriched ortb device data shown below and also in the console as part of the <code>[51Degrees RTD Submodule]: reqBidsConfigObj:</code> message (under <code>reqBidsConfigObj.global.device</code>)</li>
+        </ol>
+
+    </div>
     <div id="enriched-51" style="display: none">
         <h3>Enriched ORTB2 device data</h3>
         <pre id="enriched-51-data"></pre>

modules/51DegreesRtdProvider.md

@@ -10,7 +10,7 @@
 
 51Degrees module enriches an OpenRTB request with [51Degrees Device Data](https://51degrees.com/documentation/index.html).
 
-51Degrees module sets the following fields of the device object: `make`, `model`, `os`, `osv`, `h`, `w`, `ppi`, `pixelratio` - interested bidder adapters may use these fields as needed. In addition the module sets `device.ext.fiftyonedegrees_deviceId` to a permanent device ID which can be rapidly looked up in on premise data exposing over 250 properties including the device age, chip set, codec support, and price, operating system and app/browser versions, age, and embedded features.
+51Degrees module sets the following fields of the device object: `make`, `model`, `os`, `osv`, `h`, `w`, `ppi`, `pxratio` - interested bidder adapters may use these fields as needed. In addition the module sets `device.ext.fiftyonedegrees_deviceId` to a permanent device ID which can be rapidly looked up in on premise data exposing over 250 properties including the device age, chip set, codec support, and price, operating system and app/browser versions, age, and embedded features.
 
 The module supports on premise and cloud device detection services with free options for both. 
 
@@ -71,13 +71,29 @@ Accept-CH: sec-ch-ua-arch, sec-ch-ua-full-version, sec-ch-ua-full-version-list,
 
 See the [51Degrees documentation](https://51degrees.com/documentation/_device_detection__features__u_a_c_h__overview.html) for more information concerning UA-CH and permissions.
 
+##### Why not use GetHighEntropyValues API instead?
+
+Thanks for asking.
+
+The script this module injects has a fall back to the GetHighEntropyValues API, but does not rely on it as a first (or only) choice route - please see the illustrative cases below. Albeit it seems easier, GHEV API is not supported by all browsers (so the decision to call it should be conditional) and also even in Chrome this API will likely be a subject to the Privacy Budget in the future.
+
+In summary we recommend using `Delegate-CH` http-equiv as the preferred method of obtaining the necessary evidence because it is the fastest and future proof method.
+
+##### Illustrative Cases
+
+* if the device is iPhone/iPad then there is no point checking for or calling GetHighEntropyValues at the moment because iOS does not support this API. However this might change in the future.  Platforms like iOS require additional techniques to identify the model which are not covered via a single API call, and change from version to version of the operating system and browser rendering engine. **When used with iOS 51Degrees resolves the [iPhone/iPad model groups](https://51degrees.com/documentation/4.4/_device_detection__features__apple_device_table.html) using these techniques.** That is one of the benefits the module brings to the Prebid community as most solutions do not resolve iPhone/iPad model groups. More on Apple Device Detection [here](https://51degrees.com/documentation/4.4/_device_detection__features__apple_detection.html).
+
+* if the browser is Firefox on Android or Desktop then there is similarly no point requesting GHEV as the API is not supported.
+
+* if the browser is Chrome then the `Delegate-CH` if enabled by the publisher would enable the browser to provide the necessary evidence. However if this is not implemented - then the dynamic script would fall back to GHEV which is slower.
+
 ### Configuration
 
 This module is configured as part of the `realTimeData.dataProviders`
 
 ```javascript
 pbjs.setConfig({
-    debug: true, // we recommend turning this on for testing as it adds more logging
+    debug: true, // turn on for testing, remove in production
     realTimeData: {
         auctionDelay: 1000, // should be set lower in production use
         dataProviders: [