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>

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

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"

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. “234234”
randomKey optional a random key specified by the publisher to send into AppNexus. The value is a publisher specified value. These values map to querystring segments for enhanced targeting on the buy side. Multiple key value pairs can be added here. 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.)

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"

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

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 required Unique Tag ID 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

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    

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

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
jstag_url required The publisher specific URL of jstag ox-d.xyz.servedbyopenx.com/w/1.0/jstag?ef=db&nc=23923-EF
unit required the ad unit ID “538562284”
pgid optional The page ID “534205285”

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

Name 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"
rp_account 0.5.0 obsolete Required in 0.5.0 and before, replaced by accountId. "4934"
rp_site 0.5.0 obsolete Required in 0.5.0 and before, replaced by siteId. "13945"
rp_zonesize 0.5.0 obsolete Required in 0.5.0 and before, replaced by zoneId and sizes. "23948-15"

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 "sport=tennis"

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

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

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

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