feature/blueconicRtdProvider

dev-docs/modules/blueconicRtdProvider.md

@@ -0,0 +1,85 @@
+---
+layout: page_v2
+title: BlueConic Real Time Data Provider
+display_name: BlueConic Real-time Module
+description: BlueConic Real-time Data Module
+page_type: module
+module_type: rtd
+module_code : blueconicRtdProvider
+enable_download : true
+coppa_supported: true
+vendor_specific: true
+sidebarType : 1
+---
+
+# BlueConic Real-time Data Submodule
+{:.no_toc}
+
+* TOC
+{:toc}
+
+BlueConic's Real-time Data Provider automatically obtains segmentation data and other user level data from the BlueConic script (via `localStorage`) and passes them to the bid-stream. Please reach out to BlueConic team([email protected]) or visit our [website](https://support.blueconic.com/hc/en-us) if you have any questions or need further help to integrate Prebid or blueconicRtdProvider.
+
+## Publisher Usage
+
+Compile the BlueConic RTD module into your Prebid build:
+
+`gulp build --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter`
+
+Add the BlueConic RTD provider to your Prebid config. In this example we will configure
+publisher 1234 to retrieve segments, profile data from BlueConic. See the
+"Parameter Descriptions" below for more detailed information of the
+configuration parameters. Please work with your BlueConic Prebid support team
+([email protected]) on which version of Prebid.js supports different bidder
+and segment configurations.
+
+```
+pbjs.setConfig(
+    ...
+    realTimeData: {
+        auctionDelay: 1000,
+        dataProviders: [
+            {
+                name: "blueconic",
+                waitForIt: true,
+                params: {
+                    requestParams: {
+                        publisherId: 1234
+                    }
+                }
+            }
+        ]
+    }
+    ...
+}
+```
+
+## BlueConic Configuration Parameters
+
+{: .table .table-bordered .table-striped }
+| Name  |Type | Description   | Notes  |
+| :------------ | :------------ | :------------ |:------------ |
+| name | String | Real time data module name | Always 'blueconic' |
+| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
+| params | Object | | |
+| params.requestParams | Object | Publisher partner specific configuration options, such as optional publisher id and other segment query related metadata | Optional |
+
+
+Please see the examples available in the blueconicRtdProvider_spec.js
+tests.
+
+## Testing 
+
+To run test suite for blueconic:
+
+`gulp test --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter`
+
+## Example
+
+To view an example of available segments & profile data:
+
+`gulp serve --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter`
+
+and then point your browser at:
+
+`http://localhost:9999/integrationExamples/gpt/blueconicRtdProvider_example.html`