Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JW Player RTD Module - dev doc improvements #6811

Merged
merged 2 commits into from
May 21, 2021
Merged

JW Player RTD Module - dev doc improvements #6811

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a7d1bf
fixes markdown
May 18, 2021
9cb6644
adds clarity to player ID
May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions modules/jwplayerRtdProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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: {
Expand All @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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