Skip to content

Commit 549f32d

Browse files
authored
updates documentation (prebid#3474)
1 parent 39fabc0 commit 549f32d

1 file changed

Lines changed: 28 additions & 16 deletions

File tree

dev-docs/modules/jwplayerRtdProvider.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -110,31 +110,43 @@ Each bidRequest for which targeting information was found will conform to the fo
110110
adUnitCode: 'xyz',
111111
bidId: 'abc',
112112
...,
113-
rtd: {
114-
jwplayer: {
115-
targeting: {
116-
segments: ['123', '456'],
117-
content: {
118-
id: 'jw_abc123'
119-
}
120-
}
121-
}
122-
}
113+
ortb2: {
114+
site: {
115+
content: {
116+
id: 'jw_abc123',
117+
data: [{
118+
name: 'jwplayer',
119+
ext: {
120+
segtax: 502
121+
},
122+
segment: [{
123+
id: '123'
124+
}, {
125+
id: '456'
126+
}]
127+
}]
128+
}
129+
}
130+
}
123131
}
124132
```
133+
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).
125134

126-
Read the bidRequest.jwTargeting object and pass the values to your endpoint as appropriate.
135+
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`.
127136

128137
**BidRequest Syntax details:**
129138

130139
{: .table .table-bordered .table-striped }
131140
| Name |Type | Description | Notes |
132141
| :------------ | :------------ | :------------ |:------------ |
133-
| rtd.jwplayer.targeting | Object | | |
134-
| rtd.jwplayer.targeting.segments | Array of Strings | jwpseg targeting segments | |
135-
| rtd.jwplayer.targeting.content | Object | | |
136-
| rtd.jwplayer.targeting.content.id | String | Unique identifier for the specific media asset | |
137-
142+
| ortb2.site.content | Object | | |
143+
| ortb2.site.content.id | String | Unique identifier for the specific media asset | |
144+
| ortb2.site.content.data | Array | Contains segment taxonomy objects | |
145+
| ortb2.site.content.data[index].name | String | the `jwplayer` string indicating the provider name | |
146+
| ortb2.site.content.data[index].ext.segtax | Integer | the `502` value is the unique identifier for JW Player's proprietary taxonomy | |
147+
| ortb2.site.content.data[index].segment | Array | Contains the segment taxonomy values as an object | |
148+
| ortb2.site.content.data[index].segment[index].id | String | String representation of the data segment value | |
149+
138150
## Example
139151

140152
To view an example:

0 commit comments

Comments
 (0)