From 4428c74526d93d84e4cd64bb3f17d8ba661d5497 Mon Sep 17 00:00:00 2001 From: Anass Seddiki Date: Tue, 7 Jun 2022 14:51:27 +0000 Subject: [PATCH 1/3] Init md file with basic title structure & info --- modules/1plusXRtdProvider.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 modules/1plusXRtdProvider.md diff --git a/modules/1plusXRtdProvider.md b/modules/1plusXRtdProvider.md new file mode 100644 index 00000000000..1fd83c48747 --- /dev/null +++ b/modules/1plusXRtdProvider.md @@ -0,0 +1,23 @@ +# 1plusX Real-time Data Submodule + +## Overview + + Module Name: 1plusX Rtd Provider + Module Type: Rtd Provider + Maintainer: dev@1plusx.com + +## Description + +RTD provider for 1plusX. +Enriches the bidding object with Audience & Targeting data +Contact dev@1plusx.com for information. + +## Usage +TODO + +## Supported Bidders +Appnexus; Magnite +Others ? + +## Parameters +TODO \ No newline at end of file From ff59bf85841172921b72b6c47f8253aea8161dd5 Mon Sep 17 00:00:00 2001 From: Anass Seddiki Date: Wed, 22 Jun 2022 07:52:17 +0000 Subject: [PATCH 2/3] Added info to md file --- modules/1plusXRtdProvider.md | 59 +++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 5 deletions(-) diff --git a/modules/1plusXRtdProvider.md b/modules/1plusXRtdProvider.md index 1fd83c48747..3843d084ccc 100644 --- a/modules/1plusXRtdProvider.md +++ b/modules/1plusXRtdProvider.md @@ -13,11 +13,60 @@ Enriches the bidding object with Audience & Targeting data Contact dev@1plusx.com for information. ## Usage -TODO + +### Build +``` +gulp build --modules="rtdModule,1plusXRtdProvider,appnexusBidAdapter,..." +``` + +> Note that the global RTD module, `rtdModule`, is a prerequisite of the 1plusX RTD module. + +### Configuration + +```javascript +var TIMEOUT = 1000; +pbjs.setConfig({ + realTimeData: { + auctionDelay: TIMEOUT, + dataProviders: [{ + name: '1plusX', + waitForIt: true, + params: { + customerId: 'acme', + bidders: ['appnexus', 'rubicon'], + timeout: TIMEOUT + } + }] + } +}); +``` + +### Parameters + +| Name |Type | Description | Notes | +| :------------ | :------------ | :------------ |:------------ | +| name | String | Real time data module name | Always '1plusX' | +| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` | +| params | Object | | | +| params.customerId | Integer | Your 1plusX customer id | | +| params.biders | Array | List of bidders for which you would like data to be set | To this date only `appnexus` and `rubicon` are supported | +| params.timeout | Integer | timeout (ms) | 1000 | ## Supported Bidders -Appnexus; Magnite -Others ? +At the moment only Appnexus (`appnexus`) and Magnite (`rubicon`) are supported + + +| Bidder | ID (for `bidders` parameter) | Module name (for `gulp build`) | +| ------- | ---------------------------- | ------------------------------ | +| Xandr | `appnexus` | `appnexusBidAdapter` | +| Magnite | `rubicon` | `rubiconBidAdapter` | + +## Testing + +To view an example of how the 1plusX RTD module works : + +`gulp serve --modules=rtdModule,1plusXRtdProvider,appnexusBidAdapter,rubiconBidAdapter` + +and then point your browser at: -## Parameters -TODO \ No newline at end of file +`http://localhost:9999/integrationExamples/gpt/1plusXRtdProvider_example.html` From 7dd8b1013aaa1f0cad8f61327a2033c8c5ff7cd4 Mon Sep 17 00:00:00 2001 From: Anass Seddiki Date: Wed, 22 Jun 2022 07:55:50 +0000 Subject: [PATCH 3/3] Add a bit of details --- modules/1plusXRtdProvider.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/1plusXRtdProvider.md b/modules/1plusXRtdProvider.md index 3843d084ccc..caa60bf90e6 100644 --- a/modules/1plusXRtdProvider.md +++ b/modules/1plusXRtdProvider.md @@ -23,6 +23,10 @@ gulp build --modules="rtdModule,1plusXRtdProvider,appnexusBidAdapter,..." ### Configuration +Use `setConfig` to instruct Prebid.js to initilize the 1plusX RTD module, as specified below. + +This module is configured as part of the `realTimeData.dataProviders` + ```javascript var TIMEOUT = 1000; pbjs.setConfig({