From ab5539a1656d0a5ccfd82ef372ec05bce88e0423 Mon Sep 17 00:00:00 2001 From: Soni Goyal Date: Wed, 1 Jun 2022 12:08:17 +0530 Subject: [PATCH 1/3] add dev docs for blueconic Rtd provider --- dev-docs/modules/blueconicRtdProvider.md | 92 ++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 dev-docs/modules/blueconicRtdProvider.md diff --git a/dev-docs/modules/blueconicRtdProvider.md b/dev-docs/modules/blueconicRtdProvider.md new file mode 100644 index 0000000000..742e5a3412 --- /dev/null +++ b/dev-docs/modules/blueconicRtdProvider.md @@ -0,0 +1,92 @@ +--- +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 +vendor_specific: true +sidebarType : 1 +--- + +# BlueConic Real-time Data Submodule +{:.no_toc} + +* TOC +{:toc} + +BlueConic is the Customer Data Platform that liberates customer data to make individualized marketing a reality. We are the first and only company that delivers to marketers the promise of a single view of a customer. BlueConi gather rela-time and batch data of customers from all the channels to the tailor products, services and experiences according to their wants and needs. + +The BlueConic real-time data module in Prebid has been built so that publishers +can maximize the power of their first-party audiences, user-level and contextual data. +This module provides both an integrated BlueConic identity with real-time +contextual and audience segmentation solution that seamlessly and easily +integrates into your existing Prebid deployment. For more information, +please visit https://www.blueconic.com/ or contact our Prebid integration team at connectors@blueconic.com. + + +## 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 +(info@blueconic.com) on which version of Prebid.js supports different bidder +and segment configurations. + +``` +pbjs.setConfig( + ... + realTimeData: { + auctionDelay: 5000, + dataProviders: [ + { + name: "blueconic", + waitForIt: true, + params: { + requestParams: { + publisherId: 1234 + } + } + } + ] + } + ... +} +``` + +## Parameter Descriptions for the Blueconic Configuration Section +{: .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 and work with your Blueconic Prebid integration team (connectors@blueconic.com). + +## Testing + +To run test suite for blueconic: + +`gulp test --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter` + +## Example + +To view an example of available segments: + +`gulp serve --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter` + +and then point your browser at: + +`http://localhost:9999/integrationExamples/gpt/blueconicRtdProvider_example.html` \ No newline at end of file From 6269099a014f9cea69d0705ff6d1cffc706a0748 Mon Sep 17 00:00:00 2001 From: Soni Goyal Date: Wed, 1 Jun 2022 12:21:02 +0530 Subject: [PATCH 2/3] update table structure --- dev-docs/modules/blueconicRtdProvider.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev-docs/modules/blueconicRtdProvider.md b/dev-docs/modules/blueconicRtdProvider.md index 742e5a3412..f404c56618 100644 --- a/dev-docs/modules/blueconicRtdProvider.md +++ b/dev-docs/modules/blueconicRtdProvider.md @@ -61,9 +61,9 @@ pbjs.setConfig( } ``` -## Parameter Descriptions for the Blueconic Configuration Section -{: .table .table-bordered .table-striped } +## BlueConic Configuration Parameters +{: .table .table-bordered .table-striped } | Name |Type | Description | Notes | | :------------ | :------------ | :------------ |:------------ | | name | String | Real time data module name | Always 'blueconic' | From f611bf2eb15e958805aa4ad52fc4b85182bd6500 Mon Sep 17 00:00:00 2001 From: Soni Goyal Date: Fri, 3 Jun 2022 14:51:26 +0530 Subject: [PATCH 3/3] review comments --- dev-docs/modules/blueconicRtdProvider.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/dev-docs/modules/blueconicRtdProvider.md b/dev-docs/modules/blueconicRtdProvider.md index f404c56618..c715c5e19f 100644 --- a/dev-docs/modules/blueconicRtdProvider.md +++ b/dev-docs/modules/blueconicRtdProvider.md @@ -7,6 +7,7 @@ page_type: module module_type: rtd module_code : blueconicRtdProvider enable_download : true +coppa_supported: true vendor_specific: true sidebarType : 1 --- @@ -17,15 +18,7 @@ sidebarType : 1 * TOC {:toc} -BlueConic is the Customer Data Platform that liberates customer data to make individualized marketing a reality. We are the first and only company that delivers to marketers the promise of a single view of a customer. BlueConi gather rela-time and batch data of customers from all the channels to the tailor products, services and experiences according to their wants and needs. - -The BlueConic real-time data module in Prebid has been built so that publishers -can maximize the power of their first-party audiences, user-level and contextual data. -This module provides both an integrated BlueConic identity with real-time -contextual and audience segmentation solution that seamlessly and easily -integrates into your existing Prebid deployment. For more information, -please visit https://www.blueconic.com/ or contact our Prebid integration team at connectors@blueconic.com. - +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(info@blueconic.com) 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 @@ -44,7 +37,7 @@ and segment configurations. pbjs.setConfig( ... realTimeData: { - auctionDelay: 5000, + auctionDelay: 1000, dataProviders: [ { name: "blueconic", @@ -73,7 +66,7 @@ pbjs.setConfig( Please see the examples available in the blueconicRtdProvider_spec.js -tests and work with your Blueconic Prebid integration team (connectors@blueconic.com). +tests. ## Testing @@ -83,7 +76,7 @@ To run test suite for blueconic: ## Example -To view an example of available segments: +To view an example of available segments & profile data: `gulp serve --modules=rtdModule,blueconicRtdProvider,appnexusBidAdapter`