Skip to content

Commit

Permalink
[JW Player RTD Module] Updates docs for new content fields and deprec…
Browse files Browse the repository at this point in the history
…ated config param (#5190)

* updates docs for new content fields and deprecate config

* mentions playerID deprecation

* documents new params

* typo fix
  • Loading branch information
karimMourra authored Apr 13, 2024
1 parent f3d0b95 commit ec2dc30
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions dev-docs/modules/jwplayerRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,23 @@ To use this module, you'll need to work with [JW Player](https://www.jwplayer.co
| waitForIt | Boolean | Required to ensure that the auction is delayed until prefetch is complete | Optional. Defaults to false |
| params | Object | | |
| params.mediaIDs | Array of Strings | Media Ids for prefetching | Optional |
| params.overrideContentId | String enum: 'always', 'whenEmpty' or 'never' | Determines when the module should update the oRTB site.content.id | Defaults to 'always' |
| params.overrideContentUrl | String enum: 'always', 'whenEmpty' or 'never' | Determines when the module should update the oRTB site.content.url | Defaults to 'whenEmpty' |
| params.overrideContentTitle | String enum: 'always', 'whenEmpty' or 'never' | Determines when the module should update the oRTB site.content.title | Defaults to 'whenEmpty' |
| params.overrideContentDescription | String enum: 'always', 'whenEmpty' or 'never' | Determines when the module should update the oRTB site.content.ext.description | Defaults to 'whenEmpty' |

4. Include the content's media ID and/or the player's ID in the matching AdUnit's `fpd.context.data.jwTargeting` before calling `addAdUnits`:
```javascript
const adUnit = {1
const adUnit = {
code: '/19968336/prebid_native_example_1',
...,
ortb2Imp: {
ext: {
data: {
jwTargeting: {
// Note: the following Ids are placeholders and should be replaced with your Ids.
playerID: 'abcd',
playerDivId: 'abcd',
mediaID: '1234'
}
}
Expand All @@ -100,7 +104,8 @@ To use this module, you'll need to work with [JW Player](https://www.jwplayer.co
| :------------ | :------------ | :------------ |:------------ |
| ortb2Imp.ext.data.jwTargeting | Object | | |
| ortb2Imp.ext.data.jwTargeting.mediaID | String | Media Id of the content associated to the Ad Unit | Optional but highly recommended |
| ortb2Imp.ext.data.jwTargeting.playerID | String | the ID of the HTML div element used when instantiating the JW Player instance that will render the content associated with the Ad Unit | Optional but recommended. You can retrieve this ID by calling `player.id`, where player is the JW Player instance variable. |
| ortb2Imp.ext.data.jwTargeting.playerDivId | String | the ID of the HTML div element used when instantiating the JW Player instance that will render the content associated with the Ad Unit | Optional but recommended. You can retrieve this ID by calling `player.id`, where player is the JW Player instance variable. |
| ortb2Imp.ext.data.jwTargeting.playerID | String | Deprecated as of 8.40.0 - use playerDivId instead | |

## Implementation for Bid Adapters

Expand All @@ -118,6 +123,8 @@ Each bidRequest for which targeting information was found will conform to the fo
site: {
content: {
id: 'jw_abc123',
title: 'media title',
url: 'https:www.cdn.com/media.mp4',
data: [
{
name: 'jwplayer.com',
Expand All @@ -134,7 +141,10 @@ Each bidRequest for which targeting information was found will conform to the fo
}
]
}
]
],
ext: {
description: 'media description'
}
}
}
}
Expand All @@ -152,6 +162,9 @@ The content's ID can be obtained in the `bid.ortb2.site.content.id` property pat
| :------------ | :------------ | :------------ |:------------ |
| ortb2.site.content | Object | | |
| ortb2.site.content.id | String | Unique identifier for the specific media asset | |
| ortb2.site.content.url | String | URL for the specific media asset | |
| ortb2.site.content.title | String | The title of the media content | |
| ortb2.site.content.ext.description | String | The description of the media content | |
| ortb2.site.content.data | Array | Contains segment taxonomy objects | |
| ortb2.site.content.data[index].name | String | the `jwplayer.com` string indicating the provider name | |
| ortb2.site.content.data[index].ext.segtax | Integer | the `502` value is the unique identifier for JW Player's proprietary taxonomy | |
Expand Down

0 comments on commit ec2dc30

Please sign in to comment.