diff --git a/dev-docs/modules/index.md b/dev-docs/modules/index.md index 41806bdfab..6a52e75970 100644 --- a/dev-docs/modules/index.md +++ b/dev-docs/modules/index.md @@ -47,7 +47,7 @@ If you are looking for bidder adapter parameters, see [Bidders' Params]({{site.b | [**Freewheel**](/dev-docs/modules/freewheel.html) | Passes key value targeting to Freewheel SDK | | [**Google Ad Manager Video**](/dev-docs/modules/dfp_video.html) | Required for serving instream video through Google Ad Manager. | | [**IAB Category Translation**](/dev-docs/modules/categoryTranslation.html) | Converts IAB sub category to Ad server category for long-form videos. | -| [**Konduit Accelerate**](/dev-docs/modules/konduit.html) | Module for serving instream video through Konduit Accelerate service. | +| [**Konduit Accelerate**](/dev-docs/modules/konduit.html) | Provides Real Time Start Rate Performance per Bidder. | ## Testing and Debug Modules diff --git a/dev-docs/modules/konduit.md b/dev-docs/modules/konduit.md index ffec9daf42..86aa76663e 100644 --- a/dev-docs/modules/konduit.md +++ b/dev-docs/modules/konduit.md @@ -8,55 +8,86 @@ display_name : Konduit Accelerate enable_download : true sidebarType : 1 --- - +​ # Konduit Accelerate Module {:.no_toc} - -The Konduit Accelerate module applies the [Konduit](http://konduit.me/) video acceleration optimization to a publisher’s existing Prebid setup. This optimization can reduce load times and increase ad starts. To install the module, follow these instructions: - - +​ +The Konduit Accelerate module applies the [Konduit](https://konduitvideo.com/) video acceleration optimization to a publisher’s existing Prebid setup. This optimization provides publishers with tools to monetize previously lost revenue and drive higher fill rates on their video inventory. +​ +To install the module, follow these instructions: + ### Step 1: Prepare the base Prebid file - +​ Build your Prebid.js package in one of two ways: - -1. Receive an email package from the Prebid [Download](/download.html) page. -2. From the command line, run +​ +- Receive an email package from the Prebid [Download](/download.html) page. +​ +- From the command line, run `gulp build --modules=konduitWrapper,...` - - +​ +​ ### Step 2: Implement module code on page - +​ +- Add konduitId as config using `setConfig` prebid method (`pbjs.setConfig({ konduit: { konduitId: your_konduit_id } })`) +​ - Insert the Konduit module code in the source code of your page. - The module exposes the `pbjs.adServers.konduit.buildVastUrl` function. -- Provide input parameters to the function, including a bid to be accelerated (usually a winning bid) and Konduit-specific parameters (as shown in the sample code below). - - + The module exposes the `pbjs.adServers.konduit.processBids` function. + +- Provide input parameters to the function (all parameters are shown in the table below). +​ +{: .table .table-bordered .table-striped } + | Param | Type | Description | Default | + |---+---+---+---+---| + | bid | object | prebid object with VAST url that should be cached | if the bid parameter is not passed then first winning bid will be used | + | adUnitCode | string | adUnitCode where a winner bid can be found | - | + | timeout | number | max time to wait for Konduit response with cache key and kCpm data | 1000 | + | callback | function | callback function is called once Konduit caches data for the bid. Arguments of this function are - `error` and `bids` (error should be `null` if Konduit request is successful). | - | + +### Step 3: GAM related configuration +​ +In order for Konduit’s module to be completely integrated, line item Creatives need to be adjusted in GAM. +Please contact [support@konduit.me](mailto:support@konduit.me) for assistance. +​ +Standard implementation requires only Creative VAST URL update with the following URL: +``` +https://p.konduit.me/api/vastProxy?konduit_hb=1&konduit_hb_awarded=1&konduit_cache_key=%%PATTERN:konduit_cache_key%%&konduit_id=%%PATTERN:konduit_id%% +``` +​ ### Sample Code - +​ We recommended using the Konduit module function call in the `bidsBackHandler` callback function. - +​ ```javascript pbjs.que.push(function() { + pbjs.setConfig({ + konduit: { + konduitId: your_konduit_id, + } + }); pbjs.addAdUnits(videoAdUnits); pbjs.requestBids({ bidsBackHandler: function(bids) { var winnerBid = pbjs.getHighestCpmBids('videoAd')[0]; - - var vastTagUrl = pbjs.adServers.konduit.buildVastUrl({ +​ + pbjs.adServers.konduit.processBids({ bid: winnerBid, - params: { - konduit_id: '{konduit_client_id}', + adUnitCode: videoAdUnit[0].code, + timeout: 1500, + callback: function (error, bids) { + var videoUrl = pbjs.adServers.dfp.buildVideoUrl({ + ... + }); +​ + invokeVideoPlayer(videoUrl); } }); - - invokeVideoPlayer(vastTagUrl); } }); }); ``` - - +​ +​ ## Further Reading - +​ [Getting Started Example]({{site.baseurl}}/dev-docs/getting-started.html) -[Prebid.js for Video]({{site.baseurl}}/prebid-video/video-overview.html) +[Prebid.js for Video]({{site.baseurl}}/prebid-video/video-overview.html) diff --git a/overview/analytics.md b/overview/analytics.md index ac78af74a8..9fa10a4839 100644 --- a/overview/analytics.md +++ b/overview/analytics.md @@ -22,6 +22,7 @@ There are several analytics adapter plugins available to track header bidding pe | [Google Analytics]({{site.baseurl}}/overview/ga-analytics.html) | Free up to a certain volume. See [terms](https://www.google.com/analytics/terms/) | [Website](https://www.google.com/analytics) | | Invisibly Analytics | Contact vendor | [Website](https://invisibly.com/) | | Kargo Analytics | Contact vendor | [Website](https://kargo.com/) | +| Konduit Accelerate | Contact vendor | [Website](https://konduitvideo.com/) | | Livewrapped Analytics | Contact vendor | [Website](https://livewrapped.com/) | | LiveYield | Contact vendor | [Website](https://www.pubocean.com/liveyield) | | OpenX | Contact vendor | [Website](https://www.openx.com/publishers/header-bidding/) |