Prebid.js 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:

Features A table of features supported by the adapter.
“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
Bid Params Ad request parameters required by a given bidder, such as the tag ID, site ID, or query string parameters

You can also download the full CSV data file.

Bidder List

Bidder Documentation

1ad4good

Features

Bidder Code 1ad4good Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_1ad4good hb_bidder_1ad4good hb_adid_1ad4good
hb_size_1ad4good hb_source_1ad4good hb_format_1ad4good
hb_cache_host_1ad4go hb_cache_id_1ad4good hb_uuid_1ad4good
hb_cache_path_1ad4go hb_deal_1ad4good  

Note:

This adapter is for displaying free ads for various not profits. You can find more info at [1ad4good.org])(http://1ad4good.org).

Bid Params

Name Scope Description Example Type
placementId required Meaningless, but required id 234234 integer
cpm optional forces bidder to insert custom cpm bid 0.50 decimal

33Across

Features

Bidder Code 33across Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_33acro 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

7xbid

Features

Bidder Code 7xbid Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_7xbid hb_bidder_7xbid hb_adid_7xbid
hb_size_7xbid hb_source_7xbid hb_format_7xbid
hb_cache_host_7xbid hb_cache_id_7xbid hb_uuid_7xbid
hb_cache_path_7xbid hb_deal_7xbid  

Bid Params

Name Scope Description Example Type
placementId required This is placement Id 1425292 integer
currency optional 3-letter ISO 4217 code defining the currency of the bid (currently support USD and JPY), default is JPY 'USD' string

9 Media Online

Features

Bidder Code 9MediaOnline Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_9MediaOnline hb_bidder_9MediaOnli hb_adid_9MediaOnline
hb_size_9MediaOnline hb_source_9MediaOnli hb_format_9MediaOnli
hb_cache_host_9Media hb_cache_id_9MediaOn hb_uuid_9MediaOnline
hb_cache_path_9Media hb_deal_9MediaOnline  

Bid params

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

SafeReach

Features

Bidder Code safereach Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_safere 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_a4g 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 TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 52 Prebid Server Adapter 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
hb_cache_path_aardva 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

ablida

Features

Bidder Code ablida Prebid.org Member no
Media Types display, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_ablida hb_bidder_ablida hb_adid_ablida
hb_size_ablida hb_source_ablida hb_format_ablida
hb_cache_host_ablida hb_cache_id_ablida hb_uuid_ablida
hb_cache_path_ablida hb_deal_ablida  

Bid Params

Name Scope Description Example Type
placementId required The placement ID provided by ablida '1234567' string
categories optional IAB 2.0 category names of page ['automotive', 'news-and-politics'] Array<string>

Adagio

Features

Bidder Code adagio Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 617 Prebid Server Adapter 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
hb_cache_path_adagio hb_deal_adagio  

Note

The Adagio bidder adaptor requires setup and approval from the Adagio team. Please reach out to contact@adagio.io for more information.

Bid Params

Important: Adagio needs to collect attention data about the ads displayed on a page and must listen to some specifics ad-server events. Please refer to the Adagio user guide for details.

Name Scope Description Example Type
organizationId required Id of the Organization. Handed out by Adagio. '1010' string
site required Name of the site. Handed out by Adagio.
- max length: 50
'mysite-com' string
placement* required Refers to the placement of an adunit in a page.
Must not contain any information about the type of device.
- max length: 30
- max distinctives values: 10
'ban_atf' string
adUnitElementId required Refers to the adunit html attribute id in a page. 'gpt-ban-atf' string
pagetype* highly recommended Describes what kind of content will be present in the page.
- max length: 30
- max distinctives values: 50
'article' string
environment* recommended Environment where the page is displayed.
- max length: 30
- max distinctives values: 10
'desktop' string
category* recommended Category of the content displayed in the page.
- max length: 30
- max distinctives values: 50
'sport' string
subcategory* optional Subcategory of the content displayed in the page.
- max length: 30
- max distinctives values: 50
'handball' string
postBid optional Used in Post-Bid context only. true boolean

*These parameters will have its accentuated characters converted to their non-accentuated version: é => e

Adasta Media

Features

Bidder Code adasta Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adasta hb_bidder_adasta hb_adid_adasta
hb_size_adasta hb_source_adasta hb_format_adasta
hb_cache_host_adasta hb_cache_id_adasta hb_uuid_adasta
hb_cache_path_adasta hb_deal_adasta  

Bid Params

Name Scope Description Example Type
placementId required     string

Adasta Media is an aliased bidder for AppNexus

AdButler

Features

Bidder Code adbutler Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adbutl 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
extra optional Pass other AdButler parameters like ‘tuid’ or ‘kw’ {kw: "green"} object

Adfinity

Features

Bidder Code adfinity Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adfinity hb_bidder_adfinity hb_adid_adfinity
hb_size_adfinity hb_source_adfinity hb_format_adfinity
hb_cache_host_adfini hb_cache_id_adfinity hb_uuid_adfinity
hb_cache_path_adfini hb_deal_adfinity  

Bid Params

Name Scope Description Example Type
placement_id required Placement Id will be generated on Adfinity Platform. 0 integer
traffic optional Type traffic 'banner' string

AdformOpenRTB

Features

Bidder Code adformOpenRTB Prebid.org Member yes
Media Types native GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 50 Prebid Server Adapter 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
hb_cache_path_adform 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

Adform

Features

Bidder Code adform Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 50 Prebid Server Adapter 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
hb_cache_path_adform hb_deal_adform  

Bid Params

Name Scope Description Example Type
mid required   12345 integer
adxDomain optional The Adform domain 'adx.adform.net' string
priceType optional An expected price type (net or gross) of bids 'net' string
mkv optional Comma-separated key-value pairs 'city:NY' string
mkw optional Comma-separated keywords 'news,sport' string
minp optional Minimum CPM price 2.55 number
cdims optional Comma-separated creative dimentions '300x250' string
url optional Custom targeting URL 'https://some.app/?home' string

Note: Spaces are not allowed between comma-separated list values. For example:

// valid params
{
  mid: 12345,
  mkv: 'city:NY,city:London',
  mkv: 'news,sport',
  cdims: '300x250,250x300'
}
// invalid params
{
  mid: 12345,
  mkv: 'city:NY, city:London',
  mkv: 'news, sport',
  cdims: '300x250, 250x300'
}

Ad Generation

Features

Bidder Code adgeneration Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adgene hb_deal_adgeneration  

Bid Params

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

AdGlare Ad Server

Features

Bidder Code adglare Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adglare hb_bidder_adglare hb_adid_adglare
hb_size_adglare hb_source_adglare hb_format_adglare
hb_cache_host_adglar hb_cache_id_adglare hb_uuid_adglare
hb_cache_path_adglar hb_deal_adglare  

Bid Params

Name Scope Description Example Type
domain required Your (white label) ad serving domain 'try.engine.adglare.net' string
zID required The zone ID '475579334' string
type required The zone type 'banner' string

Adhese

Features

Bidder Code adhese Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 553 Prebid Server Adapter 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_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
hb_cache_path_adhese hb_deal_adhese  

Registration

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.

Prebid Server host companies need to work with Adhese for each additional publisher.

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, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adkern 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adkern 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adlive 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adman 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
placementId required Adman placement id '1234asdf' 'string'

AdMedia

Features

Bidder Code admedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_admedi 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_admixe hb_deal_admixer  

Bid Params

Name Scope Description Example Type
zone required     string

Adnuntius

Features

Bidder Code adnuntius Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adnuntius hb_bidder_adnuntius hb_adid_adnuntius
hb_size_adnuntius hb_source_adnuntius hb_format_adnuntius
hb_cache_host_adnunt hb_cache_id_adnuntiu hb_uuid_adnuntius
hb_cache_path_adnunt hb_deal_adnuntius  

Bid Params

Name Scope Description Example Type
auId required The ad unit ID '0000000000072345' leading zeros can be omitted. string  
network optional Used if you want to make requests to multiple networks in adnuntius. string  
targeting optional Targeting to be sent through to adnuntius with the request. string  

Targeting

The Adnuntius Documentation provides detailed information on sending targeting data to the Adnuntius adserver.

Example

Here’s an example of sending targeting information about categories to adnuntius via the bid request:

{
    code: "0000000000072345",
    mediaTypes: {
        banner: {
            sizes: [[980, 360], [980, 300], [980, 240], [980, 120]]
        }
    },
    bids: [
        {
            bidder: "adnuntius",
            params: {
                auId: "8b6bc",
                network: "adnuntius",
                targeting: {
                    c: ['prebids']
                }
            }
        }
    ]
}

AdOcean

Features

Bidder Code adocean Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adocea hb_deal_adocean  

Note

The AdOcean bid adapter may require an additional setup from the AdOcean team. Please contact with your local Technical Support team or by visiting AdOcean website.

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

Adot

Features

Bidder Code adot Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adot hb_bidder_adot hb_adid_adot
hb_size_adot hb_source_adot hb_format_adot
hb_cache_host_adot hb_cache_id_adot hb_uuid_adot
hb_cache_path_adot hb_deal_adot  

Table of Contents

Adot Bid Params

Name Scope Description Example Type
placementId optional The placement ID from Adot. 'adot_placement_224521' string
position optional Specify the position of the ad as a relative measure of visibility or prominence. Allowed values: Unknown: 0 (default); Above the fold: 1 ; Below the fold: 3. 0 integer-
video required if the adUnit is a video Object containing video targeting parameters. See Video Object for details. video: { mimes: ['video/mp4'] } object

Adot Video Object

Name Scope Description Type
mimes required Array of strings listing the content MIME types supported, e.g., ['video/mp4']. Array<string>
minduration optional Integer that defines the minimum video ad duration in seconds. integer
maxduration optional Integer that defines the maximum video ad duration in seconds. integer
protocols required Array of supported video protocols, e.g., [2, 3] Array<integer>
container optional Selector used for finding the element in which the video player will be displayed, e.g., #div-1. The ad unit code will be used if no container is provided. string
instreamContext required if video.context is instream String used to define the type of instream video. Allowed values: Pre-roll: pre-roll; Mid-roll: mid-roll ; Post-roll: post-roll. string

AdPartner

Features

Bidder Code adpartner Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adpartner hb_bidder_adpartner hb_adid_adpartner
hb_size_adpartner hb_source_adpartner hb_format_adpartner
hb_cache_host_adpart hb_cache_id_adpartne hb_uuid_adpartner
hb_cache_path_adpart hb_deal_adpartner  

Bid Params

Name Scope Description Example Type
unitId required Unit ID. 5809 integer

Adpone

Features

Bidder Code adpone Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals no Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_adpone hb_deal_adpone  

Bid Params

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

Adprime

Features

Bidder Code adprime Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adprime hb_bidder_adprime hb_adid_adprime
hb_size_adprime hb_source_adprime hb_format_adprime
hb_cache_host_adprim hb_cache_id_adprime hb_uuid_adprime
hb_cache_path_adprim hb_deal_adprime  

Note:

The Adprime Bidding adapter requires setup before beginning. Please contact us at rafal@adprime.com

Bid Params

Name Scope Description Example Type
placementId required Adprime placement id '1234asdf' string
keywords optional page context keywords [‘car’,’sport’] array

adsolut

Features

Bidder Code adsolut Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adsolu 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adspar hb_deal_adsparc  

bid params

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

AdSpend

Features

Bidder Code adspend Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adspen 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adspir 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

Adtarget

Features

Bidder Code adtarget Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_adtarget hb_bidder_adtarget hb_adid_adtarget
hb_size_adtarget hb_source_adtarget hb_format_adtarget
hb_cache_host_adtarg hb_cache_id_adtarget hb_uuid_adtarget
hb_cache_path_adtarg hb_deal_adtarget  

Registration

To use the Adtarget bidder you will need an aid from an exchange account on https://adtarget.com.tr. For further information, please contact kamil@adtarget.com.tr.

Bid params

Name Scope Description Example Type
aid required The source ID from Adtarget platform. 331133 integer

Description

Provides a solution for accessing Video demand and display demand from Adtarget

Test Parameters

    var adUnits = [

      // Video adUnit
      {
        code: 'videoPlayer',
        mediaTypes: {
          video: {
            playerSize:[640,480]
            context: 'instream'
          }
        },
        bids: [{
          bidder: 'adtarget',
          params: {
            aid: 331133
          }
        }]
      },

      // Banner adUnit
      {
        code: 'bannerAd',
        mediaTypes: {
          banner: {
            sizes: [[300, 250]]
          }
        },
        bids: [{
          bidder: 'adtarget',
          params: {
            aid: 350975
          }
        }]
      }
    ];

Additional Configuration

It is possible to configure requests to be splitted in chunks to have less bid requests in single http request (default value is 10)

    pbjs.setBidderConfig({
        config: {              
            adtarget: {
                chunkSize: 1   // makes 1 http request per 1 adunit configured
            }
        }
    });

Adtelligent

Features

Bidder Code adtelligent Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 410 Prebid Server Adapter 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_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
hb_cache_path_adtell 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.

Adtelligent now supports adpod.

Test Parameters

    var adUnits = [

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

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

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

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

Additional Configuration

It is possible to configure requests to be split into chunks so as to have fewer bid requests in a single http request (default value is 10).

    pbjs.setBidderConfig({
        config: {              
            adtelligent: {
                chunkSize: 1   // makes 1 http request per 1 adunit configured
            }
        }
    });

AdUp Technology

Features

Bidder Code aduptech Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adupte hb_deal_aduptech  

Note:

The AdUp Technology bidding adapter requires setup and approval before beginning. For more information visit www.adup-tech.com or contact info@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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_advang 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_advenu 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 TCF1 Support yes
User IDs id5Id, identityLink, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adxcg 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_adyoul 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_aja 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']
  }
});

AMX RTB

Features

Bidder Code amx Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_amx hb_bidder_amx hb_adid_amx
hb_size_amx hb_source_amx hb_format_amx
hb_cache_host_amx hb_cache_id_amx hb_uuid_amx
hb_cache_path_amx hb_deal_amx  

Bid Params

Name Scope Description Example Type
testMode optional Activate 100% fill ads true boolean
tagId optional Tag ID 'cHJlYmlkLm9yZw' string
adUnitId optional Ad Unit ID used in reporting. Will default to bid.adUnitCode 'sticky_banner' string

Test Parameters

To enable 100% fill test ads, you can use the following params:

{
  testMode: true,
  tagId: "cHJlYmlkLm9yZw"
}

Note that the tagId is case-sensitive. This will produce a bid at $10 with a test creative.

andbeyond

Features

Bidder Code andbeyond Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_andbey 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_anivie 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

AOL

Features

Bidder Code aol Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 25 Prebid Server Adapter 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
hb_cache_path_aol 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_appier 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}'
    }
  });
});

AppierBR

Features

Bidder Code appierBR Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_appierBR hb_bidder_appierBR hb_adid_appierBR
hb_size_appierBR hb_source_appierBR hb_format_appierBR
hb_cache_host_appier hb_cache_id_appierBR hb_uuid_appierBR
hb_cache_path_appier hb_deal_appierBR  

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

AppierBR is an aliased bidder for Appier

AppierExt

Features

Bidder Code appierExt Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_appierExt hb_bidder_appierExt hb_adid_appierExt
hb_size_appierExt hb_source_appierExt hb_format_appierExt
hb_cache_host_appier hb_cache_id_appierEx hb_uuid_appierExt
hb_cache_path_appier hb_deal_appierExt  

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

AppierExt is an aliased bidder for Appier

AppierGM

Features

Bidder Code appierGM Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_appierGM hb_bidder_appierGM hb_adid_appierGM
hb_size_appierGM hb_source_appierGM hb_format_appierGM
hb_cache_host_appier hb_cache_id_appierGM hb_uuid_appierGM
hb_cache_path_appier hb_deal_appierGM  

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

AppierGM is an aliased bidder for Appier

AppNexus

Features

Bidder Code appnexus Prebid.org Member yes
Media Types display, video, native GDPR TCF1 Support yes
User IDs criteo, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 32 Prebid Server Adapter 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_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
hb_cache_path_appnex 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 string value. 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
publisherId optional The publisher ID from AppNexus. It is used by the AppNexus end point to identify the publisher when placementId is not provided and invCode goes wrong. The publisherId parameter can be either a string or integer for Prebid.js, however integer is preferred. 12345 integer
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. Note that to use keyword with the Prebid Server adapter, that feature must be enabled for your account by an AppNexus account manager. 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: unknown; Above the fold: above; Below the fold: below 'above' string
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
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
minduration Integer that defines the minimum video ad duration in seconds. integer
maxduration Integer that defines the maximum video ad duration in seconds. integer
context A string that indicates the type of video ad requested. Allowed values: "pre_roll"; "mid_roll"; "post_roll"; "outstream". string
skippable Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false. boolean
skipoffset Integer that defines the number of seconds until an ad can be skipped. Assumes skippable setting was set to true. integer
playback_method A string that sets the playback method supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown". 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; MRAID 2.0: 4; ORMMA: 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: ['']
}

User Sync in AMP

If you are syncing user id’s with Prebid Server and are using AppNexus’ managed service, use the following URL for the source:
https://acdn.adnxs.com/prebid/amp/user-sync/load-cookie.html

Mobile App Display Manager Version

The AppNexus endpoint expects imp.displaymanagerver to be populated for mobile app sources requests, however not all SDKs will populate this field. If the imp.displaymanagerver field is not supplied for an imp, but request.app.ext.prebid.source and request.app.ext.prebid.version are supplied, the adapter will fill in a value for diplaymanagerver. It will concatenate the two app fields as <source>-<version> fo fill in the empty displaymanagerver before sending the request to AppNexus.

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

Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Appnexus adapter. This example includes an imp object with an Appnexus test placement ID and sizes that would match with the test creative.

	"imp": [{
		"id": "some-impression-id",
		"banner": {
			"format": [{
				"w": 600,
				"h": 500
			}, {
				"w": 300,
				"h": 600
			}]
		},
		"ext": {
			"appnexus": {
				"placementId": 13144370
			}
		}
	}]

AP Stream

Features

Bidder Code apstream Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 394 Prebid Server Adapter 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_apstream hb_bidder_apstream hb_adid_apstream
hb_size_apstream hb_source_apstream hb_format_apstream
hb_cache_host_apstre hb_cache_id_apstream hb_uuid_apstream
hb_cache_path_apstre hb_deal_apstream  

Bid Params

Name Scope Description Example type
publisherId optional* Publisher Id will be generated on AP Stream. ‘1234’ string
code optional Ad code ‘S1_Leaderboard’ string
adunitId optional Ad unit Id 1234 integer
endpoint optional Endpoint for custom bidder ‘site.com/v1’ string
test optional* Use test endpoint true boolean
sendDsu optional Send DSU to bidder (default true) false boolean

* see description below

#

Bidder config

Here parameters test and publisherId can be set globally, but will be overrided if set in specific bid.

pbjs.setBidderConfig({
    bidders: ["apstream"],
    config: {
        appstream: {
            publisherId: '1234
            test: true
        }
    }
});

Arteebee

Features

Bidder Code arteebee Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_arteeb 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

AstraOne

Features

Bidder Code astraone Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_astraone hb_bidder_astraone hb_adid_astraone
hb_size_astraone hb_source_astraone hb_format_astraone
hb_cache_host_astrao hb_cache_id_astraone hb_uuid_astraone
hb_cache_path_astrao hb_deal_astraone  

Note

You can use this adapter to get a bid from AstraOne. Please reach out to your AstraOne account team before using this plugin to get placeId. The code below returns a demo ad.

Bid Params

Name Scope Description Example Type
placeId required The place id. ‘5af45ad34d506ee7acad0c26’ string
imageUrl required URL of the image on which the banner will be displayed. ‘https://creative.astraone.io/files/default_image-1-600x400.jpg’ string
placement required Adunit placement, possible values: inImage ‘inImage’ string

InImage Example page

<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title>Prebid.js Banner Example</title>
	<script async src="prebid.js"></script>
	<style>
        .banner-block {
            position: absolute;
            width: 100%;
            height: 100%;
            top: 0;
            left: 0;
            z-index: 1;
            border: none;
            overflow: hidden;
        }
    </style>
    <script>
        var adUnits = [{
            code: 'test-div',
            sizes: [1, 1],
            bids: [{
                bidder: "astraone",
                params: {
                    placement: "inImage",
                    placeId: "5af45ad34d506ee7acad0c26",
                    imageUrl: "https://creative.astraone.io/files/default_image-1-600x400.jpg"
                }
            }]
        }];

        var pbjs = pbjs || {};
        pbjs.que = pbjs.que || [];

        pbjs.que.push(function() {
            pbjs.addAdUnits(adUnits);
            pbjs.requestBids({
                bidsBackHandler: function (e) {
                    if (pbjs.adserverRequestSent) return;
                    pbjs.adserverRequestSent = true;

                    var params = pbjs.getAdserverTargetingForAdUnitCode("test-div");
                    var iframe = document.getElementById('test-div');

                    if (params && params['hb_adid']) {
                        iframe.parentElement.style.position = "relative";
                        iframe.style.display = "block";
                        pbjs.renderAd(iframe.contentDocument, params['hb_adid']);
                    }
                }
            });
        });
    </script>
</head>

<body>
	<h2>Prebid.js InImage Banner Test</h2>

	<div style="width: 600px;">
        <img src="https://creative.astraone.io/files/default_image-1-600x400.jpg" />
        <iframe id='test-div' class="banner-block" style="display: none;"></iframe>
    </div>
</body>

</html>

InImage Example page with GPT

<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title>Prebid.js Banner Example</title>
	<script async src="prebid.js"></script>
	<script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
	<style>
		.banner-block {
			position: absolute;
			width: 100%;
			height: 100%;
			top: 0;
			left: 0;
			z-index: 1;
			border: none;
			overflow: hidden;
		}
		.banner-block div {
			width: 100%;
			height: 100%;
		}
	</style>
	<script>
		var pbjs = pbjs || {};
		pbjs.que = pbjs.que || [];

		var adUnits = [{
			code: 'div-gpt-ad-1574864639578-0',
			mediaTypes: {
				banner: {
					sizes: [1, 1],
				}
			},
			bids: [{
				bidder: "astraone",
				params: {
					placement: "inImage",
					placeId: "5af45ad34d506ee7acad0c26",
					imageUrl: "https://creative.astraone.io/files/default_image-1-600x400.jpg"
				}
			}]
		}];

		var googletag = googletag || {};
		googletag.cmd = googletag.cmd || [];

		googletag.cmd.push(() => {
			googletag.pubads().disableInitialLoad();
		});

		pbjs.que.push(() => {
			pbjs.addAdUnits(adUnits);
			pbjs.requestBids({ bidsBackHandler: sendAdServerRequest });
		});

		function sendAdServerRequest() {
			googletag.cmd.push(() => {
				pbjs.que.push(() => {
					pbjs.setTargetingForGPTAsync('div-gpt-ad-1574864639578-0');
					googletag.pubads().refresh();
				});
			});
		}

		googletag.cmd.push(() => {
			googletag
				.defineSlot('/21877108735/rtb-pbjs', [1, 1], 'div-gpt-ad-1574864639578-0')
				.addService(googletag.pubads());

			googletag.pubads().enableSingleRequest();
			googletag.enableServices();
		});
	</script>
</head>
<body>
	<h2>Prebid.js InImage Banner Test</h2>

	<div style="width: 600px; position: relative">
		<img src="https://creative.astraone.io/files/default_image-1-600x400.jpg" />

		<div id='div-gpt-ad-1574864639578-0' class="banner-block">
			<script>
				googletag.cmd.push(() => { googletag.display('div-gpt-ad-1574864639578-0'); });
			</script>
		</div>
	</div>
</body>
</html>

Atomx

Features

Bidder Code atomx Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_atomx hb_deal_atomx  

Bid Params

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

Audience Media

Features

Bidder Code audiencemedia Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_audiencemedia hb_bidder_audienceme hb_adid_audiencemedi
hb_size_audiencemedi hb_source_audienceme hb_format_audienceme
hb_cache_host_audien hb_cache_id_audience hb_uuid_audiencemedi
hb_cache_path_audien hb_deal_audiencemedi  

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'cpm.audience.media' string
zoneId required Zone ID '76156' string

AudienceRun

Features

Bidder Code audiencerun Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_audiencerun hb_bidder_audienceru hb_adid_audiencerun
hb_size_audiencerun hb_source_audienceru hb_format_audienceru
hb_cache_host_audien hb_cache_id_audience hb_uuid_audiencerun
hb_cache_path_audien hb_deal_audiencerun  

Bid Params

Name Scope Description Example Type
zoneId required     string

Description

Module that connects to AudienceRun demand sources.

Use audiencerun as bidder.

zoneId is required and must be 10 alphanumeric characters.

AdUnits configuration example

    var adUnits = [{
      code: 'test-div',
      sizes: [[300, 600]],
      bids: [{
          bidder: 'audiencerun',
          params: { 
              zoneId: 'xtov2mgij0'
          }
      }]
    }];

Automatad OpenRTB Bid Adapter

Features

Bidder Code automatad Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_automa hb_deal_automatad  

Bid Params

Name Scope Description Example Type
siteId required The site ID from automatad. "12adf45c" string
placementId required The placement ID from automatad. "a34gh6d" string

Avantis Video

Features

Bidder Code avantisvideo Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_avantisvideo hb_bidder_avantisvid hb_adid_avantisvideo
hb_size_avantisvideo hb_source_avantisvid hb_format_avantisvid
hb_cache_host_avanti hb_cache_id_avantisv hb_uuid_avantisvideo
hb_cache_path_avanti hb_deal_avantisvideo  

Note:

For more information about Avantis Video.

Bid Params

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

Test Parameters

videoAdUnit = [
{
  code: 'video1',
  mediaTypes: {
    video: {
      playerSize: [[640, 480]],
      context: 'outstream'
    },
  },
  bids: [{
    bidder: 'avantisvideo',
    params: {
      AV_PUBLISHERID: '55b78633181f4603178b4568',
      AV_CHANNELID: '5d19dfca4b6236688c0a2fc4'
    }
  }]
}];

Avocet

Features

Bidder Code avct Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_avct hb_bidder_avct hb_adid_avct
hb_size_avct hb_source_avct hb_format_avct
hb_cache_host_avct hb_cache_id_avct hb_uuid_avct
hb_cache_path_avct hb_deal_avct  

Registration

Please contact Avocet at info@avocet.io if you would like to get started selling inventory via the Avocet platform.

Bid Params

Name Scope Description Example Type
placement required A Placement ID from Avocet. "5ebd27607781b9af3ccc3332" string

Prebid Server Note: Avocet is disabled by default. Please enable it in the app config if you wish to use it. This can be done by setting adapters.avocet.disabled to false and by setting adapters.avocet.endpoint to a valid Avocet endpoint url.

Beachfront

Features

Bidder Code beachfront Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_beachf hb_deal_beachfront  

Registration

To use the beachfront bidder you will need an appId (Exchange Id) from an exchange account on platform.beachfront.io.

For further information, please contact adops@beachfront.com.

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
tagid optional Tag ID '7cd7a7b4-ef3f-4aeb-9565-3627f255fa10' string
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
placement optional Placement type for the impression.
1: In-Stream
2: In-Banner
3: In-Article
4: In-Feed
5: Interstitial/Slider/Floating
1 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
adPosterColor optional The color of the ad poster formatted as a CSS value. '#FFFFFF' 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

Prebid Server

As seen in the JSON response from {your PBS server}\/bidder\/params (example), the beachfront bidder can take either an “appId” parameter, or an “appIds” parameter. If the request is for one media type, the appId parameter should be used with the value of the Exchange Id on the Beachfront platform.

The appIds parameter is for requesting a mix of banner and video. It has two parameters, “banner”, and “video” for the appIds of two appropriately configured exchanges on the platform. The appIds parameter can be sent with just one of its two parameters and it will behave like the appId parameter.

If the request includes an appId configured for a video response, the videoResponseType parameter can be defined as “nurl”, “adm” or “both”. These will apply to all video returned. If it is not defined, the response type will be a nurl. The definitions for “nurl” vs. “adm” are here: (https://github.com/mxmCherry/openrtb/blob/master/openrtb2/bid.go).

Beintoo

Features

Bidder Code beintoo Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 618 Prebid Server Adapter 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_beintoo hb_bidder_beintoo hb_adid_beintoo
hb_size_beintoo hb_source_beintoo hb_format_beintoo
hb_cache_host_beinto hb_cache_id_beintoo hb_uuid_beintoo
hb_cache_path_beinto hb_deal_beintoo  

Bid Params

| Name | Scope | Description | Example | Type | |—————|———-|————-|———|———-| | placementId | required | | | string | Beintoo is an aliased bidder for AppNexus

BetweenDigital

Features

Bidder Code between Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_betwee 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bidflu 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bidgla hb_deal_bidglass  

Bid Params

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

Bidlab

Features

Bidder Code bidlab Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_bidlab hb_bidder_bidlab hb_adid_bidlab
hb_size_bidlab hb_source_bidlab hb_format_bidlab
hb_cache_host_bidlab hb_cache_id_bidlab hb_uuid_bidlab
hb_cache_path_bidlab hb_deal_bidlab  

Note:

The Bidlab Bidding adapter requires setup before beginning. Please contact us at hello@bidlab.ai

Bid Params

Name Scope Description Example Type
placementId required Bidlab placement id '1234asdf' 'string'

BidPhysics

Features

Bidder Code bidphysics Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bidphy 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bizzcl 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

Blue Billywig

Features

Bidder Code bluebillywig Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_bluebillywig hb_bidder_bluebillyw hb_adid_bluebillywig
hb_size_bluebillywig hb_source_bluebillyw hb_format_bluebillyw
hb_cache_host_bluebi hb_cache_id_bluebill hb_uuid_bluebillywig
hb_cache_path_bluebi hb_deal_bluebillywig  

Bid Params

Name Scope Description Example Type
publicationName required The name of your Blue Billywig publication "bbprebid" string
accountId required Your publication ID at Blue Billywig 642 integer
rendererCode required The name of the renderer to use in your Blue Billywig publication "renderer" string
connections required Back-ends to connect with. For every value in this a param matching the back-end should exist too. ["bluebillywig"] array
video optional Any OpenRTB 2.5 video params to additionally send along to the SSPs. {"maxduration": 30} object

Boldwin

Features

Bidder Code boldwin Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_boldwin hb_bidder_boldwin hb_adid_boldwin
hb_size_boldwin hb_source_boldwin hb_format_boldwin
hb_cache_host_boldwi hb_cache_id_boldwin hb_uuid_boldwin
hb_cache_path_boldwi hb_deal_boldwin  

Note:

The Boldwin Bidding adapter requires setup before beginning. Please contact us at wls_team@smartyads.com

Bid Params

Name Scope Description Example Type
placementId required Adprime placement id '1234asdf' 'string'

brainy

Features

Bidder Code brainy Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_brainy 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bridge 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 TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_bright 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

Bright Mountain Media

Features

Bidder Code brightmountainmedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_brightmountain hb_bidder_brightmoun hb_adid_brightmounta
hb_size_brightmounta hb_source_brightmoun hb_format_brightmoun
hb_cache_host_bright hb_cache_id_brightmo hb_uuid_brightmounta
hb_cache_path_bright hb_deal_brightmounta  

Bid Params

Name Scope Description Example Type
placement_id required Placement Id will be generated on Bright Mountain Media Platform. '5f21784949be81002079d08c' string
traffic required Type traffic 'banner' string

Bucksense

Features

Bidder Code bucksense Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_buckse hb_deal_bucksense  

Bid params

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

Buzzoola

Features

Bidder Code buzzoola Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_buzzoola hb_bidder_buzzoola hb_adid_buzzoola
hb_size_buzzoola hb_source_buzzoola hb_format_buzzoola
hb_cache_host_buzzoo hb_cache_id_buzzoola hb_uuid_buzzoola
hb_cache_path_buzzoo hb_deal_buzzoola  

Note:

  • The Buzzoola Header Bidding adaptor requires setup and approval before beginning. Please reach out to support@buzzoola.com for more details.
  • Please note that cookie support is required.

Bid Params

Name Scope Description Example Type
placementId required Placement ID. 417846 integer

ByPlay

Features

Bidder Code byplay Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_byplay hb_bidder_byplay hb_adid_byplay
hb_size_byplay hb_source_byplay hb_format_byplay
hb_cache_host_byplay hb_cache_id_byplay hb_uuid_byplay
hb_cache_path_byplay hb_deal_byplay  

Bid Params

Name Scope Description Example Type
sectionId required The section ID '7986' string

C1X

Features

Bidder Code c1x Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_c1x 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_ccx 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, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_cedato 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

Note

The Cedato adapter requires setup and approval from the Cedato team. Please reach out to your account team or publishers@cedato.com for more information.

Clean Media

Features

Bidder Code cleanmedia Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_cleanm 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_cleanm 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_clickf 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

Clicktripz

Features

Bidder Code clicktripz Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_clicktripz hb_bidder_clicktripz hb_adid_clicktripz
hb_size_clicktripz hb_source_clicktripz hb_format_clicktripz
hb_cache_host_clickt hb_cache_id_clicktri hb_uuid_clicktripz
hb_cache_path_clickt hb_deal_clicktripz  

Bid Params

Name Scope Description Example Type
placementId required The Placement ID from Clicktripz '4312c63f' string
siteId required The site ID from Clicktripz 'prebid' string

Cointraffic

Features

Bidder Code cointraffic Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_cointraffic hb_bidder_cointraffi hb_adid_cointraffic
hb_size_cointraffic hb_source_cointraffi hb_format_cointraffi
hb_cache_host_cointr hb_cache_id_cointraf hb_uuid_cointraffic
hb_cache_path_cointr hb_deal_cointraffic  

Bid Params

Name Scope Description Example Type
placementId required The placement ID (Tracker key)   string

Coinzilla

Features

Bidder Code coinzilla Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_coinzi 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_collec 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_colomb 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, video, native GDPR TCF1 Support no
User IDs britepoolid, identityLink, unifiedId, id5Id GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_coloss 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 yes
Media Types display GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 138 Prebid Server Adapter 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_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
hb_cache_path_connec hb_deal_connectad  

Prebid Server Note:

Please reach out to your ConnectAd Account Manager before configuring the S2S adapter for approval and setup.

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
bidfloor optional Requested Floorprice 0.15 number

Consumable

Features

Bidder Code consumable Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_consum 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_conten 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

Converge

Features

Bidder Code converge Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_converge hb_bidder_converge hb_adid_converge
hb_size_converge hb_source_converge hb_format_converge
hb_cache_host_conver hb_cache_id_converge hb_uuid_converge
hb_cache_path_conver hb_deal_converge  

Bid Params

Name Scope Description Example Type
uid required Represents the Converge bidder system Ad Slot ID associated with the respective div id from the site page. 59 integer
priceType optional Can take the values gross or net, default value is net. Net represents the header bid price with the Converge header bidder margin already extracted. Gross price does contain the Converge bidder margin within. 'gross' string
keywords optional A set of key-value pairs applied to all ad slots on the page. Values can be empty. keywords: { topic: ['stress', 'fear'] } object

Conversant

Features

Bidder Code conversant Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 24 Prebid Server Adapter 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_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
hb_cache_path_conver 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>
white_label_url optional Override the destination URL the request is sent to. 'https://mydomain.com/hbendpoint' string
pubcid_name optional Name of the pub common id. Conversant adapter can read the id directly if the UserID module is absent. Default is _pubcid. _pubcid string

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

COSMOS

Features

Bidder Code cosmos Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_cosmos hb_bidder_cosmos hb_adid_cosmos
hb_size_cosmos hb_source_cosmos hb_format_cosmos
hb_cache_host_cosmos hb_cache_id_cosmos hb_uuid_cosmos
hb_cache_path_cosmos hb_deal_cosmos  

Integration Note:

Cosmos bidder adapter requires setup and approval from the Cosmos 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 Cosmos 1001 integer
tagId optional Identifier for specific ad placement 1001 integer
bidFloor optional The minimum bid value 1.07 float

Cox

Features

Bidder Code cox Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_cox 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_cpmsta 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 TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 91 Prebid Server Adapter 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
hb_cache_path_criteo hb_deal_criteo  

Note

For Native Ads, in order to avoid further decoding issues of special characters, the assets need to be sent as placeholders. That means, sendId: true becomes mandatory for all fields receiving URLs, notably: icon, image, clickUrl, privacyLink, privacyIcon.

See Sending Asset Placeholders.

Bid Params

Name Scope Description Example Type
zoneId required (deprecated) The zone ID from Criteo. Should be replaced by networkId when using zone matching. 234234 integer
networkId required 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 required 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 adUnits = [
{
    code: 'video1',
    mediaTypes: {
        video: {
            playerSize: [640, 480],
            context: 'instream',
            mimes: ["video/mp4"],
            maxduration: 30,
            api: [1, 2],
            playerSize: [640,480],
            protocols: [2, 3]
        }
    },
    bids: [{
        bidder: 'criteo',
        params: {
            zoneId: 1455580,
            video: {
                skip: 0,
                playbackmethod: 1,
                placement: 1,
            }
        }
    }]
}];

Dailyhunt

Features

Bidder Code dailyhunt Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_dailyhunt hb_bidder_dailyhunt hb_adid_dailyhunt
hb_size_dailyhunt hb_source_dailyhunt hb_format_dailyhunt
hb_cache_host_dailyh hb_cache_id_dailyhun hb_uuid_dailyhunt
hb_cache_path_dailyh hb_deal_dailyhunt  

Bid Params

Name Scope Description Example Type
placement_id required Serving ads based on placement_id. Contact Dailyhunt for placement_id. 1 int
publisher_id required Serving ads based on publisher_id. Contact Dailyhunt for publisher_id. 1 int
partner_name required Serving ads based on partner_name. Contact Dailyhunt for partner_name. dailyhunt string
test_mode optional Serving test mode campaign only. true bool
bidfloor optional Minimum bid for this bid expressed in CPM. 1.4 float
video optional A Video object required if this bid is offered as a video ad opportunity. It is ortb video object. video: { w: 640, h: 480, mimes: ["video/mp4"] } object
site optional Details about the publisher’s website. It is ortb site object. site:{id:"102855",cat:["IAB3-1"],domain:"http://m.dailyhunt.in",page:"http://m.dailyhunt.in/1234.html "} object
device optional Details about the user’s device to which the impression will be delivered. It is ortb device object. device: { ip: "64.124.253.1", os: "OS X", ua: "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) } object
user optional Details about the human user of the device; the advertising audience. It is ortb user object. user: { id: "456789876567897654678987656789", gender: "M", gender: 1990, keywords: "marketing,traveling,reading" } object
publisher optional Details about the Publisher of the site. It is ortb publisher object. publisher: { id: "8953", name: "dailyhunt", "cat": [ "IAB3-1" ], "domain": "m.dailyhunt.in" } object

Notes: The video, site, device, user, publisher objects are all ORTB objects. Please refer to the ORTB documentation for additional details.

Test Parameters

    var adUnits = [
        {
            code: '/83414793/prebid_test_display',
            sizes: [[300, 250], [320, 50]],
            mediaTypes: {
                banner : {
                    sizes: [[300, 250], [320, 50]],
                }
            },
            bids: [
                {
                    bidder: 'dailyhunt',
                    params: {
                        placement_id: 1,
                        publisher_id: 1,
                        partner_name: 'dailyhunt',
                        device: {
                            ip: "182.23.143.212"
                        }
                    }
                }
            ]
        },
        {
            code: '/83414793/prebid_test_native',
            sizes: [[300, 250]],
            mediaTypes: {
                native: {
                    title: {
                        required: true
                    },
                    body: {
                        required: true
                    },
                    image: {
                        required: true
                    },
                    cta: {
                        required: true
                    }
                }
            },
            bids: [
                {
                    bidder: 'dailyhunt',
                    params: {
                        placement_id: 1,
                        publisher_id: 1,
                        partner_name: 'dailyhunt',
                        device: {
                            ip: "182.23.143.212"
                        }
                    }
                }
            ]
        },
        {
            code: '/83414793/prebid_test_video',
            mediaTypes: {
                video: {
                    playerSize: [1280, 720],
                    context: 'instream'
                }
            },
            bids: [
                {
                    bidder: 'dailyhunt',
                    params: {
                        placement_id: 1,
                        publisher_id: 1,
                        partner_name: 'dailyhunt',
                        device: {
                            ip: "182.23.143.212"
                        },
                        video: {
                            mimes: [
                                'video/mp4'
                            ]
                        }
                    }
                }
            ]
        }
    ];

DAN Marketplace

Features

Bidder Code danmarket Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_danmar 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_decent 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

Deepintent

Features

Bidder Code deepintent Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_deepintent hb_bidder_deepintent hb_adid_deepintent
hb_size_deepintent hb_source_deepintent hb_format_deepintent
hb_cache_host_deepin hb_cache_id_deepinte hb_uuid_deepintent
hb_cache_path_deepin hb_deal_deepintent  

Bid Params

Name Scope Description Example Type
tagId mandatory Ad Tag Id '1399' string
height optional height of the creative 350 number
width optional width of the creative 250 number
custom optional custom key value params '{"position":"right-box"}'' object
user optional user params according to IAB standards '{"gender":"F"}'' object
pos optional ad position as per IAB standards 1 number

Configuration

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

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

AdUnit Format for Banner

var adUnits = [
            {
                code: 'div-22',
                mediaTypes: {
                    banner: {
                        sizes: [
                            [300, 250],
                            [300, 600]
                         ]
                    }
                },
                bids: [{
                    bidder: 'deepintent',
                    params: {
                        tagId: "1399",
                        height: 300,
                        width: 250,
                        pos: 1,
                        user: {
                            gender: "F",
                            uid: "publisher_uid",
                            buyeruid: "test_buyeruid",
                            yob: 2000  
                        },
                        custom: {
                            "position": "right-box"
                        }
                    }
                }]
            }
        ];

Defy Media

Features

Bidder Code defymedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_defyme 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_dgads 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 144 Prebid Server Adapter 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
hb_cache_path_distri 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 TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, intentiq, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_distri 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_divrea 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

DJAX

Features

Bidder Code djax Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_djax hb_bidder_djax hb_adid_djax
hb_size_djax hb_source_djax hb_format_djax
hb_cache_host_djax hb_cache_id_djax hb_uuid_djax
hb_cache_path_djax hb_deal_djax  

Bid Params

Name Scope Description Example Type
publisherId required Publisher id associated with DJAX 1 integer

DSPx

Features

Bidder Code dspx Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_dspx hb_deal_dspx  

Note:

The DSPx Bidder Adapter requires setup and approval from DSPx team. Please reach out to your account team or prebid@dspx.tv for more information.

Bid Params

Name Scope Description Example Type
placement required Placement ID from dspx. '101' string
pfilter optional Selection filter. E.g. floorprice (min_cpm_micros) {"floorprice": 1000000} object
bcat optional List of Blocked Categories (IAB) - comma separated. 'IAB2,IAB4' string

Notice: The creative type can be checked by the type property of bidResponse object. E.g.:

bidsBackHandler: function(bids) {
    var contentType = bids[0].type // JS InSkin|JS Interscroller Type A|...;
}

EngageBDR

Features

Bidder Code ebdr Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_ebdr 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

Edge Query X

Features

Bidder Code edgequeryx Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_edgequeryx hb_bidder_edgequeryx hb_adid_edgequeryx
hb_size_edgequeryx hb_source_edgequeryx hb_format_edgequeryx
hb_cache_host_edgequ hb_cache_id_edgequer hb_uuid_edgequeryx
hb_cache_path_edgequ hb_deal_edgequeryx  

Note:

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

Bid params

Name Scope Description Example Type
accountId required The account ID test string
widgetId required The widget ID test string
domain optional The network domain (default see example) 'https://deep.edgequery.io' string
appName optional Mobile application name 'Edge Query Preview' string

Emoteev

Features

Bidder Code emoteev Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs pubCommonId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_emotee 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals no Prebid.js Adapter yes
IAB GVL ID 183 Prebid Server Adapter 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_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
hb_cache_path_emx_di hb_deal_emx_digital  

Registration

To use this bidder you will need an account and a valid tagid from our exchange. For further information, please contact your Account Manager or adops@emxdigital.com.

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

envivo

Features

Bidder Code envivo Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_envivo hb_bidder_envivo hb_adid_envivo
hb_size_envivo hb_source_envivo hb_format_envivo
hb_cache_host_envivo hb_cache_id_envivo hb_uuid_envivo
hb_cache_path_envivo hb_deal_envivo  

Bid Params

Name Scope Description Example Type
publisherId required Publisher id associated with envivo 1 integer

E-Planning

Features

Bidder Code eplanning Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_eplann 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
ml optional  Uses placement names as ad unit names instead of sizes 1 integer

Etarget

Features

Bidder Code etarget Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_etarge hb_deal_etarget  

Bid Params

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

E-volution tech

Features

Bidder Code e_volution Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_e_volution hb_bidder_e_volution hb_adid_e_volution
hb_size_e_volution hb_source_e_volution hb_format_e_volution
hb_cache_host_e_volu hb_cache_id_e_voluti hb_uuid_e_volution
hb_cache_path_e_volu hb_deal_e_volution  

Note:

The E-volution Bidding adapter requires setup before beginning. Please contact us at admin@e-volution.ai

Bid Params

Name Scope Description Example Type
placementId required E-volution tech placement id '1234asdf' 'string'

Eywamedia

Features

Bidder Code eywamedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_eywame 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_fairtr 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_featur 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_feedad 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 408 Prebid Server Adapter 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
hb_cache_path_fideli 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

fluct

Features

Bidder Code fluct Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_fluct hb_bidder_fluct hb_adid_fluct
hb_size_fluct hb_source_fluct hb_format_fluct
hb_cache_host_fluct hb_cache_id_fluct hb_uuid_fluct
hb_cache_path_fluct hb_deal_fluct  

Bid Params

Name Scope Description Example Type
tagId required The tag ID from fluct '25405:1000192893' string
groupId required The group ID from fluct '1000105712' string
dfpUnitCode optional DFP ad unit code '/62532913/s_fluct.test_hb_prebid_11940' string

FreeWheel-ssp

Features

Bidder Code freewheel-ssp Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_freewh 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_fyber 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 TCF1 Support no
User IDs id5Id, unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_gambid 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_gamma 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 TCF1 Support yes
User IDs id5Id, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_gamosh 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_getint 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_giants hb_deal_giants  

Bid Params

Name Scope Description Example Type
zoneId required Zone ID 584072408 integer

Gjirafa

Features

Bidder Code gjirafa Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_gjirafa hb_bidder_gjirafa hb_adid_gjirafa
hb_size_gjirafa hb_source_gjirafa hb_format_gjirafa
hb_cache_host_gjiraf hb_cache_id_gjirafa hb_uuid_gjirafa
hb_cache_path_gjiraf hb_deal_gjirafa  

Bid Params

Name Scope Example Type
propertyId required "12345" string
placementId required "54321" string

Glimpse Protocol

Features

Bidder Code glimpse Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_glimpse hb_bidder_glimpse hb_adid_glimpse
hb_size_glimpse hb_source_glimpse hb_format_glimpse
hb_cache_host_glimps hb_cache_id_glimpse hb_uuid_glimpse
hb_cache_path_glimps hb_deal_glimpse  

Overview

Module Name: Glimpse Protocol Adaptor
Module Type: Bidder Adapter
Maintainer: tim@glimpseprotocol.io

Description

This module connects publishers to Glimpse Protocol’s demand sources via Prebid.js. Our innovative marketplace protects consumer privacy while allowing precise targeting. It is compliant with GDPR, DPA and CCPA.

This module was built and tested against prebid 3.21.0 and so compatibility against version 2 and earlier is unknown.

Media Types

Type Support
Banner Fully supported for 320x50, 300x250, 300x600, 728x90, and 970x250.

Bid Parameters

The only parameter is placementId and it is required.

Name Scope Description Example Type
placementId Required An identifier associated unique to a publisher and ad unit. Values can be obtained through our publisher portal. ‘glimpse-demo-300x250’ String

Setup Guide

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

0. Preconditions

  • A built prebid module with the glimpse adaptor included
  • You’ve included the built prebid adaptor and GPT script in your websites html code
  • You’ve setup GAM mappings

1. Create an account and setup your domain via the Publisher Portal

Coming soon.

2. Enable Glimpse as a bidder on your ad units

const adUnits = {
  code: 'your-ad-unit-div-id',
  mediaTypes: {
    banner: {
      sizes: [[300, 250]],
    },
  },
  bids: [
    {
      bidder: 'glimpse',
      params: {
        placementId: 'placementId-from-publisher-portal',
      },
    },
    ...
  ],
  ...
}

FAQs

Can I test my setup without a Publisher Portal Account?

Yep. Use a demo placementId:

  • glimpse-demo-320x50
  • glimpse-demo-300x250
  • glimpse-demo-300x600
  • glimpse-demo-728x90
  • glimpse-demo-970x250

How do I get more help?

Reach out to us at hello@glimpseprotocol.io

GMOSSP

Features

Bidder Code gmossp Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_gmossp hb_bidder_gmossp hb_adid_gmossp
hb_size_gmossp hb_source_gmossp hb_format_gmossp
hb_cache_host_gmossp hb_cache_id_gmossp hb_uuid_gmossp
hb_cache_path_gmossp hb_deal_gmossp  

Bid Params

Name Scope Description Example Type
sid required The AdUnit ID from GMOSSP '1234' string

Go2Net

Features

Bidder Code go2net Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_go2net 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_gourme 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 TCF1 Support yes
User IDs id5Id, unifiedId, liveIntentId, digitrust GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_grid 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
keywords optional A set of key-value pairs applied to all ad slots on the page. Values can be empty. keywords: { topic: ['stress', 'fear'] } object
useNewFormat optional Indicates to use the new ad request format true boolean

TheMediaGridNM

Features

Bidder Code gridNM Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_gridNM hb_bidder_gridNM hb_adid_gridNM
hb_size_gridNM hb_source_gridNM hb_format_gridNM
hb_cache_host_gridNM hb_cache_id_gridNM hb_uuid_gridNM
hb_cache_path_gridNM hb_deal_gridNM  

Bid Params

Name Scope Description Example Type
secid required section id, will be used by JW Player to pass their info '11' string
pubid required publisher id, will be used by JW Player to pass their info '22' string
source required source of traffic, in JW Player case should be ‘jwp’ 'jw_player' string
pubdata optional publisher data, will be used by JW Player to pass their info {"jwpseg" : ["1111", "2222"]}) object
floorcpm optional floor cpm 0.56 float
video required video parameters which should be passed for no-mapping approach   object
video.mimes required Content MIME types supported ['video/mp4', 'video/x-ms-wmv'] string array
video.mind optional Minimum video ad duration in seconds. 1 integer
video.maxd optional Maximum video ad duration in seconds 60 int
video.protocols required Array of supported video protocols [1,2,3,4,5,6] integer array
video.size optional player size wxh '300x250' string
video.linearity optional Indicates if the impression must be linear, nonlinear, etc. 1 int
video.skip optional Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. 0 int
video.skipmin optional Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable. 0 int
video.skipafter optional Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable. 0 int
video.api optional List of supported API frameworks for this impression [1,2,3,4,5,6] integer array
video.startdelay optional Indicates the start delay in seconds 0 int
video.placement optional Placement type for the impression. 1 int
video.playbackmethod optional Playback methods that may be in use [1] integer array

GumGum

Features

Bidder Code gumgum Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_gumgum 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.

Server and Client Side Bid Params

Name Scope Description Example Type
zone optional Tracking ID 'ggumtest' string

Client Side only Bid Params

Name Scope Description Example Type
pubId optional Publisher ID 123 integer
slot optional Slot ID 9 integer
native optional Native ID 19 integer
iriscat optional Iris.tv segments 'segment1,segment2' string
inScreen optional Tracking ID 'ggumtest' string
inScreenPubID optional Publisher ID 123 integer
inSlot optional Slot ID 9 integer
video optional Tracking ID 'ggumtest' string
videoPubID optional Publisher ID 123 integer
inVideo optional Tracking ID 'ggumtest' string

GXOne

Features

Bidder Code gxone Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_gxone 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

H12 Media

Features

Bidder Code h12media Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_h12media hb_bidder_h12media hb_adid_h12media
hb_size_h12media hb_source_h12media hb_format_h12media
hb_cache_host_h12med hb_cache_id_h12media hb_uuid_h12media
hb_cache_path_h12med hb_deal_h12media  

Bid Params

Name Scope Description Example Type
pubid required Publisher ID 123 string
placementid optional Publisher placement ID 321 string
size optional Creative size '300x250' string
endpointdom optional Custom Endpoint URL https://h12-media.com/bid string

Example:

{
    bidder: "h12media",
    params: {
        pubid: 123,
        placementid: 321,
        size: '300x250'
    }
}

Head Bidding

Features

Bidder Code headbidding Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_headbi 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_hpmdne 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_huddle 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

Hybrid.ai

Features

Bidder Code hybrid Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_hybrid hb_bidder_hybrid hb_adid_hybrid
hb_size_hybrid hb_source_hybrid hb_format_hybrid
hb_cache_host_hybrid hb_cache_id_hybrid hb_uuid_hybrid
hb_cache_path_hybrid hb_deal_hybrid  

Note

You can use this adapter to get a bid from Hybrid.ai Please reach out to your Hybrid.ai account team before using this plugin to get placeId. The code below returns a demo ad.

Bid Params

Name Scope Description Example Type
placeId required The place id. ‘5af45ad34d506ee7acad0c26’ string
placement required Adunit placement, possible values: banner, video ‘banner’ string

Sample Banner Ad Unit

var adUnits = [{
    code: 'banner_ad_unit',
    mediaTypes: {
        banner: {
            sizes: [[728, 90]]
        }
    },
    bids: [{
        bidder: "hybrid",
        params: {
            placement: "banner",                  // required
            placeId: "5af45ad34d506ee7acad0c26"   // required
        }
    }]
}];

Sample Video Ad Unit

var adUnits = [{
    code: 'video_ad_unit',
    mediaTypes: {
        video: {
            context: 'outstream',    // required, possible values: instream, outstream 
            playerSize: [640, 480]   // required
        }
    },
    bids: [{
        bidder: 'hybrid',
        params: {
            placement: "video",                   // required
            placeId: "5af45ad34d506ee7acad0c26"   // required
        }
    }]
}];

Integral Ad Science (IAS)

Features

Bidder Code ias Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_ias 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_imonom 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, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 253 Prebid Server Adapter 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_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
hb_cache_path_improv 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
bidFloor optional Bid floor price 0.01 float
bidFloorCur optional Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK 'USD' string

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 yes
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID 10 Prebid Server Adapter 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_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
hb_cache_path_ix hb_deal_ix  

Overview

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

Description

Publishers may access Index Exchange’s (IX) network of demand sources through our Prebid.js and Prebid Server adapters. Both of these modules are GDPR and CCPA compliant.

IX Prebid.js Adapter

Our Prebid.js adapter 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 is 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 (Prebid.js)

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

Supported Media Types (Prebid Server)

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

Bid Parameters

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

Name Scope Description Example Type
siteId Required An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. '3723' string
size Required 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 adapter ignores this parameter. [300, 250] Array<integer>
id Optional An alphanumerical value used to identify the slot_id in reporting id: 'billboardHomepage', id: 'billboardArticle' string

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>
id Optional An alphanumerical value used to identify the slot_id in reporting id: 'inStreamCTP', id: 'inStreamAutoPlay' string

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: {
                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: {
                mimes: [
                    'video/mp4',
                    'video/webm'
                ],
                minduration: 0,
                maxduration: 60,
                protocols: [6]
            }
        }
    }]
}];

Video Caching

Note that the IX adapter expects a client-side Prebid Cache to be enabled for video bidding.

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

User Sync

Add the following code to enable user sync. IX strongly recommends enabling user syncing through iFrames. This functionality improves DSP user match rates and increases the IX bid rate and bid price. Be sure to call pbjs.setConfig() only once.

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

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 that are 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 that 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 taken to connect to the server. The default value when unspecified is 50ms.

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

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

IX Prebid Server Adapter

Publishers who would like to retrieve IX demand via a Prebid Server instance can do so by adding IX to the list of bidders for a Prebid Server bid request, with a valid site ID. For example:

"imp": [
  {
    "id": "test2",
    "banner": {
      "format": [
        {
          "w": 300,
          "h": 600
        }
      ]
    },
    "ext": {
      "ix": {
        "siteId": "12345"
      }
    }
  }
]

Important Prebid Server Note

Any party operating their own hosted Prebid Server instances must reach out to IX (prebid.support@indexexchange.com) to receive approval and customized setup instructions. Please do not send Prebid Server requests without first contacting us – you will not receive bid responses.

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)

Banner bids from IX have a TTL of 300 seconds while video bids have a TTL of 1 hour, 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 can I view the bid request sent to IX by Prebid.js?

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 set up 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_innity 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_inskin 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

InteractiveOffers

Features

Bidder Code interactiveOffers Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_intera 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 TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_invibe hb_deal_invibes  

Bid Params

Name Scope Description Example Type
placementId required The Invibes placement ID '1234567' string
adContainerId optional Id of ad container (only prebid js) 'test-div' string
domainId optional Id of domain (only prebid server) 1001 integer
debug optional Debug paramentes (only prebid server) { "testBvid": "1234", "testLog": true } object

iQM

Features

Bidder Code iqm Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_iqm 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

IronSource

Features

Bidder Code ironsource Prebid.org Member no
Media Types video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_ironsource hb_bidder_ironsource hb_adid_ironsource
hb_size_ironsource hb_source_ironsource hb_format_ironsource
hb_cache_host_ironso hb_cache_id_ironsour hb_uuid_ironsource
hb_cache_path_ironso hb_deal_ironsource  

Note

The IronSource adapter requires setup and approval. Please reach out to prebid-digital-brands@ironsrc.com to setup an IronSource account.

Bid Parameters

Video

Name Scope Type Description Example
isOrg required String IronSource publisher Id provided by your IronSource representative “56f91cd4d3e3660002000033”
floorPrice optional Number Minimum price in USD.

WARNING:
Misuse of this parameter can impact revenue
2.00
ifa optional String The ID for advertisers (also referred to as “IDFA”) “XXX-XXX”

Example

var adUnits = [
       {
        code: 'dfp-video-div',
        sizes: [[640, 480]],
        mediaTypes: {
          video: {
            playerSize: [[640, 480]],
            context: 'instream'
          }
        },
        bids: [{
          bidder: 'ironsource',
          params: {
            isOrg: '56f91cd4d3e3660002000033', // Required
            floorPrice: 5.00, // Optional
            ifa: 'XXX-XXX', // Optional
          }
        }]
      }
   ];

Configuration

IronSource 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: [‘ironsource’] } });

J Carter Marketing

Features

Bidder Code jcm Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_jcm hb_deal_jcm  

Bid Params

Name Scope Description Example Type
id required     string
siteId required     string
tier2SiteID optional     string
tier3SiteID optional     string

Jixie

Features

Bidder Code jixie Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals no Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_jixie hb_bidder_jixie hb_adid_jixie
hb_size_jixie hb_source_jixie hb_format_jixie
hb_cache_host_jixie hb_cache_id_jixie hb_uuid_jixie
hb_cache_path_jixie hb_deal_jixie  

Registration

To use this bidder you will need an account and a valid unit from us. For further information, please contact contact@jixie.io

Bid Params

Name Scope Description Example Type
unit required The unit from jixie Digital. 1000012-VyuoGmDF0A string

Justpremium

Features

Bidder Code justpremium Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_justpr 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 TCF1 Support no
User IDs unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_kargo 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_komoon 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

Kubient

Features

Bidder Code kubient Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_kubient hb_bidder_kubient hb_adid_kubient
hb_size_kubient hb_source_kubient hb_format_kubient
hb_cache_host_kubien hb_cache_id_kubient hb_uuid_kubient
hb_cache_path_kubien hb_deal_kubient  

Note:

The Kubient Bidder Adapter requires setup and approval before beginning. Please reach out to prebid@kubient.com for more details.

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') 'kssp.kbntx.ch' string

Kumma

Features

Bidder Code kumma Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_kumma 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,
                  }
              }
          }]
      }
  ];

LEMMA

Features

Bidder Code lemma Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_lemma hb_bidder_lemma hb_adid_lemma
hb_size_lemma hb_source_lemma hb_format_lemma
hb_cache_host_lemma hb_cache_id_lemma hb_uuid_lemma
hb_cache_path_lemma hb_deal_lemma  

Integration Note:

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

Bid params

Name Scope Description Example Type
pubId required The publisher ID from Lemma 1001 integer
adunitId required Identifier for specific ad adunit 1001 integer
bidFloor optional The minimum bid value 1.07 float

Lifestreet

Features

Bidder Code lifestreet Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_lifest 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 TCF1 Support yes
User IDs id5Id, pubCommonId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_livewr 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 TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_lkqd 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_locker hb_deal_lockerdome  

Bid Params

Name Scope Description Example Type
adUnitId required The ad unit ID from LockerDome 'LD10809467961050726' string

Logicad for Publishers

Features

Bidder Code logicad Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals no Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_logica hb_deal_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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_loopme 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

Luna Media

Features

Bidder Code lunamedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_lunamedia hb_bidder_lunamedia hb_adid_lunamedia
hb_size_lunamedia hb_source_lunamedia hb_format_lunamedia
hb_cache_host_luname hb_cache_id_lunamedi hb_uuid_lunamedia
hb_cache_path_luname hb_deal_lunamedia  

Note:

For more information about Luna Media, please contact info@lunamedia.io

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

LuponMedia

Features

Bidder Code luponmedia Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs digitrust, identityLink, liveIntentId, pubCommonId GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_luponmedia hb_bidder_luponmedia hb_adid_luponmedia
hb_size_luponmedia hb_source_luponmedia hb_format_luponmedia
hb_cache_host_luponm hb_cache_id_luponmed hb_uuid_luponmedia
hb_cache_path_luponm hb_deal_luponmedia  

Note:

The LuponMedia bidder adapter requires setup and approval from the LuponMedia support team, even for existing LuponMedia publishers. Please contact us for more information.

Bid Params

Name Scope Description Example Type
siteId required The publisher’s unique site ID 12345 integer
keyId required The key ID 4o2c4 string

Madvertise

Features

Bidder Code madvertise Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_madver 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 TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_mantis 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, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_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
hb_cache_path_marsme hb_deal_marsmedia  

Bid Params

Name Scope Description Example Type
zoneId required The zone ID from Mars Media Group. 9999 integer

Matomy

Features

Bidder Code matomy Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_matomy hb_deal_matomy  

Bid Params

Name Scope Description Example Type
placementId required     string

Meazy

Features

Bidder Code meazy Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_meazy hb_bidder_meazy hb_adid_meazy
hb_size_meazy hb_source_meazy hb_format_meazy
hb_cache_host_meazy hb_cache_id_meazy hb_uuid_meazy
hb_cache_path_meazy hb_deal_meazy  

Bid params

Note

To enable Meazy bid adaptor we kindly ask you to sign up as a Publisher: team@meazy.co

Name Scope Description Example Type
pid required Meazy Publisher ID '6910b7344ae566a1' string

MediaForce

Features

Bidder Code mediaforce Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_mediaforce hb_bidder_mediaforce hb_adid_mediaforce
hb_size_mediaforce hb_source_mediaforce hb_format_mediaforce
hb_cache_host_mediaf hb_cache_id_mediafor hb_uuid_mediaforce
hb_cache_path_mediaf hb_deal_mediaforce  

Bid params

Name Scope Description Example Type
bidfloor optional The floor price, or minimum amount, a publisher will accept for an impression, given in CPM in USD. 1.00 Float
placement_id required Identifier for specific ad placement placement123 String
publisher_id required The publisher ID assigned to the publisher by MediaForce pub_348 String

MediaFuse Lift

Features

Bidder Code mediafuseLift Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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
hb_cache_path_mediaf 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

MediaGo

Features

Bidder Code mediago Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals check with bidder Prebid.js Adapter yes
IAB GVL ID check with bidder Prebid Server Adapter 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_mediago hb_bidder_mediago hb_adid_mediago
hb_size_mediago hb_source_mediago hb_format_mediago
hb_cache_host_mediag hb_cache_id_mediago hb_uuid_mediago
hb_cache_path_mediag hb_deal_mediago  

Note:

The MediaGo Bidding adapter requires setup before beginning. Please contact us at ext_mediago_cm@baidu.com

Bid Params

Name Scope Description Example Type
token required publisher token '1e100887dd614b7f69fdd1360437' string