Bidder Params

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
adastaMedia video
adform video
adformOpenRTB native
adgeneration native
adhese video
adkernel video
adkernelAdn video
adman video
admixer video
adtelligent video
adxcg video, native
aja video, native
aniview video
appnexus video, native
audienceNetwork video, native
beachfront video
bridgewell native
ccx video
cleanmedia video
cleanmedianet video
clickforce native
conversant video
cpmstar video
criteo video, native
decenterads video, native
dgads native
ebdr video
emx_digital video
etarget video
feedad video
freewheel-ssp video
gambid video
gamma video
gamoshi video
getintent video
giants video
go2net video
grid video
gumgum native
improvedigital native
ix video
kumma video, native
lifestreet video
loopme video
mantis video, native
medianet native
mobfox video
oftmediahb video
oneVideo video
onefiftytwomedia video
open8 video
openx video
openxoutstream native
optimatic video
platformio video, native
polymorph video, native
prebidServer video
pubmatic video, native
pulsepoint video, native
quantcast video
quantum native
readpeak native
rhythmone video
richaudience video
rockyou video
rtbhouse native
rubicon video
sekindoUM video
sharethrough native
showheroes-bs video
slimcut video
smartyads native
smilewanted video
sonobi video
spotx video
stickyadstv native
stv video
synacormedia video
teads video
telaria video
trustx video
ucfunnel video, native
unruly video, native
vertamedia video
videoreach video
viewdeos video
vuble video
xhb video, native
yieldlab video
yieldmo native
yieldnexus video
yieldone video

152Media

Features

Bidder Code oftmedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_oftmedia hb_bidder_oftmedia hb_adid_oftmedia
hb_size_oftmedia hb_source_oftmedia hb_format_oftmedia
hb_cache_host_oftmed hb_cache_id_oftmedia hb_uuid_oftmedia

"Deal ID" Ad Server Key

hb_deal_oftmedia

Bid Params

Name Scope Description Example Type
placementId required     string

33Across

Features

Bidder Code 33across Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_33across hb_bidder_33across hb_adid_33across
hb_size_33across hb_source_33across hb_format_33across
hb_cache_host_33acro hb_cache_id_33across hb_uuid_33across

"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

SafeReach

Features

Bidder Code safereach Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_safereach hb_bidder_safereach hb_adid_safereach
hb_size_safereach hb_source_safereach hb_format_safereach
hb_cache_host_safere hb_cache_id_safereac hb_uuid_safereach

"Deal ID" Ad Server Key

hb_deal_safereach

bid params

Name Scope Description Example Type
ai required The auction ID 'XBC1' string
sc required The adshortcode 'AF2g' string

A4G

Features

Bidder Code a4g Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_a4g hb_bidder_a4g hb_adid_a4g
hb_size_a4g hb_source_a4g hb_format_a4g
hb_cache_host_a4g hb_cache_id_a4g hb_uuid_a4g

"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

Features

Bidder Code aardvark Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aardvark hb_bidder_aardvark hb_adid_aardvark
hb_size_aardvark hb_source_aardvark hb_format_aardvark
hb_cache_host_aardva hb_cache_id_aardvark hb_uuid_aardvark

"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

Features

Bidder Code adagio Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adagio hb_bidder_adagio hb_adid_adagio
hb_size_adagio hb_source_adagio hb_format_adagio
hb_cache_host_adagio hb_cache_id_adagio hb_uuid_adagio

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

Adasta Media

Features

Bidder Code adastaMedia Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adastaMedia hb_bidder_adastaMedi hb_adid_adastaMedia
hb_size_adastaMedia hb_source_adastaMedi hb_format_adastaMedi
hb_cache_host_adasta hb_cache_id_adastaMe hb_uuid_adastaMedia

"Deal ID" Ad Server Key

hb_deal_adastaMedia

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner '12345' string

AdButler

Features

Bidder Code adbutler Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adbutler hb_bidder_adbutler hb_adid_adbutler
hb_size_adbutler hb_source_adbutler hb_format_adbutler
hb_cache_host_adbutl hb_cache_id_adbutler hb_uuid_adbutler

"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

Features

Bidder Code adform Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adform hb_bidder_adform hb_adid_adform
hb_size_adform hb_source_adform hb_format_adform
hb_cache_host_adform hb_cache_id_adform hb_uuid_adform

"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

AdformOpenRTB

Features

Bidder Code adformOpenRTB Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adformOpenRTB hb_bidder_adformOpen hb_adid_adformOpenRT
hb_size_adformOpenRT hb_source_adformOpen hb_format_adformOpen
hb_cache_host_adform hb_cache_id_adformOp hb_uuid_adformOpenRT

"Deal ID" Ad Server Key

hb_deal_adformOpenRT

Bid params

Name Scope Description Example Type
mid required   12345 integer
adxDomain optional The Adform domain 'adx.adform.net' string
site optional Site id '123123' string
priceType optional Price type 'gross' string
publisher optional Info about publisher {"id": "2706", "name": "name", "domain": "dom"} object

Ad Generation

Features

Bidder Code adgeneration Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adgeneration hb_bidder_adgenerati hb_adid_adgeneration
hb_size_adgeneration hb_source_adgenerati hb_format_adgenerati
hb_cache_host_adgene hb_cache_id_adgenera hb_uuid_adgeneration

"Deal ID" Ad Server Key

hb_deal_adgeneration

Bid Params

Name Scope Description Example Type
id required adId '1234' string

Adhese

Features

Bidder Code adhese Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adhese hb_bidder_adhese hb_adid_adhese
hb_size_adhese hb_source_adhese hb_format_adhese
hb_cache_host_adhese hb_cache_id_adhese hb_uuid_adhese

"Deal ID" Ad Server Key

hb_deal_adhese

Note

The Adhese bid adapter may require an additional setup from the Adhese team, even for existing Adhese customers. Please reach out to your support team or info@adhese.com for more information.

Bid Params

Name Scope Description Example Type
account required Adhese account name 'demo' string
location required Adhese location name '_adhese_prebid_demo_' string
format required Adhese format name 'leaderboard' string
data optional Custom target data { 'ci': [9000, 9050] } object

Configuration

Adhese supports ‘iframe’ UserSync configuration only.

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: ['adhese']
 }});

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.

AdKernel

Features

Bidder Code adkernel Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adkernel hb_bidder_adkernel hb_adid_adkernel
hb_size_adkernel hb_source_adkernel hb_format_adkernel
hb_cache_host_adkern hb_cache_id_adkernel hb_uuid_adkernel

"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

Features

Bidder Code adkernelAdn Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adkernelAdn hb_bidder_adkernelAd hb_adid_adkernelAdn
hb_size_adkernelAdn hb_source_adkernelAd hb_format_adkernelAd
hb_cache_host_adkern hb_cache_id_adkernel hb_uuid_adkernelAdn

"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

Adlive

Features

Bidder Code adlive Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adlive hb_bidder_adlive hb_adid_adlive
hb_size_adlive hb_source_adlive hb_format_adlive
hb_cache_host_adlive hb_cache_id_adlive hb_uuid_adlive

"Deal ID" Ad Server Key

hb_deal_adlive

Bid Params

Name Scope Description Example Type
hashes required Array of hashes, provided by adlive [‘1e100887dd614b0909bf6c49ba7f69fdd1360437’] Array of strings

ADman Media

Features

Bidder Code adman Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adman hb_bidder_adman hb_adid_adman
hb_size_adman hb_source_adman hb_format_adman
hb_cache_host_adman hb_cache_id_adman hb_uuid_adman

"Deal ID" Ad Server Key

hb_deal_adman

Note:

The Adman Bidding adapter requires setup before beginning. Please contact us at prebid@admanmedia.com

Bid Params

Name Scope Description Example Type
id required Adman placement id 1234asdf string

AdMedia

Features

Bidder Code admedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admedia hb_bidder_admedia hb_adid_admedia
hb_size_admedia hb_source_admedia hb_format_admedia
hb_cache_host_admedi hb_cache_id_admedia hb_uuid_admedia

"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

Features

Bidder Code admixer Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admixer hb_bidder_admixer hb_adid_admixer
hb_size_admixer hb_source_admixer hb_format_admixer
hb_cache_host_admixe hb_cache_id_admixer hb_uuid_admixer

"Deal ID" Ad Server Key

hb_deal_admixer

Bid Params

Name Scope Description Example Type
zone required     string

AdOcean

Features

Bidder Code adocean Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adocean hb_bidder_adocean hb_adid_adocean
hb_size_adocean hb_source_adocean hb_format_adocean
hb_cache_host_adocea hb_cache_id_adocean hb_uuid_adocean

"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

Adpone

Features

Bidder Code adpone Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adpone hb_bidder_adpone hb_adid_adpone
hb_size_adpone hb_source_adpone hb_format_adpone
hb_cache_host_adpone hb_cache_id_adpone hb_uuid_adpone

Bid Params

Name Scope Description Example Type
placementId required The placement ID from Adpone. 234234 integer

adsolut

Features

Bidder Code adsolut Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsolut hb_bidder_adsolut hb_adid_adsolut
hb_size_adsolut hb_source_adsolut hb_format_adsolut
hb_cache_host_adsolu hb_cache_id_adsolut hb_uuid_adsolut

"Deal ID" Ad Server Key

hb_deal_adsolut

Note:

The adsolut Bidding adaptor requires setup and approval before beginning. Please reach out to kush@adsolut.in for more details

Bid Params

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

AdSparc

Features

Bidder Code adsparc Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsparc hb_bidder_adsparc hb_adid_adsparc
hb_size_adsparc hb_source_adsparc hb_format_adsparc
hb_cache_host_adspar hb_cache_id_adsparc hb_uuid_adsparc

"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

AdSpend

Features

Bidder Code adspend Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adspend hb_bidder_adspend hb_adid_adspend
hb_size_adspend hb_source_adspend hb_format_adspend
hb_cache_host_adspen hb_cache_id_adspend hb_uuid_adspend

"Deal ID" Ad Server Key

hb_deal_adspend

Bid Params

Name Scope Description Example Type
pubcid required Publisher ID. 0 string
bidfloor required Minimum bid for this impression expressed in CPM. 0.03 float

Please note that cookie support is required

AdSpirit

Features

Bidder Code adspirit Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adspirit hb_bidder_adspirit hb_adid_adspirit
hb_size_adspirit hb_source_adspirit hb_format_adspirit
hb_cache_host_adspir hb_cache_id_adspirit hb_uuid_adspirit

"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

Adtelligent

Features

Bidder Code adtelligent Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtelligent hb_bidder_adtelligen hb_adid_adtelligent
hb_size_adtelligent hb_source_adtelligen hb_format_adtelligen
hb_cache_host_adtell hb_cache_id_adtellig hb_uuid_adtelligent

"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

Features

Bidder Code aduptech Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aduptech hb_bidder_aduptech hb_adid_aduptech
hb_size_aduptech hb_source_aduptech hb_format_aduptech
hb_cache_host_adupte hb_cache_id_aduptech hb_uuid_aduptech

"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

Advangelists

Features

Bidder Code advangelists Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_advangelists hb_bidder_advangelis hb_adid_advangelists
hb_size_advangelists hb_source_advangelis hb_format_advangelis
hb_cache_host_advang hb_cache_id_advangel hb_uuid_advangelists

"Deal ID" Ad Server Key

hb_deal_advangelists

Note:

For more information about [Advangelists https://advangelists.com], please contact lokesh@advangelists.com

Bid Params

Name Scope Description Example Type
placement required   '263' string
pubid required   '0cf8d6d643e13d86a5b6374148a4afac' string
mimes optional video only ['video/mp4', 'application/javascript'] array of strings
playbackmethod optional video only [2,6] array of numbers
maxduration optional video only 30 number
skip optional video only 0 or 1 number

Advenue

Features

Bidder Code advenue Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_advenue hb_bidder_advenue hb_adid_advenue
hb_size_advenue hb_source_advenue hb_format_advenue
hb_cache_host_advenu hb_cache_id_advenue hb_uuid_advenue

"Deal ID" Ad Server Key

hb_deal_advenue

Bid Params

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

adxcg

Features

Bidder Code adxcg Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs pubCommon, unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adxcg hb_bidder_adxcg hb_adid_adxcg
hb_size_adxcg hb_source_adxcg hb_format_adxcg
hb_cache_host_adxcg hb_cache_id_adxcg hb_uuid_adxcg

"Deal ID" Ad Server Key

hb_deal_adxcg

Bid Params

Name Scope Description Example Type
adzoneid required adxcg zone id '1' string

Adyoulike

Features

Bidder Code adyoulike Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adyoulike hb_bidder_adyoulike hb_adid_adyoulike
hb_size_adyoulike hb_source_adyoulike hb_format_adyoulike
hb_cache_host_adyoul hb_cache_id_adyoulik hb_uuid_adyoulike

"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

AJA

Features

Bidder Code aja Prebid.org Member no
Media Types display, video, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aja hb_bidder_aja hb_adid_aja
hb_size_aja hb_source_aja hb_format_aja
hb_cache_host_aja hb_cache_id_aja hb_uuid_aja

"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

Configuration

AJA recommends setting UserSync by iframe for 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: ['aja']
  }
});

andbeyond

Features

Bidder Code andbeyond Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_andbeyond hb_bidder_andbeyond hb_adid_andbeyond
hb_size_andbeyond hb_source_andbeyond hb_format_andbeyond
hb_cache_host_andbey hb_cache_id_andbeyon hb_uuid_andbeyond

"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

ANIVIEW

Features

Bidder Code aniview Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aniview hb_bidder_aniview hb_adid_aniview
hb_size_aniview hb_source_aniview hb_format_aniview
hb_cache_host_anivie hb_cache_id_aniview hb_uuid_aniview

"Deal ID" Ad Server Key

hb_deal_aniview

Note:

For more information about Aniview Ad Server, please contact info@aniview.com.

Bid Params

Name Scope Description Example Type
AV_PUBLISHERID required Publisher/Netid '55b88d4a181f465b3e8b4567' string
AV_CHANNELID required Channel id '5a5f17a728a06102d14c2718' string

Answer Media

Features

Bidder Code answermedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_answermedia hb_bidder_answermedi hb_adid_answermedia
hb_size_answermedia hb_source_answermedi hb_format_answermedi
hb_cache_host_answer hb_cache_id_answerme hb_uuid_answermedia

"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

Features

Bidder Code aol Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aol hb_bidder_aol hb_adid_aol
hb_size_aol hb_source_aol hb_format_aol
hb_cache_host_aol hb_cache_id_aol hb_uuid_aol

"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

Appier

Features

Bidder Code appier Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appier hb_bidder_appier hb_adid_appier
hb_size_appier hb_source_appier hb_format_appier
hb_cache_host_appier hb_cache_id_appier hb_uuid_appier

"Deal ID" Ad Server Key

hb_deal_appier

Bid Params

Name Scope Description Example Type
hzid required The zone ID from Appier. "WhM5WIOp" string

Custom Settings (Optional)

Set the “farm” to use region-specific server

pbjs.que.push(function() {
  // use the bid server in Taiwan (country code: tw)
  pbjs.setConfig({
    appier: {
      'farm': 'tw'
    }
  });
});

Explicitly override the bid server used for bidding

pbjs.que.push(function() {
  pbjs.setConfig({
    appier: {
      'server': '${HOST_NAME_OF_THE_SERVER}'
    }
  });
});

AppNexus

Features

Bidder Code appnexus Prebid.org Member yes
Media Types display, video, native GDPR Support yes
User IDs criteortus COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appnexus hb_bidder_appnexus hb_adid_appnexus
hb_size_appnexus hb_source_appnexus hb_format_appnexus
hb_cache_host_appnex hb_cache_id_appnexus hb_uuid_appnexus

"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. The placementID parameter can be either a string or integer for Prebid.js, however integer is preferred. Legacy code can retain the stringvalue. Prebid Server requires an integer value. 234234 integer
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 buy-side segment targeting (login required). Values can be empty. See Passing Keys Without Values below for examples. 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

Custom Targeting keys

AppNexus returns custom keys that can be sent to the adserver through bidderSettings: buyerMemberId, dealPriority, and dealCode. The following snippet demonstrates how to add these custom keys as key-value pairs.

pbjs.bidderSettings = {
  appnexus: {
    adserverTargeting: [
      {
        key: "apn_buyer_memberid", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.buyerMemberId;
        }
      },
      {
        key: "apn_prio", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.dealPriority;
        }
      }, {
        key: "apn_dealcode", // Use key configured in your adserver
        val: function(bidResponse) {
          return bidResponse.appnexus.dealCode;
        }
      }
    ]
  }
}

Passing Keys Without Values

It’s possible to use the keywords parameter to define keys that do not have any associated values. Keys with empty values can be created in Prebid.js and can also be sent through Prebid Server to AppNexus. The following are examples of sending keys with empty values:

keywords: {
  myKeyword: '',
  myOtherKeyword: ['']
}

The preceding example passes the key myKeyword with an empty value. The key myOtherKeyword contains an empty value array.

You can define keys with values and without values in the same keywords definition. In this next example, we’ve defined the key color with an array of values: red, blue, and green. We’ve followed that with the key otherKeyword with an empty value array.

keywords: {
  color: ['red', 'blue', 'green'],
  otherKeyword: ['']
}

Debug Auction

Enabling the AppNexus Debug Auction feature should only be done for diagnosing the AppNexus auction. Do not enable this feature in a production setting where it may impact users.

To understand what is happening behind the scenes during an auction, you can enable a debug auction by adding an apn_prebid_debug cookie with a JSON string. For example:

{ "enabled": true, "dongle": "QWERTY", "debug_timeout": 1000, "member_id": 958 }

To view the results of the debug auction, add the pbjs_debug=true query string parameter and open your browser’s developer console.

Name Description Example Type
enabled Toggle the debug auction to occur true boolean
dongle Your account’s unique debug password. QWERTY string
member_id The ID of the member running the debug auction 958 integer
debug_timeout The timeout for the debug auction results to be returned 3000 integer

Archon Warp

Features

Bidder Code archon Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_archon hb_bidder_archon hb_adid_archon
hb_size_archon hb_source_archon hb_format_archon
hb_cache_host_archon hb_cache_id_archon hb_uuid_archon

"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

Features

Bidder Code arteebee Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_arteebee hb_bidder_arteebee hb_adid_arteebee
hb_size_arteebee hb_source_arteebee hb_format_arteebee
hb_cache_host_arteeb hb_cache_id_arteebee hb_uuid_arteebee

"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

Features

Bidder Code atomx Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_atomx hb_bidder_atomx hb_adid_atomx
hb_size_atomx hb_source_atomx hb_format_atomx
hb_cache_host_atomx hb_cache_id_atomx hb_uuid_atomx

"Deal ID" Ad Server Key

hb_deal_atomx

Bid Params

Name Scope Description Example Type
id required Atomx placement ID 1234 integer

Audience Network

Features

Bidder Code audienceNetwork Prebid.org Member no
Media Types display, video, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_audienceNetwor hb_bidder_audienceNe hb_adid_audienceNetw
hb_size_audienceNetw hb_source_audienceNe hb_format_audienceNe
hb_cache_host_audien hb_cache_id_audience hb_uuid_audienceNetw

"Deal ID" Ad Server Key

hb_deal_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

Features

Bidder Code automatad Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_automatad hb_bidder_automatad hb_adid_automatad
hb_size_automatad hb_source_automatad hb_format_automatad
hb_cache_host_automa hb_cache_id_automata hb_uuid_automatad

"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

Features

Bidder Code beachfront Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_beachfront hb_bidder_beachfront hb_adid_beachfront
hb_size_beachfront hb_source_beachfront hb_format_beachfront
hb_cache_host_beachf hb_cache_id_beachfro hb_uuid_beachfront

"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
banner optional Object with banner parameters. See the banner section below for details.   object
player optional Object with outstream player parameters. See the player section below for details.   object

video params

Name Scope Description Example Type
appId optional Beachfront Exchange ID for video bids. '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor optional Bid floor for video bids. 0.01 float
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

Name Scope Description Example Type
appId optional Beachfront Exchange ID for banner bids. '3b16770b-17af-4d22-daff-9606bdf2c9c3' string
bidfloor optional Bid floor for banner bids. 0.01 float

player params

Name Scope Description Example Type
progressColor optional The color of the progress bar formatted as a CSS value. #50A8FA string
expandInView optional Defines whether to expand the player when the ad slot is in view. Defaults to false. false boolean
collapseOnComplete optional Defines whether to collapse the player when ad playback has completed. Defaults to true. true boolean

BetweenDigital

Features

Bidder Code between Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_between hb_bidder_between hb_adid_between
hb_size_between hb_source_between hb_format_between
hb_cache_host_betwee hb_cache_id_between hb_uuid_between

"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

Features

Bidder Code bidfluence Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidfluence hb_bidder_bidfluence hb_adid_bidfluence
hb_size_bidfluence hb_source_bidfluence hb_format_bidfluence
hb_cache_host_bidflu hb_cache_id_bidfluen hb_uuid_bidfluence

"Deal ID" Ad Server Key

hb_deal_bidfluence

Bid Params

Name Scope Description Example Type
placementId required Placement Id '1000' string
publisherId required Publisher Id '1000' string
reservePrice optional Floor price '0.5" string

Bid Glass

Features

Bidder Code bidglass Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidglass hb_bidder_bidglass hb_adid_bidglass
hb_size_bidglass hb_source_bidglass hb_format_bidglass
hb_cache_host_bidgla hb_cache_id_bidglass hb_uuid_bidglass

"Deal ID" Ad Server Key

hb_deal_bidglass

Bid Params

Name Scope Description Example Type
adUnitId required The bid.glass Ad Unit ID '777' string

BidPhysics

Features

Bidder Code bidphysics Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidphysics hb_bidder_bidphysics hb_adid_bidphysics
hb_size_bidphysics hb_source_bidphysics hb_format_bidphysics
hb_cache_host_bidphy hb_cache_id_bidphysi hb_uuid_bidphysics

"Deal ID" Ad Server Key

hb_deal_bidphysics

Note:

The BidPhysics Header Bidding adaptor requires approval from the BidPhysics team. Please reach out to info@bidphysics.com for more information.

Bid Params

Name Scope Description Example Type
unitId optional Unit Id '13000' string
networkId optional Network Id '2300000' string
publisherId optional Publisher Id '8ba96b13-540d-4f8a-9f1b-2a7e804769cc' string

BizzClick

Features

Bidder Code bizzclick Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bizzclick hb_bidder_bizzclick hb_adid_bizzclick
hb_size_bizzclick hb_source_bizzclick hb_format_bizzclick
hb_cache_host_bizzcl hb_cache_id_bizzclic hb_uuid_bizzclick

"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

Features

Bidder Code brainy Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brainy hb_bidder_brainy hb_adid_brainy
hb_size_brainy hb_source_brainy hb_format_brainy
hb_cache_host_brainy hb_cache_id_brainy hb_uuid_brainy

"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

Features

Bidder Code bridgewell Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bridgewell hb_bidder_bridgewell hb_adid_bridgewell
hb_size_bridgewell hb_source_bridgewell hb_format_bridgewell
hb_cache_host_bridge hb_cache_id_bridgewe hb_uuid_bridgewell

"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

Features

Bidder Code brightcom Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brightcom hb_bidder_brightcom hb_adid_brightcom
hb_size_brightcom hb_source_brightcom hb_format_brightcom
hb_cache_host_bright hb_cache_id_brightco hb_uuid_brightcom

"Deal ID" Ad Server Key

hb_deal_brightcom

Note:

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

Bid params

Name Scope Description Example Type
publisherId required The publisher ID from Brightcom 2141020 integer
bidFloor optional The minimum bid value desired 1.23 float

Bucksense

Features

Bidder Code bucksense Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bucksense hb_bidder_bucksense hb_adid_bucksense
hb_size_bucksense hb_source_bucksense hb_format_bucksense
hb_cache_host_buckse hb_cache_id_bucksens hb_uuid_bucksense

"Deal ID" Ad Server Key

hb_deal_bucksense

Bid params

Name Scope Description Example Type
placementId required The Placement ID from Bucksense 1000 integer

BuySellAds

Features

Bidder Code buysellads Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_buysellads hb_bidder_buysellads hb_adid_buysellads
hb_size_buysellads hb_source_buysellads hb_format_buysellads
hb_cache_host_buysel hb_cache_id_buysella hb_uuid_buysellads

"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

Features

Bidder Code c1x Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_c1x hb_bidder_c1x hb_adid_c1x
hb_size_c1x hb_source_c1x hb_format_c1x
hb_cache_host_c1x hb_cache_id_c1x hb_uuid_c1x

"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

Clickonometrics

Features

Bidder Code ccx Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ccx hb_bidder_ccx hb_adid_ccx
hb_size_ccx hb_source_ccx hb_format_ccx
hb_cache_host_ccx hb_cache_id_ccx hb_uuid_ccx

"Deal ID" Ad Server Key

hb_deal_ccx

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

Cedato

Features

Bidder Code cedato Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cedato hb_bidder_cedato hb_adid_cedato
hb_size_cedato hb_source_cedato hb_format_cedato
hb_cache_host_cedato hb_cache_id_cedato hb_uuid_cedato

"Deal ID" Ad Server Key

hb_deal_cedato

Bid params

Name Scope Description Example Type
player_id required The player ID from Cedato 1450133326 integer
bidfloor optional Bid floor value 0.01 integer

Clean Media

Features

Bidder Code cleanmedia Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cleanmedia hb_bidder_cleanmedia hb_adid_cleanmedia
hb_size_cleanmedia hb_source_cleanmedia hb_format_cleanmedia
hb_cache_host_cleanm hb_cache_id_cleanmed hb_uuid_cleanmedia

"Deal ID" Ad Server Key

hb_deal_cleanmedia

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner '12345' string

Clean Media Net

Features

Bidder Code cleanmedianet Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cleanmedianet hb_bidder_cleanmedia hb_adid_cleanmediane
hb_size_cleanmediane hb_source_cleanmedia hb_format_cleanmedia
hb_cache_host_cleanm hb_cache_id_cleanmed hb_uuid_cleanmediane

"Deal ID" Ad Server Key

hb_deal_cleanmediane

Bid params

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

Clickforce

Features

Bidder Code clickforce Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_clickforce hb_bidder_clickforce hb_adid_clickforce
hb_size_clickforce hb_source_clickforce hb_format_clickforce
hb_cache_host_clickf hb_cache_id_clickfor hb_uuid_clickforce

"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

Coinzilla

Features

Bidder Code coinzilla Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_coinzilla hb_bidder_coinzilla hb_adid_coinzilla
hb_size_coinzilla hb_source_coinzilla hb_format_coinzilla
hb_cache_host_coinzi hb_cache_id_coinzill hb_uuid_coinzilla

"Deal ID" Ad Server Key

hb_deal_coinzilla

Bid Params

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

Collectcent

Features

Bidder Code collectcent Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_collectcent hb_bidder_collectcen hb_adid_collectcent
hb_size_collectcent hb_source_collectcen hb_format_collectcen
hb_cache_host_collec hb_cache_id_collectc hb_uuid_collectcent

"Deal ID" Ad Server Key

hb_deal_collectcent

Bid Params

Name Scope Description Example type
placementId required Placement Id will be generated on Collectcent Platform. 0 integer
traffic required Type traffic ‘banner’ string

COLOMBIA

Features

Bidder Code colombia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_colombia hb_bidder_colombia hb_adid_colombia
hb_size_colombia hb_source_colombia hb_format_colombia
hb_cache_host_colomb hb_cache_id_colombia hb_uuid_colombia

"Deal ID" Ad Server Key

hb_deal_colombia

Bid Params

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

Colossus

Features

Bidder Code colossusssp Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_colossusssp hb_bidder_colossusss hb_adid_colossusssp
hb_size_colossusssp hb_source_colossusss hb_format_colossusss
hb_cache_host_coloss hb_cache_id_colossus hb_uuid_colossusssp

"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

Features

Bidder Code connectad Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_connectad hb_bidder_connectad hb_adid_connectad
hb_size_connectad hb_source_connectad hb_format_connectad
hb_cache_host_connec hb_cache_id_connecta hb_uuid_connectad

"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

Features

Bidder Code consumable Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_consumable hb_bidder_consumable hb_adid_consumable
hb_size_consumable hb_source_consumable hb_format_consumable
hb_cache_host_consum hb_cache_id_consumab hb_uuid_consumable

"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

Features

Bidder Code contentignite Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_contentignite hb_bidder_contentign hb_adid_contentignit
hb_size_contentignit hb_source_contentign hb_format_contentign
hb_cache_host_conten hb_cache_id_contenti hb_uuid_contentignit

"Deal ID" Ad Server Key

hb_deal_contentignit

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

Features

Bidder Code conversant Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs pubCommon COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_conversant hb_bidder_conversant hb_adid_conversant
hb_size_conversant hb_source_conversant hb_format_conversant
hb_cache_host_conver hb_cache_id_conversa hb_uuid_conversant

"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

Features

Bidder Code cox Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cox hb_bidder_cox hb_adid_cox
hb_size_cox hb_source_cox hb_format_cox
hb_cache_host_cox hb_cache_id_cox hb_uuid_cox

"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

CPMStar

Features

Bidder Code cpmstar Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cpmstar hb_bidder_cpmstar hb_adid_cpmstar
hb_size_cpmstar hb_source_cpmstar hb_format_cpmstar
hb_cache_host_cpmsta hb_cache_id_cpmstar hb_uuid_cpmstar

"Deal ID" Ad Server Key

hb_deal_cpmstar

Bid Params

Name Scope Description Example Type
placementId required The placement ID from CPMStar. 81006 integer

Criteo

Features

Bidder Code criteo Prebid.org Member yes
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_criteo hb_bidder_criteo hb_adid_criteo
hb_size_criteo hb_source_criteo hb_format_criteo
hb_cache_host_criteo hb_cache_id_criteo hb_uuid_criteo

"Deal ID" Ad Server Key

hb_deal_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

Video Object

Name Scope Description Example Type
minduration optional Minimum ad duration in seconds 5 integer
startdelay optional Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: 0 (default); Mid-roll: >0; Default mid-roll: -1; Post-roll: -2; 5 integer
playbackmethod required Defines how is initiated the video inventory. Page Load with Sound On: 1; Page Load with Sound Off: 2; Click with Sound On: 3; Mouse-Over with Sound On: 4; Entering Viewport with Sound On: 5; Entering Viewport with Sound Off by Default: 6; 1 integer
placement optional Video placement type. In-Stream: 1; In-Banner: 2; In-Article: 3: In-Feed: 4; Interstitial: 5; 1 integer
skip required Ability from the video player for the user to skip the video. Not skippable: 0; Skippable: 1; 1 integer

In addition, Criteo adapter relies on parameters specified in the mediaTypes.video definition of the video ad-units, namely:

Name Scope Description Example Type
context required outstream, instream or long-form instream string
mimes required List of the content MIME types supported by the player ["video/mp4"] Array<string>
playerSize required Width and height of the player [640, 480] Array<integer>
protocols required Supported video bid response protocols. VAST 1.0: 1; VAST 2.0: 2; VAST 3.0: 3; VAST 1.0 Wrapper: 4; VAST 2.0 Wrapper: 5; VAST 3.0 Wrapper: 6; |5, 6] Array<integer>
maxduration required Maximum ad duration in seconds 20 integer
api required API frameworks supported. VPAID 1.0: 1; VPAID 2.0: 2; MRAID-1: 3; ORMMA: 4; MRAID-2: 5; [1, 2] Array<integer>

Example of Video Ad-unit

var videoAdUnits = [
{
    code: 'test-div-video',
    mediaTypes: { 
        video: { 
            playerSize: [640, 480],
            context: 'instream' ,
            mimes: ['video/mp4','video/x-flv'],
            maxduration: 30,
            api: [ 1, 2 ],
            protocols: [ 2, 3 ],
        }
    },
    bids: [{
      bidder: 'criteo',
      params: {
        zoneid: '32572',
        video: {
          skip: 1,
          minduration: 5,
          startdelay: 5,
          playbackmethod: 1,
          placement: 2
        } 
      } 
    }] 
}]

DAN Marketplace

Features

Bidder Code danmarket Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_danmarket hb_bidder_danmarket hb_adid_danmarket
hb_size_danmarket hb_source_danmarket hb_format_danmarket
hb_cache_host_danmar hb_cache_id_danmarke hb_uuid_danmarket

"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

DecenterAds

Features

Bidder Code decenterads Prebid.org Member no
Media Types display, video, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_decenterads hb_bidder_decenterad hb_adid_decenterads
hb_size_decenterads hb_source_decenterad hb_format_decenterad
hb_cache_host_decent hb_cache_id_decenter hb_uuid_decenterads

"Deal ID" Ad Server Key

hb_deal_decenterads

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

Defy Media

Features

Bidder Code defymedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_defymedia hb_bidder_defymedia hb_adid_defymedia
hb_size_defymedia hb_source_defymedia hb_format_defymedia
hb_cache_host_defyme hb_cache_id_defymedi hb_uuid_defymedia

"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

Features

Bidder Code dgads Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dgads hb_bidder_dgads hb_adid_dgads
hb_size_dgads hb_source_dgads hb_format_dgads
hb_cache_host_dgads hb_cache_id_dgads hb_uuid_dgads

"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

Features

Bidder Code districtm Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_districtm hb_bidder_districtm hb_adid_districtm
hb_size_districtm hb_source_districtm hb_format_districtm
hb_cache_host_distri hb_cache_id_district hb_uuid_districtm

"Deal ID" Ad Server Key

hb_deal_districtm

Bid Params

Name Scope Description Example Type
placementId required     string

DistrictmDMX

Features

Bidder Code districtmDMX Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_districtmDMX hb_bidder_districtmD hb_adid_districtmDMX
hb_size_districtmDMX hb_source_districtmD hb_format_districtmD
hb_cache_host_distri hb_cache_id_district hb_uuid_districtmDMX

"Deal ID" Ad Server Key

hb_deal_districtmDMX

Bid Params

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

Features

Bidder Code divreach Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_divreach hb_bidder_divreach hb_adid_divreach
hb_size_divreach hb_source_divreach hb_format_divreach
hb_cache_host_divrea hb_cache_id_divreach hb_uuid_divreach

"Deal ID" Ad Server Key

hb_deal_divreach

Bid Params

Name Scope Description Example Type
accountID required Account ID '174555' string
zoneID required Zone ID '332935' string
domain required Serving Domain 'ad.divreach.com' string

Dspx

Features

Bidder Code dspx Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dspx hb_bidder_dspx hb_adid_dspx
hb_size_dspx hb_source_dspx hb_format_dspx
hb_cache_host_dspx hb_cache_id_dspx hb_uuid_dspx

"Deal ID" Ad Server Key

hb_deal_dspx

Bid Params

Name Scope Description Example Type
placement required Placement ID from dspx. '101' string
pfilter optional Selection filter. See here for more details. {"floorprice": 1000000} object
bcat optional List of Blocked Categories (IAB) - comma separated. 'IAB2,IAB4' string
dvt optional DeVice Type of [desktop,smartphone,tv,tablet] (autodetect if not exists). 'desktop' string

EngageBDR

Features

Bidder Code ebdr Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ebdr hb_bidder_ebdr hb_adid_ebdr
hb_size_ebdr hb_source_ebdr hb_format_ebdr
hb_cache_host_ebdr hb_cache_id_ebdr hb_uuid_ebdr

"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

Emoteev

Features

Bidder Code emoteev Prebid.org Member no
Media Types display GDPR Support yes
User IDs pubCommon COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emoteev hb_bidder_emoteev hb_adid_emoteev
hb_size_emoteev hb_source_emoteev hb_format_emoteev
hb_cache_host_emotee hb_cache_id_emoteev hb_uuid_emoteev

"Deal ID" Ad Server Key

hb_deal_emoteev

Bid Params

Name Scope Description Example Type
adSpaceId required Provided by Emoteev team 5084 Integer
context required One of 'in-content', 'footer', 'overlay', 'wallpaper' 'in-content' String
externalId optional Use it when you want to link your bids to some specific id on your side. 12 Integer

EMX Digital

Features

Bidder Code emx_digital Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emx_digital hb_bidder_emx_digita hb_adid_emx_digital
hb_size_emx_digital hb_source_emx_digita hb_format_emx_digita
hb_cache_host_emx_di hb_cache_id_emx_digi hb_uuid_emx_digital

Bid Params

Name Scope Description Example Type
tagid required The Tag ID from EMX Digital. test1 string
bidfloor optional The CPM bid floor 0.25 string

E-Planning

Features

Bidder Code eplanning Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_eplanning hb_bidder_eplanning hb_adid_eplanning
hb_size_eplanning hb_source_eplanning hb_format_eplanning
hb_cache_host_eplann hb_cache_id_eplannin hb_uuid_eplanning

"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

Etarget

Features

Bidder Code etarget Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_etarget hb_bidder_etarget hb_adid_etarget
hb_size_etarget hb_source_etarget hb_format_etarget
hb_cache_host_etarge hb_cache_id_etarget hb_uuid_etarget

"Deal ID" Ad Server Key

hb_deal_etarget

Bid Params

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

Eywamedia

Features

Bidder Code eywamedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_eywamedia hb_bidder_eywamedia hb_adid_eywamedia
hb_size_eywamedia hb_source_eywamedia hb_format_eywamedia
hb_cache_host_eywame hb_cache_id_eywamedi hb_uuid_eywamedia

"Deal ID" Ad Server Key

hb_deal_eywamedia

Bid Params

Name Scope Description Example Type
publisherId required Given by Eywamedia '1234_abcd' string
bidFloor optional Floor bid price '0.50' string
cats optional IAB Categories of the web page '["iab1-1","iab23-2"]' Array<string>
keywords optional Categogy Keywords of the web page '["sports", "cricket"]' Array<string>
lat optional Latitude '12.33333' float
lon optional Longitude '77.33333' float
locn optional Location in country$region$city$zip format 'ind$ka$bengaluru$560001' string

FairTrade

Features

Bidder Code fairtrade Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_fairtrade hb_bidder_fairtrade hb_adid_fairtrade
hb_size_fairtrade hb_source_fairtrade hb_format_fairtrade
hb_cache_host_fairtr hb_cache_id_fairtrad hb_uuid_fairtrade

"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

Features

Bidder Code featureforward Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_featureforward hb_bidder_featurefor hb_adid_featureforwa
hb_size_featureforwa hb_source_featurefor hb_format_featurefor
hb_cache_host_featur hb_cache_id_featuref hb_uuid_featureforwa

"Deal ID" Ad Server Key

hb_deal_featureforwa

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

FeedAd

Features

Bidder Code feedad Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_feedad hb_bidder_feedad hb_adid_feedad
hb_size_feedad hb_source_feedad hb_format_feedad
hb_cache_host_feedad hb_cache_id_feedad hb_uuid_feedad

"Deal ID" Ad Server Key

hb_deal_feedad

Bid Params

Name Scope Description Example Type
clientToken required Your FeedAd client token. Check your FeedAd admin panel. 'EiRjZDFiYzI2ZC03OTA2LTQyOTEtOGFmMC0xYzMyZmMwNTFkMDU=' string
placementId required A FeedAd placement ID of your choice 'prebid-test' string

Fidelity Media

Features

Bidder Code fidelity Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_fidelity hb_bidder_fidelity hb_adid_fidelity
hb_size_fidelity hb_source_fidelity hb_format_fidelity
hb_cache_host_fideli hb_cache_id_fidelity hb_uuid_fidelity

"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

Features

Bidder Code freewheel-ssp Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_freewheel-ssp hb_bidder_freewheel- hb_adid_freewheel-ss
hb_size_freewheel-ss hb_source_freewheel- hb_format_freewheel-
hb_cache_host_freewh hb_cache_id_freewhee hb_uuid_freewheel-ss

"Deal ID" Ad Server Key

hb_deal_freewheel-ss

Bid Params

Name Scope Description Example Type
zoneId required     string

Fyber

Features

Bidder Code fyber Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_fyber hb_bidder_fyber hb_adid_fyber
hb_size_fyber hb_source_fyber hb_format_fyber
hb_cache_host_fyber hb_cache_id_fyber hb_uuid_fyber

"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

Gambid

Features

Bidder Code gambid Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gambid hb_bidder_gambid hb_adid_gambid
hb_size_gambid hb_source_gambid hb_format_gambid
hb_cache_host_gambid hb_cache_id_gambid hb_uuid_gambid

"Deal ID" Ad Server Key

hb_deal_gambid

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner '12345' string

Gamma

Features

Bidder Code gamma Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gamma hb_bidder_gamma hb_adid_gamma
hb_size_gamma hb_source_gamma hb_format_gamma
hb_cache_host_gamma hb_cache_id_gamma hb_uuid_gamma

"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

Gamoshi

Features

Bidder Code gamoshi Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gamoshi hb_bidder_gamoshi hb_adid_gamoshi
hb_size_gamoshi hb_source_gamoshi hb_format_gamoshi
hb_cache_host_gamosh hb_cache_id_gamoshi hb_uuid_gamoshi

"Deal ID" Ad Server Key

hb_deal_gamoshi

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner you created in the Gamoshi 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 account.

GetIntent

Features

Bidder Code getintent Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_getintent hb_bidder_getintent hb_adid_getintent
hb_size_getintent hb_source_getintent hb_format_getintent
hb_cache_host_getint hb_cache_id_getinten hb_uuid_getintent

"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

Features

Bidder Code giants Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_giants hb_bidder_giants hb_adid_giants
hb_size_giants hb_source_giants hb_format_giants
hb_cache_host_giants hb_cache_id_giants hb_uuid_giants

"Deal ID" Ad Server Key

hb_deal_giants

Bid Params

Name Scope Description Example Type
zoneId required Zone ID 584072408 integer

Go2Net

Features

Bidder Code go2net Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_go2net hb_bidder_go2net hb_adid_go2net
hb_size_go2net hb_source_go2net hb_format_go2net
hb_cache_host_go2net hb_cache_id_go2net hb_uuid_go2net

"Deal ID" Ad Server Key

hb_deal_go2net

bid params

Name Scope Description Example Type
zone required     string

Gourmet Ads

Features

Bidder Code gourmetads Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gourmetads hb_bidder_gourmetads hb_adid_gourmetads
hb_size_gourmetads hb_source_gourmetads hb_format_gourmetads
hb_cache_host_gourme hb_cache_id_gourmeta hb_uuid_gourmetads

"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

TheMediaGrid

Features

Bidder Code grid Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_grid hb_bidder_grid hb_adid_grid
hb_size_grid hb_source_grid hb_format_grid
hb_cache_host_grid hb_cache_id_grid hb_uuid_grid

"Deal ID" Ad Server Key

hb_deal_grid

Bid Params

Name Scope Description Example Type
uid required Represents the MediaGrid bidder system Ad Slot ID associated with the respective div id from the site page. 1 integer

GumGum

Features

Bidder Code gumgum Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gumgum hb_bidder_gumgum hb_adid_gumgum
hb_size_gumgum hb_source_gumgum hb_format_gumgum
hb_cache_host_gumgum hb_cache_id_gumgum hb_uuid_gumgum

"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

Features

Bidder Code gxone Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gxone hb_bidder_gxone hb_adid_gxone
hb_size_gxone hb_source_gxone hb_format_gxone
hb_cache_host_gxone hb_cache_id_gxone hb_uuid_gxone

"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

Features

Bidder Code headbidding Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_headbidding hb_bidder_headbiddin hb_adid_headbidding
hb_size_headbidding hb_source_headbiddin hb_format_headbiddin
hb_cache_host_headbi hb_cache_id_headbidd hb_uuid_headbidding

"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

HPMD Network

Features

Bidder Code hpmdnetwork Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_hpmdnetwork hb_bidder_hpmdnetwor hb_adid_hpmdnetwork
hb_size_hpmdnetwork hb_source_hpmdnetwor hb_format_hpmdnetwor
hb_cache_host_hpmdne hb_cache_id_hpmdnetw hb_uuid_hpmdnetwork

"Deal ID" Ad Server Key

hb_deal_hpmdnetwork

Note: The HPMD Network adapter requires setup and approval beforehand. For more information, visit HPMD Network website.

Bid parameters

Name Scope Description Example Type
placementId required The slot ID from HPMD Network. '2362' string

Huddled Masses

Features

Bidder Code huddledmasses Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_huddledmasses hb_bidder_huddledmas hb_adid_huddledmasse
hb_size_huddledmasse hb_source_huddledmas hb_format_huddledmas
hb_cache_host_huddle hb_cache_id_huddledm hb_uuid_huddledmasse

"Deal ID" Ad Server Key

hb_deal_huddledmasse

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)

Features

Bidder Code ias Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ias hb_bidder_ias hb_adid_ias
hb_size_ias hb_source_ias hb_format_ias
hb_cache_host_ias hb_cache_id_ias hb_uuid_ias

"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

Features

Bidder Code imonomy Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_imonomy hb_bidder_imonomy hb_adid_imonomy
hb_size_imonomy hb_source_imonomy hb_format_imonomy
hb_cache_host_imonom hb_cache_id_imonomy hb_uuid_imonomy

"Deal ID" Ad Server Key

hb_deal_imonomy

Bid Params

Name Scope Description Example Type
hbid required header-bidding id from Imonomy '14567718624' string
placementId required placement id from Imonomy 'e69148e0ba6c4c07977dc2daae5e1577' string

Improve Digital

Features

Bidder Code improvedigital Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_improvedigital hb_bidder_improvedig hb_adid_improvedigit
hb_size_improvedigit hb_source_improvedig hb_format_improvedig
hb_cache_host_improv hb_cache_id_improved hb_uuid_improvedigit

"Deal ID" Ad Server Key

hb_deal_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 Single size filter. Where a placement supports multiple sizes, this forces the response to feature only one of the multiple sizes. This parameter is ignored when usePrebidSizes is enabled (see Sizes section below) { w:300, h:250 } object

Configuration

Single-Request

By default, the adapter sends one request for each ad unit to Improve Digital’s ad server. For example, if there are 4 Prebid ad units defined on the page, you’ll see 4 calls out to ad.360yield.com/hb.

The Improve Digital adapter supports Single Request mode, where all ad unit requests are made in a single call to ad.360yield.com/hb. To turn this feature on, call setConfig:

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

Sizes

By default, the adapter doesn’t send Prebid ad unit sizes to Improve Digital’s ad server and the sizes defined for each placement in the Polaris platform will be used. If the ad server should only respond with creative sizes as defined in Prebid ad unit configuration, turn on usePrebidSizes adapter parameter like this:

pbjs.setConfig({
   improvedigital: {usePrebidSizes: true}
});

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

Index Exchange

Features

Bidder Code ix Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ix hb_bidder_ix hb_adid_ix
hb_size_ix hb_source_ix hb_format_ix
hb_cache_host_ix hb_cache_id_ix hb_uuid_ix

"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]
            ]
        },
        video: {
            context: 'instream',
            playerSize: [
                [1280, 720]
            ]
        }
    },
    // ...
}];

Supported Media Types

Type Support
Banner Fully supported for all IX approved sizes.
Video Fully supported for all IX approved sizes.
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 for client-side serving 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. Note that the ‘ix’ Prebid Server bid adpater ignores this parameter. [300, 250] Array<integer>

Video

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.video.playerSize. [300, 600] Array<integer>
video Required The video object will serve as the properties of the video ad. You can create any field under the video object that is mentioned in the OpenRTB Spec v2.5. Some fields like mimes, protocols, minduration, maxduration are required. video: { startdelay: 0 } object
video.mimes Required Array list of content MIME types supported. ['video/mp4', 'video/x-flv'] Array<string>
video.minduration Required Minimum video ad duration in seconds. 0 integer
video.maxduration Required Maximum video ad duration in seconds. 300 integer
video.protocol / video.protocols Required Either a single protocol provided as an integer, or protocols provided as a list of integers. 2 - VAST 2.0, 3 - VAST 3.0, 5 - VAST 2.0 Wrapper, 6 - VAST 3.0 Wrapper [2,3,5,6] integer / 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 (you may remove banner or video, if either does not apply).

In regards to video, context can either be 'instream' or 'outstream'. Note that outstream requires additional configuration on the adUnit.

var adUnits = [{
    code: 'banner-div-a',
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        }
    },
    bids: []
},
{
    code: 'video-div-a',
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [
                [1280, 720]
            ]
        }
    },
    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: '123456',
        size: [300, 250]
    }
}

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

Examples

Banner:

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

Video (Instream):

var adUnits = [{
    code: 'video-request-a',
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [
                [1280, 720]
            ]
        }
    },
    bids: [{
        bidder: 'ix',
        params: {
            siteId: '123456',
            size: [1280, 720],
            video: {
                skippable: false,
                mimes: [
                    'video/mp4',
                    'video/webm'
                ],
                minduration: 0,
                maxduration: 60,
                protocols: [6]
            }
        }
    }]
}];

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

Video (Outstream): Note that currently, outstream video rendering must be configured by the publisher. In the adUnit, a renderer object must be defined, which includes a url pointing to the video rendering script, and a render function for creating the video player. See http://prebid.org/dev-docs/show-outstream-video-ads.html for more information.

var adUnits = [{
    code: 'video-div-a',
    mediaTypes: {
        video: {
            context: 'outstream',
            playerSize: [[640, 360]]
        }
    },
    renderer: {
        url: 'https://test.com/my-video-player.js',
        render: function (bid) {
            ...
        }
    },
    bids: [{
        bidder: 'ix',
        params: {
            siteId: '123456',
            size: [640, 360],
            video: {
                skippable: false,
                mimes: [
                    'video/mp4',
                    'video/webm'
                ],
                minduration: 0,
                maxduration: 60,
                protocols: [6]
            }
        }
    }]
}];
2. Include ixBidAdapter in your build process

When running the build command, include ixBidAdapter as a module, as well as dfpAdServerVideo if you require video support.

gulp build --modules=ixBidAdapter,dfpAdServerVideo,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",
    "dfpAdServerVideo",
    "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.

Innity

Features

Bidder Code innity Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_innity hb_bidder_innity hb_adid_innity
hb_size_innity hb_source_innity hb_format_innity
hb_cache_host_innity hb_cache_id_innity hb_uuid_innity

"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

Features

Bidder Code inskin Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_inskin hb_bidder_inskin hb_adid_inskin
hb_size_inskin hb_source_inskin hb_format_inskin
hb_cache_host_inskin hb_cache_id_inskin hb_uuid_inskin

"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

Features

Bidder Code insticator Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_insticator hb_bidder_insticator hb_adid_insticator
hb_size_insticator hb_source_insticator hb_format_insticator
hb_cache_host_instic hb_cache_id_insticat hb_uuid_insticator

"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

Features

Bidder Code interactiveOffers Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_interactiveOff hb_bidder_interactiv hb_adid_interactiveO
hb_size_interactiveO hb_source_interactiv hb_format_interactiv
hb_cache_host_intera hb_cache_id_interact hb_uuid_interactiveO

"Deal ID" Ad Server Key

hb_deal_interactiveO

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 integer

Example:

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

Invibes

Features

Bidder Code invibes Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_invibes hb_bidder_invibes hb_adid_invibes
hb_size_invibes hb_source_invibes hb_format_invibes
hb_cache_host_invibe hb_cache_id_invibes hb_uuid_invibes

"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

Features

Bidder Code iqm Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iqm hb_bidder_iqm hb_adid_iqm
hb_size_iqm hb_source_iqm hb_format_iqm
hb_cache_host_iqm hb_cache_id_iqm hb_uuid_iqm

"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

Features

Bidder Code jcm Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_jcm hb_bidder_jcm hb_adid_jcm
hb_size_jcm hb_source_jcm hb_format_jcm
hb_cache_host_jcm hb_cache_id_jcm hb_uuid_jcm

"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

Features

Bidder Code justpremium Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_justpremium hb_bidder_justpremiu hb_adid_justpremium
hb_size_justpremium hb_source_justpremiu hb_format_justpremiu
hb_cache_host_justpr hb_cache_id_justprem hb_uuid_justpremium

"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

Features

Bidder Code kargo Prebid.org Member no
Media Types display GDPR Support no
User IDs unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kargo hb_bidder_kargo hb_adid_kargo
hb_size_kargo hb_source_kargo hb_format_kargo
hb_cache_host_kargo hb_cache_id_kargo hb_uuid_kargo

"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

Features

Bidder Code komoona Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_komoona hb_bidder_komoona hb_adid_komoona
hb_size_komoona hb_source_komoona hb_format_komoona
hb_cache_host_komoon hb_cache_id_komoona hb_uuid_komoona

"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

Features

Bidder Code kumma Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kumma hb_bidder_kumma hb_adid_kumma
hb_size_kumma hb_source_kumma hb_format_kumma
hb_cache_host_kumma hb_cache_id_kumma hb_uuid_kumma

"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

Features

Bidder Code lifestreet Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lifestreet hb_bidder_lifestreet hb_adid_lifestreet
hb_size_lifestreet hb_source_lifestreet hb_format_lifestreet
hb_cache_host_lifest hb_cache_id_lifestre hb_uuid_lifestreet

"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

Features

Bidder Code livewrapped Prebid.org Member no
Media Types display GDPR Support yes
User IDs pubcommon COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_livewrapped hb_bidder_livewrappe hb_adid_livewrapped
hb_size_livewrapped hb_source_livewrappe hb_format_livewrappe
hb_cache_host_livewr hb_cache_id_livewrap hb_uuid_livewrapped

"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

Features

Bidder Code lkqd Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lkqd hb_bidder_lkqd hb_adid_lkqd
hb_size_lkqd hb_source_lkqd hb_format_lkqd
hb_cache_host_lkqd hb_cache_id_lkqd hb_uuid_lkqd

"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

Features

Bidder Code lockerdome Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lockerdome hb_bidder_lockerdome hb_adid_lockerdome
hb_size_lockerdome hb_source_lockerdome hb_format_lockerdome
hb_cache_host_locker hb_cache_id_lockerdo hb_uuid_lockerdome

"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

Logicad for Publishers

Features

Bidder Code logicad Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_logicad hb_bidder_logicad hb_adid_logicad
hb_size_logicad hb_source_logicad hb_format_logicad
hb_cache_host_logica hb_cache_id_logicad hb_uuid_logicad

Bid Params

Name Scope Description Example Type
tid required Logicad for Publishers placement ID 'PJ2P' string
page optional Url of the webpage where the request is originating from 'url' string
cur optional Currency of request and response (Default: JPY ) 'JPY' string
test optional Indicates bidding for testing purposes true boolean

LoopMe

Features

Bidder Code loopme Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_loopme hb_bidder_loopme hb_adid_loopme
hb_size_loopme hb_source_loopme hb_format_loopme
hb_cache_host_loopme hb_cache_id_loopme hb_uuid_loopme

"Deal ID" Ad Server Key

hb_deal_loopme

Bid params

Name Scope Description Example Type
ak required LoopMe Application Key 'cc885e3acc' string

Test LoopMe application keys: banner - cc885e3acc, video - 223051e07f

Madvertise

Features

Bidder Code madvertise Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_madvertise hb_bidder_madvertise hb_adid_madvertise
hb_size_madvertise hb_source_madvertise hb_format_madvertise
hb_cache_host_madver hb_cache_id_madverti hb_uuid_madvertise

"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

Features

Bidder Code mantis Prebid.org Member no
Media Types display, video, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mantis hb_bidder_mantis hb_adid_mantis
hb_size_mantis hb_source_mantis hb_format_mantis
hb_cache_host_mantis hb_cache_id_mantis hb_uuid_mantis

"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

Features

Bidder Code marsmedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_marsmedia hb_bidder_marsmedia hb_adid_marsmedia
hb_size_marsmedia hb_source_marsmedia hb_format_marsmedia
hb_cache_host_marsme hb_cache_id_marsmedi hb_uuid_marsmedia

"Deal ID" Ad Server Key

hb_deal_marsmedia

Bid Params

Name Scope Description Example Type
publisherID required     string
floor optional     string

Matomy

Features

Bidder Code matomy Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_matomy hb_bidder_matomy hb_adid_matomy
hb_size_matomy hb_source_matomy hb_format_matomy
hb_cache_host_matomy hb_cache_id_matomy hb_uuid_matomy

"Deal ID" Ad Server Key

hb_deal_matomy

Bid Params

Name Scope Description Example Type
placementId required     string

MediaFuse Lift

Features

Bidder Code mediafuseLift Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mediafuseLift hb_bidder_mediafuseL hb_adid_mediafuseLif
hb_size_mediafuseLif hb_source_mediafuseL hb_format_mediafuseL
hb_cache_host_mediaf hb_cache_id_mediafus hb_uuid_mediafuseLif

"Deal ID" Ad Server Key

hb_deal_mediafuseLif

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

Media.net

Features

Bidder Code medianet Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_medianet hb_bidder_medianet hb_adid_medianet
hb_size_medianet hb_source_medianet hb_format_medianet
hb_cache_host_median hb_cache_id_medianet hb_uuid_medianet

"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

Mgid

Features

Bidder Code mgid Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mgid hb_bidder_mgid hb_adid_mgid
hb_size_mgid hb_source_mgid hb_format_mgid
hb_cache_host_mgid hb_cache_id_mgid hb_uuid_mgid

"Deal ID" Ad Server Key

hb_deal_mgid

Table of Contents

Description

One of the easiest way to gain access to MGID demand sources - MGID header bidding adapter.

MGID header bidding adapter connects with MGID demand sources to fetch bids for display placements. Please reach out to your account manager or prebid@mgid.com for more information.

Bid params

Name Scope Description Example Type
accountId required The account ID from Mgid '123' string
placementId optional The placement ID from Mgid '123456' string
bidFloor optional Lowest value of expected bid price 1.1 float
currency optional Currency of request and response 'GBP' string

Test Parameters

300x600 banner test

var adUnits = [{
  code: 'div-prebid',
  mediaTypes: {
    banner: {
      sizes: [[300, 600]]
    }
  },
  // Replace this object to test a new Adapter!
  bids: [{
    bidder: 'mgid',
    params : {
      accountId : "219", //test accountId, please replace after test
      placementId : "331749" // 300x600 test placementId, please replace after test
    }
  }]
}];

300x250 banner test

var adUnits = [{
  code: 'div-prebid',
  mediaTypes: {
    banner: {
      sizes: [[300, 250]]
    }
  },
  // Replace this object to test a new Adapter!
  bids: [{
    bidder: 'mgid',
    params : {
      accountId : "219", //test accountId, please replace after test
      placementId : "331748" // 300x250 test placementId, please replace after test
    }
  }]
}];

native test

var adUnits = [{
  code: 'div-prebid',
  mediaTypes: {
    native: {
        image: {
            sendId: true,
            required: true,
            sizes: [80, 80]
        },
        clickUrl: {
            sendId: true,
            required: false
        },
        title: {
            required: true,
            len: 80
        },
        sponsored: {
            required: false
        }
    }
  },
  // Replace this object to test a new Adapter!
  bids: [{
    bidder: 'mgid',
    params : {
        accountId : "219", //test accountId, please replace after test
        placementId : "350971" // 300x250 test placementId, please replace after test
    }
  }]
}];

MicroAd

Features

Bidder Code microad Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_microad hb_bidder_microad hb_adid_microad
hb_size_microad hb_source_microad hb_format_microad
hb_cache_host_microa hb_cache_id_microad hb_uuid_microad

"Deal ID" Ad Server Key

hb_deal_microad

Note: The MicroAd Bidding adapter requires setup and approval beforehand. For more information, visit MicroAd website.

Bid parameters

Name Scope Description Example Type
spot required Ad placement ID provided by MicroAd. '209e56872ae8b0442a60477ae0c58be9' string
url optional URL parameter. Effective only when provided by MicroAd. '${COMPASS_EXT_URL}' string
referrer optional Referrer parameter. Effective only when provided by MicroAd. '${COMPASS_EXT_REF}' string
ifa optional IFA parameter. Effective only when provided by MicroAd. '${COMPASS_EXT_IFA}' string
appid optional App ID parameter. Effective only when provided by MicroAd. '${COMPASS_EXT_APPID}' string
geo optional Geo parameter. Effective only when provided by MicroAd. '${COMPASS_EXT_GEO}' string

MobFox

Features

Bidder Code mobfox Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mobfox hb_bidder_mobfox hb_adid_mobfox
hb_size_mobfox hb_source_mobfox hb_format_mobfox
hb_cache_host_mobfox hb_cache_id_mobfox hb_uuid_mobfox

"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

Features

Bidder Code my6sense Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_my6sense hb_bidder_my6sense hb_adid_my6sense
hb_size_my6sense hb_source_my6sense hb_format_my6sense
hb_cache_host_my6sen hb_cache_id_my6sense hb_uuid_my6sense

"Deal ID" Ad Server Key

hb_deal_my6sense

Bid params

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

myTarget

Features

Bidder Code mytarget Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mytarget hb_bidder_mytarget hb_adid_mytarget
hb_size_mytarget hb_source_mytarget hb_format_mytarget
hb_cache_host_mytarg hb_cache_id_mytarget hb_uuid_mytarget

"Deal ID" Ad Server Key

hb_deal_mytarget

Bid params

Name Scope Description Example Type
placementId required The slot ID from myTarget. '379783' string
bidfloor optional Bid floor 10000 number
position optional Ad position on screen. See details below. 1 number
response optional Bid response type. 0 - ad url (default), 1 - ad markup. 1 number

Position

The following values are defined in the ORTB 2.5 spec.

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

Configuration

The myTarget ‘sitename’ could be set globally:

pbjs.setConfig({
   mytarget: {
     sitename: 'example.com'
   }
});

NAF Digital

Features

Bidder Code nafdigital Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nafdigital hb_bidder_nafdigital hb_adid_nafdigital
hb_size_nafdigital hb_source_nafdigital hb_format_nafdigital
hb_cache_host_nafdig hb_cache_id_nafdigit hb_uuid_nafdigital

"Deal ID" Ad Server Key

hb_deal_nafdigital

Note:

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

Bid Params

Name Scope Description Example Type
publisherId required The publisher ID from NAF Digital 2141020 integer
bidFloor optional The minimum bid value desired 1.23 float

Nano Interactive

Features

Bidder Code nanointeractive Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nanointeractiv hb_bidder_nanointera hb_adid_nanointeract
hb_size_nanointeract hb_source_nanointera hb_format_nanointera
hb_cache_host_nanoin hb_cache_id_nanointe hb_uuid_nanointeract

"Deal ID" Ad Server Key

hb_deal_nanointeract

Requirements:

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

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

Features

Bidder Code nasmediaAdmixer Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nasmediaAdmixe hb_bidder_nasmediaAd hb_adid_nasmediaAdmi
hb_size_nasmediaAdmi hb_source_nasmediaAd hb_format_nasmediaAd
hb_cache_host_nasmed hb_cache_id_nasmedia hb_uuid_nasmediaAdmi

"Deal ID" Ad Server Key

hb_deal_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

NextMillennium

Features

Bidder Code nextMillennium Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nextMillennium hb_bidder_nextMillen hb_adid_nextMillenni
hb_size_nextMillenni hb_source_nextMillen hb_format_nextMillen
hb_cache_host_nextMi hb_cache_id_nextMill hb_uuid_nextMillenni

"Deal ID" Ad Server Key

hb_deal_nextMillenni

bid params

Name Scope Description Example Type
placement_id required Placement ID, provided by nextMillennium 12345 Integer

One Fifty Two Media

Features

Bidder Code oftmedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_oftmedia hb_bidder_oftmedia hb_adid_oftmedia
hb_size_oftmedia hb_source_oftmedia hb_format_oftmedia
hb_cache_host_oftmed hb_cache_id_oftmedia hb_uuid_oftmedia

"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

152MediaHB

Features

Bidder Code oftmediahb Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_oftmediahb hb_bidder_oftmediahb hb_adid_oftmediahb
hb_size_oftmediahb hb_source_oftmediahb hb_format_oftmediahb
hb_cache_host_oftmed hb_cache_id_oftmedia hb_uuid_oftmediahb

"Deal ID" Ad Server Key

hb_deal_oftmediahb

Bid Params

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

oftmediahb is an aliased bidder for AdKernel

OneVideo

Features

Bidder Code oneVideo Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_oneVideo hb_bidder_oneVideo hb_adid_oneVideo
hb_size_oneVideo hb_source_oneVideo hb_format_oneVideo
hb_cache_host_oneVid hb_cache_id_oneVideo hb_uuid_oneVideo

"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

Features

Bidder Code onedisplay Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onedisplay hb_bidder_onedisplay hb_adid_onedisplay
hb_size_onedisplay hb_source_onedisplay hb_format_onedisplay
hb_cache_host_onedis hb_cache_id_onedispl hb_uuid_onedisplay

"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

Features

Bidder Code onefiftytwo Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onefiftytwo hb_bidder_onefiftytw hb_adid_onefiftytwo
hb_size_onefiftytwo hb_source_onefiftytw hb_format_onefiftytw
hb_cache_host_onefif hb_cache_id_onefifty hb_uuid_onefiftytwo

"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

152 Media 3.0

Features

Bidder Code onefiftytwomedia Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onefiftytwomed hb_bidder_onefiftytw hb_adid_onefiftytwom
hb_size_onefiftytwom hb_source_onefiftytw hb_format_onefiftytw
hb_cache_host_onefif hb_cache_id_onefifty hb_uuid_onefiftytwom

"Deal ID" Ad Server Key

hb_deal_onefiftytwom

Bid params

Name Scope Description Example Type
aid required The source ID 350975 integer

Test Parameters

    var adUnits = [

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

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

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

ONE by AOL Mobile

Features

Bidder Code onemobile Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onemobile hb_bidder_onemobile hb_adid_onemobile
hb_size_onemobile hb_source_onemobile hb_format_onemobile
hb_cache_host_onemob hb_cache_id_onemobil hb_uuid_onemobile

"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

Features

Bidder Code oneplanetonly Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_oneplanetonly hb_bidder_oneplaneto hb_adid_oneplanetonl
hb_size_oneplanetonl hb_source_oneplaneto hb_format_oneplaneto
hb_cache_host_onepla hb_cache_id_oneplane hb_uuid_oneplanetonl

"Deal ID" Ad Server Key

hb_deal_oneplanetonl

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

Features

Bidder Code onetag Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onetag hb_bidder_onetag hb_adid_onetag
hb_size_onetag hb_source_onetag hb_format_onetag
hb_cache_host_onetag hb_cache_id_onetag hb_uuid_onetag

"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

OPEN8

Features

Bidder Code open8 Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_open8 hb_bidder_open8 hb_adid_open8
hb_size_open8 hb_source_open8 hb_format_open8
hb_cache_host_open8 hb_cache_id_open8 hb_uuid_open8

"Deal ID" Ad Server Key

hb_deal_open8

Bid Params

Name Scope Description Example Type
slotKey required ad placement code 'abcd1234' string

OpenX

Features

Bidder Code openx Prebid.org Member yes
Media Types display, video GDPR Support yes
User IDs pubcommon COPPA Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_openx hb_bidder_openx hb_adid_openx
hb_size_openx hb_source_openx hb_format_openx
hb_cache_host_openx hb_cache_id_openx hb_uuid_openx

"Deal ID" Ad Server Key

hb_deal_openx

Bid Parameters

Name Scope Description Example Type
delDomain or platform required OpenX delivery domain or platform id provided by your OpenX representative. “PUBLISHER-d.openx.net” or “555not5a-real-plat-form-id0123456789” 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']
          },
        }
      }, {
        bidder: 'openx',
        params: {
          unit: '539439964',
          platform: 'a3aece0c-9e80-4316-8deb-faf804779bd1',
          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

OpenX Outstream

Features

Bidder Code openxoutstream Prebid.org Member yes
Media Types display, native GDPR Support no
User IDs none COPPA Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_openxoutstream hb_bidder_openxoutst hb_adid_openxoutstre
hb_size_openxoutstre hb_source_openxoutst hb_format_openxoutst
hb_cache_host_openxo hb_cache_id_openxout hb_uuid_openxoutstre

"Deal ID" Ad Server Key

hb_deal_openxoutstre

Bid Params

Name Scope Description Example Type
delDomain required OpenX delivery domain provided by your OpenX representative. “PUBLISHER-d.openx.net” String

Optimatic

Features

Bidder Code optimatic Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_optimatic hb_bidder_optimatic hb_adid_optimatic
hb_size_optimatic hb_source_optimatic hb_format_optimatic
hb_cache_host_optima hb_cache_id_optimati hb_uuid_optimatic

"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

Features

Bidder Code optimera Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_optimera hb_bidder_optimera hb_adid_optimera
hb_size_optimera hb_source_optimera hb_format_optimera
hb_cache_host_optime hb_cache_id_optimera hb_uuid_optimera

"Deal ID" Ad Server Key

hb_deal_optimera

Bid Params

Name Scope Description Example Type
clientID required The Optimera Client ID '123' string

Orbidder

Features

Bidder Code orbidder Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_orbidder hb_bidder_orbidder hb_adid_orbidder
hb_size_orbidder hb_source_orbidder hb_format_orbidder
hb_cache_host_orbidd hb_cache_id_orbidder hb_uuid_orbidder

"Deal ID" Ad Server Key

hb_deal_orbidder

Bid Params

Name Scope Description Example Type
accountId required Orbidder Account ID “someAccount” string
placementId required Placement Id “somePlacement” string
bidfloor optional Placement floor price 1.23 float
keyValues optional Custom key/value object { “key”: “value” } object

Orbitsoft

Features

Bidder Code orbitsoft Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_orbitsoft hb_bidder_orbitsoft hb_adid_orbitsoft
hb_size_orbitsoft hb_source_orbitsoft hb_format_orbitsoft
hb_cache_host_orbits hb_cache_id_orbitsof hb_uuid_orbitsoft

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

OTM

Features

Bidder Code otm Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_otm hb_bidder_otm hb_adid_otm
hb_size_otm hb_source_otm hb_format_otm
hb_cache_host_otm hb_cache_id_otm hb_uuid_otm

"Deal ID" Ad Server Key

hb_deal_otm

Bid Params

Name Scope Description Example Type
tid required A tag id '99' string
bidfloor optional Floor price 20 integer

Ozone Project

Features

Bidder Code ozone Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ozone hb_bidder_ozone hb_adid_ozone
hb_size_ozone hb_source_ozone hb_format_ozone
hb_cache_host_ozone hb_cache_id_ozone hb_uuid_ozone

"Deal ID" Ad Server Key

hb_deal_ozone

Bid Params

Name Scope Description Example Type
siteId required The site ID from ozone. "OZONENUK0001" string
publisherId required The publisher ID. "4204204201" string
placementId required The placement ID. "0420420421" string
customData optional publisher key-values used for targeting {"key1": "value1", "key2": "value2"} string
lotameData optional lotame key-values used for targeting {"key1": "value1", "key2": "value2"} string

Padsquad

Features

Bidder Code padsquad Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_padsquad hb_bidder_padsquad hb_adid_padsquad
hb_size_padsquad hb_source_padsquad hb_format_padsquad
hb_cache_host_padsqu hb_cache_id_padsquad hb_uuid_padsquad

"Deal ID" Ad Server Key

hb_deal_padsquad

Note:

The Padsquad Header Bidding adapter requires approval from the Padsquad team. Please reach out to yeeldpadsquad@gmail.com for more information.

Bid Params

Name Scope Description Example Type
unitId optional Unit Id '200000' string
networkId optional Network Id '8ba96b13-540d-4f8a-9f1b-2a7e804769cc' string
publisherId optional Publisher Id '8ba96b13-540d-4f8a-9f1b-2a7e804769cc' string

Page Science

Features

Bidder Code pagescience Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pagescience hb_bidder_pagescienc hb_adid_pagescience
hb_size_pagescience hb_source_pagescienc hb_format_pagescienc
hb_cache_host_pagesc hb_cache_id_pagescie hb_uuid_pagescience

"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

Features

Bidder Code peak226 Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_peak226 hb_bidder_peak226 hb_adid_peak226
hb_size_peak226 hb_source_peak226 hb_format_peak226
hb_cache_host_peak22 hb_cache_id_peak226 hb_uuid_peak226

"Deal ID" Ad Server Key

hb_deal_peak226

Bid Params

Name Scope Description Example Type
uid required The ID from Peak226 76221035 integer

Piximedia

Features

Bidder Code piximedia Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_piximedia hb_bidder_piximedia hb_adid_piximedia
hb_size_piximedia hb_source_piximedia hb_format_piximedia
hb_cache_host_pixime hb_cache_id_piximedi hb_uuid_piximedia

"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

Features

Bidder Code platformio Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_platformio hb_bidder_platformio hb_adid_platformio
hb_size_platformio hb_source_platformio hb_format_platformio
hb_cache_host_platfo hb_cache_id_platform hb_uuid_platformio

"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

Features

Bidder Code playgroundxyz Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_playgroundxyz hb_bidder_playground hb_adid_playgroundxy
hb_size_playgroundxy hb_source_playground hb_format_playground
hb_cache_host_playgr hb_cache_id_playgrou hb_uuid_playgroundxy

"Deal ID" Ad Server Key

hb_deal_playgroundxy

Bid Params

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

Pollux Network

Features

Bidder Code pollux Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pollux hb_bidder_pollux hb_adid_pollux
hb_size_pollux hb_source_pollux hb_format_pollux
hb_cache_host_pollux hb_cache_id_pollux hb_uuid_pollux

"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

Features

Bidder Code polymorph Prebid.org Member no
Media Types display, video, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_polymorph hb_bidder_polymorph hb_adid_polymorph
hb_size_polymorph hb_source_polymorph hb_format_polymorph
hb_cache_host_polymo hb_cache_id_polymorp hb_uuid_polymorph

"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 Type
placementId required The placement id/key provided by Polymorph 'ENvsYZ6m5DPDk6r7ogYV63DO2sBQoJ5EpckcXSlw' String
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 Integer
defaultHeight optional   250 Integer

Prebid Server

Features

Bidder Code prebidServer Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_prebidServer hb_bidder_prebidServ hb_adid_prebidServer
hb_size_prebidServer hb_source_prebidServ hb_format_prebidServ
hb_cache_host_prebid hb_cache_id_prebidSe hb_uuid_prebidServer

"Deal ID" Ad Server Key

hb_deal_prebidServer

Overview

The Prebid Server Adapter is a meta-adapter. It’s not an actual bidder, but rather a way to get a batch of bids from other bidders with one request. A request for the set of auctions is sent to Prebid Server, which performs all the auctions server side (S2S), responding in time for Prebid.js to send the results to the ad server. This lightens the performance load on the user’s device.

Bid Params

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

Errors in bidder parameters will cause Prebid Server to reject the entire request. The Prebid Server philosophy is to avoid silent failures – we assume you will test changes, and that it will be easier to notice a 4xx error coming from the server than a silent failure where it skips just the bad parameter.

Configuration

To enable prebid server, set the following configuration.

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

Configuration options

Field Type Required? Description
accountId String yes Prebid Server account ID.
bidders Array[String] yes List of bidder codes; must have been enabled during Prebid.js build.
defaultVendor String no 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 no Enables S2S; default: false (true when defaultVendor is set).
endpoint String no Set the endpoint. For example: https://prebid.adnxs.com/pbs/v1/openrtb2/auction
timeout Number no Bidder timeout, in milliseconds; default: 1000.
syncEndpoint String no Configures the user-sync endpoint. Highly recommended.
adapter String no Adapter code; default: "prebidServer".
secure Integer no 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.
adapterOptions Object no Arguments will be added to resulting OpenRTB payload to Prebid Server.
extPrebid Object no Arguments will be added to resulting OpenRTB payload to Prebid Server.

Examples

Video (Outstream): Note that currently, outstream video rendering must be configured by the publisher. In the adUnit, a renderer object must be defined, which includes a url pointing to the video rendering script, and a render function for creating the video player. See http://prebid.org/dev-docs/show-outstream-video-ads.html for more information.

var adUnits = [{
    code: 'div-gpt-ad-1460505748561-0',
    mediaTypes: {
        video: {
            playerSize: [640, 480],
            context: 'outstream',
            mimes: ['video/mp4']
        }
    },
    bids: [
        {
            bidder: 'appnexus',
            params: {
                placementId: 13232392,
                video: {
                    skippable: true,
                    playback_method: ['auto_play_sound_off']
                }
            },

        }
    ],
    renderer: {
        url: 'http://cdn.adnxs.com/renderer/video/ANOutstreamVideo.js',
        render: function (bid) {
            adResponse = {
                ad: {
                    video: {
                        content: bid.vastXml,
                        player_height: bid.playerHeight,
                        player_width: bid.playerWidth
                    }
                }
            }
            // push to render queue because ANOutstreamVideo may not be loaded yet.
            bid.renderer.push(() => {
                ANOutstreamVideo.renderAd({
                    targetId: bid.adUnitCode, // target div id to render video.
                    adResponse: adResponse
                });
            });
        }
    }
}];

Project Limelight

Features

Bidder Code project-limelight Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_project-limeli hb_bidder_project-li hb_adid_project-lime
hb_size_project-lime hb_source_project-li hb_format_project-li
hb_cache_host_projec hb_cache_id_project- hb_uuid_project-lime

"Deal ID" Ad Server Key

hb_deal_project-lime

Bid Params

Name Scope Description Example type
adUnitId required Ad Unit Id will be generated on Project Limelight Platform. 0 integer
adUnitType required Type of Ad Unit (‘video’, ‘banner’) ‘banner’ string

PubMatic

Features

Bidder Code pubmatic Prebid.org Member yes
Media Types display, video, native GDPR Support yes
User IDs unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pubmatic hb_bidder_pubmatic hb_adid_pubmatic
hb_size_pubmatic hb_source_pubmatic hb_format_pubmatic
hb_cache_host_pubmat hb_cache_id_pubmatic hb_uuid_pubmatic

"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 optional Ad Slot Name (see below) '38519891' 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' (Value configured only in the 1st adunit will be passed on.
Values if present in subsequent adunits, will be ignored.)
string
dctr optional Deal Custom Targeting
(Value configured only in the 1st adunit will be passed on.
Values if present in subsequent adunits, will be ignored.)
'key1=123|key2=345' string
bcat optional Blocked IAB Categories
(Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ] array of strings

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.

adSlot Specification and Multi-Size Ad Units

The adSlot parameter supports two different formats:

Format Example
Without Size '38519891'
With Size '38519891@300x205'

Support and behavior differs by Prebid.js version

Prebid.js v2.13.0 and later:

adSlot parameter is now optional. To omit the adSlot parameter, your publisher account must have default site and tag enabled. Consult your account manager to find out if default site and tag is enabled on your account. If used, both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. All options will send the ad request with all sizes specified in the Prebid ad unit configuration.

Prebid.js v2.9.0 to v2.12.0:

Both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. Both formats will send the ad request with all sizes specified in the Prebid ad unit configuration.

Prebid.js v1.1.18 to v2.8.0:

Both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. Without Size will send the ad request with all sizes specified in the Prebid ad unit configuration. With Size will only request the specified size. Mutli-sized ad units are not supported when using Prebid Server.

Prebid.js v1.1.17 and earlier:

Only With Size is supported. To support multi-size ad units, list the PubMatic bidder entry multiple times, once for each size. Mutli-sized ad units are not supported when using Prebid Server.

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

AdUnit Format for Native

var adUnits = [
{
    code: 'test-div',    
    mediaTypes: {
       native: {
            image: {
                required: true,
                sizes: [150, 50]
            },
            title: {
                required: true,
                len: 80
            },
            sponsoredBy: {
                required: true
            },
            body: {
                required: true
            }
        }
    },
    bids: [{
      bidder: 'pubmatic',
      params: {
        publisherId: '156295',               // required
        adSlot: 'pubmatic_test2@1x1',       // required
      }
    }]
}];

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

Features

Bidder Code pubnx Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pubnx hb_bidder_pubnx hb_adid_pubnx
hb_size_pubnx hb_source_pubnx hb_format_pubnx
hb_cache_host_pubnx hb_cache_id_pubnx hb_uuid_pubnx

"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

Features

Bidder Code pulsepoint Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs pubcommonId, unifiedId, digitrustId, id5Id COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pulsepoint hb_bidder_pulsepoint hb_adid_pulsepoint
hb_size_pulsepoint hb_source_pulsepoint hb_format_pulsepoint
hb_cache_host_pulsep hb_cache_id_pulsepoi hb_uuid_pulsepoint

"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
bcat optional Blocked IAB Categories [ 'IAB1-5', 'IAB1-6' ] array of strings
battr optional Blocked Creative Attributes [ 1, 2, 5 ] array of integers
badv optional Blocked Advertisers by their domains ['ford.com', 'pepsi.com'] array of strings
bidfloor optional Bid floor price CPM 1.23 float
video required Required for video requests. OpenRTB Video object. { w: 400, h: 300 } object

Video parameters

Parameters on the Video object in Bid params for PulsePoint. OpenRTB 2.5 Video object specification is used. Below are some sample parameters from the OpenRTB Video specs.

Name Scope Description Example
video.mimes required Content MIME types supported ['video/mp4','video/x-flv']
video.minduration optional Minimum video ad duration in seconds 8
video.maxduration optional Maximum video ad duration in seconds 20
video.protocols optional Array of supported video protocols [2, 3]
video.w optional Width of the video player in device independent pixels 400
video.h optional Height of the video player in device independent pixels 300
video.startdelay optional Start delay in seconds 5
video.skip optional Indicates if the player will allow the video to be skipped 1
video.minbitrate optional Minumim bit rate in Kbps. 200
video.maxbitrate optional Maximum bit rate in Kbps. 500
video.api optional List of supported API frameworks for this impression [1, 2]

Quantcast

Features

Bidder Code quantcast Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_quantcast hb_bidder_quantcast hb_adid_quantcast
hb_size_quantcast hb_source_quantcast hb_format_quantcast
hb_cache_host_quantc hb_cache_id_quantcas hb_uuid_quantcast

"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

Features

Bidder Code quantum Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_quantum hb_bidder_quantum hb_adid_quantum
hb_size_quantum hb_source_quantum hb_format_quantum
hb_cache_host_quantu hb_cache_id_quantum hb_uuid_quantum

"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

Features

Bidder Code rdn Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rdn hb_bidder_rdn hb_adid_rdn
hb_size_rdn hb_source_rdn hb_format_rdn
hb_cache_host_rdn hb_cache_id_rdn hb_uuid_rdn

"Deal ID" Ad Server Key

hb_deal_rdn

Bid Params

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

Configuration

The RDN adapter allows the endpoint to be configured with the following configuration option.

pbjs.setConfig({
   rdn: {
     endpoint: "https://new-endpoint.rakuten.com"
   }
});

If unspecified the adapter will fallback to the default endpoint.

ReadPeak

Features

Bidder Code readpeak Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_readpeak hb_bidder_readpeak hb_adid_readpeak
hb_size_readpeak hb_source_readpeak hb_format_readpeak
hb_cache_host_readpe hb_cache_id_readpeak hb_uuid_readpeak

"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

ReklamStore

Features

Bidder Code reklamstore Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_reklamstore hb_bidder_reklamstor hb_adid_reklamstore
hb_size_reklamstore hb_source_reklamstor hb_format_reklamstor
hb_cache_host_reklam hb_cache_id_reklamst hb_uuid_reklamstore

"Deal ID" Ad Server Key

hb_deal_reklamstore

Bid Params

Name Scope Description Example Type
regionId required The placement id provided by ReklamStore 1234567 integer

Reload

Features

Bidder Code reload Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_reload hb_bidder_reload hb_adid_reload
hb_size_reload hb_source_reload hb_format_reload
hb_cache_host_reload hb_cache_id_reload hb_uuid_reload

"Deal ID" Ad Server Key

hb_deal_reload

Bid Params

Name Scope Description Example Type
plcmID required Placement ID (provided by Reload) “4234897234” string
partID required Partition ID (provided by Reload) “part_01” string
opdomID required Internal parameter (provided by Reload) 0 int
bsrvID required Internal parameter (provided by Reload) 12 int
type optional Internal parameter (provided by Reload) “pcm” string

Example

var adUnits = [
  // Banner adUnit
  {
    code: 'banner-div',
    mediaTypes: {
      banner: {
        sizes: [
          [300, 250]
        ],
      }
    },
    bids: [{
      bidder: 'reload',
      params: {
        plcmID: '4234897234',
        partID: 'part_2',
        opdomID: 0,
	bsrvID: 0,
        type: 'pcm'
      }
    }]
  }];

REXRTB

Features

Bidder Code rexrtb Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rexrtb hb_bidder_rexrtb hb_adid_rexrtb
hb_size_rexrtb hb_source_rexrtb hb_format_rexrtb
hb_cache_host_rexrtb hb_cache_id_rexrtb hb_uuid_rexrtb

"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

Features

Bidder Code rhythmone Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rhythmone hb_bidder_rhythmone hb_adid_rhythmone
hb_size_rhythmone hb_source_rhythmone hb_format_rhythmone
hb_cache_host_rhythm hb_cache_id_rhythmon hb_uuid_rhythmone

"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' string
zone optional Optional string issued by RhythmOne to the publisher '1r' string
path optional Optional string issued by RhythmOne to the publisher 'mvo' string

Rich Audience

Features

Bidder Code richaudience Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_richaudience hb_bidder_richaudien hb_adid_richaudience
hb_size_richaudience hb_source_richaudien hb_format_richaudien
hb_cache_host_richau hb_cache_id_richaudi hb_uuid_richaudience

"Deal ID" Ad Server Key

hb_deal_richaudience

Bid Params

Name Scope Description Example Type
pid required The placement ID from Rich Audience. 'ADb1f40rmi' string
supplyType required Define if site or app. 'site / app' string
ifa optional Identifier For Advertisers 'AAAAAAAAA-BBBB-CCCC-1111-222222220000234234234234234' string
bidfloor optional Bid Floor 0.80 float

RockYou

Features

Bidder Code rockyou Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rockyou hb_bidder_rockyou hb_adid_rockyou
hb_size_rockyou hb_source_rockyou hb_format_rockyou
hb_cache_host_rockyo hb_cache_id_rockyou hb_uuid_rockyou

"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

Rtbdemand bidder

Features

Bidder Code rtbdemand Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rtbdemand hb_bidder_rtbdemand hb_adid_rtbdemand
hb_size_rtbdemand hb_source_rtbdemand hb_format_rtbdemand
hb_cache_host_rtbdem hb_cache_id_rtbdeman hb_uuid_rtbdemand

"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

Features

Bidder Code rtbdemandadk Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rtbdemandadk hb_bidder_rtbdemanda hb_adid_rtbdemandadk
hb_size_rtbdemandadk hb_source_rtbdemanda hb_format_rtbdemanda
hb_cache_host_rtbdem hb_cache_id_rtbdeman hb_uuid_rtbdemandadk

"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

Features

Bidder Code rtbhouse Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rtbhouse hb_bidder_rtbhouse hb_adid_rtbhouse
hb_size_rtbhouse hb_source_rtbhouse hb_format_rtbhouse
hb_cache_host_rtbhou hb_cache_id_rtbhouse hb_uuid_rtbhouse

"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
bidfloor optional Minimal CPM value 0.01 float

Rubicon Project

Features

Bidder Code rubicon Prebid.org Member yes
Media Types display, video GDPR Support yes
User IDs unifiedId/tradedesk, digitrust COPPA Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rubicon hb_bidder_rubicon hb_adid_rubicon
hb_size_rubicon hb_source_rubicon hb_format_rubicon
hb_cache_host_rubico hb_cache_id_rubicon hb_uuid_rubicon

"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 the AdUnit’s mediaTypes.banner.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"} object

Video

The following video parameters are supported:

Name Scope Description Example Type
playerWidth optional Video player width in pixels. If not specified, takes width set in mediaTypes.video.playerSize '640' string
playerHeight optional Video player height in pixels. If not specified, takes height set in mediaTypes.video.playerSize '360' string
size_id optional Integer indicating the Rubicon Project video ad format ID. If not set, infers from mediaTypes.video.context 201 integer
language recommended 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

For Prebid.js 2.5 and later, the Rubicon Project adapter for video requires more parameters in the AdUnit’s mediaTypes.video definition than required for version 2.4 and earlier. We are requiring these parameters for publishers to fully declare their video inventory to be transparent to bidders, getting the best chance at a high value and technically compatible bid. Specifically, we’re requiring: mimes, protocols, maxduration, linearity, and api. See the example below.

Here’s a video example for Prebid.js 2.5 or later:

var videoAdUnit = {
    code: 'myVideoAdUnit',
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [640, 480],
            mimes: ['video/mp4', 'video/x-ms-wmv']
            protocols: [2,5],
            maxduration:30,
            linearity: 1,
            api: [2]
        }
    },
    bids: [{
        bidder: 'rubicon',
        params: {
            accountId: '7780',
            siteId: '87184',
            zoneId: '413290',
            video: {
                language: 'en'
            }
        }
    }]
};

This example adunit will also work Prebid.js 2.4 and earlier, but mimes, protocols, maxduration, linearity, and api are not required.

We recommend discussing video demand with your Rubicon Project account representative.

Lists of api, protocol, and linearity values are in the OpenRTB 2.5 documentation, copied here for convenience:

api
  • 1 : VPAID 1.0
  • 2 : VPAID 2.0
  • 3 : MRAID 1.0
  • 4 : ORMMA
  • 5 : MRAID 2.0
  • 6 : MRAID 3.0
linearity
  • 1 : Linear / In-Stream
  • 2 : Non-Linear / Overlay
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

Outstream Video

Rubicon Project supports outstream video with these restrictions:

  • The publisher must provide their own renderer.
  • Rubicon Project does not make concurrent banner and video requests. The Rubicon adapter will send a video request if bids[].params.video is supplied, else a banner request will be made.

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

Features

Bidder Code rxrtb Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rxrtb hb_bidder_rxrtb hb_adid_rxrtb
hb_size_rxrtb hb_source_rxrtb hb_format_rxrtb
hb_cache_host_rxrtb hb_cache_id_rxrtb hb_uuid_rxrtb

"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

Features

Bidder Code sara Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sara hb_bidder_sara hb_adid_sara
hb_size_sara hb_source_sara hb_format_sara
hb_cache_host_sara hb_cache_id_sara hb_uuid_sara

"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

seedtag

Features

Bidder Code seedtag Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_seedtag hb_bidder_seedtag hb_adid_seedtag
hb_size_seedtag hb_source_seedtag hb_format_seedtag
hb_cache_host_seedta hb_cache_id_seedtag hb_uuid_seedtag

"Deal ID" Ad Server Key

hb_deal_seedtag

Note

Please reach out to your seedtag account team before using this plugin.
The publisher id 0000-0000-01 returns demo responses.

Bid Params

Name Scope Description Example Type
publisherId required The publisher id. 0000-0000-01 string
adunitId required The adunit id. 00000 string
placement required Adunit placement, posibles values: banner, video, inImage, inScreen banner string
adPosition optional 0 - Below the Fold, 1 - Above the Fold 0 number
video optional for video Video targeting parameters. See the video section below. {} object

Video Param

All parameters are optional and correspond to the the OpenRTB 2.5 specification.

Name Example
mimes [‘video/mp4’]
minduration 5
maxduration 60
boxingallowed 1
skip 1
startdelay 1
linearity 1
battr [1, 2]
maxbitrate 10
playbackmethod [1]
delivery [1]
placement 1
const adUnits = [
  {
    code: '/21804003197/prebid_test_300x250',
    mediaTypes: {
      banner: {
        sizes: [[300, 250]]
      }
    },
    bids: [
      {
        bidder: 'seedtag',
        params: {
          publisherId: '0000-0000-01',      // required
          adUnitId: '0000',                 // required
          placement: 'banner',              // required
          adPosition: 0                     // optional
        }
      }
    ]
  }
]

Video InStream Example

var adUnits = [{
  code: 'video',
  mediaTypes: {
    video: {
      context: 'instream',   // required
      playerSize: [600, 300] // required
    }
  },
  bids: [
    {
      bidder: 'seedtag',
      params: {
        publisherId: '0000-0000-01',    // required
        adUnitId: '0000',               // required
        placement: 'video',             // required
        adPosition: 0,                  // optional
        // Video object as specified in OpenRTB 2.5
        video: {
          mimes: ['video/mp4'],         // recommended
          minduration: 5,               // optional
          maxduration: 60,              // optional
          boxingallowed: 1,             // optional
          skip: 1,                      // optional
          startdelay: 1,                // optional
          linearity: 1,                 // optional
          battr: [1, 2],                // optional
          maxbitrate: 10,               // optional
          playbackmethod: [1],          // optional
          delivery: [1],                // optional
          placement: 1,                 // optional
        }
      }
    }
  ]
}];

SekindoUM

Features

Bidder Code sekindoUM Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sekindoUM hb_bidder_sekindoUM hb_adid_sekindoUM
hb_size_sekindoUM hb_source_sekindoUM hb_format_sekindoUM
hb_cache_host_sekind hb_cache_id_sekindoU hb_uuid_sekindoUM

"Deal ID" Ad Server Key

hb_deal_sekindoUM

Bid Params

Name Scope Description Example Type
spaceId required     string

Serverbid

Features

Bidder Code serverbid Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_serverbid hb_bidder_serverbid hb_adid_serverbid
hb_size_serverbid hb_source_serverbid hb_format_serverbid
hb_cache_host_server hb_cache_id_serverbi hb_uuid_serverbid

"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

Features

Bidder Code sharethrough Prebid.org Member no
Media Types display, native GDPR Support yes
User IDs unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sharethrough hb_bidder_sharethrou hb_adid_sharethrough
hb_size_sharethrough hb_source_sharethrou hb_format_sharethrou
hb_cache_host_sharet hb_cache_id_sharethr hb_uuid_sharethrough

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

ShowHeroes

Features

Bidder Code showheroes-bs Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_showheroes-bs hb_bidder_showheroes hb_adid_showheroes-b
hb_size_showheroes-b hb_source_showheroes hb_format_showheroes
hb_cache_host_showhe hb_cache_id_showhero hb_uuid_showheroes-b

"Deal ID" Ad Server Key

hb_deal_showheroes-b

bid params

Name Scope Description Example Type
playerId required ShowHeroes player ID '0151f985-fb1a-4f37-bb26-cfc62e43ec05' string
vpaidMode optional Vpaid wrapper; default: false. true boolean

Slimcut

Features

Bidder Code slimcut Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_slimcut hb_bidder_slimcut hb_adid_slimcut
hb_size_slimcut hb_source_slimcut hb_format_slimcut
hb_cache_host_slimcu hb_cache_id_slimcut hb_uuid_slimcut

"Deal ID" Ad Server Key

hb_deal_slimcut

Overview

This documentation covers the parameters for the SlimCut bidder adapter. And is intended to be referenced by publishers using prebid 1.0 and later.

Bid Params

Only placementId is required and will be sent to you by your SlimCut account manager.

Example Ad Unit

var adUnit = {
    "code": "scm_outstream",
    "mediaTypes": {
        "video": {
            "playerSize": [640, 480],
            "context": "instream"
        }
    },
    "bids": [{
        "bidder": "slimcut",
        "params": {
            "placementId": 5015
        }
    }]
}

Smart AdServer

Features

Bidder Code smartadserver Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartadserver hb_bidder_smartadser hb_adid_smartadserve
hb_size_smartadserve hb_source_smartadser hb_format_smartadser
hb_cache_host_smarta hb_cache_id_smartads hb_uuid_smartadserve

"Deal ID" Ad Server Key

hb_deal_smartadserve

Note:

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

Bid params

Name Scope Description Example Type
siteId required The placement site ID 1234 integer
pageId required The placement page ID 1234 integer
formatId required The placement format ID 1234 integer
domain optional The network domain (default see example) 'http://prg.smartadserver.com', 'https://prg.smartadserver.com' string
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 AdServer user ID 1234567890123456789 integer

SmartRTB

Features

Bidder Code smartrtb Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartrtb hb_bidder_smartrtb hb_adid_smartrtb
hb_size_smartrtb hb_source_smartrtb hb_format_smartrtb
hb_cache_host_smartr hb_cache_id_smartrtb hb_uuid_smartrtb

"Deal ID" Ad Server Key

hb_deal_smartrtb

Bid Params

Name Scope Description Example Type
pubId required   231 number
medId required   'm_00a95d003340dbb2fcb8ee668a84fa' string
zoneId required   'z_261b6c7e7d4d4985393b293cc903d1' string

SmartyAds

Features

Bidder Code smartyads Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartyads hb_bidder_smartyads hb_adid_smartyads
hb_size_smartyads hb_source_smartyads hb_format_smartyads
hb_cache_host_smarty hb_cache_id_smartyad hb_uuid_smartyads

"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

SmileWanted

Features

Bidder Code smilewanted Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smilewanted hb_bidder_smilewante hb_adid_smilewanted
hb_size_smilewanted hb_source_smilewante hb_format_smilewante
hb_cache_host_smilew hb_cache_id_smilewan hb_uuid_smilewanted

"Deal ID" Ad Server Key

hb_deal_smilewanted

Note

To use us as a bidder you must have an account and an active “zoneId” on our SmileWanted platform.

Test zoneId

zoneId: 1

This zoneId will always deliver an ad, a SmileWanted creation with a price of requested CPM, which offer you to test and to win every auctions. (Please note that impressions and revenues of this test zone this will not be recorded and not be paid)

Bid params

Name Scope Description Example Type
zoneId required The placement zone ID 350975 integer

Somo Audience

Features

Bidder Code somoaudience Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_somoaudience hb_bidder_somoaudien hb_adid_somoaudience
hb_size_somoaudience hb_source_somoaudien hb_format_somoaudien
hb_cache_host_somoau hb_cache_id_somoaudi hb_uuid_somoaudience

"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

Features

Bidder Code sonobi Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs pubCommon, unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sonobi hb_bidder_sonobi hb_adid_sonobi
hb_size_sonobi hb_source_sonobi hb_format_sonobi
hb_cache_host_sonobi hb_cache_id_sonobi hb_uuid_sonobi

"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

You *must only include one ID field - either placement_id or ad_unit, not both. If you have questions on which parameter to use, please reach out to your Account Manager.

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

Features

Bidder Code sortable Prebid.org Member yes
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sortable hb_bidder_sortable hb_adid_sortable
hb_size_sortable hb_source_sortable hb_format_sortable
hb_cache_host_sortab hb_cache_id_sortable hb_uuid_sortable

"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

Features

Bidder Code sovrn Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sovrn hb_bidder_sovrn hb_adid_sovrn
hb_size_sovrn hb_source_sovrn hb_format_sovrn
hb_cache_host_sovrn hb_cache_id_sovrn hb_uuid_sovrn

"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

Features

Bidder Code spotx Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_spotx hb_bidder_spotx hb_adid_spotx
hb_size_spotx hb_source_spotx hb_format_spotx
hb_cache_host_spotx hb_cache_id_spotx hb_uuid_spotx

"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
ad_unit required Token that describes which ad unit to play: instream or outstream 'outstream' string
outstream_function optional Custom function to be used as a renderer. function(bid){console.log(bid);} function
outstream_options optional Object to set options on the renderer. See outstream_options Object {} object
secure optional Boolean identifying whether the reqeusts should be https or not (used to override the protocol if the page isn’t secure. true boolean
mimes optional List of mimetypes to allow in ad. ['application/javascript', 'video/mp4', 'video/webm'] array
ad_volume optional Value between 0 and 1 to denote the volume the ad should start at   float
price_floor optional Set the current channel price floor in real time. 10 integer
hide_skin optional Set to true to hide the spotx skin   boolean
custom optional See SpotX documentation here   object

outstream_options Object

Name Scope Description Example Type
slot required ID of element that video ad should be rendered into. 'adSlot1' string
ad_mute optional Set to true to start the ad with the volume muted. true boolean
playersize_auto_adapt optional Set to true to make video auto-adapt to the ad’s dimensions true boolean
in_iframe optional ID of iFrame element to insert EASI script tag. 'iframe1' string
custom_override optional Object of script tag attributes to override from the list here: EASI Attributes. (Note: Exclude data-spotx_ from attribute name; channel_id, vast_url, content_page_url, and ad_unit overrides are ignored.) {content_height: 300, content_width: 400} object

StickyAdsTv

Features

Bidder Code stickyadstv Prebid.org Member no
Media Types display, native GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_stickyadstv hb_bidder_stickyadst hb_adid_stickyadstv
hb_size_stickyadstv hb_source_stickyadst hb_format_stickyadst
hb_cache_host_sticky hb_cache_id_stickyad hb_uuid_stickyadstv

"Deal ID" Ad Server Key

hb_deal_stickyadstv

Stv

Features

Bidder Code stv Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_stv hb_bidder_stv hb_adid_stv
hb_size_stv hb_source_stv hb_format_stv
hb_cache_host_stv hb_cache_id_stv hb_uuid_stv

"Deal ID" Ad Server Key

hb_deal_stv

Bid Params

Name Scope Description Example Type
placement required Placement ID from stv. 'prer0-0%3D4137' string
pfilter optional Selection filter. See here for more details. {min_duration:1} object
noskip optional No skip flag: 0 - false, 1 - true 1 integer

Supply2

Features

Bidder Code supply2 Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_supply2 hb_bidder_supply2 hb_adid_supply2
hb_size_supply2 hb_source_supply2 hb_format_supply2
hb_cache_host_supply hb_cache_id_supply2 hb_uuid_supply2

"Deal ID" Ad Server Key

hb_deal_supply2

Bid Params

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

Synacor Media

Features

Bidder Code synacormedia Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_synacormedia hb_bidder_synacormed hb_adid_synacormedia
hb_size_synacormedia hb_source_synacormed hb_format_synacormed
hb_cache_host_synaco hb_cache_id_synacorm hb_uuid_synacormedia

"Deal ID" Ad Server Key

hb_deal_synacormedia

Note

The Synacor Media bidder adapter requires setup and approval from Synacor. Please reach out to your account manager for more information and to start using it.

Configuration

Synacor Media requires that iframe is used for user syncing.

Example configuration:

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

To use video, setup a VAST redirect creative within Google Ad Manager (formerly DFP) with the following VAST tag URL:

https://track.technoratimedia.com/openrtb/tags?ID=%%PATTERN:hb_cache_id_synacorm%%&AUCTION_PRICE=%%PATTERN:hb_pb_synacormedia%%

Bid params

Name Scope Description Example Type
seatId required The seat ID from Synacor Media. This will be the same for all ad units. 'prebid' string
placementId required The placement ID from Synacor Media. 'demo1' string
bidfloor optional The floor price for the request. 0.1 float
pos optional The position of the placement on the page, see Open RTB spec v2.5. 0 int
video optional Optional properties specific to video, see next table { } Object

Example Ad Unit

var adUnits = [{
    "code": "test-div",
    "mediaTypes": {
        "video": {
            "playerSize": [300, 250],
            "context": "instream"
        }
    },
    "bids": [{
        "bidder": "synacormedia",
        "params": {
            "seatId": "prebid",
            "placementId": "demo1",
            "bidfloor": 0.20,
            "pos": 1,
            "video": {
                "minduration": 15,
                "maxduration": 30,
                "startdelay": 1,
                "linearity": 1
            }
        }
    }]
}]

Video Parameters (see OpenRTB 2.5 spec, all are optional)

Name Scope Description Default Type
minduration optional Minimum ad duration in seconds 2 int
maxduration optional Maximum ad duration in seconds 60 int
startdelay optional Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. 0 int
placement optional Placement type for the impression. null int
linearity optional Indicates if the impression must be linear, nonlinear, etc. 1 int
mimes optional Content MIME types supported. ["video/mp4", "application/javascript"] Array(String)
protocols optional Array of supported video protocols. [1,2,3,4,5,6,7] Array(int)
api optional List of supported API frameworks for this impression. [1,2] Array(int)
playbackmethod optional Single element array with supported playback methods for this video impression. If multiple values are supplied, first element will be used. [1] Array(int)

TapHype

Features

Bidder Code taphype Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_taphype hb_bidder_taphype hb_adid_taphype
hb_size_taphype hb_source_taphype hb_format_taphype
hb_cache_host_taphyp hb_cache_id_taphype hb_uuid_taphype

"Deal ID" Ad Server Key

hb_deal_taphype

Note:

The TapHype adaptor requires setup and approval from your TapHype account manager. Please reach out to your account manager to enable Prebid.js for your account.

Bid Params

Name Scope Description Example Type
placementId required The placement ID from TapHype. 12345 integer

Teads

Features

Bidder Code teads Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_teads hb_bidder_teads hb_adid_teads
hb_size_teads hb_source_teads hb_format_teads
hb_cache_host_teads hb_cache_id_teads hb_uuid_teads

"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

Features

Bidder Code telaria Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_telaria hb_bidder_telaria hb_adid_telaria
hb_size_telaria hb_source_telaria hb_format_telaria
hb_cache_host_telari hb_cache_id_telaria hb_uuid_telaria

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

Telaria Prebid Example

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

TheAdx

Features

Bidder Code theadx Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_theadx hb_bidder_theadx hb_adid_theadx
hb_size_theadx hb_source_theadx hb_format_theadx
hb_cache_host_theadx hb_cache_id_theadx hb_uuid_theadx

"Deal ID" Ad Server Key

hb_deal_theadx

Bid Params

Name Scope Description Example Type
pid required Publisher GUID from TheAdx.com '1000' int
wid required Web Site ID from TheAdx.com '2000' int
tagId required Tag ID from TheAdx.com '3000' int

Tim Media

Features

Bidder Code tim Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_tim hb_bidder_tim hb_adid_tim
hb_size_tim hb_source_tim hb_format_tim
hb_cache_host_tim hb_cache_id_tim hb_uuid_tim

"Deal ID" Ad Server Key

hb_deal_tim

Bid Params

Name Scope Description Example Type
placementCode required   ‘testcode’ string
publisherid required   ‘testid’ string
bidfloor optional   1 number

Trafficroots

Features

Bidder Code trafficroots Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trafficroots hb_bidder_trafficroo hb_adid_trafficroots
hb_size_trafficroots hb_source_trafficroo hb_format_trafficroo
hb_cache_host_traffi hb_cache_id_trafficr hb_uuid_trafficroots

"Deal ID" Ad Server Key

hb_deal_trafficroots

Bid Params

Name Scope Description Example Type
zoneId required The Trafficroots zone ID 'aa0444af31' string
deliveryUrl optional The bid endpoint (might be used for debug) 'https://service.trafficroots.com/prebid' string

Tremor

Features

Bidder Code tremor Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_tremor hb_bidder_tremor hb_adid_tremor
hb_size_tremor hb_source_tremor hb_format_tremor
hb_cache_host_tremor hb_cache_id_tremor hb_uuid_tremor

"Deal ID" Ad Server Key

hb_deal_tremor

Bid Params

Name Scope Description Example Type
adCode required The Ad Code from Tremor. 'ssp-!demo!-lufip' String
supplyCode required The Supply Code from Tremor. 'ssp-%21demo%21-rm6rh' String
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 Integer
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 Integer
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 Integer
mediaUrl optional The URL to the content video source. 'http://www.mycms.com/myhostedvideo.mp4' String
mediaTitle optional The title of the content video aligned with the ad opportunity. 'Description of the content video' String
contentLength optional The length of the content video in seconds. 120 Integer
srcPageUrl optional The url of the page where the video ad will be displayed. 'http://www.mysite.com/my-content-page/' String
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' String
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' String
custom optional Any custom value that will be later be available for reporting. 'myCustomValue' String
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' String
srcRelationship optional Describes the relationship between the content owner and the requestor of the ad opportunity. 1 for “direct”, 0 for “indirect” 1 Integer
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' String
skip optional Is the video skippable? True or false. 1/T/Y is true and 0/F/N/null is false. '1' Character
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 Integer
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 Integer
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' String
placement optional Integer value of placement type. See below as well as RTB 2.5 specification for valid values. 1 Integer
videoMinBitrate optional Minimum bitrate in kbps 400 Integer
videoMaxBitrate optional Maximum bitrate in kbps 800 Integer
minDur optional Minimum duration for an ad in seconds 15 Integer
maxDur optional Maximum duration for an ad in seconds 60 Integer

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

Features

Bidder Code trion Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trion hb_bidder_trion hb_adid_trion
hb_size_trion hb_source_trion hb_format_trion
hb_cache_host_trion hb_cache_id_trion hb_uuid_trion

"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

Features

Bidder Code triplelift Prebid.org Member no
Media Types display GDPR Support yes
User IDs unifiedId/tradedesk COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_triplelift hb_bidder_triplelift hb_adid_triplelift
hb_size_triplelift hb_source_triplelift hb_format_triplelift
hb_cache_host_triple hb_cache_id_tripleli hb_uuid_triplelift

"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

Features

Bidder Code trustx Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trustx hb_bidder_trustx hb_adid_trustx
hb_size_trustx hb_source_trustx hb_format_trustx
hb_cache_host_trustx hb_cache_id_trustx hb_uuid_trustx

"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

ucfunnel

Features

Bidder Code ucfunnel Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ucfunnel hb_bidder_ucfunnel hb_adid_ucfunnel
hb_size_ucfunnel hb_source_ucfunnel hb_format_ucfunnel
hb_cache_host_ucfunn hb_cache_id_ucfunnel hb_uuid_ucfunnel

"Deal ID" Ad Server Key

hb_deal_ucfunnel

Bid params

Name Scope Description Example Type
adid required The ad unit ID retrived from ucfunnel dashboard   string
var adUnits = [{
    code: 'div-gpt-ad-1460505748511-01',
    sizes: [
        [300, 250]
    ],
    bids: [{
        bidder: 'ucfunnel',
        params: {
            adid: '123456789'
        }
    }]
}]

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

Examples

Underdog Media

Features

Bidder Code underdogmedia Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_underdogmedia hb_bidder_underdogme hb_adid_underdogmedi
hb_size_underdogmedi hb_source_underdogme hb_format_underdogme
hb_cache_host_underd hb_cache_id_underdog hb_uuid_underdogmedi

"Deal ID" Ad Server Key

hb_deal_underdogmedi

Bid Params

Name Scope Description Example Type
siteId required     string

Undertone

Features

Bidder Code undertone Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_undertone hb_bidder_undertone hb_adid_undertone
hb_size_undertone hb_source_undertone hb_format_undertone
hb_cache_host_undert hb_cache_id_underton hb_uuid_undertone

"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

Configuration

To maximize revenue efficiency, please enable iframe-based user syncing. This functionality will improve user match rates and will help increasing the bid rate.

Example code to enable iframe user-sync for Undertone:

pbjs.setConfig({
  userSync: {
    filterSettings: {
      iframe: {
        bidders: ['undertone'],
        filter: 'include'
      }
    }
  }
});

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.

Unruly

Features

Bidder Code unruly Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_unruly hb_bidder_unruly hb_adid_unruly
hb_size_unruly hb_source_unruly hb_format_unruly
hb_cache_host_unruly hb_cache_id_unruly hb_uuid_unruly

"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

Features

Bidder Code uol Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_uol hb_bidder_uol hb_adid_uol
hb_size_uol hb_source_uol hb_format_uol
hb_cache_host_uol hb_cache_id_uol hb_uuid_uol

"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

Features

Bidder Code vertamedia Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vertamedia hb_bidder_vertamedia hb_adid_vertamedia
hb_size_vertamedia hb_source_vertamedia hb_format_vertamedia
hb_cache_host_vertam hb_cache_id_vertamed hb_uuid_vertamedia

"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

Features

Bidder Code vertoz Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vertoz hb_bidder_vertoz hb_adid_vertoz
hb_size_vertoz hb_source_vertoz hb_format_vertoz
hb_cache_host_vertoz hb_cache_id_vertoz hb_uuid_vertoz

"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

Features

Bidder Code vi Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vi hb_bidder_vi hb_adid_vi
hb_size_vi hb_source_vi hb_format_vi
hb_cache_host_vi hb_cache_id_vi hb_uuid_vi

"Deal ID" Ad Server Key

hb_deal_vi

bid params

Name Scope Description Example
pubId required Publisher ID, provided by vi ‘sb_test’
lang required Ad language, in ISO 639-1 language code format ‘en-US’, ‘es-ES’, ‘de’
cat required Ad IAB category (top-level or subcategory), single one supported ‘IAB1’, ‘IAB9-1’
bidFloor optional Lowest value of expected bid price 0.001
useSizes optional Specifies from which section of the config sizes are taken, possible values are ‘banner’, ‘video’. If omitted, sizes from both sections are merged. ‘banner’

Vidazoo

Features

Bidder Code vidazoo Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vidazoo hb_bidder_vidazoo hb_adid_vidazoo
hb_size_vidazoo hb_source_vidazoo hb_format_vidazoo
hb_cache_host_vidazo hb_cache_id_vidazoo hb_uuid_vidazoo

"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

Video Reach

Features

Bidder Code videoreach Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_videoreach hb_bidder_videoreach hb_adid_videoreach
hb_size_videoreach hb_source_videoreach hb_format_videoreach
hb_cache_host_videor hb_cache_id_videorea hb_uuid_videoreach

"Deal ID" Ad Server Key

hb_deal_videoreach

Bid Params

Name Scope Description Example Type
TagId required Video Reach Tag Id - provided by your account manager 'ABCDE' string

Viewdeos

Features

Bidder Code viewdeos Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_viewdeos hb_bidder_viewdeos hb_adid_viewdeos
hb_size_viewdeos hb_source_viewdeos hb_format_viewdeos
hb_cache_host_viewde hb_cache_id_viewdeos hb_uuid_viewdeos

"Deal ID" Ad Server Key

hb_deal_viewdeos

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner '12345' string

VIS.X

Features

Bidder Code visx Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_visx hb_bidder_visx hb_adid_visx
hb_size_visx hb_source_visx hb_format_visx
hb_cache_host_visx hb_cache_id_visx hb_uuid_visx

"Deal ID" Ad Server Key

hb_deal_visx

Note

To be able to use the full bandwidth of VIS.X high impact ad products, we strongly recommend disabling SafeFrames:

  • If you are using Google Ad Manager (GAM), make sure the “Serve in Safeframe” box in creative settings is unchecked,
  • If you are using AppNexus Seller Tag, make sure the enableSafeFrame parameter is set to False.

If you require SafeFrames to be activated, please reach out to your YOC account manager to obtain further details.

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

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.

VMG

Features

Bidder Code vmg Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vmg hb_bidder_vmg hb_adid_vmg
hb_size_vmg hb_source_vmg hb_format_vmg
hb_cache_host_vmg hb_cache_id_vmg hb_uuid_vmg

"Deal ID" Ad Server Key

hb_deal_vmg

Bid Params

Name Scope Description Example Type
(none) optional no params required '' n/a

Vuble

Features

Bidder Code vuble Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vuble hb_bidder_vuble hb_adid_vuble
hb_size_vuble hb_source_vuble hb_format_vuble
hb_cache_host_vuble hb_cache_id_vuble hb_uuid_vuble

"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

Features

Bidder Code weborama Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_weborama hb_bidder_weborama hb_adid_weborama
hb_size_weborama hb_source_weborama hb_format_weborama
hb_cache_host_webora hb_cache_id_weborama hb_uuid_weborama

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

Widespace

Features

Bidder Code widespace Prebid.org Member no
Media Types display GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_widespace hb_bidder_widespace hb_adid_widespace
hb_size_widespace hb_source_widespace hb_format_widespace
hb_cache_host_widesp hb_cache_id_widespac hb_uuid_widespace

"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

Features

Bidder Code xhb Prebid.org Member no
Media Types display, video, native GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_xhb hb_bidder_xhb hb_adid_xhb
hb_size_xhb hb_source_xhb hb_format_xhb
hb_cache_host_xhb hb_cache_id_xhb hb_uuid_xhb

"Deal ID" Ad Server Key

hb_deal_xhb

Bid Params

Name Scope Description Example Type
placementId required     string

Xendiz

Features

Bidder Code xendiz Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_xendiz hb_bidder_xendiz hb_adid_xendiz
hb_size_xendiz hb_source_xendiz hb_format_xendiz
hb_cache_host_xendiz hb_cache_id_xendiz hb_uuid_xendiz

"Deal ID" Ad Server Key

hb_deal_xendiz

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

Yieldbot

Features

Bidder Code yieldbot Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldbot hb_bidder_yieldbot hb_adid_yieldbot
hb_size_yieldbot hb_source_yieldbot hb_format_yieldbot
hb_cache_host_yieldb hb_cache_id_yieldbot hb_uuid_yieldbot

"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

Features

Bidder Code yieldlab Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldlab hb_bidder_yieldlab hb_adid_yieldlab
hb_size_yieldlab hb_source_yieldlab hb_format_yieldlab
hb_cache_host_yieldl hb_cache_id_yieldlab hb_uuid_yieldlab

"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
extId optional External Id 'abc' string

Yieldmo

Features

Bidder Code yieldmo Prebid.org Member no
Media Types display, native GDPR Support no
User IDs pubCommon COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldmo hb_bidder_yieldmo hb_adid_yieldmo
hb_size_yieldmo hb_source_yieldmo hb_format_yieldmo
hb_cache_host_yieldm hb_cache_id_yieldmo hb_uuid_yieldmo

"Deal ID" Ad Server Key

hb_deal_yieldmo

Bid Params

Name Scope Description Example Type
placementId required Yieldmo placement id '825209316101005155' string
bidFloor optional Bid Floor 0.1 float

Yield Nexus

Features

Bidder Code yieldnexus Prebid.org Member no
Media Types display, video GDPR Support yes
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldnexus hb_bidder_yieldnexus hb_adid_yieldnexus
hb_size_yieldnexus hb_source_yieldnexus hb_format_yieldnexus
hb_cache_host_yieldn hb_cache_id_yieldnex hb_uuid_yieldnexus

"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

YIELDONE

Features

Bidder Code yieldone Prebid.org Member no
Media Types display, video GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldone hb_bidder_yieldone hb_adid_yieldone
hb_size_yieldone hb_source_yieldone hb_format_yieldone
hb_cache_host_yieldo hb_cache_id_yieldone hb_uuid_yieldone

"Deal ID" Ad Server Key

hb_deal_yieldone

Note:

THE YIELDONE adapter requires setup and approval from the YIELDONE team. Please reach out to your account team or y1s@platform-one.co.jp for more information.

Bid Params

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

ZEDO

Features

Bidder Code zedo Prebid.org Member no
Media Types display GDPR Support no
User IDs none COPPA Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_zedo hb_bidder_zedo hb_adid_zedo
hb_size_zedo hb_source_zedo hb_format_zedo
hb_cache_host_zedo hb_cache_id_zedo hb_uuid_zedo

"Deal ID" Ad Server Key

hb_deal_zedo

Bid Params

Name Scope Description Example Type
channelCode required Publisher code associated with ZEDO 2264004118 integer
dimId required ZEDO dimension Id associated with the adunit 9 integer
pubId optional ZEDO Publisher Id associated with the adunit 0 integer