Bidders’ Params

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

For each bidder listed below, you’ll find:

  • 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 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.

Bidders

Common

bidResponse

These parameters in the bidReponse object are common across all bidders.

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

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    

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"

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 adapter doesn’t support multiple sizes per ad-unit and will use the first one if multiple sizes are defined.

bid params

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

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    

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

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. Must be unique per page. "desktop_articlepage_something_box_300_250"
server optional The server domain name. Default is adserver.adtechus.com. EU customers must use adserver.adtech.de. "adserver.adtech.de"
sizeId optional The size ID from AOL. "170"
bidFloor optional Dynamic bid floor (added in Prebid 0.8.1) "0.80"

(The first of the sizes set in adUnit object will also apply to the AOL bid requests.)

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

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. 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"

(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.

  • mimes: An array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"].

  • minduration: An integer that defines the minimum video ad duration, in seconds.

  • maxduration: An integer that defines the maximum video ad duration, in seconds.

  • startdelay: An integer that determines whether the ad should be shown before, during, or after the video content. If the value is greater than 0, the position is mid-roll and the value indicates the start delay, in seconds. Defaults to 0.
    • Pre-roll: 0
    • Mid-roll: -1
    • Post-roll: -2
  • skippable: A boolean which, if true, means the user can click a button to skip the video ad. Defaults to false.

  • playback_method: An array of strings listing the 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: An array of integers listing the 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

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"
randomKey optional A key specified by the publisher. The value maps to a querystring segment for enhanced buy-side targeting. Multiple k-v pairs can be added. randomKey => randomVal
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"

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

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

bid params

Name Scope Description Example
placementId required The Placement ID from Audience Network “555555555555555_555555555555555”

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

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

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 Scope Description Example
site_id required The site ID from Conversant. "87293"
secure optional Specifies whether the adm should be served securely. true
bidfloor optional Bid floor 0.50

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

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    

Feature Forward

bidder code:

featureforward

bid params

Name Scope Description Example
placementId required    

Feature Forward is an aliased bidder for AppNexus

Fidelity

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"
loc optional The web page URL location "http://site.com/page.html"
click optional The placeholder for third party click tracking URL "http://tracker.com&click="
subid optional The placeholder for SubID "hb" by default
server optional Bidder Domain "x.fidelity-media.com" by default

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"

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 'MyTrackingID'
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/'
allowedSize optional Placement size to allow [300,600]
sizeTolerance optional Tolerance of allowedSize in pixels 5

Index Exchange (Casale)

bidder code:

indexExchange

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    

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

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    

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"

Krux Link

bidder code:

kruxlink

Send All Bids Ad Server Keys:

hb_pb_kruxlink hb_adid_kruxlink hb_size_kruxlink

Default Deal ID Ad Server Key:

hb_deal_kruxlink

Note:

The Krux Link Header Bidding adaptor requires setup and approval from the Krux Link team. Please reach out to link-team@krux.com for more information and to get started today.

bid params

Name Scope Description Example
impid required The placement ID within Krux Link 250

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
jstag_url required JS Ad-Tag URL '//ads.lfstmedia.com/getad?site=285071'
slot required Ad Slot 'slot166704'
adkey required Ad Key '78c'
ad_size required Ad Size '160x600'
timeout optional Prebid.js Timeout 1500

Mantis

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    

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    

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    

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    

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 The ad unit ID provided by OpenX “538562284”
delDomain required The publisher specific domain provided by OpenX “clientname-d.openx.net”
customParams optional Permits passing any publisher key-value pairing into the bid request {“gender”: “female”}

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

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.)

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

bid params

Name Scope Description Example
publisherId required The publisher ID “32572”
adSlot required the unit ID “38519891@300x250”

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

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

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"

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 Fastlane 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 and to enable using this adapter.

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. {"rating":"5-star", "prodtype":"tech"}
visitor 0.6.0 optional An object defining arbitrary key-value pairs concerning the visitor for use in targeting. {"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 optional 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 optional Video player width in pixels "playerWidth": "640"
playerHeight optional Video player height in pixels "playerHeight": "360"
size_id optional 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 optional 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"}

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    

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 AdServer

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 AdServer bidder adaptor requires setup and approval from the Smart AdServer 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 (not yet supported) "sport=tennis"
currency optional Override the default currency code (ISO 4217) of the ad request. (Default: "USD") "EUR"

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

Name Scope Description Example
banner_id required    
`` optional    

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

bid params

Name Scope Description Example
zoneId required    

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

release version:

0.8.0

bid params : DFP adUnit Code format

Name Scope Description Example
ad_unit required The ad unit ID “/1234567/example/adUnit/code”
dom_id optional The DOM Id of the ad slot “div-gpt-ad-12345-0”
floor optional The numerical floor value desired 1

bid params : Sonobi Placement Id format

Name Scope Description Example
placement_id required The placement ID “1a2b3c4d5e6f1a2b3c4d”
dom_id optional The DOM Id of the ad slot “div-gpt-ad-12345-0”
floor optional The numerical floor value desired 1

Caveats

  • The Placement Id format is now deprecated. Your account manager will be in contact to help with transitioning to the adUnit format.
  • More detailed instructions can be found here.
  • If you require assistance with any of our open source code, please email support at github@sonobi.com

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”
sizes optional Override the default prebid size array [970, 250]

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

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

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

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

Underdog Media

bidder code:

underdogmedia

bid params

Name Scope Description Example
siteId required    

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    
placementId required    

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'

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    
cur required    

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    

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