From dad29528ae86e90eba1b5d67348287d0d908e42d Mon Sep 17 00:00:00 2001 From: Vinay Prasad Date: Wed, 1 Aug 2018 12:36:08 -0700 Subject: [PATCH 1/5] Changed the name of the file from tremor to telaria (Company was renamed) and updated the documentation --- dev-docs/bidders/{tremor.md => telaria.md} | 44 +++++++++++++++++----- 1 file changed, 35 insertions(+), 9 deletions(-) rename dev-docs/bidders/{tremor.md => telaria.md} (76%) diff --git a/dev-docs/bidders/tremor.md b/dev-docs/bidders/telaria.md similarity index 76% rename from dev-docs/bidders/tremor.md rename to dev-docs/bidders/telaria.md index 1042884ac6..dbacfcc554 100644 --- a/dev-docs/bidders/tremor.md +++ b/dev-docs/bidders/telaria.md @@ -1,35 +1,37 @@ --- layout: bidder -title: Tremor -description: Prebid Tremor Bidder Adaptor +title: Telaria +description: Prebid Telaria Bidder Adaptor top_nav_section: dev_docs nav_section: reference hide: true -biddercode: tremor +biddercode: telaria biddercode_longer_than_12: false media_types: video --- -This is the `tremor` adapter +This is the **Telaria** `(previously Tremor Video)` adapter ### bid params -{: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |-------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-----------| | `adCode` | required | The Ad Code from Tremor. | `'ssp-!demo!-lufip'` | `string` | | `supplyCode` | required | The Supply Code from Tremor. | `'ssp-%21demo%21-rm6rh'` | `string` | | `playerWidth` | optional | The width of the video player. Full-screen video fills the width of the device, that is, if the video can play in full screen mode, the player width is the screen width. | `600` | `integer` | | `playerHeight` | optional | The height of the video player. Full-screen video fills the height of the device, that is, if the video can play in full screen mode, the player height is the screen height. | `400` | `integer` | -| `mediaId` | optional | A unique (not random) value that identifies the content video aligned with the ad opportunity. Typically provided by the video player CMS. | `'12345'` | `string` | +| `videoId` | optional | A unique (not random) value that identifies the content video aligned with the ad opportunity. Typically provided by the video player CMS. | `'12345'` | `string` | | `mediaUrl` | optional | The URL to the content video source. | `'http://www.mycms.com/myhostedvideo.mp4'` | `string` | -| `mediaTitle` | optional | The title of the content video aligned with the ad opportunity. | `'Description of the content video'` | `string` | +| `videoTitle` | optional | The title of the content video aligned with the ad opportunity. | `'Description of the content video'` | `string` | | `contentLength` | optional | The length of the content video in seconds. | `120` | `integer` | | `srcPageUrl` | optional | The url of the page where the video ad will be displayed. | `'http://www.mysite.com/mycontentpage/'` | `string` | | `floor` | optional | This is a formatted string of values. The format is a comma separated list of "currency pairs". Each pair consists of a currency code and the floor for that currency, separated by a colon. | `'USD:5.00,AUD:7.25'` | `string` | | `efloor` | optional | Same as floor, except the entire string is encrypted using HMAC encryption and the encryption keys set on the supply's seat from the SSP UI. | `'IFHR00cxR5ul_t20sMQ0OsvMVP7fOS-mnVsxu78%3d'` | `string` | | `custom` | optional | Any custom value that will be later be available for reporting. | `'myCustomValue'` | `string` | +| `c2` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC2Value'` | `string` | +| `c3` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC3Value'` | `string` | +| `c4` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC4Value'` | `string` | | `categories` | optional | Validated against RTB table 6.1 (Send comma delimited list if more than one category applies. | `'IAB20,IAB20-1'` | `string` | | `keywords` | optional | Comma separated list of keywords describing the supply. | `'funny,television'` | `string` | | `srcRelationship` | optional | Describes the relationship between the content owner and the requestor of the ad opportunity. 1 for "direct", 0 for "indirect" | `1` | `integer` | @@ -43,10 +45,34 @@ This is the `tremor` adapter | `videoMaxBitrate` | optional | Maximum bitrate in kbps | `800` | `integer` | | `minDur` | optional | Minimum duration for an ad in seconds | `15` | `integer` | | `maxDur` | optional | Maximum duration for an ad in seconds | `60` | `integer` | +| `inclIdSync` | optional | If set to true, the Ad Server will return an `ext` object containing the user sync urls | `true` | `boolean` | +| `gdpr` | optional | 0=GDPR does not apply 1=GDPR applies. If the user is GDPR relevant based on IP address, it cannot be overriden | `1` | `integer` | +| `gdpr_consent` | optional | Encodes the consented-to purposes and vendor consent string, as obtained from the CMP JS API | This is an encoded consent string where Telaria has permissions: `BOQpb9yOQpb9yDKABBENAIwAAAB9uABAGUA` & `BOQpf97OQpf97AMABBENAIwAAAB9uABAAYA` for the opposite | `string` | -The following values are defined in the [ORTB 2.5 spec](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf). +### Other bid Params: +Please refer to the **Tag Parameters** section in the [Telaria Console](https://console.telaria.com) - +### Example Ad Unit +```javascript +var adUnit = { + "code": "video1", + "mediaTypes": { + "video": { + "playerSize": [640, 480], + "context": "instream" + } + }, + "bids": [{ + "bidder": "telaria", + "params": { + "supplyCode": "ssp-demo-rm6rh", + "adCode": "ssp-!demo!-lufip", + "videoId": "MyCoolVideo" + // Other params go here + } + }] +} +``` ### delivery From a0ac5fddde52ac8a5a55bf8486b6196f57387ea7 Mon Sep 17 00:00:00 2001 From: Vinay Prasad Date: Thu, 2 Aug 2018 09:20:17 -0700 Subject: [PATCH 2/5] - Added back the documentation for the older (prebid 0.x) adapter --- dev-docs/bidders/telaria.md | 5 +-- dev-docs/bidders/tremor.md | 62 +++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 dev-docs/bidders/tremor.md diff --git a/dev-docs/bidders/telaria.md b/dev-docs/bidders/telaria.md index dbacfcc554..45e33ac381 100644 --- a/dev-docs/bidders/telaria.md +++ b/dev-docs/bidders/telaria.md @@ -1,7 +1,7 @@ --- layout: bidder title: Telaria -description: Prebid Telaria Bidder Adaptor +description: **Prebid 1.x** Telaria Bidder Adaptor top_nav_section: dev_docs nav_section: reference hide: true @@ -10,7 +10,8 @@ biddercode_longer_than_12: false media_types: video --- -This is the **Telaria** `(previously Tremor Video)` adapter +### Overview +This documentation covers some of the parameters that the **Telaria** `(previously Tremor Video)` exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found in the **tremor.md** file ### bid params diff --git a/dev-docs/bidders/tremor.md b/dev-docs/bidders/tremor.md new file mode 100644 index 0000000000..37af20fe4e --- /dev/null +++ b/dev-docs/bidders/tremor.md @@ -0,0 +1,62 @@ +--- +layout: bidder +title: Tremor +description: **Prebid 0.x** Tremor Bidder Adaptor +top_nav_section: dev_docs +nav_section: reference +hide: true +biddercode: tremor +biddercode_longer_than_12: false +--- + +This is the `tremor` adapter + + +### bid params + +| Name | Scope | Description | Example | +|---------------------|----------|----------------------------------------------------|------------------| +| `adCode` | required | The Ad Code from Tremor. | `ssp-!demo!-lufip` | +|`supplyCode` | required | The Supply Code from Tremor. | `ssp-%21demo%21-rm6rh` | +|`playerWidth` | optional |The width of the video player. Full-screen video fills the width of the device, that is, if the video can play in full screen mode, the player width is the screen width. | `600` | +|`playerHeight` | optional | The height of the video player. Full-screen video fills the height of the device, that is, if the video can play in full screen mode, the player height is the screen height. | `400` | +|`mediaId` | optional | A unique (not random) value that identifies the content video aligned with the ad opportunity. Typically provided by the video player CMS. | `12345` | +|`mediaUrl` | optional | The URL to the content video source. | `http://www.mycms.com/myhostedvideo.mp4` | +|`mediaTitle` | optional | The title of the content video aligned with the ad opportunity. | `Description of the content video` | +|`contentLength` | optional | The length of the content video in seconds. | `120` | +|`srcPageUrl` | optional | The url of the page where the video ad will be displayed. | `http://www.mysite.com/mycontentpage/` | +|`floor` | optional | This is a formatted string of values. The format is a comma separated list of "currency pairs". Each pair consists of a currency code and the floor for that currency, separated by a colon. | `USD:5.00,AUD:7.25` | +|`efloor` | optional | Same as floor, except the entire string is encrypted using HMAC encryption and the encryption keys set on the supply's seat from the SSP UI. | `IFHR00cxR5ul_t20sMQ0OsvMVP7fOS-mnVsxu78%3d` | +|`custom` | optional | Any custom value that will be later be available for reporting. | `myCustomValue` | +|`categories` | optional | Validated against RTB table 6.1 (Send comma delimited list if more than one category applies. | `IAB20,IAB20-1` | +|`keywords` | optional | Comma separated list of keywords describing the supply. | `funny,television` | +|`srcRelationship` | optional | Describes the relationship between the content owner and the requestor of the ad opportunity. 1 for "direct", 0 for "indirect" | `1` | +|`blockDomains` | optional | A comma separated list of advertiser domains that should be added to the existing list of blocked advertiser domains that is set in the SSP console. | `blockthis.com, blockthat.com` | +|`skip` | optional | Is the video skippable? True or false. 1|T|Y is true and 0|F|N|null is false. | `1` | +|`skipmin` | optional | Shortest video ad (in seconds) that can be skipped. If provided and "skip" is not, then "skip" is automatically set to true. | `30` | +|`skipafter` | optional | Number of seconds after which the video can be skipped. If provided and "skip" is not, then "skip" is automatically set to true. | `15` | +|`delivery` | optional | Comma delimited listed of Integers representing allowed delivery methods. See below as well as RTB 2.5 specification for valid values. | `1,3` | +|`placement` | optional | Integer value of placement type. See below as well as RTB 2.5 specification for valid values. | `1` | +|`videoMinBitrate` | optional | Minimum bitrate in kbps | `400` | +|`videoMaxBitrate` | optional | Maximum bitrate in kbps | `800` | +|`minDur` | optional | Minimum duration for an ad in seconds | `15` | +|`maxDur` | optional | Maximum duration for an ad in seconds | `60` | + + +The following values are defined in the [ORTB 2.5 spec](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf). + + + +### delivery + ++ `1` : In-Stream: Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll). ++ `2` : In-Banner: Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery. ++ `3` : In-Article: Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message. ++ `4` : In-Feed: Found in content, social, or product feeds. ++ `5` : Interstitial/Slider/Floating: Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the imp.instl field. + +### placement + ++ `1` : Streaming ++ `2` : Progressive ++ `3` : Download \ No newline at end of file From b62f59c482867e2c492d7c02e5907157b78f1b55 Mon Sep 17 00:00:00 2001 From: Vinay Prasad Date: Thu, 2 Aug 2018 09:31:11 -0700 Subject: [PATCH 3/5] Removed the parameter section from the doc because they can change. Pubs using our adapter can login to our console to get a list of params. --- dev-docs/bidders/telaria.md | 38 +------------------------------------ 1 file changed, 1 insertion(+), 37 deletions(-) diff --git a/dev-docs/bidders/telaria.md b/dev-docs/bidders/telaria.md index 45e33ac381..878c06bf17 100644 --- a/dev-docs/bidders/telaria.md +++ b/dev-docs/bidders/telaria.md @@ -14,43 +14,7 @@ media_types: video This documentation covers some of the parameters that the **Telaria** `(previously Tremor Video)` exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found in the **tremor.md** file -### bid params - -| Name | Scope | Description | Example | Type | -|-------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-----------| -| `adCode` | required | The Ad Code from Tremor. | `'ssp-!demo!-lufip'` | `string` | -| `supplyCode` | required | The Supply Code from Tremor. | `'ssp-%21demo%21-rm6rh'` | `string` | -| `playerWidth` | optional | The width of the video player. Full-screen video fills the width of the device, that is, if the video can play in full screen mode, the player width is the screen width. | `600` | `integer` | -| `playerHeight` | optional | The height of the video player. Full-screen video fills the height of the device, that is, if the video can play in full screen mode, the player height is the screen height. | `400` | `integer` | -| `videoId` | optional | A unique (not random) value that identifies the content video aligned with the ad opportunity. Typically provided by the video player CMS. | `'12345'` | `string` | -| `mediaUrl` | optional | The URL to the content video source. | `'http://www.mycms.com/myhostedvideo.mp4'` | `string` | -| `videoTitle` | optional | The title of the content video aligned with the ad opportunity. | `'Description of the content video'` | `string` | -| `contentLength` | optional | The length of the content video in seconds. | `120` | `integer` | -| `srcPageUrl` | optional | The url of the page where the video ad will be displayed. | `'http://www.mysite.com/mycontentpage/'` | `string` | -| `floor` | optional | This is a formatted string of values. The format is a comma separated list of "currency pairs". Each pair consists of a currency code and the floor for that currency, separated by a colon. | `'USD:5.00,AUD:7.25'` | `string` | -| `efloor` | optional | Same as floor, except the entire string is encrypted using HMAC encryption and the encryption keys set on the supply's seat from the SSP UI. | `'IFHR00cxR5ul_t20sMQ0OsvMVP7fOS-mnVsxu78%3d'` | `string` | -| `custom` | optional | Any custom value that will be later be available for reporting. | `'myCustomValue'` | `string` | -| `c2` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC2Value'` | `string` | -| `c3` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC3Value'` | `string` | -| `c4` | optional | An optional custom value that may be passed into a request that will be able to be identified in reporting available through the SSP console | `'myCustomC4Value'` | `string` | -| `categories` | optional | Validated against RTB table 6.1 (Send comma delimited list if more than one category applies. | `'IAB20,IAB20-1'` | `string` | -| `keywords` | optional | Comma separated list of keywords describing the supply. | `'funny,television'` | `string` | -| `srcRelationship` | optional | Describes the relationship between the content owner and the requestor of the ad opportunity. 1 for "direct", 0 for "indirect" | `1` | `integer` | -| `blockDomains` | optional | A comma separated list of advertiser domains that should be added to the existing list of blocked advertiser domains that is set in the SSP console. | `'blockthis.com, blockthat.com'` | `string` | -| `skip` | optional | Is the video skippable? True or false. `1`,`T`,`Y` are true and `0`, `F`, `N`, `null` are false. | `'1'` | `string` | -| `skipmin` | optional | Shortest video ad (in seconds) that can be skipped. If provided and "skip" is not, then "skip" is automatically set to true. | `30` | `integer` | -| `skipafter` | optional | Number of seconds after which the video can be skipped. If provided and "skip" is not, then "skip" is automatically set to true. | `15` | `integer` | -| `delivery` | optional | Comma delimited listed of Integers representing allowed delivery methods. See below as well as RTB 2.5 specification for valid values. | `'1,3'` | `string` | -| `placement` | optional | Integer value of placement type. See below as well as RTB 2.5 specification for valid values. | `1` | `integer` | -| `videoMinBitrate` | optional | Minimum bitrate in kbps | `400` | `integer` | -| `videoMaxBitrate` | optional | Maximum bitrate in kbps | `800` | `integer` | -| `minDur` | optional | Minimum duration for an ad in seconds | `15` | `integer` | -| `maxDur` | optional | Maximum duration for an ad in seconds | `60` | `integer` | -| `inclIdSync` | optional | If set to true, the Ad Server will return an `ext` object containing the user sync urls | `true` | `boolean` | -| `gdpr` | optional | 0=GDPR does not apply 1=GDPR applies. If the user is GDPR relevant based on IP address, it cannot be overriden | `1` | `integer` | -| `gdpr_consent` | optional | Encodes the consented-to purposes and vendor consent string, as obtained from the CMP JS API | This is an encoded consent string where Telaria has permissions: `BOQpb9yOQpb9yDKABBENAIwAAAB9uABAGUA` & `BOQpf97OQpf97AMABBENAIwAAAB9uABAAYA` for the opposite | `string` | - -### Other bid Params: +### Bid Params Please refer to the **Tag Parameters** section in the [Telaria Console](https://console.telaria.com) ### Example Ad Unit From c68f74946b5eb6f1cdfa8edb8736b8e406cc9cc8 Mon Sep 17 00:00:00 2001 From: bretg Date: Thu, 9 Aug 2018 23:15:33 -0400 Subject: [PATCH 4/5] adding link made the reference to tremor a link, don't need the 1.0 note in the description -- moving to the prebid_1_0_supported flag --- dev-docs/bidders/telaria.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/dev-docs/bidders/telaria.md b/dev-docs/bidders/telaria.md index 878c06bf17..6a8facaeb7 100644 --- a/dev-docs/bidders/telaria.md +++ b/dev-docs/bidders/telaria.md @@ -1,17 +1,18 @@ --- layout: bidder title: Telaria -description: **Prebid 1.x** Telaria Bidder Adaptor +description: Telaria Bidder Adaptor top_nav_section: dev_docs nav_section: reference hide: true biddercode: telaria biddercode_longer_than_12: false +prebid_1_0_supported : true media_types: video --- ### Overview -This documentation covers some of the parameters that the **Telaria** `(previously Tremor Video)` exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found in the **tremor.md** file +This documentation covers some of the parameters that the **Telaria** `(previously Tremor Video)` exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found under [tremor]({{site.baseurl}}/dev-docs/bidders/bidders.html#tremor) ### Bid Params From ff80a4785e5f17acb96b176d885f660dd5fea50f Mon Sep 17 00:00:00 2001 From: Vinay Prasad Date: Mon, 1 Apr 2019 15:30:03 -0700 Subject: [PATCH 5/5] Updated to set gdpr_supported: true. --- dev-docs/bidders/telaria.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/bidders/telaria.md b/dev-docs/bidders/telaria.md index cf0c6669fe..4c2a257340 100644 --- a/dev-docs/bidders/telaria.md +++ b/dev-docs/bidders/telaria.md @@ -6,6 +6,7 @@ hide: true biddercode: telaria biddercode_longer_than_12: false media_types: video +gdpr_supported: true --- ### Overview