diff --git a/modules/jwplayerRtdProvider.md b/modules/jwplayerRtdProvider.md index 0723e8cbb6c..7fb1bb13d74 100644 --- a/modules/jwplayerRtdProvider.md +++ b/modules/jwplayerRtdProvider.md @@ -2,7 +2,7 @@ The purpose of this Real Time Data Provider is to allow publishers to target aga having to integrate with the Player Bidding product. This prebid module makes JW Player's video ad targeting information accessible to Bid Adapters. -#Usage for Publishers: +# Usage for Publishers: Compile the JW Player RTD Provider into your Prebid build: @@ -30,7 +30,7 @@ Lastly, include the content's media ID and/or the player's ID in the matching Ad ```javascript const adUnit = { code: '/19968336/prebid_native_example_1', - ... + ..., ortb2Imp: { ext: { data: { @@ -51,10 +51,12 @@ pbjs.que.push(function() { }); }); ``` +**Note**: The player ID is the ID of the HTML div element used when instantiating the player. +You can retrieve this ID by calling `player.id`, where player is the JW Player instance variable. **Note**: You may also include `jwTargeting` information in the prebid config's `ortb2.site.ext.data`. Information provided in the adUnit will always supersede, and information in the config will be used as a fallback. -##Prefetching +## Prefetching In order to prefetch targeting information for certain media, include the media IDs in the `jwplayerDataProvider` var and set `waitForIt` to `true`: ```javascript @@ -76,7 +78,7 @@ realTimeData = { }; ``` -#Usage for Bid Adapters: +# Usage for Bid Adapters: Implement the `buildRequests` function. When it is called, the `bidRequests` param will be an array of bids. Each bid for which targeting information was found will conform to the following object structure: @@ -118,6 +120,6 @@ To view an example: **Note:** the mediaIds in the example are placeholder values; replace them with your existing IDs. -#Maintainer info +# Maintainer info Maintained by JW Player. For any questions, comments or feedback please contact Karim Mourra, karim@jwplayer.com