Skip to content

Commit

Permalink
updates docs for 9.0 api changes
Browse files Browse the repository at this point in the history
  • Loading branch information
karimMourra committed Jun 4, 2024
1 parent c7ace0c commit 1525d46
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions dev-docs/modules/jwplayerRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ To use this module, you'll need to work with [JW Player](https://www.jwplayer.co
name: "jwplayer",
waitForIt: true,
params: {
mediaIDs: ['abc', 'def', 'ghi', 'jkl']
mediaIDs: ['abc', 'def', 'ghi', 'jkl'],
overrideContentId: 'always',
overrideContentUrl: 'always',
overrideContentTitle: 'always',
overrideContentDescription: 'always'
}
}]
}
Expand All @@ -65,7 +69,7 @@ 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.overrideContentId | String enum: 'always', 'whenEmpty' or 'never' | Determines when the module should update the oRTB site.content.id | Defaults to 'whenEmpty' |
| 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' |
Expand Down Expand Up @@ -182,6 +186,6 @@ To view an example:

* in your browser, navigate to:

`http://localhost:9999/integrationExamples/gpt/jwplayerRtdProvider_example.html`
`http://localhost:9999/integrationExamples/realTimeData/jwplayerRtdProvider_example.html`

**Note:** the mediaIds in the example are placeholder values; replace them with your existing IDs.

0 comments on commit 1525d46

Please sign in to comment.