Skip to content

Commit

Permalink
updates documentation (#3474)
Browse files Browse the repository at this point in the history
  • Loading branch information
karimMourra authored Jan 14, 2022
1 parent 39fabc0 commit 549f32d
Showing 1 changed file with 28 additions and 16 deletions.
44 changes: 28 additions & 16 deletions dev-docs/modules/jwplayerRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,31 +110,43 @@ Each bidRequest for which targeting information was found will conform to the fo
adUnitCode: 'xyz',
bidId: 'abc',
...,
rtd: {
jwplayer: {
targeting: {
segments: ['123', '456'],
content: {
id: 'jw_abc123'
}
}
}
}
ortb2: {
site: {
content: {
id: 'jw_abc123',
data: [{
name: 'jwplayer',
ext: {
segtax: 502
},
segment: [{
id: '123'
}, {
id: '456'
}]
}]
}
}
}
}
```
Each bid for which targeting information was found will have a ortb2 param conforming to the [oRTB v2 object structure](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf). The `ortb2` object will contain our proprietaty targeting segments in a format compliant with the [IAB's segment taxonomy structure](https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/extensions/community_extensions/segtax.md).

Read the bidRequest.jwTargeting object and pass the values to your endpoint as appropriate.
The content's ID can be obtained in the `bid.ortb2.site.content.id` property path and the targeting segments can be found in `bid.ortb2.site.content.data.segment`.

**BidRequest Syntax details:**

{: .table .table-bordered .table-striped }
| Name |Type | Description | Notes |
| :------------ | :------------ | :------------ |:------------ |
| rtd.jwplayer.targeting | Object | | |
| rtd.jwplayer.targeting.segments | Array of Strings | jwpseg targeting segments | |
| rtd.jwplayer.targeting.content | Object | | |
| rtd.jwplayer.targeting.content.id | String | Unique identifier for the specific media asset | |

| ortb2.site.content | Object | | |
| ortb2.site.content.id | String | Unique identifier for the specific media asset | |
| ortb2.site.content.data | Array | Contains segment taxonomy objects | |
| ortb2.site.content.data[index].name | String | the `jwplayer` 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 | |
| ortb2.site.content.data[index].segment | Array | Contains the segment taxonomy values as an object | |
| ortb2.site.content.data[index].segment[index].id | String | String representation of the data segment value | |

## Example

To view an example:
Expand Down

0 comments on commit 549f32d

Please sign in to comment.