From 7eff4ce6288bbba9f36c1623c15c703d7a6aead2 Mon Sep 17 00:00:00 2001 From: Karim Mourra Date: Mon, 20 Dec 2021 16:57:46 -0500 Subject: [PATCH] updates documentation --- dev-docs/modules/jwplayerRtdProvider.md | 44 ++++++++++++++++--------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/dev-docs/modules/jwplayerRtdProvider.md b/dev-docs/modules/jwplayerRtdProvider.md index 2950e4fceb..346e354e93 100644 --- a/dev-docs/modules/jwplayerRtdProvider.md +++ b/dev-docs/modules/jwplayerRtdProvider.md @@ -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: