From 583f21bb5ddbdfa3b58b15c5d6524a8dc44a2cc9 Mon Sep 17 00:00:00 2001 From: torizoemitchell Date: Mon, 6 Feb 2023 19:22:56 -0700 Subject: [PATCH 1/3] add TOC, server side and client side sections --- dev-docs/bidders/sovrn.md | 54 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/dev-docs/bidders/sovrn.md b/dev-docs/bidders/sovrn.md index 89326a2289..c4f6d1242c 100644 --- a/dev-docs/bidders/sovrn.md +++ b/dev-docs/bidders/sovrn.md @@ -13,9 +13,62 @@ schain_supported: true gvl_id: 13 floors_supported: true media_types: banner, video +multiformat_supported: yes +safeframes_ok: no sidebarType: 1 --- +### Table of contents + +- [Introduction](#introduction) +- [Client-side Integration](#client-side) +- [Server-side Integration](#server-side) +- [Display Bid Params](#display) +- [Video Bid Params](#video) +- [Examples](#examples) + + + +### Introduction +**Publishers may access the Sovrn ad network through our Prebid.js and Prebid Server adapters.** + +Both of these modules are GDPR and CCPA compliant. +The Sovrn ad exchange relies on the ad unit format where banner and video properties, including the size parameter, are stored in the `adUnits[].mediaTypes` object. + + + +### Client-side Integration +**Set up Prebid.js to call Sovrn directly from the browser.** + +1. Download [Prebid.js](https://docs.prebid.org/download.html) from the Prebid site to use the standard compiled binary that Prebid includes in the download process and select Sovrn as an adapter. +2. Define the Sovrn-specific parameters at the bidder level including setting `sovrn` as the bidder. For Sovrn bidder-specific parameters, see the Bid request parameters section below, and the examples at the end of this article. +3. Define your ad units in the adUnit object. Sovrn requires you use the Zone ID for this parameter. For more information about this object, see Prebid’s [Ad Unit Reference](https://docs.prebid.org/dev-docs/adunit-reference.html) documentation. +4. Enable user syncing by adding the following code in the pbjs.setConfig() function. Sovrn strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Index bid rate and bid price. Make sure to call pbjs.setConfig() only once. This configuration is optional in Prebid, but highly recommended by Sovrn. + +INSERT CODE HERE??? + + + +### Server-side Integration +**Set up Prebid.js to call Sovrn through Prebid Server.** + +In this configuration, Prebid.js makes a call to Prebid Server and then Prebid Server uses our server-side adapter to call Sovrn. Complete the following steps to complete the Sovrn-specific configuration: + +In your PrebidServer adapter configuration Prebid.js, you must enable the Sovrn adapter as follows: + +``` +adapters.sovrn.enabled=true +adapters.sovrn.endpoint=http:// +``` + +1. In the `pbjs.setConfig()` function, within the `s2sConfig` property, add `sovrn` to the `bidders` attribute. +2. Define the Sovrn-specific parameters at the bidder level. For Sovrn's bidder-specific parameters, see the examples section below. +3. Define your ad units in the `adUnit` object. For more information about this object, see Prebid’s [Ad Unit Reference](https://docs.prebid.org/dev-docs/adunit-reference.html) documentation. +4. Enable user syncing by adding the following code in the `pbjs.setConfig()` function. Sovrn strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases bid rate and bid price. Be sure to call `pbjs.setConfig()` only once. This configuration is optional in Prebid, but highly recommended by Sovrn. +5. Ensure that you are utilizing the `pbs.lijit.com` endpoint for your Sovrn connection. + +CONFIRM #5 IS CORRECT + ### Bid Params {: .table .table-bordered .table-striped } @@ -122,6 +175,7 @@ video/3gpp Source: [OpenRTB scpecification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) ### Example +Below are example JavaScript objects that the Sovrn adapter will translate into JSON. #### Video instream adUnit From 880649f851a6679239a43598cef113eed5b163df Mon Sep 17 00:00:00 2001 From: torizoemitchell Date: Tue, 7 Feb 2023 16:13:54 -0700 Subject: [PATCH 2/3] add headers, bid param descriptios, notes. formatting. --- dev-docs/bidders/sovrn.md | 139 +++++++++++++++++++++++++++----------- 1 file changed, 98 insertions(+), 41 deletions(-) diff --git a/dev-docs/bidders/sovrn.md b/dev-docs/bidders/sovrn.md index c4f6d1242c..70adc8bf0a 100644 --- a/dev-docs/bidders/sovrn.md +++ b/dev-docs/bidders/sovrn.md @@ -23,8 +23,14 @@ sidebarType: 1 - [Introduction](#introduction) - [Client-side Integration](#client-side) - [Server-side Integration](#server-side) -- [Display Bid Params](#display) -- [Video Bid Params](#video) +- [Bid Params (Display and Video)](#bid-params) + - [Notes for Display](#notes-for-display) +- [Video-Specific Bid Params](#video) + - [MIME Types](#mime-types) + - [Playback Methods](#playback-methods) + - [Playback Cessation Modes](#playback-cessation-modes) + - [Ad Position](#ad-position) + - [API Framework](#sovrn-api-framework) - [Examples](#examples) @@ -45,7 +51,18 @@ The Sovrn ad exchange relies on the ad unit format where banner and video proper 3. Define your ad units in the adUnit object. Sovrn requires you use the Zone ID for this parameter. For more information about this object, see Prebid’s [Ad Unit Reference](https://docs.prebid.org/dev-docs/adunit-reference.html) documentation. 4. Enable user syncing by adding the following code in the pbjs.setConfig() function. Sovrn strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Index bid rate and bid price. Make sure to call pbjs.setConfig() only once. This configuration is optional in Prebid, but highly recommended by Sovrn. -INSERT CODE HERE??? +``` +pbjs.setConfig({ + userSync: { + filterSettings: { + iframe: { + bidders: 'sovrn', + filter: 'include' + } + } + } +}); +``` @@ -67,17 +84,48 @@ adapters.sovrn.endpoint=http:// 4. Enable user syncing by adding the following code in the `pbjs.setConfig()` function. Sovrn strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases bid rate and bid price. Be sure to call `pbjs.setConfig()` only once. This configuration is optional in Prebid, but highly recommended by Sovrn. 5. Ensure that you are utilizing the `pbs.lijit.com` endpoint for your Sovrn connection. -CONFIRM #5 IS CORRECT + ### Bid Params +**Bid parameters for display and video** {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |------------|----------|----------------------|------------|----------| -| `tagid` | required | The sovrn Ad Tag ID | `'315045'` | `string` | -| `bidfloor` | optional | Bid floor in dollars | `'0.04'` | `string` | +| `tagid` | required | The sovrn Ad Tag ID | `'315045'` | `string` | +| `bidfloor` | optional | Bid floor in dollars. This will override any settings defined in the Sovrn Platform. If no bidfloor is set here or defined in the Sovrn Platform, it defaults to 0. | `0.04` | `float` | +| `domain` | required | Must be a domain that has been submitted and approved in your Sovrn account in order to monetize. | `"abc.com"` | `string` | +| `site.publisher.id`| optional | Sovrn publisher id, which can be found in your Sovrn account. | `'315045'` | `string` | +| `user.buyeruid` | required | Buyer-specific ID for the user as mapped by the exchange for the buyer (hashed). | `"a303ebccfb5cf5c32610b15c"` | `string` | + + + +#### Notes for Display + +How to view bid requests sent to Sovrn: +1. Go to a page with Sovrn ads. A good example is [worldhistory.org](https://www.worldhistory.org/) +2. Open the Developer tools. +3. In Developer tools, click the Network tab. +4. In the Network tab, search for requests sent to lijit.com. + +Recommended Global Bidder settings: +- Sovrn recommends enabling local storage. As of Prebid.js 7.x, local storage access must be explicitly specified. By leveraging local storage, Sovrn is able to take advantage of the latest features our exchange has to offer. For instructions on enabling local storage, see Prebid’s pbjs.bidderSettings documentation. +- Example: +``` +pbjs.bidderSettings = { + sovrn: { + storageAllowed: true + } +}; +``` + + -Bid Params for video ads. These params should be added to `mediatype.video`. + + + +### Video-specific Bid Params +**Bid Pparameters for video ads. These params should be added to `mediatype.video`.** {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | @@ -107,24 +155,24 @@ Bid Params for video ads. These params should be added to `mediatype.video`. | `api` | recommended | List of supported API frameworks for this impression. Refer to [API Frameworks](#sovrn-api-frameworks) | `[1, 2, 3]` | `integer array` | -### Note - -[Protocols list](#epsilon-protocols) +*note: +[Protocols list](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-subtypes---audiovideo-) -#### MIME types: + +#### MIME types -##### With VPAID2: +With VPAID2 +- video/mp4 +- video/3gpp +- application/javascript -video/mp4, -video/3gpp, -application/javascript +Without VPAID +- video/mp4 +- video/3gpp -##### Without VPAID2: + -video/mp4, -video/3gpp - -#### Video Playback Methods: +#### Playback Methods {: .table .table-bordered .table-striped } | Value | Description | @@ -136,7 +184,9 @@ video/3gpp | `5` | Initiates on Entering Viewport with Sound On | | `6` | Initiates on Entering Viewport with Sound Off by Default | -#### Playback Cessation Modes: + + +#### Playback Cessation Modes {: .table .table-bordered .table-striped } | Value | Description | @@ -145,7 +195,9 @@ video/3gpp | `2` | On Leaving Viewport or when Terminated by User | | `3` | On Leaving Viewport Continues as a Floating/Slider Unit until Video Completion or when Terminated by User | -#### Ad Position: + + +#### Ad Position {: .table .table-bordered .table-striped } | Value | Description | @@ -160,7 +212,9 @@ video/3gpp | `7` | Full Screen | -#### API Frameworks: + + +#### API Frameworks {: .table .table-bordered .table-striped } | Value | Description | @@ -172,12 +226,28 @@ video/3gpp | `5` | MRAID-2 | | `6` | MRAID-3 | -Source: [OpenRTB scpecification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) +*source: [OpenRTB scpecification](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf) + + -### Example -Below are example JavaScript objects that the Sovrn adapter will translate into JSON. +### Examples +**Below are example JavaScript objects.** The Sovrn adapter will translate these into JSON. -#### Video instream adUnit +#### Display + +``` + var bannerAdUnit = { + code: 'banner-div', + sizes: [[300, 250]], + bids: [{ + bidder: 'sovrn', + params: { + tagid: '315045' + } + }] + } +``` +#### Video instream ``` var instreamAdUnit = { @@ -199,7 +269,7 @@ Below are example JavaScript objects that the Sovrn adapter will translate into }] } ``` -#### Video outstream adUnit +#### Video outstream ``` var outstreamAdUnit = { @@ -221,17 +291,4 @@ Below are example JavaScript objects that the Sovrn adapter will translate into }] }, ``` -#### Banner adUnit -``` - var bannerAdUnit = { - code: 'banner-div', - sizes: [[300, 250]], - bids: [{ - bidder: 'sovrn', - params: { - tagid: '315045' - } - }] - } -``` From fd17f0fe68b0d5037463d7a2cbb3e6120f057c67 Mon Sep 17 00:00:00 2001 From: torizoemitchell Date: Tue, 14 Mar 2023 16:07:00 -0600 Subject: [PATCH 3/3] fix ortb supported version --- dev-docs/bidders/sovrn.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/dev-docs/bidders/sovrn.md b/dev-docs/bidders/sovrn.md index 70adc8bf0a..05e306982c 100644 --- a/dev-docs/bidders/sovrn.md +++ b/dev-docs/bidders/sovrn.md @@ -119,9 +119,6 @@ pbjs.bidderSettings = { }; ``` - - - ### Video-specific Bid Params @@ -226,7 +223,7 @@ Without VPAID | `5` | MRAID-2 | | `6` | MRAID-3 | -*source: [OpenRTB scpecification](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf) +*source: [OpenRTB scpecification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf)