Bidders’ Params

This page contains documentation on the specific parameters required by each supported bidder.

For each bidder listed below, you’ll find the following information:

Bidder Code The unique code Prebid.js uses to identify the bidder
“Send All Bids” Ad Server Keys Used for sending all bids to the ad server, as described in Send All Bids to the Ad Server
“Default Deal ID” Ad Server Key Used for enabling deals using Prebid.js, as described in Enable Deals in Prebid
Bid Params Ad request parameters required by a given bidder, such as the tag ID, site ID, or query string parameters

In addition to the bidder-specific parameters, there are common parameters that appear in all bid responses.

For information about which bidders support video and native demand, see this list of bidders with video and native demand.

Bidders

Common Bid Response Parameters

The following parameters in the bidResponse object are common across all bidders.

Name Type Description Example
bidder String Unique bidder code used by ad server’s line items to identify the bidder "appnexus"
adId String Unique identifier of a bid creative. Used by the line item’s creative as in this example "123"
pbLg String Low granularity price bucket: $0.50 increment, capped at $5, floored to 2 decimal places (0.50, 1.00, 1.50, …, 5.00) "1.50"
pbMg String Medium granularity price bucket: 0.10 increment, capped at $20, floored to 2 decimal places (0.10, 0.20, …, 19.90, 20.00) "1.60"
pbHg String High granularity price bucket: 0.01 increment, capped at $20, floored to 2 decimal places (0.01, 0.02, …, 19.99, 20.00) "1.61"
size String Size of the bid creative; concatenation of width and height by ‘x’ "300x250"
width Integer Width of the bid creative in pixels 300
height Integer Height of the bid creative in pixels 250
adTag String Creative’s payload in HTML "<html><body><img src=\"http://cdn.com/creative.png\"></body></html>"

Bidders with Video and Native Demand

Bidder Supported Media Types Prebid 1.0 Support?
adform video X
adgeneration native X
adkernel video X
adkernelAdn video X
admixer video X
adtelligent video X
adxcg video, native X
aerserv video
aol video X
appnexusAst video, native
appnexus video, native X
audienceNetwork video, native X
beachfront video X
conversant video X
criteo native
ebdr video X
freewheel-ssp video X
gamma video X
getintent video X
gumgum native X
indexExchange video
lifestreet video X
mantis video, native X
mobfox video X
openx video X
optimatic video X
platformio video, native X
prebidServer video X
pulsepoint native X
pulsepointLite native
quantcast video X
quantum native X
readpeak native X
rhythmone video X
rockyou video X
rubicon video X
sekindoUM video X
sharethrough native X
smartadserver video X
smartyads native X
sonobi video X
spotx video
stickyadstv native
tremor video
unruly video, native
vertamedia video X
vuble video X
yieldlab video X
yieldmo native X

Bidders integrated with Prebid Server

Demand from the bidders listed below is available via the Prebid Server integration.

152Media

Bidder Code

oftmedia

"Send All Bids" Ad Server Keys

hb_pb_oftmedia hb_adid_oftmedia hb_size_oftmedia

"Default Deal ID" Ad Server Key

hb_deal_oftmedia

bid params

Name Scope Description Example
placementId required    

33Across

Bidder Code

33across

"Send All Bids" Ad Server Keys

hb_pb_33across hb_adid_33across hb_size_33across

"Default Deal ID" Ad Server Key

hb_deal_33across

bid params

Name Scope Description Example
siteId required Publisher GUID from 33Across 'pub123'
productId required 33Across Product ID that the Publisher has registered for (use only ‘siab’ for the present since others are not supported yet) 'siab'

A4g

Bidder Code

a4g

"Send All Bids" Ad Server Keys

hb_pb_a4g hb_adid_a4g hb_size_a4g

"Default Deal ID" Ad Server Key

hb_deal_a4g

bid params

Name Scope Description Example
zoneId required The A4G zone ID "59304"
deliveryUrl optional The bid endpoint (might be used for debug) "http://dev01.ad4game.com/v1/bid"

Aardvark

Bidder Code

aardvark

"Send All Bids" Ad Server Keys

hb_pb_aardvark hb_adid_aardvark hb_size_aardvark

"Default Deal ID" Ad Server Key

hb_deal_aardvark

bid params

Name Scope Description Example
ai required The rtk auction ID "XBC1"
sc required The rtk shortcode "AF2g"

Adblade

Bidder Code

adblade

"Send All Bids" Ad Server Keys

hb_pb_adblade hb_adid_adblade hb_size_adblade

"Default Deal ID" Ad Server Key

hb_deal_adblade

Note:

The Adblade Header Bidding adaptor requires setup and approval from the Adblade team. Please go to the Adblade publisher page for more details.

bid params

Name Scope Description Example
partnerId required Your partner ID (provided by Adblade) 39875
bidfloor optional The bid floor for units returned from Adblade 0.50

AdBund

Bidder Code

adbund

"Send All Bids" Ad Server Keys

hb_pb_adbund hb_adid_adbund hb_size_adbund

"Default Deal ID" Ad Server Key

hb_deal_adbund

bid params

Name Scope Description Example
sid required slot id 110238
bidfloor required   0.036

AdButler

Bidder Code

adbutler

"Send All Bids" Ad Server Keys

hb_pb_adbutler hb_adid_adbutler hb_size_adbutler

"Default Deal ID" Ad Server Key

hb_deal_adbutler

bid params

Name Scope Description Example
accountID required Account ID '167283'
zoneID required Zone ID '210093'
keyword optional Keyword(s) used for custom targeting 'green,orange'
minCPM optional Minimum CPM value to accept '1.00'
maxCPM optional Maximum CPM value to accept '5.00'

Adform

Bidder Code

adform

"Send All Bids" Ad Server Keys

hb_pb_adform hb_adid_adform hb_size_adform

"Default Deal ID" Ad Server Key

hb_deal_adform

bid params

Name Scope Description Example
mid required   12345
adxDomain optional The Adform domain "adx.adform.net"

Ad Generation

Bidder Code

adgeneration

"Send All Bids" Ad Server Keys

hb_pb_adgeneration hb_adid_adgeneration hb_size_adgeneration

"Default Deal ID" Ad Server Key

hb_deal_adgeneration

bid params

Name Scope Description Example
id required adId '1234'

AdKernel

Bidder Code

adkernel

"Send All Bids" Ad Server Keys

hb_pb_adkernel hb_adid_adkernel hb_size_adkernel

"Default Deal ID" Ad Server Key

hb_deal_adkernel

Note:

The Adkernel Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

bid params

Name Scope Description Example
host required Ad network’s RTB host 'cpm.metaadserving.com'
zoneId required RTB zone id '30164'

AdKernelAdn

Bidder Code

adkernelAdn

"Send All Bids" Ad Server Keys

hb_pb_adkernelAdn hb_adid_adkernelAdn hb_size_adkernelAdn

"Default Deal ID" Ad Server Key

hb_deal_adkernelAdn

Note:

The AdkernelAdn Header Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

bid params

Name Scope Description Example
host optional Ad network host 'tag.adkernel.com'
pubId required Publisher Id 102

AdMedia

Bidder Code

admedia

"Send All Bids" Ad Server Keys

hb_pb_admedia hb_adid_admedia hb_size_admedia

"Default Deal ID" Ad Server Key

hb_deal_admedia

bid params

Name Scope Description Example
aid required The Affiliate ID for the Publisher "1234"

AdMixer

Bidder Code

admixer

"Send All Bids" Ad Server Keys

hb_pb_admixer hb_adid_admixer hb_size_admixer

"Default Deal ID" Ad Server Key

hb_deal_admixer

bid params

Name Scope Description Example
zone required    

AdOcean

Bidder Code

adocean

"Send All Bids" Ad Server Keys

hb_pb_adocean hb_adid_adocean hb_size_adocean

"Default Deal ID" Ad Server Key

hb_deal_adocean

bid params

Name Scope Description Type Example
slaveId required slave ID string 'adoceanmyaozpniqismex'
masterId required master ID string 'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7'
emiter required traffic source id string 'myao.adocean.pl'

AdSparc

Bidder Code

adsparc

"Send All Bids" Ad Server Keys

hb_pb_adsparc hb_adid_adsparc hb_size_adsparc

"Default Deal ID" Ad Server Key

hb_deal_adsparc

bid params

Name Scope Description Example
siteId required The site ID from AdSparc. 12345
networkId required The network ID from AdSparc. 9969

AdSupply

Bidder Code

adsupply

"Send All Bids" Ad Server Keys

hb_pb_adsupply hb_adid_adsupply hb_size_adsupply

"Default Deal ID" Ad Server Key

hb_deal_adsupply

Note:

The AdSupply adapter requires setup and approval from the AdSupply team, even for existing AdSupply publishers. Please reach out to your account representative or support@adsupply.com for more information.

bid params

Name Scope Description Example
clientId required AdSupply client identifier. Provided by AdSupply. "b367CB268B1094004A3689751E7AC568F"
siteId required AdSupply site identifier. Provided by AdSupply. "9e3ba26d-eaac-4004-9c7d-c0ac269d0cf2"
zoneId required AdSupply zone identifier. A zone entity manages caps, sizes, etc. Provided by AdSupply. 28384
endpointUrl required AdSupply engine domain. engine.4dsply.com

Adtelligent

Bidder Code

adtelligent

"Send All Bids" Ad Server Keys

hb_pb_adtelligent hb_adid_adtelligent hb_size_adtelligent

"Default Deal ID" Ad Server Key

hb_deal_adtelligent

Bid params

Name Scope Description Example
aid required The source ID from Adtelligent. 350975

Description

Get access to multiple demand partners across Adtelligent AdExchange and maximize your yield with Adtelligent header bidding adapter.

Adtelligent header bidding adapter connects with Adtelligent demand sources in order to fetch bids. This adapter provides a solution for accessing Video demand and display demand

Test Parameters

    var adUnits = [

      // Video instream adUnit
      {
        code: 'div-test-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            context: 'instream'
          }
        },
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 331133
          }
        }]
      },

      // Video outstream adUnit
      {
        code: 'outstream-test-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            context: 'outstream'
          }
        },
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 331133
          }
        }]
      },

      // Banner adUnit
      {
        code: 'div-test-div',
        sizes: [[300, 250]],
        bids: [{
          bidder: 'adtelligent',
          params: {
            aid: 350975
          }
        }]
      }
    ];

adxcg

Bidder Code

adxcg

"Send All Bids" Ad Server Keys

hb_pb_adxcg hb_adid_adxcg hb_size_adxcg

"Default Deal ID" Ad Server Key

hb_deal_adxcg

bid params

Name Scope Description Example
adzoneid required adxcg zone id "1"

Adyoulike

Bidder Code

adyoulike

"Send All Bids" Ad Server Keys

hb_pb_adyoulike hb_adid_adyoulike hb_size_adyoulike

"Default Deal ID" Ad Server Key

hb_deal_adyoulike

Note:

The Adyoulike Header Bidding adaptor requires setup and approval from the Adyoulike team. Please reach out to your account manager or prebid@adyoulike.com for more information.

bid params

Name Scope Description Example
placement required The placement ID from Adyoulike. "194f787b85c829fb8822cdaf1ae64435"
DC optional The data center name "usa01"

AerServ

Bidder Code

aerserv

"Send All Bids" Ad Server Keys

hb_pb_aerserv hb_adid_aerserv hb_size_aerserv

"Default Deal ID" Ad Server Key

hb_deal_aerserv

Note:

Banner sizes will be derived from placement’s configuration in the AerServ UI, and will ignore the values within the bid request.

bid params

Name Scope Description Example
plc required The AerServ Placement ID. 480
coppa optional COPPA override. Send 1 if the request’s source falls under COPPA regulations. 1

Video

Video requests will use the first size passed in the Prebid request, but it can be overridden with the parameters below.

video params

Name Scope Description Example
vpw optional video width override 480
vph optional video height override 360

AOL

Bidder Code

aol

"Send All Bids" Ad Server Keys

hb_pb_aol hb_adid_aol hb_size_aol

"Default Deal ID" Ad Server Key

hb_deal_aol

Note:

This adapter allows use of both ONE by AOL: Display and ONE by AOL: Mobile platforms. In order to differentiate these sources of demand in your ad server and reporting, you may use the optional onedisplay and onemobile adapter aliases instead.

bid params

Name Scope Description Example
placement required The placement ID from AOL. "23324932"
network required The network ID from AOL. "5071.1"
alias optional The placement alias from AOL. "desktop_articlepage_something_box_300_250"
server optional The server domain name. Default is adserver-us.adtech.advertising.com. EU customers must use adserver-eu.adtech.advertising.com, and Asia customers adserver-as.adtech.advertising.com. "adserver-eu.adtech.advertising.com"
bidFloor optional Dynamic bid floor (added in Prebid 0.8.1) "0.80"

AppNexus AST

Bidder Code

appnexusAst

"Send All Bids" Ad Server Keys

hb_pb_appnexusAst hb_adid_appnexusAst hb_size_appnexusAst

"Default Deal ID" Ad Server Key

hb_deal_appnexusAst

Advantages of using the appnexusAst adapter over the appnexus adapter include:

  • Requests all the adUnits at once, which reduces latency on page

  • Supports additional formats (such as Video)

  • Will continue to be upgraded as enhancements are made to Prebid.js for expanding capabilities

As part of the transition to Prebid 1.0, the AppNexus AST adapter will become the standard (and only) AppNexus adapter (and be renamed to “AppNexus”). From a developer’s perspective, the primary change from the legacy adapter is that keywords must be passed using the keywords parameter documented below.

All AppNexus placements included in a single call to requestBids must belong to the same publisher object. If placements from two different publishers are included in the call, the AppNexus bidder may not return any demand for those placements.
Note: This requirement does not apply to adapters that are aliasing the AppNexus adapter.

bid params

Name Scope Description Example
placementId required The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. "234234"
allowSmallerSizes optional If true, ads smaller than the values in your ad unit’s sizes array will be allowed to serve. Defaults to false. true
keywords optional A set of key-value pairs applied to all ad slots on the page. Mapped to query string segments for buy-side targeting (login required). keywords: { genre: ['rock', 'pop'] }
video optional Video targeting parameters. See the video section below for details. video: { playback_method: ['auto_play_sound_off'] }
invCode optional The inventory code from AppNexus. Must be used with member. "abc123"
member optional The member ID from AppNexus. Must be used with invCode. "12345"
reserve optional Sets a floor price for the bid that is returned 0.90

(Sizes set in adUnit object will also apply to the AppNexus bid requests.)

video

The following video parameters are supported. For more information, see the video parameters in the OpenRTB specification.

Name Description
mimes Array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"].
minduration Integer that defines the minimum video ad duration in seconds.
maxduration Integer that defines the maximum video ad duration in seconds.
startdelay Integer that determines whether to show the ad before, during, or after video content. If > 0, position is mid-roll and value indicates start delay, in seconds. Allowed values: Pre-roll: 0 (default); Mid-roll: -1 ; Post-roll: -2.
skippable Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false.
playback_method Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown".
frameworks Array of integers listing API frameworks supported by the publisher. Allowed values: None: 0; VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5.

AppNexus

Bidder Code

appnexus

"Send All Bids" Ad Server Keys

hb_pb_appnexus hb_adid_appnexus hb_size_appnexus

"Default Deal ID" Ad Server Key

hb_deal_appnexus

Table of Contents

Bid params

Name Scope Description Example
placementId required The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. "234234"
"arbitraryKey" optional This key can be any publisher-defined string. The value (also a string) maps to a querystring segment for enhanced buy-side targeting. Multiple key-value pairs can be added as shown below. 'genre': 'rock'
invCode optional The inventory code from AppNexus. Must be used with member. "abc123"
member optional The member ID from AppNexus. Must be used with invCode. "12345"
reserve optional Sets a floor price for the bid that is returned. 0.90

Support for publisher-defined keys

To pass in a publisher-defined key whose value maps to a querystring segment for buy-side targeting, set up your params object as shown below. For more information, see the query string targeting documentation (login required).

var adUnits = [{
    code: 'div-gpt-ad-1460505748511-01',
    sizes: [
        [300, 250],
        [300, 50]
    ],
    bids: [{
        bidder: 'appnexus',
        params: {
            placementId: '123456789',
            'playlist': '12345', // <----| Publisher-defined key-values
            'genre': 'rock'      // <----| (key and value must be strings)
        }
    }]
}]

Sizes set in the adUnit object will also apply to the AppNexus bid requests.

AppNexus supports the banner features described in:

Video Ads

AppNexus supports the video features described in:

Native Ads

AppNexus supports the native features described in:

Multi-Format

AppNexus supports the multi-format ad unit features described in:

Archon Warp

Bidder Code

archon

"Send All Bids" Ad Server Keys

hb_pb_archon hb_adid_archon hb_size_archon

"Default Deal ID" Ad Server Key

hb_deal_archon

bid params

Name Scope Description Example
siteId required The site ID from 152 Media 2.0. 12345
networkId required The network ID from 152 Media 2.0. 9969

Arteebee

Bidder Code

arteebee

"Send All Bids" Ad Server Keys

hb_pb_arteebee hb_adid_arteebee hb_size_arteebee

"Default Deal ID" Ad Server Key

hb_deal_arteebee

bid params

Name Scope Description Example
pub required RTB publisher id 'prebidtest'
source required RTB traffic source id 'prebidtest'
coppa optional flag this request subject to COPPA 1

Atomx

Bidder Code

atomx

"Send All Bids" Ad Server Keys

hb_pb_atomx hb_adid_atomx hb_size_atomx

"Default Deal ID" Ad Server Key

hb_deal_atomx

bid params

Name Scope Description Example
id required Atomx placement ID 1234

Audience Network

Bidder Code

audienceNetwork

"Default Deal ID" Ad Server Key

hb_deal_audienceNetwork

send all bids ad server keys

(Truncated to 20 chars due to DFP limit)

hb_pb_audienceNetwor hb_adid_audienceNetw hb_size_audienceNetw

bid params

Name Scope Description Example
placementId required The Placement ID from Audience Network “555555555555555_555555555555555”
format optional Format, one of “native”, “fullwidth” or “video” “native”

Automatad

Bidder Code

automatad

"Send All Bids" Ad Server Keys

hb_pb_automatad hb_adid_automatad hb_size_automatad

"Default Deal ID" Ad Server Key

hb_deal_automatad

bid params

Name Scope Description Example
siteId required The site ID from Automatad. 12345
networkId required The network ID from Automatad. 9969

Beachfront

Bidder Code

beachfront

"Send All Bids" Ad Server Keys

hb_pb_beachfront hb_adid_beachfront hb_size_beachfront

"Default Deal ID" Ad Server Key

hb_deal_beachfront

bid params

Name Scope Description Example
appId required Beachfront Exchange ID '11bc5dd5-7421-4dd8-c926-40fa653bec76'
bidfloor required Bid floor 0.01
video optional Object with video parameters. See the video section below for details.  

video params

Name Scope Description Example
mimes optional Array of strings listing supported MIME types. ["video/mp4", "application/javascript"]

Bidfluence

Bidder Code

bidfluence

"Send All Bids" Ad Server Keys

hb_pb_bidfluence hb_adid_bidfluence hb_size_bidfluence

"Default Deal ID" Ad Server Key

hb_deal_bidfluence

bid params

Name Scope Description Example
adunitId required Tag ID "7f75fdc7-cc9e-49d7-b481-77f18029eb50"
pubId required Publisher ID "d8dbcff7-92c1-4cf4-bc41-ca4ef831808a"
reservePrice optional Floor price "0.5"

bRealTime

Bidder Code

brealtime

"Send All Bids" Ad Server Keys

hb_pb_brealtime hb_adid_brealtime hb_size_brealtime

"Default Deal ID" Ad Server Key

hb_deal_brealtime

bid params

Name Scope Description Example
placementId required The placement ID from bRealTime "1234567"

bRealTime is an aliased bidder for AppNexus

Bridgewell

Bidder Code

bridgewell

"Send All Bids" Ad Server Keys

hb_pb_bridgewell hb_adid_bridgewell hb_size_bridgewell

"Default Deal ID" Ad Server Key

hb_deal_bridgewell

bid params

Name Scope Description Example
ChannelID required The channel ID from Bridgewell. CgUxMjMzOBIBNiIFcGVubnkqCQisAhD6ARoBOQ

Brightcom

Bidder Code

brightcom

"Send All Bids" Ad Server Keys

hb_pb_brightcom hb_adid_brightcom hb_size_brightcom

"Default Deal ID" Ad Server Key

hb_deal_brightcom

bid params

Name Scope Description Example
tagId required Tag ID in Brightcom 16577
bidFloor optional Bid floor rate 1.23

C1X

Bidder Code

c1x

"Send All Bids" Ad Server Keys

hb_pb_c1x hb_adid_c1x hb_size_c1x

"Default Deal ID" Ad Server Key

hb_deal_c1x

Note:

The C1X Header Bidding adaptor requires approval from the C1X team. Please reach out to header-bidding@c1exchange.com for more information.

bid params

Name Scope Description Example
siteId required Site ID from which the request is originating '999'
pixelId optional Publisher’s pixel ID '12345'
floorPriceMap optional Minimum floor prices needed from the DSP’s to enter the auction {'300x250': 4.00,'300x600': 3.00}
dspid optional DSP ID '4321'
pageurl optional Url of the webpage where the request is originating from '4321'

Carambola

Bidder Code

carambola

"Send All Bids" Ad Server Keys

hb_pb_carambola hb_adid_carambola hb_size_carambola

"Default Deal ID" Ad Server Key

hb_deal_carambola

bid params

Name Scope Description Example
pid required    
did required    
wid required    

Clickforce

Bidder Code

clickforce

"Send All Bids" Ad Server Keys

hb_pb_clickforce hb_adid_clickforce hb_size_clickforce

"Default Deal ID" Ad Server Key

hb_deal_clickforce

bid params

Name Scope Description Example
zone required The CLICKFORCE zone ID "6682"

Colossus

Bidder Code

colossusssp

"Send All Bids" Ad Server Keys

hb_pb_colossusssp hb_adid_colossusssp hb_size_colossusssp

"Default Deal ID" Ad Server Key

hb_deal_colossusssp

bid params

Name Scope Description Example
placement_id required Placement Id will be generated on Colossus SSP Platform. 0
traffic optional Type traffic ‘banner’

ConnectAd

Bidder Code

connectad

"Send All Bids" Ad Server Keys

hb_pb_connectad hb_adid_connectad hb_size_connectad

"Default Deal ID" Ad Server Key

hb_deal_connectad

bid params

Name Scope Description Example
siteId required The site ID from ConnectAd. 12345
networkId required The network ID from ConnectAd. 10047

Content Ignite

Bidder Code

contentignite

"Default Deal ID" Ad Server Key

hb_deal_contentignite

bid params

Name Scope Description Example
accountID required Account ID '168237'
zoneID required Zone ID '299680'
keyword optional Keyword(s) used for custom targeting 'business'
minCPM optional Minimum CPM value to accept '0.10'
maxCPM optional Maximum CPM value to accept '5.00'

Conversant

Bidder Code

conversant

"Send All Bids" Ad Server Keys

hb_pb_conversant hb_adid_conversant hb_size_conversant

"Default Deal ID" Ad Server Key

hb_deal_conversant

bid params

Name Type Scope Description Example
site_id String Required The site ID from Conversant. "87293"
secure Integer Required (For Secure Pages) If impression requires secure HTTPS URL creative assets and markup. 0 for non-secure, 1 for secure. Default is non-secure 1
bidfloor Float Optional Bid floor 0.50
tag_id String Optional Identifies specific ad placement. "cnvr-test-tag"
position Integer Optional Ad position on screen. See details below. 1
mimes String (Inside an Array) Optional Array of content MIME types supported. Required for video ["video/mp4"]
maxduration Integer Optional Maximum duration in seconds for this video as an integer. 30
api Integer (Inside an Array) Optional Array of supported API frameworks. See details below. [2]
protocols Integer (Inside an Array) Optional Array of supported video protocols. See details below. [2]

The following values are defined in the ORTB 2.5 spec.

position

  • 0 : Unknown
  • 1 : Above the Fold
  • 3 : Below the Fold
  • 4 : Header
  • 5 : Footer
  • 6 : Sidebar
  • 7 : Full Screen

api

  • 1 : VPAID 1.0
  • 2 : VPAID 2.0
  • 3 : MRAID 1.0
  • 4 : ORMMA
  • 5 : MRAID 2.0
  • 6 : MRAID 3.0

protocols

  • 1 : VAST 1.0
  • 2 : VAST 2.0
  • 3 : VAST 3.0
  • 4 : VAST 1.0 Wrapper
  • 5 : VAST 2.0 Wrapper
  • 6 : VAST 3.0 Wrapper
  • 7 : VAST 4.0
  • 8 : VAST 4.0 Wrapper
  • 9 : DAAST 1.0
  • 10 : DAAST 1.0 Wrapper

Cox

Bidder Code

cox

"Send All Bids" Ad Server Keys

hb_pb_cox hb_adid_cox hb_size_cox

"Default Deal ID" Ad Server Key

hb_deal_cox

bid params

Name Scope Description Example
size required Size "300x250"
id required Ad space id 2000005991707
siteId required Site id 2000100948180

Criteo

Bidder Code

criteo

"Send All Bids" Ad Server Keys

hb_pb_criteo hb_adid_criteo hb_size_criteo

bid params

Name Scope Description Example
zoneId required The zone ID from Criteo. Can be replaced by networkId when using zone matching. 234234
networkId optional The network ID from Criteo.Please reach out your Criteo representative for more details. 456456
nativeCallback optional Callback to perform render in native integrations. Please reach out your Criteo representative for more details. function(payload) { console.log(payload); }
integrationMode optional Integration mode to use for ad render (none or ‘AMP’). Please reach out your Criteo representative for more details. "AMP"

DAN Marketplace

Bidder Code

danmarket

"Send All Bids" Ad Server Keys

hb_pb_danmarket hb_adid_danmarket hb_size_danmarket

"Default Deal ID" Ad Server Key

hb_deal_danmarket

bid params

Name Scope Description Example
uid required Represents the DAN Marketplace bidder system Ad Slot ID associated with the respective div id from the site page. 5
priceType optional Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the DAN Marketplace bidder margin within. gross

Defy Media

Bidder Code

defymedia

"Send All Bids" Ad Server Keys

hb_pb_defymedia hb_adid_defymedia hb_size_defymedia

"Default Deal ID" Ad Server Key

hb_deal_defymedia

bid params

Name Scope Description Example
placementId required    

Defy Media is an aliased bidder for AppNexus

DistrictM

Note:

This is a S2S adapter only.

Bidder Code

districtm

"Send All Bids" Ad Server Keys

hb_pb_districtm hb_adid_districtm hb_size_districtm

"Default Deal ID" Ad Server Key

hb_deal_districtm

bid params

Name Scope Description Example
placementId required    

DistrictmDMX

Bidder Code

districtmDMX

"Send All Bids" Ad Server Keys

hb_pb_districtmDMX hb_adid_districtmDMX hb_size_districtmDMX

"Default Deal ID" Ad Server Key

hb_deal_districtmDMX

bid params

Name Scope Description Example
id required    
floor optional    
revShare optional    
currency optional    

EngageBDR

Bidder Code

ebdr

"Send All Bids" Ad Server Keys

hb_pb_ebdr hb_adid_ebdr hb_size_ebdr

"Default Deal ID" Ad Server Key

hb_deal_ebdr

Bid params

Name Scope Description Example
zoneid required The EngageBDR Zone ID '99999'
bidfloor optional Bid Floor Price '1.00'
IDFA optional IDFA ID 'xxx-xxxx'
ADID optional ADID ID 'xxx-xxxx'
latitude optional latitude '34.089811'
longitude optional longitude '-118.392805'

E-Planning

Bidder Code

eplanning

"Send All Bids" Ad Server Keys

hb_pb_eplanning hb_adid_eplanning hb_size_eplanning

"Default Deal ID" Ad Server Key

hb_deal_eplanning

Note:

The E-Planning Header Bidding adaptor requires setup and approval from the E-Planning team. Please go to E-Planning website for more details.

bid params

Name Scope Description Example
ci required Your partner ID (provided by E-Planning) 18f66
sv optional Indicates a bidder URL different than default ads.us.e-planning.net
isv optional Indicates a CDN URL different than default us.img.e-planning.net
t optional Indicates bidding for testing purposes 1

Essens

Bidder Code

essens

"Send All Bids" Ad Server Keys

hb_pb_essens hb_adid_essens hb_size_essens

"Default Deal ID" Ad Server Key

hb_deal_essens

bid params

Name Scope Description Example
placementID required (String) The placement ID from Essens. “abc-123”
dealId optional (String) ID of deal. “deal1”
floorPrice optional (Float) Floor price corresponding the deal. In float. 7.5
currency optional ISO currency string “NOK”

FairTrade

Bidder Code

fairtrade

"Send All Bids" Ad Server Keys

hb_pb_fairtrade hb_adid_fairtrade hb_size_fairtrade

"Default Deal ID" Ad Server Key

hb_deal_fairtrade

bid params

Name Scope Description Example
uid required Represents the FairTrade bidder system Ad Slot ID associated with the respective div id from the site page. 5
priceType optional Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the FairTrade bidder margin within. gross

Feature Forward

Bidder Code

featureforward

"Default Deal ID" Ad Server Key

hb_deal_featureforward

bid params

Name Scope Description Example
pubId required unique identifier per publisher, number range 1-999 ‘32’
siteId required unique identifier per publisher site, number range 1-999 ‘01’
placementId required unique identifier per placement per publisher site, ranges from 0-9 ‘3’

Fidelity Media

Bidder Code

fidelity

"Send All Bids" Ad Server Keys

hb_pb_fidelity hb_adid_fidelity hb_size_fidelity

"Default Deal ID" Ad Server Key

hb_deal_fidelity

bid params

Name Scope Description Example
zoneid required The ad zone or tag specific ID "27248"
floor optional The floor CPM price for the request 0.1234
server optional Bidder domain "x.fidelity-media.com" by default

FreeWheel-ssp

Bidder Code

freewheel-ssp

"Default Deal ID" Ad Server Key

hb_deal_freewheel-ssp

bid params

Name Scope Description Example
zoneId required    

Gamma

Bidder Code

gamma

"Send All Bids" Ad Server Keys

hb_pb_gamma hb_adid_gamma hb_size_gamma

"Default Deal ID" Ad Server Key

hb_deal_gamma

bid params

Name Scope Description Type Example
siteId required Site ID integer 1465446377
zoneId required Zone ID integer 1515999290

GetIntent

Bidder Code

getintent

"Send All Bids" Ad Server Keys

hb_pb_getintent hb_adid_getintent hb_size_getintent

"Default Deal ID" Ad Server Key

hb_deal_getintent

bid params

Name Scope Description Example  
pid required Publisher ID registered in GetIntent system 123  
tid optional Unique Tag ID. Required if multiple tags are used on the same page. abc  
cur optional Currency of the ad request. Default is the one configured at publisher settings. USD  
floor optional Floor price for the request. 0.123  
video optional Object with video parameters. See the video section below.    

video

Name Scope Description Example
protocols optional The list of the restricted VAST protocol versions. Possible values: 1 – VAST 1.0, 2 – VAST 2.0, 3 – VAST 3.0, 4 – VAST 1.0 Wrapper, 5 – VAST 2.0 Wrapper, 6 – VAST 3.0 Wrapper. protocols: [4,5,6]
mimes optional Array of Mime Type strings. mimes: ["application/javascript"]
min_dur optional Minimal video duration. min_dur: 30
max_dur optional Maximal video duration. max_dur: 30
min_btr optional Minimal Video bitrate. min_btr: 256
max_btr optional Maximal Video bitrate. max_btr: 512
vi_format optional Video inventory format. Possible values: 1 - In-Stream video, 2 - Out-Stream video. vi_format: 1
api optional API of the inventory. Possible values: 1 - VPAID 1.0, 2 - VPAID 2.0, 3 - MRAID-1, 4 - ORMMA, 5 - MRAID-2. api: [3,4]
skippable optional Skippability of the inventory. Possible values (case insensitive): ALLOW - skippable inventory is allowed, NOT_ALLOW - skippable inventory is not allowed, REQUIRE - only skippable inventory is allowed, UNKNOWN - skippability is unknown (default value). skippable: "NOT_ALLOW"

Gourmet Ads

Bidder Code

gourmetads

"Send All Bids" Ad Server Keys

hb_pb_gourmetads hb_adid_gourmetads hb_size_gourmetads

"Default Deal ID" Ad Server Key

hb_deal_gourmetads

bid params

Name Scope Description Example
placementId required    

Gourmet Ads is an aliased bidder for AppNexus

GumGum

Bidder Code

gumgum

"Send All Bids" Ad Server Keys

hb_pb_gumgum hb_adid_gumgum hb_size_gumgum

"Default Deal ID" Ad Server Key

hb_deal_gumgum

Note:

The GumGum Header Bidding adaptor requires setup and approval from the GumGum team. Please reach out to your account manager or support@gumgum.com for more information.

bid params

Name Scope Description Example
inScreen optional Tracking ID 'ggumtest'
inSlot optional Slot ID 9

Head Bidding

Bidder Code

headbidding

"Send All Bids" Ad Server Keys

hb_pb_headbidding hb_adid_headbidding hb_size_headbidding

"Default Deal ID" Ad Server Key

hb_deal_headbidding

bid params

Name Scope Description Example
zoneId required    
host required    

Head Bidding is an aliased bidder for AdKernel

HIRO Media

Bidder Code

hiromedia

"Send All Bids" Ad Server Keys

hb_pb_hiromedia hb_adid_hiromedia hb_size_hiromedia

"Default Deal ID" Ad Server Key

hb_deal_hiromedia

bid params

Name Scope Description Example
accountId required Account ID '750'
bidUrl optional The bid server endpoint URL 'https://example.com/'

Huddled Masses

Bidder Code

huddledmasses

"Send All Bids" Ad Server Keys

hb_pb_huddledmasses hb_adid_huddledmasses hb_size_huddledmasses

"Default Deal ID" Ad Server Key

hb_deal_huddledmasses

bid params

Name Scope Description Example
placement_id required Placement Id will be generated on Huddled Masses SSP Platform. 0

Integral Ad Science (IAS)

Bidder Code

ias

"Send All Bids" Ad Server Keys

hb_pb_ias hb_adid_ias hb_size_ias

"Default Deal ID" Ad Server Key

hb_deal_ias

Note:

This module is an integration with prebid.js with an IAS product, pet.js. It is not a bidder per se but works in a similar way: retrieve data that publishers might be interested in setting keyword targeting, like predicted viewability and brand safety words. Please reach out to your account manager or check out our publisher solutions for more information.

bid params

Name Scope Description Example
pubId required Publisher client ID, provided by IAS '1234'
adUnitPath required Ad unit path. The same one you use for GPT '/1234567/sports'

imonomy

Bidder Code

imonomy

"Send All Bids" Ad Server Keys

hb_pb_imonomy hb_adid_imonomy hb_size_imonomy

"Default Deal ID" Ad Server Key

hb_deal_imonomy

Note: The imonomy bidder adaptor requires setup and approval from the imonomy Service team. Please reach out to your account manager for more information and start using it or contact us at info@imonomy.com.

bid params

Name Scope Description Example
publisher_id required imonomy publisher id '1234567890'

Improve Digital

Bidder Code

improvedigital

"Default Deal ID" Ad Server Key

hb_deal_improvedigital

Send All Bids Ad Server Keys:

(truncated to 20 chars due to DFP limit)

hb_bidder_improvedig hb_pb_improvedigital hb_adid_improvedigit hb_size_improvedigit

Bid params

Depending on your setup in our system, your placements will either have a globally-unique placement ID or a publisher-unique placement key as an identifier. Therefore, to identify your placement you either need a placementId only, or a combination of publisherId and placementKey.

Name Scope Description Example
placementId optional The placement ID from Improve Digital. 1234567
publisherId optional Your publisher ID. This is only required when using a placementKey 950
placementKey optional The placement key for your placement. Must be used with publisherId. "myMainBannerPlacement300x200"
keyValues optional Contains one or more key-value pairings for key-value targeting {testKey1: ["testValueA"], testKey2: ["testValueB", "testValueC"]}
size optional Size filter. Where a placement supports multiple sizes, this forces the response to featur only one of the multiple sizes {w:300,h:250}

Examples

Configuration With placementId

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId:1053688
            }
        }
    ]
}];

Configuration With publisherId/placementKey

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementKey:'',
                publisherId: 
            }
        }
    ]
}];

Configuration With PlacementId and Key-Values

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
               placementId:1053689,
                keyValues: {
                    testKey1: ["testValueA"],
                    testKey2: ["testValueB", "testValueC"]
                }
            }
        }
    ]
}];

Configuration With PlacementId and Size Filter

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId:1053687,
                size: {
                    w:300,
                    h:300
                }
            }
        }
    ]
}];

Sizes set in the adUnit object will not be used since sizes are already defined as part of the placement setup.

Index Exchange (Casale)

Bidder Code

indexExchange

"Default Deal ID" Ad Server Key

hb_deal_indexExchange

Prebid Server Note:

Before configuring the Index Exchange adapter as S2S, you must reach out to the Index Exchange team for approval and setup steps.

Send All Bids Ad Server Keys:

(truncated to 20 chars due to DFP limit)

hb_pb_indexExchange hb_adid_indexExchang hb_size_indexExchang

Default Deal ID Keys:

hb_deal_indexExchang

bid params

Name Scope Description Example
id required The placement ID  
siteID required the site ID  
tier2SiteID optional    
tier3SiteID optional    

bid params: Video

Name Scope Description Example
video required Video parameters. See video params table {"siteID": 12345, "playerType":"HTML5", "protocols":[2,3,5,6], "maxduration":15}

Video params

Name Scope Description Example
siteID required Publisher site ID 12345
playerType required String representing video player type, either HTML5 or FLASH "HTML5"
protocols required Array of integers representing VAST versions supported by the player, as defined in OpenRTB 2.3 section 5.6 [2, 3, 5, 6]
maxduration required Integer representing allowable max duration of the video ad, in seconds 15
minduration optional Integer representing allowable min duration of the video ad, in seconds. Default of 0 assumed if none is specified. 5
startdelay optional Defines the start of the ad, when a string is specified then generic RTB values are used, when a number is specified then is interpreted as the number of seconds into the content video at which the ad should play. Default assumed to be preroll if none specified "preroll"
linearity optional String representing whether video ad is linear or overlay. Defaults to "linear" if not defined "linear"
mimes optional Array of strings representing player supported mime types. Overrides the supported MIME types otherwise inferred by playerType setting. ["video/mp4", "video/webm"]
allowVPAID optional Boolean defining whether player supports any version of VPAID. Which versions are supported is inferred from playerType. Defaults to false false
apiList optional Array of integers representing player supported VPAID versions, as defined in OpenRTB 2.3 section 5.6. Overrides versions inferred from playerType. [1, 2]

Inneractive

Bidder Code

inneractive

"Send All Bids" Ad Server Keys

hb_pb_inneractive hb_adid_inneractive hb_size_inneractive

"Default Deal ID" Ad Server Key

hb_deal_inneractive

bid params

Name Scope Description Example
appId required The app. ID provided by Inneractive Company_App_OS
adSpotType required The ad spot type "BANNER" / "RECTANGLE"
customParams optional Allows passing custom parameters in the bid request See more details at: https://confluence.inner-active.com/display/DevWiki/IA+Adapter+AdUnit+Bidder+Configuration

Innity

Bidder Code

innity

"Send All Bids" Ad Server Keys

hb_pb_innity hb_adid_innity hb_size_innity

"Default Deal ID" Ad Server Key

hb_deal_innity

Note:

The Innity bidder adapter requires setup and approval from the Innity Media team, even for existing Innity Network publishers. Please reach out to your account manager for more information and to enable using this adapter.

bid params

Name Scope Description Example
pub required The publisher account ID 267
zone required The zone ID 62546

Inskin

Bidder Code

inskin

"Send All Bids" Ad Server Keys

hb_pb_inskin hb_adid_inskin hb_size_inskin

"Default Deal ID" Ad Server Key

hb_deal_inskin

Note:

The Inskin bidder adapter requires additional setup and approval from the Inskin Media Integrations team. Please reach out to your account manager for more information and to start using it.

bid params

Name Scope Description Example
siteId required Site ID provided by Inskin. 12345
networkId required Network ID provided by Inskin. 9969

Insticator

Bidder Code

insticator

"Send All Bids" Ad Server Keys

hb_pb_insticator hb_adid_insticator hb_size_insticator

"Default Deal ID" Ad Server Key

hb_deal_insticator

bid params

Name Scope Description Example
siteId required The site ID from Insticator. 12345
networkId required The network ID from Insticator. 9969

Invibes

Bidder Code

invibes

"Send All Bids" Ad Server Keys

hb_pb_invibes hb_adid_invibes hb_size_invibes

"Default Deal ID" Ad Server Key

hb_deal_invibes

bid params

Name Scope Description Example
placementId required The Invibes placement ID "1234567"
adContainerId optional Id of ad container "test-div"

iQM

Bidder Code

iqm

"Send All Bids" Ad Server Keys

hb_pb_iqm hb_adid_iqm hb_size_iqm

"Default Deal ID" Ad Server Key

hb_deal_iqm

bid params

Name Scope Description Example
publisherId required The Publisher ID from iQM. df5fd732-c5f3-11e7-abc4-cec278b6b50a
tagId required The Tag ID from iQM. 1c5c9ec2-c5f4-11e7-abc4-cec278b6b50a
placementId required The Placement ID from iQM. 50cc36fe-c5f4-11e7-abc4-cec278b6b50a
bidfloor required Bid floor 0.50

J Carter Marketing

Bidder Code

jcm

"Send All Bids" Ad Server Keys

hb_pb_jcm hb_adid_jcm hb_size_jcm

"Default Deal ID" Ad Server Key

hb_deal_jcm

bid params

Name Scope Description Example
id required    
siteID required    
tier2SiteID optional    
tier3SiteID optional    

Justpremium

Bidder Code

justpremium

"Send All Bids" Ad Server Keys

hb_pb_justpremium hb_adid_justpremium hb_size_justpremium

"Default Deal ID" Ad Server Key

hb_deal_justpremium

bid params

Name Scope Description Example
zone required The zone ID provided by Justpremium “34604”
allow optional Permits publisher to decide which products can be run from specific ad unit [“lb”, “wp”]
exclude optional Permits publisher to decide which products should be excluded from running in specific ad unit [“is”]

Kargo

Bidder Code

kargo

"Send All Bids" Ad Server Keys

hb_pb_kargo hb_adid_kargo hb_size_kargo

"Default Deal ID" Ad Server Key

hb_deal_kargo

Note:

Kargo is an invitation-only marketplace. Please reach out to your Kargo account manager to get setup.

bid params

Name Scope Description Example
placementId required    

Komoona

Bidder Code

komoona

"Send All Bids" Ad Server Keys

hb_pb_komoona hb_adid_komoona hb_size_komoona

"Default Deal ID" Ad Server Key

hb_deal_komoona

bid params

Name Scope Description Example
hbid required header-bidding id from Komoona "1f5b2c10e66e419580bd943b9af692ab"
placementId required placement id from Komoona "e69148e0ba6c4c07977dc2daae5e1577"

Kumma

Bidder Code

kumma

"Send All Bids" Ad Server Keys

hb_pb_kumma hb_adid_kumma hb_size_kumma

"Default Deal ID" Ad Server Key

hb_deal_kumma

bid params

Name Scope Description Example
pubId required The publisher account ID 55879
siteId required The publisher site ID 26047
placementId optional The publisher placement ID 17394
bidFloor optional The bid floor 0.001

Lifestreet

Bidder Code

lifestreet

"Send All Bids" Ad Server Keys

hb_pb_lifestreet hb_adid_lifestreet hb_size_lifestreet

"Default Deal ID" Ad Server Key

hb_deal_lifestreet

bid params

Name Scope Description Example
slot required Ad Slot 'slot166704'
adkey required Ad Key '78c'
ad_size required Ad Size '160x600'

LKQD

Bidder Code

lkqd

"Send All Bids" Ad Server Keys

hb_pb_lkqd hb_adid_lkqd hb_size_lkqd

"Default Deal ID" Ad Server Key

hb_deal_lkqd

Note:

For more information about LKQD Ad Serving and Management, please contact info@lkqd.com.

bid params

Name Scope Description Example
placementId required   "263"
siteId required   "662921"

Madvertise

Bidder Code

madvertise

"Send All Bids" Ad Server Keys

hb_pb_madvertise hb_adid_madvertise hb_size_madvertise

"Default Deal ID" Ad Server Key

hb_deal_madvertise

bid params

Name Scope Description Example
s required Zone code. This parameter should be the unique Publisher ID of your mobile application or website. “/4543756/prebidadaptor/madvertiseHB”
donottrack optional Possible values are “0” or “1”. If the of value is “1”, the user does not want to be tracked (opt out). 1
lat optional Latitude 48.866667
long optional Longitude 2.333333
age optional Age 19
gender optional Gender m or f “f”
locale optional Locale “fr”
floor optional Bid floor 1.0

MANTIS Ad Network

Bidder Code

mantis

"Send All Bids" Ad Server Keys

hb_pb_mantis hb_adid_mantis hb_size_mantis

"Default Deal ID" Ad Server Key

hb_deal_mantis

bid params

Name Scope Description Example
property required The unique identifier provided for your entire account. 5a5840d00000000000000000
zone required The unique identifier for the placement defined in our admin. sidebar-top-1

Marsmedia

Bidder Code

marsmedia

"Send All Bids" Ad Server Keys

hb_pb_marsmedia hb_adid_marsmedia hb_size_marsmedia

"Default Deal ID" Ad Server Key

hb_deal_marsmedia

bid params

Name Scope Description Example
publisherID required    
floor optional    

Matomy

Bidder Code

matomy

"Send All Bids" Ad Server Keys

hb_pb_matomy hb_adid_matomy hb_size_matomy

"Default Deal ID" Ad Server Key

hb_deal_matomy

bid params

Name Scope Description Example
placementId required    

Media.net

Bidder Code

medianet

"Send All Bids" Ad Server Keys

hb_pb_medianet hb_adid_medianet hb_size_medianet

"Default Deal ID" Ad Server Key

hb_deal_medianet

bid params

Name Scope Description Example
cid required The customer id provided by Media.net. "8CUX0H51C"
crid optional The placement id provided by Media.net "1234567"
bidfloor optional Bidfloor for the impression 1.0

Meme Global

Bidder Code

memeglobal

"Send All Bids" Ad Server Keys

hb_pb_memeglobal hb_adid_memeglobal hb_size_memeglobal

"Default Deal ID" Ad Server Key

hb_deal_memeglobal

bid params

Name Scope Description Example
tagid required    

MobFox

Bidder Code

mobfox

"Send All Bids" Ad Server Keys

hb_pb_mobfox hb_adid_mobfox hb_size_mobfox

"Default Deal ID" Ad Server Key

hb_deal_mobfox

bid params

Name Scope Description Example
s required The hash of your inventory to identify which app is making the request 267d72ac3f77a3f447b32cf7ebf20673
imp_instl optional set to 1 if using interstitial otherwise delete or set to 0 1

Nasmedia Admixer

Bidder Code

nasmediaAdmixer

"Default Deal ID" Ad Server Key

hb_deal_nasmediaAdmixer

Send All Bids Ad Server Keys

(Truncated to 20 chars due to DFP limit)

hb_pb_nasmediaAdmixe hb_adid_nasmediaAdmi hb_size_nasmediaAdmi

Note:

The Nasmedia Admixer Bidder Adapter requires setup and approval from the Nasmedia Admixer team.
Please reach out to prebid@nasmedia.co.kr for more information.

bid params

Name Scope Description Example
ax_key required Publisher Key provided by Nasmedia Admixer 'ajj7jba3'

NginAd

Bidder Code

nginad

"Send All Bids" Ad Server Keys

hb_pb_nginad hb_adid_nginad hb_size_nginad

"Default Deal ID" Ad Server Key

hb_deal_nginad

bid params

Name Scope Description Example
pzoneid required    
nginadDomain required    

One Fifty Two Media

Bidder Code

oftmedia

"Send All Bids" Ad Server Keys

hb_pb_oftmedia hb_adid_oftmedia hb_size_oftmedia

"Default Deal ID" Ad Server Key

hb_deal_oftmedia

bid params

Name Scope Description Example
placementId required    
randomKey optional    
invCode optional    
member optional    

One Fifty Two Media is an aliased bidder for AppNexus

ONE by AOL Display

Bidder Code

onedisplay

"Send All Bids" Ad Server Keys

hb_pb_onedisplay hb_adid_onedisplay hb_size_onedisplay

"Default Deal ID" Ad Server Key

hb_deal_onedisplay

bid params

Name Scope Description Example
placement required The placement ID from AOL. "23324932"
network required The network ID from AOL. "5071.1"
alias optional The placement alias from AOL. "desktop_articlepage_something_box_300_250"
server optional The server domain name. Default is adserver-us.adtech.advertising.com. EU customers must use adserver-eu.adtech.advertising.com, and Asia customers adserver-as.adtech.advertising.com. "adserver-eu.adtech.advertising.com"
bidFloor optional Dynamic bid floor (added in Prebid 0.8.1) "0.80"

ONE by AOL Display is an aliased bidder for AOL

152 Media 2.0

Bidder Code

onefiftytwo

"Send All Bids" Ad Server Keys

hb_pb_onefiftytwo hb_adid_onefiftytwo hb_size_onefiftytwo

"Default Deal ID" Ad Server Key

hb_deal_onefiftytwo

bid params

Name Scope Description Example
siteId required The site ID from 152 Media 2.0. 12345
networkId required The network ID from 152 Media 2.0. 9969

ONE by AOL Mobile

Bidder Code

onemobile

"Send All Bids" Ad Server Keys

hb_pb_onemobile hb_adid_onemobile hb_size_onemobile

"Default Deal ID" Ad Server Key

hb_deal_onemobile

bid params

Name Scope Description Example
dcn required Site ID provided by ONE. "2c9d2b50015a5aa95b70a9b0b5b10012"
pos required Position on a page where an ad will appear. "header"
ext optional Object that allows the client to send any extra parameters.  

ONE by AOL Mobile is an aliased bidder for AOL

Oneplanetonly

Bidder Code

oneplanetonly

"Default Deal ID" Ad Server Key

hb_deal_oneplanetonly

bid params

Name Scope Description Example
siteId required The site id ‘5’
adUnitId required The ad unit id ‘5-4587544’

Example:

{
    bidder: 'oneplanetonly',
    params: {
      siteId: '5',
      adUnitId: '5-4587544'
    }
}

OpenX

Bidder Code

openx

"Send All Bids" Ad Server Keys

hb_pb_openx hb_adid_openx hb_size_openx

"Default Deal ID" Ad Server Key

hb_deal_openx

bid params

Name Scope Description Example
unit required OpenX ad unit ID provided by your OpenX representative. “1611023122”
delDomain required OpenX delivery domain provided by your OpenX representative. “PUBLISHER-d.openx.net”
customParams optional User-defined targeting key-value pairs. customParams applies to a specific unit. {key1: "v1", key2: ["v2","v3"]}
customFloor optional Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50 1.50

Configuration

Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes. OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the OpenX bid rate and bid price. Be sure to call pbjs.setConfig() only once.

pbjs.setConfig({
   userSync: {
      iframeEnabled: true
   }
});

Optimatic

Bidder Code

optimatic

"Send All Bids" Ad Server Keys

hb_pb_optimatic hb_adid_optimatic hb_size_optimatic

"Default Deal ID" Ad Server Key

hb_deal_optimatic

Note:

Optimatic adapter only supports video ads.

bid params

Name Scope Description Example
placement required Optimatic Placement ID '2chy7Gc2eSQL'
bidfloor required Bid floor 2.00

Optimera

Bidder Code

optimera

"Send All Bids" Ad Server Keys

hb_pb_optimera hb_adid_optimera hb_size_optimera

"Default Deal ID" Ad Server Key

hb_deal_optimera

bid params

Name Scope Description Example
clientID required The Optimera Client ID "123"

Orbitsoft

Bidder Code

orbitsoft

"Send All Bids" Ad Server Keys

hb_pb_orbitsoft hb_adid_orbitsoft hb_size_orbitsoft

"Default Deal ID" Ad Server Key

hb_deal_orbitsoft

bid params

Name Scope Description Example
placementId required The placement ID (site channel ID) 142
requestUrl required Url to perform search request “http://adserver.com/ads/show/hb”
style optional Creative styles. Actual only for text ads
customParams optional Permits passing any publisher key-value pairing into the bid request { macro_name: “macro_value” }

Example:

{
    bidder: "orbitsoft",
    params: {
        placementId: 142,
        requestUrl: "https://orbitsoft.com/php/ads/hb.php",
        style: {
            title: {
                family: "Tahoma",
                size: "medium",
                weight: "normal",
                style: "normal",
                color: "0053F9"
            },
            description: {
                family: "Tahoma",
                size: "medium",
                weight: "normal",
                style: "normal",
                color: "0053F9"
            },
            url: {
                family: "Tahoma",
                size: "medium",
                weight: "normal",
                style: "normal",
                color: "0053F9"
            },
            colors: {
                background: "ffffff",
                border: "E0E0E0",
                link: "5B99FE"
            }
        }
        customParams: {
            macro_name: "macro_value"
        }
    }
}

Page Science

Bidder Code

pagescience

"Send All Bids" Ad Server Keys

hb_pb_pagescience hb_adid_pagescience hb_size_pagescience

"Default Deal ID" Ad Server Key

hb_deal_pagescience

bid params

Name Scope Description Example
placementId required    
randomKey optional    
invCode optional    
member optional    

Page Science is an aliased bidder for AppNexus

Peak226

Bidder Code

peak226

"Send All Bids" Ad Server Keys

hb_pb_peak226 hb_adid_peak226 hb_size_peak226

"Default Deal ID" Ad Server Key

hb_deal_peak226

bid params

Name Scope Description Example
uid required The ID from Peak226 76221035

Piximedia

Bidder Code

piximedia

"Send All Bids" Ad Server Keys

hb_pb_piximedia hb_adid_piximedia hb_size_piximedia

"Default Deal ID" Ad Server Key

hb_deal_piximedia

bid params

Name Scope Description Example
siteId required The site ID from Piximedia. “SITE”
placementId required The placement ID from Piximedia. “PLACEMENT”
currency optional Override the default currency (euro) “USD”
sizes optional Override the default prebid size array [[300, 250]]

(Sizes set in adUnit object will also apply to the Piximedia bid requests.)

Platform.io

Bidder Code

platformio

"Send All Bids" Ad Server Keys

hb_pb_platformio hb_adid_platformio hb_size_platformio

"Default Deal ID" Ad Server Key

hb_deal_platformio

bid params

Name Scope Description Example
pubId required The publisher account ID 28082
siteId required The publisher site ID 26047
size required Ad size identifier 300X250
placementId required Identifies specific ad placement 17394
bidFloor optional The bid floor 0.001

test params

  var adUnits = [{
          code: 'dfp-native-div',
          mediaType: 'native',
          mediaTypes: {
              native: {
                  title: {
                      required: true,
                      len: 75
                  },
                  image: {
                      required: true
                  },
                  body: {
                      len: 200
                  },
                  icon: {
                      required: false
                  }
              }
          },
          bids: [{
              bidder: 'platformio',
              params: {
                  pubId: '29521',
                  siteId: '26048',
                  placementId: '123',
              }
          }]
      },
      {
          code: 'dfp-banner-div',
          mediaTypes: {
              banner: {
                  sizes: [
                      [300, 250]
                  ],
              }
          },
          bids: [{
              bidder: 'platformio',
              params: {
                  pubId: '29521',
                  siteId: '26049',
                  size: '300X250',
                  placementId: '123',
              }
          }]
      },
      {
          code: 'dfp-video-div',
          sizes: [640, 480],
          mediaTypes: {
              video: {
                  context: "instream"
              }
          },
          bids: [{
              bidder: 'platformio',
              params: {
                  pubId: '29521',
                  siteId: '26049',
                  size: '640X480',
                  placementId: '123',
                  video: {
                      skippable: true,
                  }
              }
          }]
      }
  ];

Pollux Network

Bidder Code

pollux

"Send All Bids" Ad Server Keys

hb_pb_pollux hb_adid_pollux hb_size_pollux

"Default Deal ID" Ad Server Key

hb_deal_pollux

bid params

Name Scope Description Example
zone required The zone ID from Pollux Network. You must identify a zone using a valid ID provided on Pollux Network platform. "276"

(Sizes set in adUnit object will apply to the Pollux Network bid requests. If the indicated zone does not support any of the requested sizes, a null bid will be responded.)

Prebid Server

Bidder Code

prebidServer

"Default Deal ID" Ad Server Key

hb_deal_prebidServer

Sign up

Sign up for account on prebid.adnxs.com

bid params

Bid params are sourced from the adapter configurations set for client side. These do not need to change for Prebid Server.

Configuration

To enable prebid server, set the following configuration.

pbjs.setConfig({
    s2sConfig: {
        accountId : '12345',
        bidders : ['appnexus','pubmatic', 'rubicon'], 
        defaultVendor: 'appnexus'
    }
});

Configuration options

Field Type Required? Description
accountId String X Prebid Server account ID.
bidders Array[String] X List of bidder codes; must have been enabled during Prebid.js build.
defaultVendor String   Automatically includes all following options in the config with vendor’s default values. Individual properties can be overridden by including them in the config along with this setting.
enabled Boolean X Enables S2S; default: false.
endpoint String X Set the endpoint. For example: https://prebid.adnxs.com/pbs/v1/auction
timeout Number   Bidder timeout, in milliseconds; default: 1000.
syncEndpoint String   Configures the user-sync endpoint. Highly recommended.
adapter String   Adapter code; default: "prebidServer".
cookieSet Boolean   Set to false to opt out of cookieset/link rewriting.
secure Integer   Override Prebid Server’s determination of whether the request needs secure assets. Set to 1 to force secure assets on the response, or 0 for non-secure assets.

Pubgears

Bidder Code

pubgears

"Send All Bids" Ad Server Keys

hb_pb_pubgears hb_adid_pubgears hb_size_pubgears

"Default Deal ID" Ad Server Key

hb_deal_pubgears

bid params

Name Scope Description Example
publisherName required    
pubZone required    

PubMatic

Bidder Code

pubmatic

"Send All Bids" Ad Server Keys

hb_pb_pubmatic hb_adid_pubmatic hb_size_pubmatic

"Default Deal ID" Ad Server Key

hb_deal_pubmatic

Prebid Server Note:

Before configuring the PubMatic adapter as S2S, you must reach out to the PubMatic team for approval and setup steps.

Prebid 1.0 Upgrade Note:

If you upgrading from a Prebid version prior to 1.0, please reach out to your PubMatic Customer Success Manager prior to your upgrade. Publisher accounts need new settings to function correctly with the PubMatic Prebid 1.0 adapter and your Customer Success Manager will ensure your account is setup correctly.

bid params

Name Scope Description Example
publisherId required Publisher ID “32572”
adSlot required Ad Unit ID “38519891@300x250”
pmzoneid optional Zone ID “zone1,zone2”
lat optional Latitude “40.712775”
lon optional Longitude “-74.005973”
yob optional Year of Birth “1982”
gender optional Gender “M”
kadpageurl optional Overrides Page URL “http://www.yahoo.com/”
kadfloor optional Bid Floor “1.75”

Configuration

PubMatic recommends the UserSync configuration below. Without it, the PubMatic adapter will not able to perform user syncs, which lowers match rate and reduces monetization.

pbjs.setConfig({
   userSync: {
    iframeEnabled: true,
    enabledBidders: ['pubmatic'],
    syncDelay: 6000
 }});

Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.

PulsePoint

Bidder Code

pulsepoint

"Send All Bids" Ad Server Keys

hb_pb_pulsepoint hb_adid_pulsepoint hb_size_pulsepoint

"Default Deal ID" Ad Server Key

hb_deal_pulsepoint

bid params

Name Scope Description Example
cf required Ad size identifier "300X250"
cp required Publisher Id 12345
ct required Ad Tag Id 12345

PulsePoint Lite

Bidder Code

pulsepointLite

"Default Deal ID" Ad Server Key

hb_deal_pulsepointLite

bid params

Name Scope Description Example
cf required Ad size identifier "300X250"
cp required Publisher Id 12345
ct required Ad Tag Id 12345

Quantcast

Bidder Code

quantcast

"Send All Bids" Ad Server Keys

hb_pb_quantcast hb_adid_quantcast hb_size_quantcast

"Default Deal ID" Ad Server Key

hb_deal_quantcast

bid params

Name Scope Description Example
publisherId required The publisher id provided by Quantcast “LCOf845vzU”
battr optional Array of Blocked creative attributes as per OpenRTB Spec List 5.3 [6,7]

Quantum

Bidder Code

quantum

"Send All Bids" Ad Server Keys

hb_pb_quantum hb_adid_quantum hb_size_quantum

"Default Deal ID" Ad Server Key

hb_deal_quantum

bid params

Name Scope Description Example
placementId required The ID issued by Quantum to the publisher 34887

ReadPeak

Bidder Code

readpeak

"Send All Bids" Ad Server Keys

hb_pb_readpeak hb_adid_readpeak hb_size_readpeak

"Default Deal ID" Ad Server Key

hb_deal_readpeak

bid params

Name Scope Description Example
publisherId required Publisher ID provided by ReadPeak 11bc5dd5-7421-4dd8-c926-40fa653bec76
bidfloor optional CPM Bid Floor 0.5

RealVu

Bidder Code

realvu

"Send All Bids" Ad Server Keys

hb_pb_realvu hb_adid_realvu hb_size_realvu

"Default Deal ID" Ad Server Key

hb_deal_realvu

bid params

Name Scope Description Example
placementId required The placement ID from RealVu. "9339508"
partnerId required The member ID from RealVu. "1Y"

(Sizes set in adUnit object will also apply to the RealVu bid requests.)

RhythmOne

Bidder Code

rhythmone

"Send All Bids" Ad Server Keys

hb_pb_rhythmone hb_adid_rhythmone hb_size_rhythmone

"Default Deal ID" Ad Server Key

hb_deal_rhythmone

bid params

Name Scope Description Example
placementId required The ID issued by RhythmOne to the publisher 34887

RockYou

Bidder Code

rockyou

"Send All Bids" Ad Server Keys

hb_pb_rockyou hb_adid_rockyou hb_size_rockyou

"Default Deal ID" Ad Server Key

hb_deal_rockyou

bid params

Name Scope Description Example
placementId required The placement ID assigned to the publisher by RockYou 4322

Roxot

Bidder Code

roxot

"Send All Bids" Ad Server Keys

hb_pb_roxot hb_adid_roxot hb_size_roxot

"Default Deal ID" Ad Server Key

hb_deal_roxot

bid params

Name Scope Description Example
publisherId required The publisher id from Roxot "550e8400-e29b-41d4-a716-446655440000"

Rtbdemand bidder

Bidder Code

rtbdemand

"Send All Bids" Ad Server Keys

hb_pb_rtbdemand hb_adid_rtbdemand hb_size_rtbdemand

"Default Deal ID" Ad Server Key

hb_deal_rtbdemand

bid params

Name Scope Description Example
zoneid required The ad zone or tag specific ID "9999"
floor optional The floor CPM price for the request 0.1234
server optional Bidder domain "bidding.rtbdemand.com" by default

RTBHouse

Bidder Code

rtbhouse

"Send All Bids" Ad Server Keys

hb_pb_rtbhouse hb_adid_rtbhouse hb_size_rtbhouse

"Default Deal ID" Ad Server Key

hb_deal_rtbhouse

bid params

Name Scope Description Example
publisherId required Unique publisher ID ABCDEF
region required Assigned region prebid-eu

Rubicon

Bidder Code

rubicon

"Send All Bids" Ad Server Keys

hb_pb_rubicon hb_adid_rubicon hb_size_rubicon

"Default Deal ID" Ad Server Key

hb_deal_rubicon

Note:

The Rubicon Project adapter requires setup and approval from the Rubicon Project team, even for existing Rubicon Project publishers. Please reach out to your account team or globalsupport@rubiconproject.com for more information.

bid params

Parameter Version Scope Description Example
accountId 0.6.0 required The publisher account ID "4934"
siteId 0.6.0 required The site ID "13945"
zoneId 0.6.0 required The zone ID "23948"
sizes 0.6.0 optional Array of Rubicon Project size IDs. If not specified, the system will try to convert from bid.sizes. [15]
keywords 0.6.0 optional Array of page-specific keywords. May be referenced in Rubicon Project reports. ["travel", "tourism"]
inventory 0.6.0 optional An object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays. {"rating":["5-star"], "prodtype":["tech","mobile"]}
visitor 0.6.0 optional An object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays. {"ucat":["new"], "search":["iphone"]}
position 0.6.0 optional Set the page position. Valid values are “atf” and “btf”. "atf"
userId 0.6.0 optional Site-specific user ID may be reflected back in creatives for analysis. Note that userId needs to be the same for all slots. "12345abc"
floor 0.19.0 optional Sets the global floor – no bids will be made under this value. 0.50
video 0.19.0 required for video Video targeting parameters. See the video section below. {"language": "en", "playerHeight": "360", "playerWidth": "640", "size_id": "201"}

Video

The following video parameters are supported as of 0.19.0:

Video Parameter Scope Description Example
playerWidth required for video Video player width in pixels "playerWidth": "640"
playerHeight required for video Video player height in pixels "playerHeight": "360"
size_id required for video Integer indicating the video ad format ID:

201: Pre-Roll
202: Interstitial
203: OutStream
204: Mid-Roll
205: Post-Roll
207: Vertical Video
"size_id": "201"
language required for video Indicates the language of the content video, in ISO 639-1/alpha2. Highly recommended for successful monetization for pre-, mid-, and post-roll video ads. Not applicable for interstitial and outstream. "language": "en"
aeParams optional Optional parameter that enables overriding of pre-defined video options in account setup. Some common samples are shown below. Additional options are available by contacting your account team.  
aeParams.p_aso.video.ext.skip optional Defines whether the user can skip the ad. Defaults to non-skippable. Set to 1 to indicate skippable. "aeParams": {"p_aso.video.ext.skip": "1"}
aeParams.p_aso.video.ext.skipdelay optional If the ad is skippable, this is an integer duration (in seconds) after which the user has the option to skip the ad. Default is 0. "aeParams": {"p_aso.video.ext.skipdelay": "15"}
aeParams.p_aso.video.ext.maxbitrate optional Integer indicating maximum bitrate of video ad in kbps. "aeParams": {"p_aso.video.ext.maxbitrate": "1200"}
aeParams.p_aso.video.ext.minbitrate optional Integer indicating minimum bitrate of video ad in kbps. "aeParams": {"p_aso.video.ext.minbitrate": "400"}
aeParams.p_aso.video.ext.boxingallowed optional Integer indicating whether the seller permits letterboxing. The default is “1”, – letterboxing is permitted. “0” indicates it is not permitted. "aeParams": {"p_aso.video.ext.boxingallowed": "1"}

Configuration

The Rubicon adapter has the ability to initiate user-sync requests that will improve DSP user ID match rate, with the aim of generating higher bid prices. By default, Rubicon Project sync requests are off. To improve monetization, we recommend firing user syncs 5 seconds after the auction is complete with a call to setConfig().

$$PREBID_GLOBAL$$.setConfig({ 
   userSync: {
    enabledBidders: ['rubicon'],
    iframeEnabled: true
 }});

Note: this config should be combined with any other UserSync config calls, as subsequent calls to setConfig for the same attribute overwrite each other.

Notes

There can only be one siteId and zoneId in an AdUnit. To get bids on multiple sitesIds or zoneIds, just add more ‘rubicon’ entries in the bids array.

rxrtb

Bidder Code

rxrtb

"Send All Bids" Ad Server Keys

hb_pb_rxrtb hb_adid_rxrtb hb_size_rxrtb

"Default Deal ID" Ad Server Key

hb_deal_rxrtb

bid params

Name Scope Description Type Example
id required endpoint id integer 123
token required endpoint token string '657f11a5efbbfe2f9be3f1f146fcbc22'
source required traffic source id string 'prebidtest'

SARA

Bidder Code

sara

"Send All Bids" Ad Server Keys

hb_pb_sara hb_adid_sara hb_size_sara

"Default Deal ID" Ad Server Key

hb_deal_sara

bid params

Name Scope Description Example
uid required Represents the SARA bidder system Ad Slot ID associated with the respective div id from the site page. 5
priceType optional Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the SARA bidder margin within. gross

Sekindo

Bidder Code

sekindoUM

"Send All Bids" Ad Server Keys

hb_pb_sekindoUM hb_adid_sekindoUM hb_size_sekindoUM

"Default Deal ID" Ad Server Key

hb_deal_sekindoUM

bid params

Name Scope Description Example
spaceId required    

Serverbid

Bidder Code

serverbid

"Send All Bids" Ad Server Keys

hb_pb_serverbid hb_adid_serverbid hb_size_serverbid

"Default Deal ID" Ad Server Key

hb_deal_serverbid

bid params

Name Scope Description Example
siteId required The site ID from Serverbid. 12345
networkId required The network ID from Serverbid. 9969

Sharethrough

Bidder Code

sharethrough

"Send All Bids" Ad Server Keys

hb_pb_sharethrough hb_adid_sharethrough hb_size_sharethrough

"Default Deal ID" Ad Server Key

hb_deal_sharethrough

Note:

The Sharethrough bidder adapter requires additional setup and approval from the Sharethrough Integrations team. Please reach out to your account manager for more information to start using it.

bid params

Name Scope Description Example
pkey required The placement key 'DfFKxpkRGPMS7A9f71CquBgZ'

Smart

Bidder Code

smartadserver

"Send All Bids" Ad Server Keys

hb_pb_smartadserver hb_adid_smartadserver hb_size_smartadserver

"Default Deal ID" Ad Server Key

hb_deal_smartadserver

Note:

The Smart bidder adaptor requires setup and approval from the Smart Service team. Please reach out to your account manager for more information and start using it.

bid params

Name Scope Description Example
domain required The network domain 'http://prg.smartadserver.com', 'https://prg.smartadserver.com'
siteId required The placement site ID 1234
pageId required The placement page ID 1234
formatId required The placement format ID 1234
target optional The keyword targeting "sport=tennis"
currency optional Override the default currency code (ISO 4217) of the ad request. (Default: "USD") "EUR"
bidfloor optional Bid floor for this placement in USD or in the currency specified by the currency parameter. (Default: 0.0) 0.42
appName optional Mobile application name Smart AdServer Preview
buId optional Mobile application bundle ID com.smartadserver.android.dashboard
ckId optional Unique Smart user ID 1234567890123456789

SmartyAds

Bidder Code

smartyads

"Send All Bids" Ad Server Keys

hb_pb_smartyads hb_adid_smartyads hb_size_smartyads

"Default Deal ID" Ad Server Key

hb_deal_smartyads

bid params Prebid 0.34

Name Scope Description Example
banner_id required    
`` optional    

bid params Prebid 1.x

Name Scope Description Example
placementId required    
`` optional    

Somo Audience

Bidder Code

somoaudience

"Send All Bids" Ad Server Keys

hb_pb_somoaudience hb_adid_somoaudience hb_size_somoaudience

"Default Deal ID" Ad Server Key

hb_deal_somoaudience

bid params

Name Scope Description Example
placementId required Placement ID provided by Somo Audience 22a58cfb0c9b656bff713d1236e930e8

Sonobi

Bidder Code

sonobi

"Send All Bids" Ad Server Keys

hb_pb_sonobi hb_adid_sonobi hb_size_sonobi

"Default Deal ID" Ad Server Key

hb_deal_sonobi

Note:

The Sonobi Bidder adapter requires setup and approval from your Sonobi Account Manager. If you require assistance implementing our adapter please don’t hesitate to contact us at apex.prebid@sonobi.com.

bid params

Name Scope Description Type Example
placement_id required The placement ID String '1a2b3c4d5e6f1a2b3c4d'
ad_unit required The adunit ID String '/1234567/example/adUnit/code'
floor optional Bid floor for this placement in USD Integer 0.50
sizes optional Adunit sizes that will override global sizes Array[String] [[300, 250], [300, 600]]
hfa optional Publisher Unique Identifier String '123985'

Configuration

The ad_unit and placement_id are mutually exclusive but at least one is required. If you pass both, ad_unit takes precedence.

If you pass the optional sizes Array in your bid params it will override the global config sizes for the Sonobi Adapter only.

The hfa parameter requires your Sonobi Account Manager to enable this feature for you. Please contact them for further information.

Video Example

Sonobi Video

Sovrn

Bidder Code

sovrn

"Send All Bids" Ad Server Keys

hb_pb_sovrn hb_adid_sovrn hb_size_sovrn

"Default Deal ID" Ad Server Key

hb_deal_sovrn

bid params

Name Scope Description Example
tagid required The sovrn Ad Tag ID “315045”
bidfloor optional Bid floor in dollars “0.04”

SpotX

Bidder Code

spotx

"Send All Bids" Ad Server Keys

hb_pb_spotx hb_adid_spotx hb_size_spotx

"Default Deal ID" Ad Server Key

hb_deal_spotx

bid params

Name Scope Description Example
channel_id required A unique 5 digit ID that is generated by the SpotX publisher platform when a channel is created '85394'
video_slot required The video slot is the video object that the creative can use to render 'contentElement'
slot required HTML element on the page in which the ad is to be rendered. 'content'
content_width optional The desired width of the video ad placement. Requires content_height to also be set '640'
content_height optional The desired height of the video ad placement. Requires content_width to also be set '480'
content_id optional An identifier for the content that can be used for refinement and custom reporting '9876543210'
contentPageUrl optional Set the url to be used for the content page, uses the current pages url by default 'http://www.spotx.tv'
ados optional See SpotX documentation here  
ad_volume optional Value between 0 and 1 to denote the volume the ad should start at  
hide_skin optional Set to true to hide the spotx skin  
autoplay optional Set to true to attempt to play the ad as soon as it is loaded  
ad_mute optional Set to true to start the ad with the volume muted  
custom optional See SpotX documentation here  

SpringServe

Bidder Code

springserve

"Send All Bids" Ad Server Keys

hb_pb_springserve hb_adid_springserve hb_size_springserve

"Default Deal ID" Ad Server Key

hb_deal_springserve

bid params

Name Scope Description Example
impId required The impression ID 12345
supplyPartnerId required The supply partner ID 1

StickyAdsTv

Bidder Code

stickyadstv

"Send All Bids" Ad Server Keys

hb_pb_stickyadstv hb_adid_stickyadstv hb_size_stickyadstv

"Default Deal ID" Ad Server Key

hb_deal_stickyadstv

TapSense

Bidder Code

tapsense

"Send All Bids" Ad Server Keys

hb_pb_tapsense hb_adid_tapsense hb_size_tapsense

"Default Deal ID" Ad Server Key

hb_deal_tapsense

bid params

Name Scope Description Example
ad_unit_id required The placement ID from TapSense. "5580935be4b0a4d1a4e8d2b6"
user required The user’s IDFA "771fc655-6e4e-4bae-a4b6-751614d788b5"
refer optional Site that ad request is originating from. "https://tapsense.com"
lat optional User’s latitude “47.5643”"
long optional User’s longitude “-122.151”
price_floor optional Bid floor in dollars "0.04"

Currently TapSense only supports banner (320x50) ad sizes for header bidding.

ThoughtLeadr

Bidder Code

thoughtleadr

"Send All Bids" Ad Server Keys

hb_pb_thoughtleadr hb_adid_thoughtleadr hb_size_thoughtleadr

"Default Deal ID" Ad Server Key

hb_deal_thoughtleadr

bid params

Name Scope Description Example
placementId required The Placement ID from ThoughtLeadr 01234567-89ab-cdef-0123-456789abcdef

Tremor

Bidder Code

tremor

"Send All Bids" Ad Server Keys

hb_pb_tremor hb_adid_tremor hb_size_tremor

"Default Deal ID" Ad Server Key

hb_deal_tremor

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 are true and 0, F, N, null are 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.

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

Trion Interactive

Bidder Code

trion

"Send All Bids" Ad Server Keys

hb_pb_trion hb_adid_trion hb_size_trion

"Default Deal ID" Ad Server Key

hb_deal_trion

bid params

Name Scope Description Example
pubId required publisher Id provided by Trion Interactive 111111
sectionId required section Id provided by Trion Interactive 11
re optional click through redirect http://clicktrackingurl.com?re=

TripleLift

Bidder Code

triplelift

"Send All Bids" Ad Server Keys

hb_pb_triplelift hb_adid_triplelift hb_size_triplelift

"Default Deal ID" Ad Server Key

hb_deal_triplelift

bid params

Name Scope Description Example
inventoryCode required TripleLift inventory code for this ad unit (provided to you by your partner manager) pubname_main_feed
floor optional Bid floor 1.00

TrustX

Bidder Code

trustx

"Send All Bids" Ad Server Keys

hb_pb_trustx hb_adid_trustx hb_size_trustx

"Default Deal ID" Ad Server Key

hb_deal_trustx

bid params

Name Scope Description Example
uid required Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. 42

global params

These parameters must be specified as properties of the ‘window’ object.

Name Scope Description Example
globalprebidTrustxPriceType optional Can take the values gross or net, default value is net. Net represents the header bid price with the TrustX header bidder margin already extracted. Gross price does contain the TrustX bidder margin within. gross

Twenga

Bidder Code

twenga

"Send All Bids" Ad Server Keys

hb_pb_twenga hb_adid_twenga hb_size_twenga

"Default Deal ID" Ad Server Key

hb_deal_twenga

bid params

Name Scope Description Example
placementId required Identifier for the ad placement, as provided by Twenga. "123456"
siteId optional Identifier for the site, as an integer value. Mainly used for reports. 123456
publisherId optional Identifier for the publisher, as an integer value. Mainly used for reports. 123456
currency optional ISO 4217 currency code for the bid price and floor. The default currency is EUR. "USD"
bidFloor optional Minimum CPM to participate with a bid for this ad placement. Should be in EUR or the currency specified by currency. 0.35
country optional Two-letter ISO 3166-1 country code for merchant selection. By default, the user IP address will be used to determine this. DE

ucfunnel

Bidder Code

ucfunnel

"Send All Bids" Ad Server Keys

hb_pb_ucfunnel hb_adid_ucfunnel hb_size_ucfunnel

"Default Deal ID" Ad Server Key

hb_deal_ucfunnel

bid params

Name Scope Description Example
adid required ID of the ad unit  
width required width of ad slot  
height required height of ad slot  
`` optional    

Underdog Media

Bidder Code

underdogmedia

"Default Deal ID" Ad Server Key

hb_deal_underdogmedia

bid params

Name Scope Description Example
siteId required    

Undertone

Bidder Code

undertone

"Send All Bids" Ad Server Keys

hb_pb_undertone hb_adid_undertone hb_size_undertone

"Default Deal ID" Ad Server Key

hb_deal_undertone

bid params

Name Scope Description Example
placementId required Your placement ID (provided by undertone) 10433394
publisherId required publisher ID (provided by undertone) 12345

Unruly

Bidder Code

unruly

"Send All Bids" Ad Server Keys

hb_pb_unruly hb_adid_unruly hb_size_unruly

"Default Deal ID" Ad Server Key

hb_deal_unruly

bid params

Name Scope Description Example
siteId required The site ID from Unruly. This will be provided to you by your Unruly account manager 123456
targetingUUID required The targeting UUID from Unruly. This will be provided to you by your Unruly account manager "766220b5-3d02-46c5-aa8b-2bc60c6f7418"

Vertamedia

Bidder Code

vertamedia

"Send All Bids" Ad Server Keys

hb_pb_vertamedia hb_adid_vertamedia hb_size_vertamedia

"Default Deal ID" Ad Server Key

hb_deal_vertamedia

Bid params

Name Scope Description Example
aid required The source ID from Vertamedia. 350975

Description

Get access to multiple demand partners across VertaMedia AdExchange and maximize your yield with VertaMedia header bidding adapter.

VertaMedia header bidding adapter connects with VertaMedia demand sources in order to fetch bids. This adapter provides a solution for accessing Video demand and display demand

Test Parameters

    var adUnits = [

      // Video instream adUnit
      {
        code: 'div-test-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            context: 'instream'
          }
        },
        bids: [{
          bidder: 'vertamedia',
          params: {
            aid: 331133
          }
        }]
      },

      // Video outstream adUnit
      {
        code: 'outstream-test-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            context: 'outstream'
          }
        },
        bids: [{
          bidder: 'vertamedia',
          params: {
            aid: 331133
          }
        }]
      },

      // Banner adUnit
      {
        code: 'div-test-div',
        sizes: [[300, 250]],
        bids: [{
          bidder: 'vertamedia',
          params: {
            aid: 350975
          }
        }]
      }
    ];

Vertoz

Bidder Code

vertoz

"Send All Bids" Ad Server Keys

hb_pb_vertoz hb_adid_vertoz hb_size_vertoz

"Default Deal ID" Ad Server Key

hb_deal_vertoz

Note:

The Vertoz adapter currently doesn’t support multiple sizes per ad placement and will favour the first one if multiple sizes exists.

bid params

Name Scope Description Example
placementId required vertoz placement id 'VH-HB-123'
cpmFloor optional cpm floor price 0.1

vi

Bidder Code

vi

"Send All Bids" Ad Server Keys

hb_pb_vi hb_adid_vi hb_size_vi

"Default Deal ID" Ad Server Key

hb_deal_vi

bid params

Name Scope Description Example
pubId required Publisher ID, provided by vi ‘sb_test’
lang required Ad language, in ISO 639-1 language code format ‘en-US’, ‘es-ES’, ‘de’
cat required Ad IAB category (top-level or subcategory), single one supported ‘IAB1’, ‘IAB9-1’
bidFloor optional Lowest value of expected bid price 0.001

Vidazoo

Bidder Code

vidazoo

"Send All Bids" Ad Server Keys

hb_pb_vidazoo hb_adid_vidazoo hb_size_vidazoo

"Default Deal ID" Ad Server Key

hb_deal_vidazoo

bid params

Name Scope Description Example
cId required The connection ID from Vidazoo. "5a3a543645ea6b0004869360"
pId required The publisher ID from Vidazoo. "59ac17c192832d0011283fe3"
bidFloor required The minimum bid value desired. Vidazoo will not respond with bids lower than this value. 0.90

VIS.X

Bidder Code

visx

"Send All Bids" Ad Server Keys

hb_pb_visx hb_adid_visx hb_size_visx

"Default Deal ID" Ad Server Key

hb_deal_visx

Note

The VIS.X adaptor requires setup and approval from your YOC account manager team, even for existing YOC publishers. Please reach out to your account manager to enable Prebid.js for your account.

Bid params

Parameter Scope Description Example
uid required The publisher’s ad unit ID in VIS.X '903536'
priceType optional The price type for received bids. Valid values are 'net' or 'gross'. Defaults to 'net'. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the VIS.X bidder margin within. 'net'

Configuration

The VIS.X adaptor has the ability to work in different currencies. Currently this adaptor supports 'EUR', 'USD', 'GBP', 'PLN'. Defaults to 'EUR'.

$$PREBID_GLOBAL$$.setConfig({
    currency: {
        adServerCurrency: 'GBP'
    }
});

Note: this currency config should correspond with your VIS.X account setting. Please reach out to your account manager for more information.

Vuble

Bidder Code

vuble

"Send All Bids" Ad Server Keys

hb_pb_vuble hb_adid_vuble hb_size_vuble

"Default Deal ID" Ad Server Key

hb_deal_vuble

Note:

The Vuble adapter requires setup and approval from the Vuble team, even for existing Vuble publishers. Please reach out to your account team, or contact publishers-us@vuble.tv or publishers-fr@vuble.tv for more information.

Bid params

Name Scope Description Example
env required The environment. Must be ‘net’ or ‘com’. This information will be given to you by the Vuble team. "net"
pubId required Your publisher ID. This information will be given to you by the Vuble team. 3
zoneId required A zone ID for the SSP. 12345
referrer optional The page’s referrer. Not mandatory but recommended. "http://www.vuble.tv/"
floorPrice optional The desired floor price. If none is given, the floor price will depend on the zone ID. 5.00

Example

var adUnits = [
    {
        code: 'test-vuble-instream',
        sizes: [[640, 360]],
        mediaTypes: {
            video: {
                context: 'instream'
            }
        },
        bids: [
            {
                bidder: 'vuble',
                params: {
                    env: 'net',
                    pubId: 18,
                    zoneId: '12345',
                    referrer: "http://www.vuble.tv/",
                    floorPrice: 5.00
                }
            }
        ]
    }
]

Sizes set in the adUnit object will also apply to the Vuble bid requests.

WideOrbit

Bidder Code

wideorbit

"Send All Bids" Ad Server Keys

hb_pb_wideorbit hb_adid_wideorbit hb_size_wideorbit

"Default Deal ID" Ad Server Key

hb_deal_wideorbit

bid params

Name Scope Description Example
pbId required The publisher ID from WideOrbit Programmatic Digital 12345
pId required The placement ID from WideOrbit Programmatic Digital 67890

Widespace

Bidder Code

widespace

"Send All Bids" Ad Server Keys

hb_pb_widespace hb_adid_widespace hb_size_widespace

"Default Deal ID" Ad Server Key

hb_deal_widespace

Bid params

Name Scope Description Example
sid required Widespace Ad Space ID '00000000-0000-0000-0000-000000000000'
currency Optional Currency 'EUR'
bidFloor Optional Bid floor rate '1.25'
demo Optional User’s demographic data {}
demo.gender Optional User’s demographic data gender: 'M'
demo.country Optional Country name country: 'Sweden'
demo.region Optional Region name region: 'Stockholm'
demo.city Optional City name city: 'Stockholm'
demo.postal Optional Postal code postal: '11153'
demo.yob Optional Year of birth yob: '1984'

Xaxis

Bidder Code

xhb

"Send All Bids" Ad Server Keys

hb_pb_xhb hb_adid_xhb hb_size_xhb

"Default Deal ID" Ad Server Key

hb_deal_xhb

bid params

Name Scope Description Example
placementId required    

Xendiz

Bidder Code

xenidz

"Send All Bids" Ad Server Keys

hb_pb_xenidz hb_adid_xenidz hb_size_xenidz

"Default Deal ID" Ad Server Key

hb_deal_xenidz

Bid params

Note

To enable XENDIZ bid adaptor we kindly ask you to sign up as a Publisher: hello@xendiz.com

Name Scope Description Example
pid required Xendiz placement ID '00000000-0000-0000-0000-000000000000'

Yieldbot

Bidder Code

yieldbot

"Send All Bids" Ad Server Keys

hb_pb_yieldbot hb_adid_yieldbot hb_size_yieldbot

"Default Deal ID" Ad Server Key

hb_deal_yieldbot

bid params

Name Scope Description Example
psn required The publisher ID  
slot required The slot  

Yieldlab

Bidder Code

yieldlab

"Send All Bids" Ad Server Keys

hb_pb_yieldlab hb_adid_yieldlab hb_size_yieldlab

"Default Deal ID" Ad Server Key

hb_deal_yieldlab

bid params

Name Scope Description Example
adslotId required Yieldlab Adslot ID ‘12345’
supplyId required Yieldlab Supply ID. Please reach out to your account management for more information. ‘12345’
adSize required Override the default prebid size ‘970x250’

Yieldmo

Bidder Code

yieldmo

"Send All Bids" Ad Server Keys

hb_pb_yieldmo hb_adid_yieldmo hb_size_yieldmo

"Default Deal ID" Ad Server Key

hb_deal_yieldmo

bid params

Name Scope Description Example
placementId required Yieldmo placement id 'ym_825209316101005155'

YIELDONE

Bidder Code

yieldone

"Send All Bids" Ad Server Keys

hb_pb_yieldone hb_adid_yieldone hb_size_yieldone

"Default Deal ID" Ad Server Key

hb_deal_yieldone

bid params

Name Scope Description Example
placementId required The placement ID