Bidders’ Params

Prebid.org does not support any version of Prebid.js prior to version 1.0.

This page contains documentation on the specific parameters required by each supported bidder. These docs only apply to Prebid.js bidders. For Prebid Server, AMP, or Prebid Mobile, see the Prebid Server Bidders page.

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?
adagio X
adform video X
adgeneration native X
adkernel video X
adkernelAdn video X
admixer video X
adtelligent video X
aduptech
adxcg video, native X
aerserv video
aja video X
aol video X
appnexus video, native X
audienceNetwork video, native X
beachfront video X
bridgewell native X
cxx video X
clickforce native X
conversant video X
criteo native X
dgads native X
divreach video X
ebdr video X
etarget video X
fidelity X
freewheel-ssp video X
fyber X
gambid video X
gamma video X
getintent video X
giants video X
gumgum native X
indexExchange video
interactiveOffers X
kumma video, native X
lifestreet video X
livewrapped X
mantis video, native X
mobfox video X
nanointeractive X
oneVideo video X
onetag X
openx video X
optimatic video X
piximedia X
platformio video, native X
polymorph video, native X
prebidServer video X
pubmatic video X
pulsepoint native X
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
sortable X
spotx video
stickyadstv native
teads video X
telaria video X
ucfunnel video, native X
unruly video, native X
uol X
vertamedia video X
vuble video X
xhb video, native X
yieldnexus video X
yieldlab video X
yieldmo native X

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

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 Type
siteId required Publisher GUID from 33Across 'examplePub123' string
productId required 33Across Product ID that the Publisher has registered for (use 'siab' for standard supply and 'inview' for renderer) 'siab' string

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 Type
zoneId required The A4G zone ID '59304' string
deliveryUrl optional The bid endpoint (might be used for debug) 'http://dev01.ad4game.com/v1/bid' string

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 Type
ai required The rtk auction ID 'XBC1' string
sc required The rtk shortcode 'AF2g' string
categories optional Deal ID Categories ['news','sports'] array

Adagio

Bidder Code

adagio

"Send All Bids" Ad Server Keys

hb_pb_adagio hb_adid_adagio hb_size_adagio

"Default Deal ID" Ad Server Key

hb_deal_adagio

bid params

Name Scope Description Example Type
siteId required Site ID from Adagio. 0 string
placementId required Placement ID from Adagio. Refers to the placement of an ad unit in a page. 4 string
pagetypeId required Page type ID from Adagio. 343 string
categories required IAB categories of the page. ['IAB12', 'IAB12-2'] Array<string>

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 Type
partnerId required Your partner ID (provided by Adblade) 39875 integer
bidfloor optional The bid floor for units returned from Adblade 0.50 float

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 Type
sid required slot id 110238 integer
bidfloor required   0.036 float

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 Type
accountID required Account ID '167283' string
zoneID required Zone ID '210093' string
keyword optional Keyword(s) used for custom targeting 'green,orange' string
minCPM optional Minimum CPM value to accept '1.00' string
maxCPM optional Maximum CPM value to accept '5.00' string

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 Type
mid required   12345 integer
adxDomain optional The Adform domain 'adx.adform.net' string

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 Type
id required adId '1234' string

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 Type
host required Ad network’s RTB host 'cpm.metaadserving.com' string
zoneId required RTB zone id '30164' string

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 Type
host optional Ad network host 'tag.adkernel.com' string
pubId required Publisher Id 102 integer

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 Type
aid required The Affiliate ID for the Publisher '1234' string

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 Type
zone required     string

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 Example Type
slaveId required slave ID 'adoceanmyaozpniqismex' string
masterId required master ID 'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7' string
emiter required traffic source id 'myao.adocean.pl' string

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 Type
siteId required The site ID from AdSparc. 12345 integer
networkId required The network ID from AdSparc. 9969 integer

AdSpirit

Bidder Code

adspirit

"Send All Bids" Ad Server Keys

hb_pb_adspirit hb_adid_adspirit hb_size_adspirit

"Default Deal ID" Ad Server Key

hb_deal_adspirit

bid params

Name Scope Description Example Type
placementId required The placement ID '5' string
host required (only for biddercode adspirit) The advertiser specific url provided by AdSpirit 'n1test.adspirit.de' string

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 Type
clientId required AdSupply client identifier. Provided by AdSupply. 'b367CB268B1094004A3689751E7AC568F' string
siteId required AdSupply site identifier. Provided by AdSupply. '9e3ba26d-eaac-4004-9c7d-c0ac269d0cf2' string
zoneId required AdSupply zone identifier. A zone entity manages caps, sizes, etc. Provided by AdSupply. 28384 integer
endpointUrl required AdSupply engine domain. 'engine.4dsply.com' string

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 Type
aid required The source ID from Adtelligent. 350975 integer

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
          }
        }]
      }
    ];

Ad Up Technology

Bidder Code

aduptech

"Send All Bids" Ad Server Keys

hb_pb_aduptech hb_adid_aduptech hb_size_aduptech

"Default Deal ID" Ad Server Key

hb_deal_aduptech

Note:

The Ad Up Technology Bidding adapter requires setup and approval before beginning.
For more information visit www.adup-tech.com.

Bid params

Name Scope Description Example
publisher required Unique publisher id '1234'
placement required Unique placement id per publisher '5678'
query optional Semicolon separated list of keywords 'urlaub;ibiza;mallorca'
adtest optional Impressions and clicks will not be tracked if enabled true

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 Type
adzoneid required adxcg zone id '1' string

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 Type
placement required The placement ID from Adyoulike. '194f787b85c829fb8822cdaf1ae64435' string
DC optional The data center name 'usa01' string

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 Type
plc required The AerServ Placement ID. 480 integer
coppa optional COPPA override. Send 1 if the request’s source falls under COPPA regulations. 1 integer

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 Type
vpw optional video width override 480 integer
vph optional video height override 360 integer

AJA Inc.

Bidder Code

aja

"Send All Bids" Ad Server Keys

hb_pb_aja hb_adid_aja hb_size_aja

"Default Deal ID" Ad Server Key

hb_deal_aja

Note:

The AJA Bidding adaptor requires setup and approval before beginning. Please reach out to ssp_support@aja-kk.co.jp for more details

bid params

Name Scope Description Example Type
asi required ad spot hash code '123abc' string

andbeyond

Bidder Code

andbeyond

"Send All Bids" Ad Server Keys

hb_pb_andbeyond hb_adid_andbeyond hb_size_andbeyond

"Default Deal ID" Ad Server Key

hb_deal_andbeyond

Note:

The andbeyond Bidding adaptor requires setup and approval before beginning. Please reach out to shreyanschopra@rtbdemand.com for more details

bid params

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

Answer Media

Bidder Code

answermedia

"Send All Bids" Ad Server Keys

hb_pb_answermedia hb_adid_answermedia hb_size_answermedia

"Default Deal ID" Ad Server Key

hb_deal_answermedia

bid params

Name Scope Description Example Type
siteId required The site ID from Answer Media. 12345 Integer
zoneIds optional An array of integer zone IDs from Answer Media. [12345, 4567] Array of integers
networkId required The network ID from Answer Media. 9969 Integer

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

ONE by AOL: Display

Name Scope Description Example Type
placement required The placement ID from AOL. '23324932' string
network required The network ID from AOL. '5071.1' string
alias optional The placement alias from AOL. 'desktop_articlepage_something_box_300_250' string
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' string
bidFloor optional Dynamic bid floor (added in Prebid 0.8.1) '0.80' string

ONE by AOL: Mobile

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

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

All AppNexus placements included in a single call to requestBids must belong to the same parent Publisher. If placements from two different publishers are included in the call, the AppNexus bidder will 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 Type
placementId required The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. '234234' string
member optional The member ID from AppNexus. Must be used with invCode. '12345' string
invCode optional The inventory code from AppNexus. Must be used with member. 'abc123' string
user optional Object that specifies information about an external user. See User Object for details. user: { age: 25, gender: 0, dnt: true} object
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 boolean
usePaymentRule optional If true, Appnexus will return net price to Prebid.js after publisher payment rules have been applied. true boolean
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'] } object
video optional Object containing video targeting parameters. See Video Object for details. video: { playback_method: ['auto_play_sound_off'] } object
app optional Object containing mobile app parameters. See the App Object for details. app : { id: 'app-id'} object
reserve optional Sets a floor price for the bid that is returned. If floors have been configured in the AppNexus Console, those settings will override what is configured here. 0.90 float
position optional Identify the placement as above or below the fold. Allowed values: Unknown: 0; Above the fold: 1; Below the fold: 2 1 integer
trafficSourceCode optional Specifies the third-party source of this impression. 'my_traffic_source' string
supplyType optional Indicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app 'web' string
pubClick optional Specifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using AppNexus click tracking properly. 'http://click.adserver.com/' string
extInvCode optional Specifies predefined value passed on the query string that can be used in reporting. The value must be entered into the system before it is logged. '10039' string
externalImpId optional Specifies the unique identifier of an externally generated auction. 'bacbab02626452b097f6030b3c89ac05' string

Video Object

Name Description Type
mimes Array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"]. Array<string>
minduration Integer that defines the minimum video ad duration in seconds. integer
maxduration Integer that defines the maximum video ad duration in seconds. integer
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. integer
skippable Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false. boolean
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". Array<string>
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. Array<integer>

User Object

Name Description Example Type
age The age of the user. 35 integer
externalUid Specifies a string that corresponds to an external user ID for this user. '1234567890abcdefg' string
segments Specifies the segments to which the user belongs. [1, 2] Array<integer>
gender Specifies the gender of the user. Allowed values: Unknown: 0; Male: 1; Female: 2 1 integer
dnt Do not track flag. Indicates if tracking cookies should be disabled for this auction true boolean
language Two-letter ANSI code for this user’s language. EN string

App Object

AppNexus supports using prebid within a mobile app’s webview. If you are interested in using an SDK, please see Prebid Mobile instead.

Name Description Example Type
id The App ID. 'B1O2W3M4AN.com.prebid.webview' string
device_id Object that contains the advertising identifiers of the user (idfa, aaid, md5udid, sha1udid, or windowsadid). { aaid: "38400000-8cf0-11bd-b23e-10b96e40000d" } object
geo Object that contains the latitude (lat) and longitude (lng) of the user. { lat: 40.0964439, lng: -75.3009142 } object

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 Type
siteId required The site ID from 152 Media 2.0. 12345 integer
networkId required The network ID from 152 Media 2.0. 9969 integer

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 Type
pub required RTB publisher id 'prebidtest' string
source required RTB traffic source id 'prebidtest' string
coppa optional flag this request subject to COPPA 1 integer

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 Type
id required Atomx placement ID 1234 integer

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 Type
placementId required The Placement ID from Audience Network '555555555555555\_555555555555555' string
format optional Format, one of “native”, “fullwidth” or “video” 'native' string

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 Type
siteId required The site ID from Automatad. 12345 integer
networkId required The network ID from Automatad. 9969 integer

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 Type
appId required Beachfront Exchange ID '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor required Bid floor 0.01 float
video optional Object with video parameters. See the video section below for details.   object

video params

Name Scope Description Example Type
mimes optional Array of strings listing supported MIME types. ["video/mp4", "application/javascript"] Array<string>
playbackmethod optional Playback method supported by the publisher.
1: Auto-play sound on
2: Auto-play sound off
3: Click-to-play
4: Mouse-over
1 integer
maxduration optional Maximum video ad duration in seconds. 30 integer

BetweenDigital

Bidder Code

between

"Send All Bids" Ad Server Keys

hb_pb_between hb_adid_between hb_size_between

"Default Deal ID" Ad Server Key

hb_deal_between

bid params

Name Scope Description Example
w required width of placement(Number) 240
h required height of placement(Number) 400
s required Section ID, provided by betweendigital 12345

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 Type
adunitId required Tag ID '7f75fdc7-cc9e-49d7-b481-77f18029eb50' string
pubId required Publisher ID 'd8dbcff7-92c1-4cf4-bc41-ca4ef831808a' string
reservePrice optional Floor price '0.5" string

BizzClick

Bidder Code

bizzclick

"Send All Bids" Ad Server Keys

hb_pb_bizzclick hb_adid_bizzclick hb_size_bizzclick

"Default Deal ID" Ad Server Key

hb_deal_bizzclick

bid params

Name Scope Description Example Type
placementId required Placement Id will be generated on Bizzclick SSP Platform. 0 integer
type optional Type traffic 'banner' string

brainy

Bidder Code

brainy

"Send All Bids" Ad Server Keys

hb_pb_brainy hb_adid_brainy hb_size_brainy

"Default Deal ID" Ad Server Key

hb_deal_brainy

bid params

Name Scope Description Example Type
accountID required accountID of the ad unit   string
slotID required slotID of the ad unit   string
width required width of ad slot   string
height required height of ad slot   string

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 Type
ChannelID required The channel ID from Bridgewell. 'CgUxMjMzOBIBNiIFcGVubnkqCQisAhD6ARoBOQ' string

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 Type
tagId required Tag ID in Brightcom 16577 integer
bidFloor optional Bid floor rate 1.23 float

BuySellAds

Bidder Code

buysellads

"Send All Bids" Ad Server Keys

hb_pb_buysellads hb_adid_buysellads hb_size_buysellads

"Default Deal ID" Ad Server Key

hb_deal_buysellads

bid params

Name Scope Description Example
siteId required The site ID from BuySellAds. 12345
zoneIds optional An array of integer zone IDs from BuySellAds. [12345, 4567]
networkId required The network ID from BuySellAds. 9969

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 Type
siteId required Site ID from which the request is originating '999' string
pixelId optional Publisher’s pixel ID '12345' string
floorPriceMap optional Minimum floor prices needed from the DSP’s to enter the auction {'300x250': 4.00,'300x600': 3.00} object
dspid optional DSP ID '4321' string
pageurl optional Url of the webpage where the request is originating from '4321' string

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 Type
pid required     string
did required     string
wid required     string

Clickonometrics

Bidder Code

cxx

"Send All Bids" Ad Server Keys

hb_pb_cxx hb_adid_cxx hb_size_cxx

"Default Deal ID" Ad Server Key

hb_deal_cxx

bid params

Common params (banner, video)

Name Scope Description Example Type
placementId required Clickonometrics placement ID 12345 integer

Video params

Name Scope Description Example Type
video.playbackmethod optional See OpenRTB docs for info [1, 2, 3, 4] Array<integer>
video.protocols optional See OpenRTB docs for info [2, 3, 5, 6] Array<integer>
video.mimes optional See OpenRTB docs for info ['video/mp4', 'video/x-flv'] Array<string>
video.skip optional See OpenRTB docs for info 1 integer
video.skipafter optional See OpenRTB docs for info 5 integer

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 (display ad)

Name Scope Description Example Type
zone required The CLICKFORCE zone ID '6682' string

bid params (native ad)

Name Scope Description Example Type
zone required The CLICKFORCE zone ID '6878' string

COLOMBIA

Bidder Code

colombia

"Send All Bids" Ad Server Keys

hb_pb_colombia hb_adid_colombia hb_size_colombia

"Default Deal ID" Ad Server Key

hb_deal_colombia

bid params

Name Scope Description Example Type
placementId required The placement ID(Adunit Id)   string

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 Type
placement_id required Placement Id will be generated on Colossus SSP Platform. 0 integer
traffic optional Type traffic 'banner' string

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 Type
siteId required The site ID from ConnectAd. 12345 integer
networkId required The network ID from ConnectAd. 10047 integer

Consumable

Bidder Code

consumable

"Send All Bids" Ad Server Keys

hb_pb_consumable hb_adid_consumable hb_size_consumable

"Default Deal ID" Ad Server Key

hb_deal_consumable

Note:

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

bid params

Name Scope Description Example Type
siteId required The site ID from Consumable. 12345 integer
networkId required The network ID from Consumable. 9969 integer
unitId required The unit ID from Consumable. 987654 integer
unitName required The unit name from Consumable. cnsmbl-unit string

Content Ignite

Bidder Code

contentignite

"Default Deal ID" Ad Server Key

hb_deal_contentignite

bid params

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

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 Type
site_id required The site ID from Conversant. '87293' string
secure 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 integer
bidfloor optional Bid floor 0.50 float
tag_id optional Identifies specific ad placement. 'cnvr-test-tag' string
position optional Ad position on screen. See details below. 1 integer
mimes optional Array of content MIME types supported. Required for video ['video/mp4'] Array<string>
maxduration optional Maximum duration in seconds for this video as an integer. 30 integer
api optional Array of supported API frameworks. See details below. [2] Array<integer>
protocols optional Array of supported video protocols. See details below. [2] Array<integer>

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 Type
size required Size '300x250' string
id required Ad space id 2000005991707 integer
siteId required Site id 2000100948180 integer

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 Type
zoneId required The zone ID from Criteo. Can be replaced by networkId when using zone matching. 234234 integer
networkId optional The network ID from Criteo.Please reach out your Criteo representative for more details. 456456 integer
nativeCallback optional Callback to perform render in native integrations. Please reach out your Criteo representative for more details. function(payload) { console.log(payload); } function
integrationMode optional Integration mode to use for ad render (none or ‘AMP’). Please reach out your Criteo representative for more details. 'AMP' string

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 Type
uid required Represents the DAN Marketplace bidder system Ad Slot ID associated with the respective div id from the site page. 5 integer
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' string

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

Defy Media is an aliased bidder for AppNexus

dgads

Bidder Code

dgads

"Send All Bids" Ad Server Keys

hb_pb_dgads hb_adid_dgads hb_size_dgads

"Default Deal ID" Ad Server Key

hb_deal_dgads

bid params

Name Scope Description Example Type
site_id required Publisher ID '12' string
location_id required Placement ID '23' string

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

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

Setting for Prebid version 1.0 and above.
Name Scope Description Example Type
dmxid required Placement Id 100001 integer
memberid required Account id 100003 integer

=======

Prebid 0.34~ legacy
Name Scope Description Example Type
id required Placement ID 123456789 integer
floor optional Bid floor price “1.00” string
revShare optional Publisher Revenue Share “0.85” string
currency optional Currency code “usd” string

DivReach

Bidder Code

divreach

"Send All Bids" Ad Server Keys

hb_pb_divreach hb_adid_divreach hb_size_divreach

"Default Deal ID" Ad Server Key

hb_deal_divreach

bid params

Name Scope Description Example Type
zone required     string

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 Type
zoneid required The EngageBDR Zone ID '99999' string
bidfloor optional Bid Floor Price '1.00' string
IDFA optional IDFA ID 'xxx-xxxx' string
ADID optional ADID ID 'xxx-xxxx' string
latitude optional latitude '34.089811' string
longitude optional longitude '-118.392805' string

EMX Digital (formally bRealTime)

Bidder Code

emxdigital

"Send All Bids" Ad Server Keys

hb_pb_emxdigital hb_adid_emxdigital hb_size_emxdigital

"Default Deal ID" Ad Server Key

hb_deal_emxdigital

bid params

Name Scope Description Example Type
placementId required The placement ID from EMX Digital '1234567' string

EMX Digital is an aliased bidder for AppNexus

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 Type
ci required Your partner ID (provided by E-Planning) '18f66' string
sv optional Indicates a bidder URL different than default 'ads.us.e-planning.net' string
isv optional Indicates a CDN URL different than default 'us.img.e-planning.net' string
t optional Indicates bidding for testing purposes 1 integer

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 Type
placementID required (String) The placement ID from Essens. 'abc-123' string
dealId optional (String) ID of deal. 'deal1' string
floorPrice optional (Float) Floor price corresponding the deal. In float. 7.5 float
currency optional ISO currency string 'NOK' string

Etarget

Bidder Code

etarget

"Send All Bids" Ad Server Keys

hb_pb_etarget hb_adid_etarget hb_size_etarget

"Default Deal ID" Ad Server Key

hb_deal_etarget

bid params

Name Scope Description Example
refid required   12345
country required Country domain 1

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 Type
uid required Represents the FairTrade bidder system Ad Slot ID associated with the respective div id from the site page. 5 integer
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' string

Feature Forward

Bidder Code

featureforward

"Default Deal ID" Ad Server Key

hb_deal_featureforward

bid params

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

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 Type
zoneid required The ad zone or tag specific ID '27248' string
floor optional The floor CPM price for the request 0.1234 float
server optional Bidder domain (default 'x.fidelity-media.com') 'x.fidelity-media.com' string

FreeWheel-ssp

Bidder Code

freewheel-ssp

"Default Deal ID" Ad Server Key

hb_deal_freewheel-ssp

bid params

Name Scope Description Example Type
zoneId required     string

Fyber

Bidder Code

fyber

"Send All Bids" Ad Server Keys

hb_pb_fyber hb_adid_fyber hb_size_fyber

"Default Deal ID" Ad Server Key

hb_deal_fyber

bid params

Name Scope Description Example Type
appId required The app. ID provided by Inneractive 'Company_App_OS' string
adSpotType required The ad spot type ('BANNER'/RECTANGLE) 'BANNER' string
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   object

Gamoshi

Bidder Code

gambid

"Send All Bids" Ad Server Keys

hb_pb_gambid hb_adid_gambid hb_size_gambid

"Default Deal ID" Ad Server Key

hb_deal_gambid

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner you created in the Gambid dashboard. '12345' string
rtbEndpoint optional If you have a whitelabel account on Gamoshi, specify it here. 'rtb.mybidder.com' string

This adapter only requires you to provide your supply partner ID, and optionally your RTB endpoint, in order to request bids from your Gamoshi Gambid account.

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 Example Type
siteId required Site ID 1465446377 integer
zoneId required Zone ID 1515999290 integer

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 Type
pid required Publisher ID registered in GetIntent system 123 integer
tid optional Unique Tag ID. Required if multiple tags are used on the same page. 'abc' string
cur optional Currency of the ad request. Default is the one configured at publisher settings. 'USD' string
floor optional Floor price for the request. 0.123 float
video optional Object with video parameters. See the video section below.   object

video

Name Scope Description Example Type
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. [4,5,6] Array<integer>
mimes optional Array of Mime Type strings. ['application/javascript'] Array<string>
min_dur optional Minimal video duration. 30 integer
max_dur optional Maximal video duration. 30 integer
min_btr optional Minimal Video bitrate. 256 integer
max_btr optional Maximal Video bitrate. 512 integer
vi_format optional Video inventory format. Possible values: 1 - In-Stream video, 2 - Out-Stream video. 1 integer
api optional API of the inventory. Possible values: 1 - VPAID 1.0, 2 - VPAID 2.0, 3 - MRAID-1, 4 - ORMMA, 5 - MRAID-2. [3,4] Array<integer>
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). 'NOT_ALLOW' string

IPAX

Bidder Code

giants

"Send All Bids" Ad Server Keys

hb_pb_giants hb_adid_giants hb_size_giants

"Default Deal ID" Ad Server Key

hb_deal_giants

bid params

Name Scope Description Example Type
zoneId required Zone ID 584072408 integer

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

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 Type
inScreen optional Tracking ID 'ggumtest' string
inSlot optional Slot ID 9 integer

GXOne

Bidder Code

gxone

"Send All Bids" Ad Server Keys

hb_pb_gxone hb_adid_gxone hb_size_gxone

"Default Deal ID" Ad Server Key

hb_deal_gxone

bid params

Name Scope Description Example Type
uid required Represents the GXOne bidder system Ad Slot ID associated with the respective div id from the site page. 2 integer
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 GXOne bidder margin within. 'gross' string

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 Type
zoneId required     string
host required     string

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 Type
accountId required Account ID '750' string
bidUrl optional The bid server endpoint URL 'https://example.com/' string

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 Type
placement_id required Placement Id will be generated on Huddled Masses SSP Platform. 0 integer

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 Type
pubId required Publisher client ID, provided by IAS '1234' string
adUnitPath required Ad unit path. The same one you use for GPT '/1234567/sports' string

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 Type
publisher_id required imonomy publisher id '1234567890' string

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 Type
placementId optional The placement ID from Improve Digital. 1234567 integer
publisherId optional Your publisher ID. This is only required when using a placementKey 950 integer
placementKey optional The placement key for your placement. Must be used with publisherId. 'myMainBannerPlacement300x200' string
keyValues optional Contains one or more key-value pairings for key-value targeting { testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] } object
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 } object

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

Bidder Code

ix

"Send All Bids" Ad Server Keys

hb_pb_ix hb_adid_ix hb_size_ix

"Default Deal ID" Ad Server Key

hb_deal_ix

Overview

Module Name: Index Exchange Adapter
Module Type: Bidder Adapter
Maintainer: prebid.support@indexexchange.com

Description

This module connects publishers to Index Exchange’s (IX) network of demand sources through Prebid.js. This module is GDPR compliant.

It is compatible with both the older ad unit format where the sizes and mediaType properties are placed at the top-level of the ad unit, and the newer format where this information is encapsulated within the mediaTypes object. We recommend that you use the newer format when possible as it will be better able to accommodate new feature additions.

If a mix of properties from both formats are present within an ad unit, the newer format’s properties will take precedence.

Here are examples of both formats.

Older Format
var adUnits = [{
    // ...

    sizes: [
        [300, 250],
        [300, 600]
    ]

    // ...
}];
Newer Format
var adUnits = [{
    // ...

    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        }
    }

    // ...
}];

Supported Media Types

Type Support
Banner Fully supported for all IX approved sizes.
Video Not supported.
Native Not supported.

Bid Parameters

Each of the IX-specific parameters provided under the adUnits[].bids[].params object are detailed here.

Name Scope Description Example Type
siteId required An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. '3723' string
size required The single size associated with the site ID. It should be one of the sizes listed in the ad unit under adUnits[].sizes or adUnits[].mediaTypes.banner.sizes. [300, 250] Array<integer>

Setup Guide

Follow these steps to configure and add the IX module to your Prebid.js integration.

The examples in this guide assume the following starting configuration:

var adUnits = [{
    code: 'banner-div-a',
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        }
    },
    bids: []
}];
1. Add IX to the appropriate ad units

For each size in an ad unit that IX will be bidding on, add one of the following bid objects under adUnits[].bids:

{
    bidder: 'ix',
    params: {
        siteId: '',
        size: []
    }
}

Set params.siteId and params.size in each bid object to the values provided by your IX representative.

Example

var adUnits = [{
    code: 'banner-div-a',
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        }
    },
    bids: [{
        bidder: 'ix',
        params: {
            siteId: '12345',
            size: [300, 250]
        }
    }, {
        bidder: 'ix',
        params: {
            siteId: '12345',
            size: [300, 600]
        }
    }]
}];

Please note that you can re-use the existing siteId within the same flex position.

2. Include ixBidAdapter in your build process

When running the build command, include ixBidAdapter as a module.

gulp build --modules=ixBidAdapter,fooBidAdapter,bazBidAdapter

If a JSON file is being used to specify the bidder modules, add "ixBidAdapter" to the top-level array in that file.

[
    "ixBidAdapter",
    "fooBidAdapter",
    "bazBidAdapter"
]

And then build.

gulp build --modules=bidderModules.json

Setting First Party Data (FPD)

FPD allows you to specify key-value pairs which will be passed as part of the query string to IX for use in Private Marketplace Deals which rely on query string targeting for activation. For example, if a user is viewing a news-related page, you can pass on that information by sending category=news. Then in the IX Private Marketplace setup screens you can create Deals which activate only on pages which contain category=news. Please reach out to your IX representative if you have any questions or need help setting this up.

To include FPD in a bid request, it must be set before pbjs.requestBids is called. To set it, call pbjs.setConfig and provide it with a map of FPD keys to values as such:

pbjs.setConfig({
    ix: {
        firstPartyData: {
            '<key name>': '<key value>',
            '<key name>': '<key value>',
            // ...
        }
    }
});

The values can be updated at any time by calling pbjs.setConfig again. The changes will be reflected in any proceeding bid requests.

Setting a Server Side Timeout

Setting a server-side timeout allows you to control the max length of time the servers will wait on DSPs to respond before generating the final bid response and returning it to this module.

This is distinctly different from the global bidder timeout that can be set in Prebid.js in the browser.

To add a server-side timeout, it must be set before pbjs.requestBids is called. To set it, call pbjs.setConfig and provide it with a timeout value as such:

pbjs.setConfig({
    ix: {
        timeout: 500
    }
});

The timeout value must be a positive whole number in milliseconds.

Additional Information

Bid Request Limit

If a single bid request to IX contains more than 20 impression requests (i.e. more than 20 objects in bidRequest.imp), only the first 20 will be accepted, the rest will be ignored.

To avoid this situation, ensure that when pbjs.requestBid is invoked, that the number of bid objects (i.e. adUnits[].bids) with adUnits[].bids[].bidder set to 'ix' across all ad units that bids are being requested for does not exceed 20.

Time-To-Live (TTL)

All bids received from IX have a TTL of 35 seconds, after which time they become invalid.

If an invalid bid wins, and its associated ad is rendered, it will not count towards total impressions on IX’s side.

FAQs

Why do I have to input size in adUnits[].bids[].params for IX when the size is already in the ad unit?

There are two important reasons why we require it:

  1. An IX site ID maps to a single size, whereas an ad unit can have multiple sizes. To ensure that the right site ID is mapped to the correct size in the ad unit we require the size to be explicitly stated.

  2. An ad unit may have sizes that IX does not support. By explicitly stating the size, you can choose not to have IX bid on certain sizes that are invalid.

How do I view IX’s bid request in the network?

In your browser of choice, create a new tab and open the developer tools. In developer tools, select the network tab. Then, navigate to a page where IX is setup to bid. Now, in the network tab, search for requests to casalemedia.com/cygnus. These are the bid requests.

Index Exchange (Legacy)

Bidder Code

indexExchange

"Default Deal ID" Ad Server Key

hb_deal_indexExchange

Legacy Adapter

This is the IndexExchange legacy adapter and you should reference the new IX adapter for bidder information.

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 Type
appId required The app. ID provided by Inneractive 'Company_App_OS' string
adSpotType required The ad spot type ('BANNER'/'RECTANGLE') 'BANNER' string
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   object

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 Type
pub required The publisher account ID 267 integer
zone required The zone ID 62546 integer

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 Type
siteId required Site ID provided by Inskin. 12345 integer
networkId required Network ID provided by Inskin. 9969 integer

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 Type
siteId required The site ID from Insticator. 12345 integer
networkId required The network ID from Insticator. 9969 integer

InteractiveOffers

Bidder Code

interactiveOffers

"Default Deal ID" Ad Server Key

hb_deal_interactiveOffers

Note:

Module that connects to interactiveOffers demand sources. Param pubId is required.

bid params

Name Scope Description Example Type
pubId required The placement ID (site channel ID) 4 integer
tmax optional Max timeout for response 150 integet

Example:

{
    bidder: "interactiveOffers",
    params: {
        pubId: 4,
        tmax: 150
    }
}

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 Type
placementId required The Invibes placement ID '1234567' string
adContainerId optional Id of ad container 'test-div' string

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 Type
publisherId required The Publisher ID from iQM. 'df5fd732-c5f3-11e7-abc4-cec278b6b50a' string
tagId required The Tag ID from iQM. '1c5c9ec2-c5f4-11e7-abc4-cec278b6b50a' string
placementId required The Placement ID from iQM. '50cc36fe-c5f4-11e7-abc4-cec278b6b50a' string
bidfloor required Bid floor 0.50 integer

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 Type
id required     string
siteID required     string
tier2SiteID optional     string
tier3SiteID optional     string

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 Type
zone required The zone ID provided by Justpremium '34604' string
allow optional Permits publisher to decide which products can be run from specific ad unit ['lb', 'wp'] Array<string>
exclude optional Permits publisher to decide which products should be excluded from running in specific ad unit ['is'] Array<string>

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. Also, you must test on a mobile device, or emulate a mobile device by manipulating the user agent string sent to the server.

bid params

Name Scope Description Example Type
placementId required     string

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 Type
hbid required header-bidding id from Komoona '1f5b2c10e66e419580bd943b9af692ab' string
placementId required placement id from Komoona 'e69148e0ba6c4c07977dc2daae5e1577' string

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 Type
pubId required The publisher account ID '28082' string
siteId required The publisher site ID '26047' string
placementId required Identifies specific ad placement '17394' string
bidFloor optional The bid floor '0.001' string
ifa optional IFA ID 'XXX-XXX' string
latitude optional Latitude '40.712775' string
longitude optional Longitude '-74.005973' string

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: 'kumma',
              params: {
                  pubId: '29521',
                  siteId: '26048',
                  placementId: '123',
              }
          }]
      },
      {
          code: 'dfp-banner-div',
          mediaTypes: {
              banner: {
                  sizes: [
                      [300, 250]
                  ],
              }
          },
          bids: [{
              bidder: 'kumma',
              params: {
                  pubId: '29521',
                  siteId: '26049',
                  placementId: '123',
              }
          }]
      },
      {
          code: 'dfp-video-div',
          sizes: [640, 480],
          mediaTypes: {
              video: {
                  context: "instream"
              }
          },
          bids: [{
              bidder: 'kumma',
              params: {
                  pubId: '29521',
                  siteId: '26049',
                  placementId: '123',
                  video: {
                      skippable: true,
                  }
              }
          }]
      }
  ];

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 Type
slot required Ad Slot 'slot166704' string
adkey required Ad Key '78c' string
ad_size required Ad Size '160x600' string

Livewrapped

Bidder Code

livewrapped

"Send All Bids" Ad Server Keys

hb_pb_livewrapped hb_adid_livewrapped hb_size_livewrapped

"Default Deal ID" Ad Server Key

hb_deal_livewrapped

Note:

The Livewrapped Bidder Adapter requires setup and approval from Livewrapped AB. Please reach out to sales@livewrapped.com for more information.

bid Params

Name Scope Description Example Type
adUnitId required The ad unit ID from Livewrapped. You may identify an ad unit using the publisherId and adUnitName instead of an ad unit ID. '6A32352E-BC17-4B94-B2A7-5BF1724417D7' string
publisherId optional The publisher ID from Livewrapped. Must be used with adUnitName. 'C6E31E93-116B-4040-A185-E7BA621C3799' string
adUnitName optional The ad unit name from Livewrapped. Must be used with publisherId. 'panorama_d_1' string
userId optional If a user id is available, pass the id into this parameter. 'user id' string

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 Type
placementId required   '263' string
siteId required   '662921' string

LockerDome

Bidder Code

lockerdome

"Send All Bids" Ad Server Keys

hb_pb_lockerdome hb_adid_lockerdome hb_size_lockerdome

"Default Deal ID" Ad Server Key

hb_deal_lockerdome

bid params

Name Scope Description Example Type
adUnitId required The ad unit ID from LockerDome 10809467961050726 integer

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 Type
s required Zone code. This parameter should be the unique Publisher ID of your mobile application or website. '/4543756/prebidadaptor/madvertiseHB' string
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 integer
lat optional Latitude 48.866667 float
long optional Longitude 2.333333 float
age optional Age 19 integer
gender optional Gender m or f 'f' string
locale optional Locale 'fr' string
floor optional Bid floor 1.0 float

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 Type
property required The unique identifier provided for your entire account. '5a5840d00000000000000000' string
zone required The unique identifier for the placement defined in our admin. 'sidebar-top-1' string

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 Type
publisherID required     string
floor optional     string

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

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 Type
cid required The customer id provided by Media.net. '8CUX0H51C' string
crid optional The placement id provided by Media.net '1234567' string
bidfloor optional Bidfloor for the impression 1.0 float

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 Type
tagid required     string

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 Type
s required The hash of your inventory to identify which app is making the request '267d72ac3f77a3f447b32cf7ebf20673' string
imp_instl optional set to 1 if using interstitial otherwise delete or set to 0 1 integer

my6Sense

Bidder Code

my6Sense

"Send All Bids" Ad Server Keys

hb_pb_my6Sense hb_adid_my6Sense hb_size_my6Sense

"Default Deal ID" Ad Server Key

hb_deal_my6Sense

bid params

Name Scope Description Example
key required Widget key, provided by the network. “dxSUw7n8ec74Nqxl7mxKk3”
pageUrl   Used to pass the served page URL. “[PAGE_URL]”
zone   Used to pass optional data to the platform. “[ZONE]”
dataView   3rd party tracker URL in order to track widget view. ””
organicClicks   3rd party click tracker URL to track organic clicks. ””
paidClicks   3rd party click tracker URL to track paid clicks. ””

Nano Interactive

Bidder Code

nanointeractive

"Default Deal ID" Ad Server Key

hb_deal_nanointeractive


Requirements:

To be able to get identification key (pid), please contact us at
https://www.nanointeractive.com/publishers



Send All Bids Ad Server Keys:

(truncated to 20 chars due to DFP limit)

hb_adid_nanointeract hb_bidder_nanointera hb_pb_nanointeractiv hb_format_nanointera hb_size_nanointeract hb_source_nanointera

Default Deal ID Keys:

hb_deal_nanointeract

bid params

Name Scope Description Example Type
pid required Identification key, provided by Nano Interactive '5afaa0280ae8996eb578de53' string
category optional Contextual taxonomy 'automotive' string
categoryName optional Contextual taxonomy (from URL query param) 'cat_name' string
nq optional User search query 'automobile search query' string
name optional User search query (from URL query param) 'search_param' string
subId optional Channel - used to separate traffic sources '123' string

Configuration

The category and categoryName are mutually exclusive. If you pass both, categoryName takes precedence.
The nq and name are mutually exclusive. If you pass both, name takes precedence.

Example with only required field pid

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53'
        }
    }]
}];

Example with category

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            category: 'automotive',
            subId: '123'
        }
    }]
}];

Example with categoryName

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // Category "automotive" is in the URL like:
            // https://www....?cat_name=automotive&...
            categoryName: 'cat_name',
            subId: '123'
        }
    }]
}];

Example with nq

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // User searched "automobile search query" (extracted from search text field)
            nq: 'automobile search query',
            subId: '123'
        }
    }]
}];

Example with name

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // User searched "automobile search query" and it is in the URL like:
            // https://www....?search_param=automobile%20search%20query&...
            name: 'search_param',
            subId: '123'
        }
    }]
}];

Example with category and nq

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            category: 'automotive',
            nq: 'automobile search query',
            subId: '123'
        }
    }]
}];

Example with categoryName and name

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            categoryName: 'cat_name',
            name: 'search_param',
            subId: '123'
        }
    }]
}];

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 Type
ax_key required Publisher Key provided by Nasmedia Admixer 'ajj7jba3' string

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 Type
pzoneid required     string
nginadDomain required     string

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 Type
placementId required     string
randomKey optional     string
invCode optional     string
member optional     string

One Fifty Two Media is an aliased bidder for AppNexus

OneVideo

Bidder Code

oneVideo

"Send All Bids" Ad Server Keys

hb_pb_oneVideo hb_adid_oneVideo hb_size_oneVideo

"Default Deal ID" Ad Server Key

hb_deal_oneVideo

Note:

One Video adapter only supports video ads.

bid params

Name Scope Description Example Type
pubId required Publisher ID 'brxd' string

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 Type
placement required The placement ID from AOL. '23324932' string
network required The network ID from AOL. '5071.1' string
alias optional The placement alias from AOL. 'desktop_articlepage_something_box_300_250' string
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' string
bidFloor optional Dynamic bid floor (added in Prebid 0.8.1) '0.80' string

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 Type
siteId required The site ID from 152 Media 2.0. 12345 integer
networkId required The network ID from 152 Media 2.0. 9969 integer

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 Type
dcn required Site ID provided by ONE. '2c9d2b50015a5aa95b70a9b0b5b10012' string
pos required Position on a page where an ad will appear. 'header' string
ext optional Object that allows the client to send any extra parameters.   object

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 Type
siteId required The site id '5' string
adUnitId required The ad unit id '5-4587544' string

Example:

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

OneTag

Bidder Code

onetag

"Send All Bids" Ad Server Keys

hb_pb_onetag hb_adid_onetag hb_size_onetag

"Default Deal ID" Ad Server Key

hb_deal_onetag

bid params

Name Scope Description Example Type
pubId required   386276e072 string
type optional The media type, default is banner 'banner' string

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 Parameters

Name Scope Description Example Type
delDomain required OpenX delivery domain provided by your OpenX representative. “PUBLISHER-d.openx.net” String
unit required OpenX ad unit ID provided by your OpenX representative. “1611023122” String
customParams optional User-defined targeting key-value pairs. customParams applies to a specific unit. {key1: "v1", key2: ["v2","v3"]} Object
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

WARNING:
Misuse of this parameter can impact revenue
1.50 Number
doNotTrack optional Prevents advertiser from using data for this user.

WARNING:
Impacts all bids in the request. May impact revenue.
true Boolean
coppa optional Enables Child’s Online Privacy Protection Act (COPPA) regulations. WARNING:
Impacts all bids in the request. May impact revenue.
true Boolean

Video

Name Scope Description Example Type
unit required OpenX ad unit ID provided by your OpenX representative. “1611023122” String
delDomain required OpenX delivery domain provided by your OpenX representative. “PUBLISHER-d.openx.net” String
openrtb optional An OpenRtb Impression with Video subtype properties { imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] } Object

Example

var adUnits = [
  {
    code: 'test-div',
    sizes: [[728, 90]],  // a display size
    mediaTypes: {'banner': {}},
    bids: [
      {
        bidder: 'openx',
        params: {
          unit: '539439964',
          delDomain: 'se-demo-d.openx.net',
          customParams: {
            key1: 'v1',
            key2: ['v2', 'v3']
          },
        }
      }
    ]
  },
  {
    code: 'video1',
    mediaTypes: {
      video: {
        playerSize: [640, 480],
        context: 'instream'
      }
    },
    bids: [{
      bidder: 'openx',
      params: {
        unit: '1611023124',
        delDomain: 'PUBLISHER-d.openx.net',
        openrtb: {
          imp: [{
            video: {
              mimes: ['video/x-ms-wmv, video/mp4']
            }
          }]
        }
      }
    }]
  }
];

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
   }
});

Additional Details

Banner Ads

Video Ads

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 Type
placement required Optimatic Placement ID '2chy7Gc2eSQL' string
bidfloor required Bid floor 2.00 float

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 Type
clientID required The Optimera Client ID '123' string

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 Type
placementId required The placement ID (site channel ID) 142 integer
requestUrl required Url to perform search request 'http://adserver.com/ads/show/hb' string
style optional Creative styles. Actual only for text ads   string
customParams optional Permits passing any publisher key-value pairing into the bid request { macro_name: 'macro_value' } object

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 Type
placementId required     string
randomKey optional     string
invCode optional     string
member optional     string

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 Type
uid required The ID from Peak226 76221035 integer

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 Type
siteId required the site ID 'SITE' string
placementId required the placement ID 'PLACEMENT' string

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 Type
pubId required The publisher account ID '28082' string
siteId required The publisher site ID '26047' string
size required Ad size identifier '300X250' string
placementId required Identifies specific ad placement '17394' string
bidFloor optional The bid floor '0.001' string
ifa optional IFA ID 'XXX-XXX' string
latitude optional Latitude '40.712775' string
longitude optional Longitude '-74.005973' string

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,
                  }
              }
          }]
      }
  ];

Playground XYZ

Bidder Code

playgroundxyz

"Default Deal ID" Ad Server Key

hb_deal_playgroundxyz

Send All Bids Ad Server Keys

(Truncated to 20 chars due to DFP limit)

hb_adid_playgroundxy

bid params

Name Scope Description Example Type
placementId required The placement ID. '1751864' string

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 Type
zone required The zone ID from Pollux Network. You must identify a zone using a valid ID provided on Pollux Network platform. '276' string

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

Polymorph

Bidder Code

polymorph

"Send All Bids" Ad Server Keys

hb_pb_polymorph hb_adid_polymorph hb_size_polymorph

"Default Deal ID" Ad Server Key

hb_deal_polymorph

Note:

Polymorph adapter requires setup and approval from the Polymorph team. Please reach out to your account team or support@getpolymorph.com for more information.

bid params

Name Scope Description Example  
placementId required The placement id/key provided by Polymorph 'ENvsYZ6m5DPDk6r7ogYV63DO2sBQoJ5EpckcXSlw'  
defaultWidth optional In case multiple ad sizes are supported, it’s recommended to specify default height and width for native ad (in case native ad is chose as a winner). In case of banner or outstream ad any one of the above sizes can be chosen depending on the highest bid. 300  
defaultHeight optional   250  

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/openrtb2/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 Type
publisherName required     string
pubZone required     string

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 Type
publisherId required Publisher ID '32572' string
adSlot required Ad Unit ID '38519891@300x250' string
pmzoneid optional Zone ID 'zone1,zone2' string
lat optional Latitude '40.712775' string
lon optional Longitude '-74.005973' string
yob optional Year of Birth '1982' string
gender optional Gender 'M' string
kadpageurl optional Overrides Page URL 'http://www.yahoo.com/' string
kadfloor optional Bid Floor '1.75' string
currency optional Bid currency 'AUD' string
dctr optional Deal Custom Targeting 'key1=123|key2=345' string

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.

For Prebid.js v1.15.0 and later:

pbjs.setConfig({
  userSync: {
    filterSettings: {
      iframe: {
        bidders: '*',      // '*' represents all bidders
        filter: 'include'
      }
    }
  }
});

For Prebid.js v1.14.0 and before:

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

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.

video parameters

The PubMatic adapter supports video as of Prebid 1.16.0

Name Scope Description Example
video.mimes required Video MIME types ['video/mp4','video/x-flv']
video.skippable optional If ‘true’, user can skip ad true
video.minduration optional Minimum ad duration in seconds 5
video.maxduration optional Maximum ad duration in seconds 30
video.startdelay optional Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements 5
video.playbackmethod optional Defines whether inventory is user-initiated or autoplay sound on/off
Values:
1: Auto-play, sound on
2: Auto-play, sound off
3: Click-to-play
4: mouse-over
1
video.api optional API frameworks supported
Values:
1: VPAID 1.0
2: VPAID 2.0
3: MRAID-1
4: ORMMA
5: MRAID-2
[1, 2]
video.protocols optional Supported video bid response protocols
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
[5, 6]
video.battr optional Blocked creative attributes, See OpenRTB 2.5 specification, List 5.3 for values [3, 9]
video.linearity optional Indicates if the impression is linear or nonlinear
Values:
1: Linear/In-Stream
2: Non-Linear/Overlay.
1
video.placement optional Video placement type. See OpenRTB 2.5 specification, List 5.9 for Values 1
video.minbitrate optional Minumim bit rate in Kbps. 50
video.maxbitrate optional Maximum bit rate in Kbps. 70

AdUnit Format for Video

var videoAdUnits = [
{
    code: 'test-div-video',
    mediaTypes: {
        video: {
            playerSize: [640, 480],           // required
            context: 'instream'
        }
    },
    bids: [{
      bidder: 'pubmatic',
      params: {
        publisherId: '32572',                     // required
        adSlot: '38519891@300x250',              // required
        video: {
          mimes: ['video/mp4','video/x-flv'],   // required
          skippable: true,                      // optional
          minduration: 5,                       // optional
          maxduration: 30,                      // optional
          startdelay: 5,                        // optional
          playbackmethod: [1,3],                // optional
          api: [ 1, 2 ],                        // optional
          protocols: [ 2, 3 ],                  // optional
          battr: [ 13, 14 ],                    // optional
          linearity: 1,                         // optional
          placement: 2,                         // optional
          minbitrate: 10,                       // optional
          maxbitrate: 10                        // optional
        }
      }
    }]
}]

Configuration for video

For Video ads, prebid cache needs to be enabled for PubMatic adapter.

pbjs.setConfig({
    cache: {
        url: 'https://prebid.adnxs.com/pbc/v1/cache'
    }
});

PubNX

Bidder Code

pubnx

"Send All Bids" Ad Server Keys

hb_pb_pubnx hb_adid_pubnx hb_size_pubnx

"Default Deal ID" Ad Server Key

hb_deal_pubnx

bid params

Name Scope Description Example Type
siteId required The site ID from PubNX. 12345 Integer
zoneIds optional An array of integer zone IDs from PubNX. [12345, 4567] Array of integers
networkId required The network ID from PubNX. 9969 Integer

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 Type
cf required Ad size identifier '300X250' string
cp required Publisher Id 12345 integer
ct required Ad Tag Id 12345 integer

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 Type
publisherId required The publisher id provided by Quantcast 'LCOf845vzU' string
battr optional Array of Blocked creative attributes as per OpenRTB Spec List 5.3 [6,7] Array<integer>

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 Type
placementId required The ID issued by Quantum to the publisher 34887 integer

RDN

Bidder Code

rdn

"Send All Bids" Ad Server Keys

hb_pb_rdn hb_adid_rdn hb_size_rdn

"Default Deal ID" Ad Server Key

hb_deal_rdn

bid params

Name Scope Description Example Type
adSpotId required The AdSpot ID 1234 int

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 Type
publisherId required Publisher ID provided by ReadPeak '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor optional CPM Bid Floor 0.5 float

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 Type
placementId required The placement ID from RealVu. '9339508' string
partnerId required The member ID from RealVu. '1Y' string

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

REXRTB

Bidder Code

rexrtb

"Send All Bids" Ad Server Keys

hb_pb_rexrtb hb_adid_rexrtb hb_size_rexrtb

"Default Deal ID" Ad Server Key

hb_deal_rexrtb

bid params

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

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 Type
placementId required The ID issued by RhythmOne to the publisher 34887 integer

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 Type
placementId required The placement ID assigned to the publisher by RockYou 4322 integer

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 Type
publisherId required The publisher id from Roxot '550e8400-e29b-41d4-a716-446655440000' string

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 Type
zoneid required The ad zone or tag specific ID '9999' string
floor optional The floor CPM price for the request 0.1234 float
server optional Bidder domain 'bidding.rtbdemand.com' string

Rtbdemandadk

Bidder Code

rtbdemandadk

"Send All Bids" Ad Server Keys

hb_pb_rtbdemandadk hb_adid_rtbdemandadk hb_size_rtbdemandadk

"Default Deal ID" Ad Server Key

hb_deal_rtbdemandadk

Note:

The RtbdemandAdk Bidding adaptor requires setup and approval before beginning. Please reach out to shreyanschopra@rtbdemand.com for more details

bid params

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

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 Type
publisherId required Unique publisher ID 'ABCDEF' string
region required Assigned region 'prebid-eu' string

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

Name Scope Description Example Type  
accountId required The publisher account ID '4934' string  
siteId required The site ID '13945' string  
zoneId required The zone ID '23948' string  
sizes optional Array of Rubicon Project size IDs. If not specified, the system will try to convert from bid.sizes. [15] Array<integer>  
keywords optional Array of page-specific keywords. May be referenced in Rubicon Project reports. ['travel', 'tourism'] Array<string>  
inventory   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']} object
visitor optional An object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays. {'ucat':['new'], 'search':['iphone']} object  
position optional Set the page position. Valid values are “atf” and “btf”. 'atf' string  
userId 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' string  
floor optional Sets the global floor – no bids will be made under this value. 0.50 float  
latLong optional Sets the latitude and longitude for the visitor (avail since PBJS 1.10) [40.7608, 111.8910] Array<float>  
video required for video Video targeting parameters. See the video section below. {'language': 'en', 'playerHeight': '360', 'playerWidth': '640', 'size_id': '201'} object  

Video

The following video parameters are supported:

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

201: Pre-Roll
202: Interstitial
204: Mid-Roll
205: Post-Roll
207: Vertical Video
201 integer
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. 'en' string
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.   object

aeParams

Name Scope Description Example Type
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. 1 integer
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. 15 integer
aeParams.p_aso.video.ext.maxbitrate optional Integer indicating maximum bitrate of video ad in kbps. 1200 integer
aeParams.p_aso.video.ext.minbitrate optional Integer indicating minimum bitrate of video ad in kbps. 400 integer
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. 1 integer

Configuration

Single-Request

By default, the Rubicon Project adapter sends one request to rubiconproject.com for each AdUnit. For example, if there are 4 PBJS AdUnits defined on the page, you’ll see 4 calls out to rubiconproject.com/fastlane.json.

As of PBJS 1.12, the Rubicon Project adapter supports Single Request mode, where all AdUnit requests are made in a single call to rubiconproject.com. To turn this feature on, call setConfig:

pbjs.setConfig({
   rubicon: {singleRequest: true}
});

Notes

There can only be one siteId and zoneId in an AdUnit bid. 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 Example Type
id required endpoint id 123 integer
token required endpoint token '657f11a5efbbfe2f9be3f1f146fcbc22' string
source required traffic source id 'prebidtest' string

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 Type
uid required Represents the SARA bidder system Ad Slot ID associated with the respective div id from the site page. 5 integer
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' string

SekindoUM

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 Type
spaceId required     string

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 Type
siteId required The site ID from Serverbid. 12345 integer
networkId required The network ID from Serverbid. 9969 integer

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 Type
pkey required The placement key 'DfFKxpkRGPMS7A9f71CquBgZ' string
iframe optional If true, the ad will render in an iframe. Defaults to false. true boolean
iframeSize optional [width, height] If provided, use this size for the iframe size. Only applicable if iframe is true. If omitted, the largest size from the ad unit sizes array will be used. [300, 250] Array<integer>

Smart

Bidder Code

smartadserver

"Default Deal ID" Ad Server Key

hb_deal_smartadserver

“Send All Bids” Ad Server Keys:

(truncated to 20 chars due to DFP limit)

hb_pb_smartadserver hb_adid_smartadserve hb_size_smartadserve

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

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 Type
banner_id required     string

bid params Prebid 1.x

Name Scope Description Example Type
placementId required     string

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 Type
placementId required Placement ID provided by Somo Audience '22a58cfb0c9b656bff713d1236e930e8' string

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 Example Type
placement_id required The placement ID '1a2b3c4d5e6f1a2b3c4d' string
ad_unit required The adunit ID '/1234567/example/adUnit/code' string
floor optional Bid floor for this placement in USD 0.50 float
sizes optional Adunit sizes that will override global sizes [[300, 250], [300, 600]] Array<Array>
hfa optional Publisher Unique Identifier '123985' string
referrer optional Overrides the default value for the ref param in a bid request 'prebid.org' string

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

Sortable

Bidder Code

sortable

"Send All Bids" Ad Server Keys

hb_pb_sortable hb_adid_sortable hb_size_sortable

"Default Deal ID" Ad Server Key

hb_deal_sortable

Table of Contents

Bid params

Name Scope Description Example
tagId required The tag ID from Sortable. "test-pb-leaderboard"
siteId optional Override the global Sortable site ID, see here. Please reach out to your Sortable Account Manager for more details. "example.com"
floor optional The minumum CPM (in USD) requred to participate 0.25
keywords optional Publisher-defined key-value string pairs { "key1": "val1", "key2": "val2" }

Sortable supports the banner features described in:

Configuration

The Sortable site ID should be set globally in order to improve user sync. How to do so:

pbjs.setConfig({
   sortable: {
     siteId: "example.com"
   }
});

The Sortable 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, Sortable sync requests are off. Setting the Sortable site ID globally as described above is required for user-sync requests.

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

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

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 Type
tagid required The sovrn Ad Tag ID '315045' string
bidfloor optional Bid floor in dollars '0.04' string

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

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 Type
impId required The impression ID 12345 integer
supplyPartnerId required The supply partner ID 1 integer

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 Type
ad_unit_id required The placement ID from TapSense. '5580935be4b0a4d1a4e8d2b6' string
user required The user’s IDFA '771fc655-6e4e-4bae-a4b6-751614d788b5' string
refer optional Site that ad request is originating from. 'https://tapsense.com' string
lat optional User’s latitude '47.5643' string
long optional User’s longitude '-122.151' string
price_floor optional Bid floor in dollars '0.04' string

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

Teads

Bidder Code

teads

"Send All Bids" Ad Server Keys

hb_pb_teads hb_adid_teads hb_size_teads

"Default Deal ID" Ad Server Key

hb_deal_teads

Note:

The Teads Bidding adapter requires setup before beginning. Please contact us on https://teads.tv/teads-contact/

bid params

Name Scope Description Example Type
pageId required Teads page id 2453 integer
placementId required Teads placement id 113244 integer

Telaria

Bidder Code

telaria

"Send All Bids" Ad Server Keys

hb_pb_telaria hb_adid_telaria hb_size_telaria

"Default Deal ID" Ad Server Key

hb_deal_telaria

Overview

This documentation covers some of the parameters that the Telaria (previously Tremor Video) exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found under tremor

Bid Params

Please refer to the Tag Parameters section in the Telaria Console

Example Ad Unit

var adUnit = {
    "code": "video1",
    "mediaTypes": {
        "video": {
            "playerSize": [640, 480],
            "context": "instream"
        }
    },
    "bids": [{
        "bidder": "telaria",
        "params": {
            "supplyCode": "ssp-demo-rm6rh",
            "adCode": "ssp-!demo!-lufip",
            "videoId": "MyCoolVideo"    
            // Other params go here       
        }
    }]
}

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

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 Type
placementId required The Placement ID from ThoughtLeadr '01234567-89ab-cdef-0123-456789abcdef' string

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 is true and 0 F N null is 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 Type
pubId required publisher Id provided by Trion Interactive '111111' string
sectionId required section Id provided by Trion Interactive '11' string
re optional click through redirect 'http://clicktrackingurl.com?re=' string

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 Type
inventoryCode required TripleLift inventory code for this ad unit (provided to you by your partner manager) 'pubname_main_feed' string
floor optional Bid floor 1.00 float

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 Type
uid required Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. 42 integer
priceType 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' string

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 Type
placementId required Identifier for the ad placement, as provided by Twenga. '123456' string
siteId optional Identifier for the site, as an integer value. Mainly used for reports. 123456 integer
publisherId optional Identifier for the publisher, as an integer value. Mainly used for reports. 123456 integer
currency optional ISO 4217 currency code for the bid price and floor. The default currency is EUR. 'USD' string
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 float
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' string

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

Table of Contents

Bid params

Name Scope Description Example Type
adid required The ad unit ID retrived from ucfunnel dashboard   string

{% highlight js %} var adUnits = [{ code: ‘div-gpt-ad-1460505748511-01’, sizes: [ [300, 250] ], bids: [{ bidder: ‘ucfunnel’, params: { adid: ‘123456789’ } }] }] {% endhighlight %}

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

Examples

  • Banner Ads(https://cdn.aralego.net/ucfad/test/ucfunnel/compliance/pbjs_banner.html)
  • Video Ads (Instream)(https://cdn.aralego.net/ucfad/test/ucfunnel/compliance/pbjs_video.html)
  • Native Ads(https://cdn.aralego.net/ucfad/test/ucfunnel/compliance/pbjs_native.html)

Underdog Media

Bidder Code

underdogmedia

"Default Deal ID" Ad Server Key

hb_deal_underdogmedia

bid params

Name Scope Description Example Type
siteId required     string

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 Type
placementId optional Your placement ID (provided by undertone) "13as14d0" string
publisherId required publisher ID (provided by undertone) 12345 integer

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 Type
siteId required The site ID from Unruly. This will be provided to you by your Unruly account manager 123456 integer
targetingUUID required The targeting UUID from Unruly. This will be provided to you by your Unruly account manager '766220b5-3d02-46c5-aa8b-2bc60c6f7418' string

UOL

Bidder Code

uol

"Send All Bids" Ad Server Keys

hb_pb_uol hb_adid_uol hb_size_uol

"Default Deal ID" Ad Server Key

hb_deal_uol

Note:

The UOL Project adapter requires setup and approval from the UOL Project team, even for existing UOL Project publishers. Please reach out to your account team or l-prebid@uolinc.com for more information.

bid params

Name Scope Description Example
placementId required UOL placement ID ‘123124’, 123154
test optional Activate AdServer test endpoint true, false
cpmFactor optional Positive Integer value that will be used by the AdServer as a cpm multiplier. If passed, also requires ‘test’ flag to be set to ‘true’ 1, 2, 5

Note:

Currently, the UOL bidAdapter is under initial tests. Please follow this page for updates regarding required parameters and new features.

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 Type
aid required The source ID from Vertamedia. 350975 integer

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 Type
placementId required vertoz placement id 'VH-HB-123' string
cpmFloor optional cpm floor price 0.1 float

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 Type
pubId required Publisher ID, provided by vi 'sb_test' string
lang required Ad language, in ISO 639-1 language code format 'en-US' string
cat required Ad IAB category (top-level or subcategory), single one supported 'IAB1' string
bidFloor optional Lowest value of expected bid price 0.001 float

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 Type
cId required The connection ID from Vidazoo. '5a3a543645ea6b0004869360' string
pId required The publisher ID from Vidazoo. '59ac17c192832d0011283fe3' string
bidFloor required The minimum bid value desired. Vidazoo will not respond with bids lower than this value. 0.90 float

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 YOC 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

Name Scope Description Example Type
uid required The publisher’s ad unit ID in VIS.X '903536' string
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' string

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 Type
env required The environment. Must be ‘net’ or ‘com’. This information will be given to you by the Vuble team. 'net' string
pubId required Your publisher ID. This information will be given to you by the Vuble team. 3 integer
zoneId required A zone ID for the SSP. 12345 integer
referrer optional The page’s referrer. Not mandatory but recommended. 'http://www.vuble.tv/' string
floorPrice optional The desired floor price. If none is given, the floor price will depend on the zone ID. 5.00 float

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.

Weborama

Bidder Code

weborama

"Send All Bids" Ad Server Keys

hb_pb_weborama hb_adid_weborama hb_size_weborama

"Default Deal ID" Ad Server Key

hb_deal_weborama

bid params

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

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 Type
pbId required The publisher ID from WideOrbit Programmatic Digital 12345 integer
pId required The placement ID from WideOrbit Programmatic Digital 67890 integer

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 Type
sid required Widespace Ad Space ID '00000000-0000-0000-0000-000000000000' string
currency Optional Currency 'EUR' string
bidFloor Optional Bid floor rate '1.25' string
demo Optional User’s demographic data {} object

Demo params

Name Scope Description Example Type
demo.gender Optional User’s demographic data 'M' string
demo.country Optional Country name 'Sweden' string
demo.region Optional Region name 'Stockholm' string
demo.city Optional City name 'Stockholm' string
demo.postal Optional Postal code '11153' string
demo.yob Optional Year of birth '1984' string

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

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 Type
pid required Xendiz placement ID '00000000-0000-0000-0000-000000000000' string

Yield Nexus

Bidder Code

yieldnexus

"Send All Bids" Ad Server Keys

hb_pb_yieldnexus hb_adid_yieldnexus hb_size_yieldnexus

"Default Deal ID" Ad Server Key

hb_deal_yieldnexus

Bid params

Name Scope Description Example Type
spid required The supply account’s ID in your YieldNexus dashboard. "1253", "1254", etc string

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 Type
psn required The publisher ID   string
slot required The slot   string

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 Type
adslotId required Yieldlab Adslot ID '12345' string
supplyId required Yieldlab Supply ID. Please reach out to your account management for more information. '12345' string
adSize required Override the default prebid size '970x250' string
targeting optional Key-Value Targeting { 'key1': 'value1', 'key2': 'value2' } object

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 Type
placementId required Yieldmo placement id '825209316101005155' string

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 Type
placementId required The placement ID   string

ZEDO

Bidder Code

zedo

"Send All Bids" Ad Server Keys

hb_pb_zedo hb_adid_zedo hb_size_zedo

"Default Deal ID" Ad Server Key

hb_deal_zedo

bid params

Name Scope Description Example Type
channelCode required Publisher code associated with ZEDO 123456 integer
dimId required ZEDO dimension Id associated the adunit 9 integer