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

[AD-1505] [RTD - JW Player] Write to oRTB content segments #3474

Merged
merged 1 commit into from
Jan 14, 2022
Merged

[AD-1505] [RTD - JW Player] Write to oRTB content segments #3474

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 28 additions & 16 deletions dev-docs/modules/jwplayerRtdProvider.md
View file
Open in desktop
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