This page contains documentation on the specific parameters required by each supported bidder.
These docs only apply to Prebid Server bidders. For Prebid.js bidders see the
Prebid.js Bidders page.
For each bidder listed below, you’ll find the following information:
These are 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 Banner or Outstream Video , 'inview' for Adhesion, 'instream' for Instream Video)
'siab'
string
Ad Unit Setup for Banner
varadUnits=[{code:'33across-hb-ad-123456-1',// ad slot HTML element ID mediaTypes:{banner:{sizes:[[300,250],[728,90]]}}bids:[{bidder:'33across',params:{siteId:'examplePub123',// required productId:'siab|inview'// required}}]}
Ad Unit Setup for Outstream Video
varadUnits=[{code:'33across-hb-ad-123456-1',// ad slot HTML element ID mediaTypes:{video:{// We recommend setting the following video params// in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. playerSize:[300,250],// requiredcontext:'outstream',// requiredmimes:['video/mp4','video/x-flv'],// requiredprotocols:[2,3],// required, set at least 1 value in arrayplacement:2,// optional, defaults to 2 when context = outstreamapi:[1,2],// optionalskip:0,// optionalminduration:5,// optionalmaxduration:30,// optionalplaybackmethod:[1,3],// optionalbattr:[13,14],// optionallinearity:1,// optionalminbitrate:10,// optionalmaxbitrate:10// optional}},bids:[{bidder:'33across',params:{siteId:'examplePub123',// required productId:'siab'// required }}],...}
Ad Unit Setup for Instream Video
varadUnits=[{code:'33across-hb-ad-123456-1',// ad slot HTML element ID mediaTypes:{video:{// We recommend setting the following video params// in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. playerSize:[300,250],// requiredcontext:'instream',// requiredmimes:['video/mp4','video/x-flv'],// requiredprotocols:[2,3],// required, set at least 1 value in arrayplacement:1,// optional, defaults to 1 when context = instreamstartdelay:0,// optional, defaults to 0 when context = instreamapi:[1,2],// optionalskip:0,// optionalminduration:5,// optionalmaxduration:30,// optionalplaybackmethod:[1,3],// optionalbattr:[13,14],// optionallinearity:1,// optionalminbitrate:10,// optionalmaxbitrate:10// optional}},bids:[{bidder:'33across',params:{siteId:'examplePub123',// required productId:'instream'// required }}],...}
Ad Unit Setup for Multi-format: Banner, Video (Outstream)
varadUnits=[{code:'33across-hb-ad-123456-1',// ad slot HTML element ID mediaTypes:{banner:{sizes:[[300,250],[728,90]]},video:{// We recommend setting the following video params// in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. playerSize:[300,250],// requiredcontext:'outstream',// requiredmimes:['video/mp4','video/x-flv'],// requiredprotocols:[2,3],// required, set at least 1 value in arrayplacement:2,// optional, defaults to 2 when context = outstreamapi:[1,2],// optionalskip:0,// optionalminduration:5,// optionalmaxduration:30,// optionalplaybackmethod:[1,3],// optionalbattr:[13,14],// optionallinearity:1,// optionalminbitrate:10,// optionalmaxbitrate:10// optional}},bids:[{bidder:'33across',params:{siteId:'examplePub123',// required productId:'siab'// required }}],...}
SRA Mode
We recommend using SRA mode to optimize the bidding process as this allows our adapter to group together bid requests for Ad Units pertaining to the same product and site ID thereby minimizing the number of http requests made to our endpoint. To enable SRA set the following bidder specific config under 33Across
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aax
hb_bidder_aax
hb_adid_aax
hb_size_aax
hb_source_aax
hb_format_aax
hb_cache_host_aax
hb_cache_id_aax
hb_uuid_aax
hb_cache_path_aax
hb_deal_aax
Bid Params
Name
Scope
Description
Example
Type
cid
required
The customer id provided by Aax.
'aax_test_customer'
string
crid
required
The placement id provided by Aax.
'aax_crid'
string
video
required for video Ad units
Object containing video targeting parameters. See Video Object for details.
video: { maxduration: 60 }
object
Video Object
Name
Type
Description
Example
mimes
array of strings
(Recommended) Specifies the video content MIME types supported; for example, video/x-ms-wmv and video/x-flv.
[“video/x-ms-wmv”,”video/x-flv”]
minduration
integer
(Recommended) Specifies the minimum video ad duration, in seconds.
10
maxduration
integer
(Recommended) Specifies the maximum video ad duration, in seconds.
60
w
integer
(Recommended) Specifies the width of the video player, in pixels. Required if playerSize not present in mediaTypes.video
640
h
integer
(Recommended) Specifies the height of the video player, in pixels. Required if playerSize not present in mediaTypes.video
480
startdelay
integer
(Recommended) Specifies the start delay of the video ad
0
battr
array of integers
Specifies the video creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes.
[ 13, 14 ]
playbackmethod
array of integers
Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are: 1: Autoplay, sound on; 2: Autoplay, sound off; 3: Click to play; 4: Mouse over to play
[1, 3]
api
array of integers
Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are: 1: VPAID 1.0; 2: VPAID 2.0; 3: MRAID-1; 4: ORMMA; 5: MRAID-2
Placement type for the impression. Possible options: 1: In-Stream; 2: In-banner; 3: Outstream/In-article; 4: In-feed; 5: Interstitial/Slider/Floating; 6: Long-Form;
1
Besides the above-mentioned parameters, we support all other OpenRTB 2.x video objects as optional parameters.
In addition to bids[].params.video, Aax adapter consumes parameters specified in the mediaTypes.video.
These are 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
Adhese
Features
Bidder Code
adhese
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
id5Id
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adhese
hb_bidder_adhese
hb_adid_adhese
hb_size_adhese
hb_source_adhese
hb_format_adhese
hb_cache_host_adhese
hb_cache_id_adhese
hb_uuid_adhese
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.
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 TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
yes
Multi Format Support
will-bid-on-one
ORTB Blocking Support
yes
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adkernel
hb_bidder_adkernel
hb_adid_adkernel
hb_size_adkernel
hb_source_adkernel
hb_format_adkernel
hb_cache_host_adkern
hb_cache_id_adkernel
hb_uuid_adkernel
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
integer
AdKernelAdn
Features
Bidder Code
adkernelAdn
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adkernelAdn
hb_bidder_adkernelAd
hb_adid_adkernelAdn
hb_size_adkernelAdn
hb_source_adkernelAd
hb_format_adkernelAd
hb_cache_host_adkern
hb_cache_id_adkernel
hb_uuid_adkernelAdn
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
ADman Media
Features
Bidder Code
adman
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
uid2, lotamePanoramaId, idx
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adman
hb_bidder_adman
hb_adid_adman
hb_size_adman
hb_source_adman
hb_format_adman
hb_cache_host_adman
hb_cache_id_adman
hb_uuid_adman
hb_cache_path_adman
hb_deal_adman
Note:
The Adman Bidding adapter requires setup before beginning. Please contact us at prebid@admanmedia.com
Due to different integration API prebid.js and prebid-server api params are different
Prebid.JS Bid Params
Name
Scope
Description
Example
Type
placementId
required
Adman placement id
'1234asdf'
'string'
Prebid server Bid Params
Name
Scope
Description
Example
Type
TagID
required
Adman placement id
'1234asdf'
'string'
AdMixer
Features
Bidder Code
admixer
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
AdmixerID
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admixer
hb_bidder_admixer
hb_adid_admixer
hb_size_admixer
hb_source_admixer
hb_format_admixer
hb_cache_host_admixe
hb_cache_id_admixer
hb_uuid_admixer
hb_cache_path_admixe
hb_deal_admixer
Bid Params
Name
Scope
Description
Example
Type
zone
required
The unique identifier of the ad placement. Could be obtained from the Admixer UI or from your account manager.
“e5ff8e48-4bd0-4a2c-9236-55530ab8981d”
string
kvTargeting
optional
Key/Value - a pair of the unique values that will be used for the custom targeting option.
{key1: value2, key2: value2}
object
Adnuntius
Features
Bidder Code
adnuntius
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
yes
Multi Format Support
will-bid-on-any
ORTB Blocking Support
no
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.
'0000000000072345'
string
network
optional
Used if you want to make requests to multiple networks in adnuntius.
'adnuntius'
string
targeting
optional
Targeting to be sent through to adnuntius with the request.
{ c: ['prebids'] }
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:
You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuintius will not set it for internal ads.
Use cookie will always be set to true by default. Changing it to false will disable cookies.
Prebid Server Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the server-side Adnuntius adapter. the auId below will not return a creative. Please substitute it with your own.
As a publisher you have the option to set no cookie in the device request to let Adnuntius adserver know not to set cookies in the client’s browser. In order to do that you just need to pass this in the request:
"device": {
"ext": {
"noCookies": true
}
},
First Party Data
publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:
ortb2.site
ortb2.user
These fields are optional and only needed for user identification and contextual targeting. How to use it can be read here: Prebid ortb2. Currently we only support this for our prebid server bidder, but will add it to the client bidder in the future.
Video requests
Currently we only support client requests and instream context. An example request would look like this:
These are 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
Adoppler
Features
Bidder Code
adoppler
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adoppler
hb_bidder_adoppler
hb_adid_adoppler
hb_size_adoppler
hb_source_adoppler
hb_format_adoppler
hb_cache_host_adoppl
hb_cache_id_adoppler
hb_uuid_adoppler
hb_cache_path_adoppl
hb_deal_adoppler
Bid Params
Name
Scope
Description
Example
Type
adunit
required
AdUnit to bid against
‘test’
string
client
optional
Client name
‘ads’
string
Adot
Features
Bidder Code
adot
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
pubProvidedId
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Prebid JS
Bid Params
Name
Scope
Description
Example
Type
placementId
optional
The placement ID from Adot.
'adot_placement_224521'
string
video
optional
Object containing video targeting parameters. See Video Object for details.
object
Video Object
Name
Scope
Description
Type
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
Bid Config
PublisherId
You can set a publisherId using pbjs.setBidderConfig for the bidder adot
An ID which identifies this placement of the impression.
'adot_placement_224521'
string
parallax
optional (only for prebid-server)
Specify if the wanted advertising’s creative is a parallax.
true/false
boolean
publisherPath
optional
Specific to each integration. Do not use until asked by someone from adot.
/hubvisor
string
Testing Bid Request
The following test parameters can be used to verify that Prebid Server is working properly with the
server-side adot adapter. This is a mobile Bid-request example.
These are 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.
529814
integer
Description
Provides a solution for accessing Video demand and display demand from Adtarget
These are 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.
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
}
}
});
Adtarget.me
Features
Bidder Code
adtrgtme
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
yes
Multi Format Support
will-bid-on-one
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtrgtme
hb_bidder_adtrgtme
hb_adid_adtrgtme
hb_size_adtrgtme
hb_source_adtrgtme
hb_format_adtrgtme
hb_cache_host_adtrgt
hb_cache_id_adtrgtme
hb_uuid_adtrgtme
hb_cache_path_adtrgt
hb_deal_adtrgtme
Note:
The Adtrgtme bidding adapter requires setup before beginning. Please contact us at info@adtarget.me
Advangelists
Features
Bidder Code
advangelists
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_advangelists
hb_bidder_advangelis
hb_adid_advangelists
hb_size_advangelists
hb_source_advangelis
hb_format_advangelis
hb_cache_host_advang
hb_cache_id_advangel
hb_uuid_advangelists
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
AdView
Features
Bidder Code
AdView
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_AdView
hb_bidder_AdView
hb_adid_AdView
hb_size_AdView
hb_source_AdView
hb_format_AdView
hb_cache_host_AdView
hb_cache_id_AdView
hb_uuid_AdView
hb_cache_path_AdView
hb_deal_AdView
Note:
Currently adapter doesn’t support multi impression and can not perform impression splitting, so only the first impression will be delivered.
The Example Bidding adapter requires setup before beginning. Please contact us at partner@adview.com
Bid Params
Name
Scope
Description
Example
Type
placementId
required
Placement ID
'posid00001'
string
accountId
required
Account ID
'accountid01'
string
adxcg
Features
Bidder Code
adxcg
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
id5Id, identityLink, pubCommonId, unifiedId
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adxcg
hb_bidder_adxcg
hb_adid_adxcg
hb_size_adxcg
hb_source_adxcg
hb_format_adxcg
hb_cache_host_adxcg
hb_cache_id_adxcg
hb_uuid_adxcg
hb_cache_path_adxcg
hb_deal_adxcg
Note
Prebid-server activation requires setup and approval before beginning. Please reach out to your account manager or info@adxcg.com for more details.
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, video, native
GDPR TCF Support
yes
User IDs
criteo, sharedId
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adyoulike
hb_bidder_adyoulike
hb_adid_adyoulike
hb_size_adyoulike
hb_source_adyoulike
hb_format_adyoulike
hb_cache_host_adyoul
hb_cache_id_adyoulik
hb_uuid_adyoulike
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
Same ‘placement’ parameter can be used from either prebid JS or prebid server.
AJA
Features
Bidder Code
aja
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
criteo, unifiedId, imuid
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aja
hb_bidder_aja
hb_adid_aja
hb_size_aja
hb_source_aja
hb_format_aja
hb_cache_host_aja
hb_cache_id_aja
hb_uuid_aja
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 biddersfilter:"include",},},},});
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_algorix
hb_bidder_algorix
hb_adid_algorix
hb_size_algorix
hb_source_algorix
hb_format_algorix
hb_cache_host_algori
hb_cache_id_algorix
hb_uuid_algorix
hb_cache_path_algori
hb_deal_algorix
Note:
AlgoriX adapter requires setup and approval from the AlgoriX team, even for existing in-app developers and publishers. Please reach out to your account team or email to prebid@algorix.co for more information.
Bid Params
Name
Scope
Description
Example
Type
sid
required
Sid
'30014'
string
token
required
Token
'028bca2d3b5c4f0ba155fa34864b0c4d'
string
placementId
optional
Placement Id
'123456'
string
appId
optional
App Id
'asdasdasd'
string
region
optional
Server Region
'APAC', 'USE', 'EUC'
string
Note:
Prebid Server adapter only checks for and uses first imp bid params. All other imp bid params are ignored.
placementId and appId will be generated on AlgoriX Platform.
region is optional param, which determine the AlgoriX server. APAC for SG endpoint, USE for US endpoint, EUC for EU endpoint, Other for Global endpoint.
Alkimi
Features
Bidder Code
alkimi
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
will-bid-on-any
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_alkimi
hb_bidder_alkimi
hb_adid_alkimi
hb_size_alkimi
hb_source_alkimi
hb_format_alkimi
hb_cache_host_alkimi
hb_cache_id_alkimi
hb_uuid_alkimi
hb_cache_path_alkimi
hb_deal_alkimi
Bid Params
Name
Scope
Description
Example
Type
token
required
The ID issued by Alkimi to the publisher
'8a80d8e9-0cf9-4329-8486-6f5bbcd8a61a'
string
bidFloor
required
Minimum bid for this impression expressed in CPM.
0
float
pos
optional
Specify the position of the ad as a relative measure of visibility or prominence. Allowed values: Above the fold: 1; Below the fold: 3; Middle of the fold: 7;
0
integer
AMX RTB
Features
Bidder Code
amx
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
yes
Multi Format Support
true
ORTB Blocking Support
check with bidder
GPP Support
yes
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
tagId
required
Tag ID
'cHJlYmlkLm9yZw'
string
testMode
optional
Activate 100% fill ads
true
boolean
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"}
This will produce a bid at $10 with a test creative.
Note that the tagId is case-sensitive. Do not use cHJlYmlkLm9yZw in production environments: this ID is for testing only.
First Party Data
From Prebid.js >= 4.30, publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:
ortb2.site
ortb2.user
Note that all fields are optional. For contextual data (e.g. categories), standard IAB taxonomies are supported. We do not support passing first party data via bid parameters.
Example - Setting ortb2.site and ortb2.user fields
(*) Please do not use placementId and siteId at the same time.
Geo Object
If the publisher has GEO data of the user’s device. Make it available through the geo audience so we can improve ad targeting, which means improving bids. The list of fields can be referenced in Section 3.2.19 from the OpenRTB 2.5 document.
Name
Scope
Description
Example
Type
lat
required
Latitude from -90.0 to +90.0, where negative is south.
17.98928
float
lon
required
Longitude from -180.0 to +180.0, where negative is west.
99.7741712
float
accuracy
required
Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation.
20
integer
lastfix
optional
Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken.
30
integer
utcoffset
optional
Local time as the number +/- of minutes from UTC.
-420
integer
Video Ad Unit
Publishers declare video inventory by passing the following parameters via mediaTypes.video
Name
Scope
Description
Example
Type
context
required
instream or outstream
"outstream"
string
playerSize
required
width, height of the player in pixels
[640,360] - will be translated to w and h in bid request
array<integers>
mimes
recommended
List of content MIME types supported by the player (see openRTB v2.5 for options)
Playback methods that may be in use. Only one method is typically used in practice. (see openRTB v2.5 section 5.10 for options)
[2]
array<integers>
skip
optional
Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.
1
integer
skipafter
optional
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
6
integer
minbitrate
optional
Minimum bit rate in Kbps.
300
integer
maxbitrate
optional
Maximum bit rate in Kbps.
9600
integer
startdelay*
recommended
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. >0: Mid-Roll (value indicates start delay in second) 0: Pre-Roll -1: Generic Mid-Roll -2: Generic Post-Roll
0
integer
placement*
recommended
Placement type for the impression. (see openRTB v2.5 section 5.9 for options)
1
integer
Lists of values are in the OpenRTB 2.5 documentation as referenced above.
Sample Banner Ad Unit
var adUnits = [
{
code: 'test-div',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
},
bids: [
{
bidder: 'apacdex',
params: {
siteId: 'apacdex1234', // siteId provided by Apacdex
floorPrice: 0.01, // default is 0.01 if not declared
}
}
]
}
];
mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document
You must review all video parameters to ensure validity for your player and DSPs
mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document
You must review all video parameters to ensure validity for your player and DSPs
Applogy
Features
Bidder Code
applogy
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_applogy
hb_bidder_applogy
hb_adid_applogy
hb_size_applogy
hb_source_applogy
hb_format_applogy
hb_cache_host_applog
hb_cache_id_applogy
hb_uuid_applogy
hb_cache_path_applog
hb_deal_applogy
Bid Params
Name
Scope
Description
Example
Type
token
required
Applogy tokeb
‘aaaa’
string
AppNexus
Features
Bidder Code
appnexus
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
all (with commercial activation)
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
yes
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Disclosure:
This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.
All AppNexus (Xandr) 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
Starting with Prebid.js version 7.36.0, an update was made to the appnexusBidAdapter.js file to support bid params in a lower-case underscore format (eg invCode to inv_code) similar to how the params are formatted for the Prebid Server AppNexus bidder. This change was implemented to streamline publisher setups for both projects instead of maintaining separate versions of the same params depending on what setup is used.
To avoid breaking changes, the old ‘camelCase’ format is still currently supported for all AppNexus bid params in the appnexusBidAdapter.js file. If you are using an older version of Prebid.js, you will need to continue to use the older ‘camelCase’ format as appropriate.
The table below will reflect both formats, though it’s recommended to use the lower-case underscore format where possible going forward (assuming you’re using a compatible version of Prebid.js).
Name
Scope
Description
Example
Type
placement_id (PBS+PBJS) or placementId (PBJS)
required
The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. This 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 or inv_code
optional
The inventory code from AppNexus. Must be used with member.
'abc123'
string
publisherId or publisher_id
optional
The publisher ID from AppNexus. It is used by the AppNexus end point to identify the publisher when placement id 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
frameworks
optional
Array of integers listing API frameworks for Banner supported by the publisher.
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 or allow_smaller_sizes
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 (PBJS) or use_pmt_rule (PBS+PBJS)
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). A maximum of 100 key/value pairs can be defined at the page level. Each tag can have up to 100 additional key/value pairs defined. Values can be empty. See Passing Keys Without Values below for examples. If you want to pass keywords for all adUnits, see Auction Level Keywords for an example. 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.
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 unless ‘Reserve Price Override’ is checked. See Xandr docs
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 or traffic_source_code
optional
Specifies the third-party source of this impression.
'my_traffic_source'
string
supplyType or supply_type
optional
Indicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app
'web'
string
pubClick or pub_click
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 or ext_inv_code
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 or external_imp_id
optional
Specifies the unique identifier of an externally generated auction.
'bacbab02626452b097f6030b3c89ac05'
string
generate_ad_pod_id
optional
Signal to AppNexus to split impressions by ad pod and add unique ad pod id to each request. Specific to long form video endpoint only. Supported by Prebid Server, not Prebid JS.
true
boolean
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"; "mouse_over"; "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; OMID 1.0 6.
Array<integer>
User Object
Name
Description
Example
Type
age
The age of the user.
35
integer
externalUid or external_uid
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;
}
}
]
}
}
Auction Level Keywords
It’s possible to pass a set of keywords for the whole request, rather than a particular adUnit. Though they would apply to all adUnits (which include the appnexus bidder) in an auction, these keywords can work together with the bidder level keywords (if for example you want to have specific targeting for a particular adUnit).
Below is an example of how to define these auction level keywords for the appnexus bidder:
Like in the bidder.params.keywords, the values here can be empty. Please see the section immediately below for more details.
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.
Publishers should use the ortb2 method of setting First Party Data.
At this time however, the appnexus bidder only reads the First Party Data when using the Prebid Server and Prebid Server Premium endpoints. The client-side version of the appnexus bidder does not use the values from the First Party Data fields.
PBS/PSP supports all first party data fields: site, user, segments, and imp-level first party data.
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:
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.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appush
hb_bidder_appush
hb_adid_appush
hb_size_appush
hb_source_appush
hb_format_appush
hb_cache_host_appush
hb_cache_id_appush
hb_uuid_appush
hb_cache_path_appush
hb_deal_appush
Prebid Params
Name
Scope
Description
Example
Type
placementId
optional
Placement Id
'0'
'string'
endpointId
optional
Endpoint Id
'0'
'string'
Audience Network
Features
Bidder Code
audienceNetwork
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_audienceNetwor
hb_bidder_audienceNe
hb_adid_audienceNetw
hb_size_audienceNetw
hb_source_audienceNe
hb_format_audienceNe
hb_cache_host_audien
hb_cache_id_audience
hb_uuid_audienceNetw
hb_cache_path_audien
hb_deal_audienceNetw
Registration
Audience Network will not bid on requests made from device simulators.
When testing for Mobile bids, you must make bid requests using a real device.
Note: Audience Network is disabled by default. Please enable it in the app config if you wish to use it. Make sure you provide the partnerID for the auctions to run correctly.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
The Placement ID from Audience Network
'555555555555555\_555555555555555'
string
format
optional
Format, one of “native”, “fullwidth” or “video”
'native'
string
Automatad OpenRTB Bid Adapter
Features
Bidder Code
automatad
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
no
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_automatad
hb_bidder_automatad
hb_adid_automatad
hb_size_automatad
hb_source_automatad
hb_format_automatad
hb_cache_host_automa
hb_cache_id_automata
hb_uuid_automatad
hb_cache_path_automa
hb_deal_automatad
Prebid.js Bid Params
Name
Scope
Description
Example
Type
siteId
required
The site ID from automatad.
"12adf45c"
string
placementId
optional
The placement ID from automatad.
"a34gh6d"
string
Prebid-Server Bid Params
Name
Scope
Description
Example
Type
position
optional
Position field from automatad
22390678
string
placementId
optional
The placement ID from automatad.
"a34gh6d"
string
Avocet
Features
Bidder Code
avct
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.
Axonix
Features
Bidder Code
axonix
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_axonix
hb_bidder_axonix
hb_adid_axonix
hb_size_axonix
hb_source_axonix
hb_format_axonix
hb_cache_host_axonix
hb_cache_id_axonix
hb_uuid_axonix
hb_cache_path_axonix
hb_deal_axonix
Prebid Server Note:
The Axonix Bidding adapter requires setup before beginning. Please contact us at support.axonix@emodoinc.com.
Bid Params
Name
Scope
Description
Example
supplyId
required
Supply UUID
'2c426f78-bb18-4a16-abf4-62c6cd0ee8de'
region
optional
Cloud region
'us-east-1'
endpoint
optional
Supply custom endpoint
'https://open-rtb.axonix.com/custom'
instl
optional
Set to 1 if using interstitial (default: 0)
1
Beachfront
Features
Bidder Code
beachfront
Prebid.org Member
yes
Media Types
display, video
GDPR TCF Support
yes
User IDs
unifiedId, identityLink, uid2, hadronId
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
yes
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_beachfront
hb_bidder_beachfront
hb_adid_beachfront
hb_size_beachfront
hb_source_beachfront
hb_format_beachfront
hb_cache_host_beachf
hb_cache_id_beachfro
hb_uuid_beachfront
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. The floor price module will take priority over this value.
As seen in the JSON response from {your PBS server}\/bidder\/params, 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 TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Between
Features
Bidder Code
between
Prebid.org Member
no
Media Types
display
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_between
hb_bidder_between
hb_adid_between
hb_size_between
hb_source_between
hb_format_between
hb_cache_host_betwee
hb_cache_id_between
hb_uuid_between
hb_cache_path_betwee
hb_deal_between
Prebid.js Bid Params
Name
Scope
Description
Example
Type
s
required
Section ID from Between SSP control panel
999999
integer
cur
optional
3-letter ISO 4217 code defining the currency of the bid (currently support USD and EUR), default is USD
'USD'
string
Prebid-Server Bid Params
Name
Scope
Description
Example
Type
host
required
Between SSP host url prefix. Defines data center where requests will be sent. Choose the closest one to the prebid-server you are using. Allowed values: lbs-eu1.ads, lbs-ru1.ads, lbs-asia1.ads, lbs-us-east1.ads
'lbs-eu1.ads'
string
publisher_id
required
Publisher ID from Between SSP control panel
'123'
string
Bidmachine
Features
Bidder Code
bidmachine
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidmachine
hb_bidder_bidmachine
hb_adid_bidmachine
hb_size_bidmachine
hb_source_bidmachine
hb_format_bidmachine
hb_cache_host_bidmac
hb_cache_id_bidmachi
hb_uuid_bidmachine
hb_cache_path_bidmac
hb_deal_bidmachine
Prebid Server Note:
The Bidmachine Bidding adapter requires setup before beginning. Please contact us at hi@bidmachine.io .
Bid Params
Name
Scope
Description
Example
Type
host
required
DC region
"api-eu"
string
path
required
URL path, will be provided by manager
"auction/rtb/v2"
string
seller_id
required
Your ID in Bidmachine system
"1"
string
BidMyAdz
Features
Bidder Code
bidmyadz
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidmyadz
hb_bidder_bidmyadz
hb_adid_bidmyadz
hb_size_bidmyadz
hb_source_bidmyadz
hb_format_bidmyadz
hb_cache_host_bidmya
hb_cache_id_bidmyadz
hb_uuid_bidmyadz
hb_cache_path_bidmya
hb_deal_bidmyadz
Prebid Server Bid Params
Currently adapter doesn’t support multiimpression, so only the first impression will be delivered
Name
Scope
Description
Example
Type
placementId
required
Placement Id will be generated on BidMyAdz Platform.
'1234'
string
BidsCube
Features
Bidder Code
bidscube
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidscube
hb_bidder_bidscube
hb_adid_bidscube
hb_size_bidscube
hb_source_bidscube
hb_format_bidscube
hb_cache_host_bidscu
hb_cache_id_bidscube
hb_uuid_bidscube
hb_cache_path_bidscu
hb_deal_bidscube
Note:
The BidsCube Bidding adapter requires setup before beginning. Please contact us at support@bidscube.com
Bid Params
Name
Scope
Description
Example
Type
placementId
required
Placement ID
'12345'
string
Bidstack
Features
Bidder Code
bidstack
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidstack
hb_bidder_bidstack
hb_adid_bidstack
hb_size_bidstack
hb_source_bidstack
hb_format_bidstack
hb_cache_host_bidsta
hb_cache_id_bidstack
hb_uuid_bidstack
hb_cache_path_bidsta
hb_deal_bidstack
Registration
The Bidstack Bidding adapter requires setup before beginning. Please contact us at tech@bidstack.com
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
'be224bf2-fd3f-4afb-b6fc-4a97718be2f5'
string
placementId
optional
Placement ID
'some_placement_id'
string
consent
optional
User EULA consent
true
boolean
BizzClick
Features
Bidder Code
bizzclick
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bizzclick
hb_bidder_bizzclick
hb_adid_bizzclick
hb_size_bizzclick
hb_source_bizzclick
hb_format_bizzclick
hb_cache_host_bizzcl
hb_cache_id_bizzclic
hb_uuid_bizzclick
hb_cache_path_bizzcl
hb_deal_bizzclick
Note:
The Example Bidding adapter requires setup before beginning. Please contact us at support@bizzclick.com .BizzClick will only respond to the first impression and that multiple ad formats of that single impression are not supported.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
placement id
'hash'
string
accountId
required
account id
'bizzclickTest'
string
BLIINK
Features
Bidder Code
bliink
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bliink
hb_bidder_bliink
hb_adid_bliink
hb_size_bliink
hb_source_bliink
hb_format_bliink
hb_cache_host_bliink
hb_cache_id_bliink
hb_uuid_bliink
hb_cache_path_bliink
hb_deal_bliink
Note:
The BLIINK Header Bidding adaptor requires setup and approval from the BLIINK team. Please reach out to your account manager for more informations.
Bid Params
Name
Scope
Description
Example
Type
tagId
required
The TagID from BLIINK.
'32'
string
imageUrl
optional
The image url on which the ad is displayed in case of in-image ad.
'https://image.png'
string
Blue
Features
Bidder Code
blue
Prebid.org Member
no
Media Types
display
GDPR TCF Support
yes
User IDs
id5Id, identityLink, pubProvidedId
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_blue
hb_bidder_blue
hb_adid_blue
hb_size_blue
hb_source_blue
hb_format_blue
hb_cache_host_blue
hb_cache_id_blue
hb_uuid_blue
hb_cache_path_blue
hb_deal_blue
Note:
The bidder requires setup before usage. Please get in touch with our publisher team at celsooliveira@getblue.io to get started.
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Unique publisher ID
'ABCDEF'
string
Bright Mountain Media
Features
Bidder Code
bmtm
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
no
User IDs
id5Id, sharedId
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bmtm
hb_bidder_bmtm
hb_adid_bmtm
hb_size_bmtm
hb_source_bmtm
hb_format_bmtm
hb_cache_host_bmtm
hb_cache_id_bmtm
hb_uuid_bmtm
hb_cache_path_bmtm
hb_deal_bmtm
Bid Params
Name
Scope
Description
Example
Type
placement_id
required
Placement ID will be generated on Bright Mountain Media Platform
1
integer
Boldwin
Features
Bidder Code
boldwin
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
optional
Placement Id
'0'
string
endpointId
optional
Endpoint Id
'0'
string
For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
Brave
Features
Bidder Code
brave
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
check with bidder
ORTB Blocking Support
yes
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brave
hb_bidder_brave
hb_adid_brave
hb_size_brave
hb_source_brave
hb_format_brave
hb_cache_host_brave
hb_cache_id_brave
hb_uuid_brave
hb_cache_path_brave
hb_deal_brave
Note:
The Brave Header Bidding adapter requires setup and approval from the Brave team. Please reach out to your account manager or support@thebrave.io for more information
Bid Params
Name
Scope
Description
Example
Type
placementId
required
Brave’s platform placement id
'to0QI2aPgkbBZq6vgf0oHitouZduz0qw'
string
Brightroll
Features
Bidder Code
brightroll
Prebid.org Member
yes
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brightroll
hb_bidder_brightroll
hb_adid_brightroll
hb_size_brightroll
hb_source_brightroll
hb_format_brightroll
hb_cache_host_bright
hb_cache_id_brightro
hb_uuid_brightroll
hb_cache_path_bright
hb_deal_brightroll
Registration
Brightroll requires registration for each Prebid Server host company
and each publisher. Contact dsp-supply-prebid@verizonmedia.com
Bid Params
Name
Scope
Description
Example
Type
publisher
required
Publisher Name to use
‘pub1’
string
Clickonometrics
Features
Bidder Code
ccx
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ccx
hb_bidder_ccx
hb_adid_ccx
hb_size_ccx
hb_source_ccx
hb_format_ccx
hb_cache_host_ccx
hb_cache_id_ccx
hb_uuid_ccx
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
CodeFuel
Features
Bidder Code
CodeFuel
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_CodeFuel
hb_bidder_CodeFuel
hb_adid_CodeFuel
hb_size_CodeFuel
hb_source_CodeFuel
hb_format_CodeFuel
hb_cache_host_CodeFu
hb_cache_id_CodeFuel
hb_uuid_CodeFuel
hb_cache_path_CodeFu
hb_deal_CodeFuel
Description
Module that connects to Codefuel bidder to fetch bids.
Display format is supported but not native format. Using OpenRTB standard.
Bid Params
| Name | Scope | Description | Example | Type |
|—————|———-|————————————-|——————————————|———-|
| placementId | required | Placement-Id defined by the caller | '0111f8ac-2d40-4613-8557-b47dbf622fff' | string |
These are 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
Colossus
Features
Bidder Code
colossus
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
britepoolid, identityLink, unifiedId, id5Id, uid2
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_colossus
hb_bidder_colossus
hb_adid_colossus
hb_size_colossus
hb_source_colossus
hb_format_colossus
hb_cache_host_coloss
hb_cache_id_colossus
hb_uuid_colossus
hb_cache_path_coloss
hb_deal_colossus
Disclosure:
This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.
Prebid.Server Bid Params
Name
Scope
Description
Example
Type
TagID
optional
Placement Id will be generated on Colossus SSP Platform.
'0'
string
groupId
optional
Group Id will be generated on Colossus SSP Platform.
'0'
string
You only need to use one parameter: either TagID or groupId
For prebidJS parametres, look into colossusssp.md
Compass
Features
Bidder Code
compass
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_compass
hb_bidder_compass
hb_adid_compass
hb_size_compass
hb_source_compass
hb_format_compass
hb_cache_host_compas
hb_cache_id_compass
hb_uuid_compass
hb_cache_path_compas
hb_deal_compass
Bid Params
Name
Scope
Description
Example
Type
placementId
optional
Placement Id
'0'
'string'
endpointId
optional
Endpoint Id
'0'
'string'
Note
For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
These are 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, video
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_consumable
hb_bidder_consumable
hb_adid_consumable
hb_size_consumable
hb_source_consumable
hb_format_consumable
hb_cache_host_consum
hb_cache_id_consumab
hb_uuid_consumable
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.
Disclosure:
The Consumable bid adapter may cycle the ad initially shown with a new one at various intervals. This means the advertiser meta-data accompanying the bid response may be incomplete at the time of response.
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
CPMStar
Features
Bidder Code
cpmstar
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
These are 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
Notes
This bidder adapter automatically includes the Criteo User ID module and performs iFrame syncs.
Prebid-Server support is on alpha test and is currently a non-finished product. Activation requires setup and approval before beginning. Please reach out to your account manager or publishers@criteo.com for more details.
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
(Prebid.js only) Callback to perform render in native integrations. Please reach out your Criteo representative for more details.
function(payload) { console.log(payload); }
function
integrationMode
optional
(Prebid.js only) Integration mode to use for ad render (none or ‘AMP’). Please reach out your Criteo representative for more details.
'AMP'
string
publisherSubId
optional
Custom identifier for reporting. Please reach out your Criteo representative for more details.
'adunit-1'
string
First Party Data
Criteo supports both ortb2 (site and user) and ortb2Imp methods to set First Party Data.
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 the video inventory is initiated. 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;
Criteo Bid Adapter supports the collection of the user’s hashed email, if available.
Please consider passing it to the adapter, following these guidelines.
C-WIRE
Features
Bidder Code
cwire
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cwire
hb_bidder_cwire
hb_adid_cwire
hb_size_cwire
hb_source_cwire
hb_format_cwire
hb_cache_host_cwire
hb_cache_id_cwire
hb_uuid_cwire
hb_cache_path_cwire
hb_deal_cwire
Bid Params
Name
Scope
Description
Example
Type
pageId
required
C-WIRE page id
2453
integer
placementId
required
C-WIRE placement id
113244
integer
URL parameters
Additionally, the following parameters can be passed by URL parameters for testing.
Name
Scope
Description
Example
Type
cwcreative
optional
C-WIRE creative id to force
&cwcreative=1234
string
cwgroups
optional
C-WIRE group name to force
&cwgroups=test-group
string
cwfeatures
optional
Comma separated list of features
&cwfeatures=feature1,feature2
string
cwdebug
optional
Debug flag
&cwdebug=true
string
DataBlocks
Features
Bidder Code
datablocks
Prebid.org Member
yes
Media Types
display, native
GDPR TCF Support
yes
User IDs
criteo,unifiedId,netId,pubcid
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_datablocks
hb_bidder_datablocks
hb_adid_datablocks
hb_size_datablocks
hb_source_datablocks
hb_format_datablocks
hb_cache_host_databl
hb_cache_id_databloc
hb_uuid_datablocks
hb_cache_path_databl
hb_deal_datablocks
Bid Params
Name
Scope
Description
Example
Type
sourceId
required
Website Source Id
111
integer
host
optional
Network Host to request from
‘prebid.datablocks.bet’
string
tagid
optional
Placement ID
‘leaderboard_1’
string
vis_optout
optional
Opt out of visibility metric
true
boolean
Deepintent
Features
Bidder Code
deepintent
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 biddersfilter:'include'}}}});
If you are using Google Ad Manager (GAM), it is highly recommended to make sure the “Serve in Safeframe” box in creative settings is unchecked.
If you absolutely want to run Duration Media in a Saferame creative, please contact your Duration Media repsentative to coordinate this setup.
Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false.
boolean
playback_method
Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown"; "viewport_sound_on", "viewport_sound_off".
Array<string>
position
Array of strings listing video player position supported by the publisher. Allowed values: "na", "atf", "btf", "head", "foot", "sidebar", "full".
Array<string>
mimes
Array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"].
Array<string>
minduration
Integer that defines the minimum video ad duration in seconds.
integer
maxduration
Integer that defines the maximum video ad duration in seconds.
integer
frameworks
Array of integers listing API frameworks supported by the publisher. Allowed values: None: 0; VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5.
Array<integer>
E-volution tech
Features
Bidder Code
e_volution
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
id5Id
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Prebid.JS Bid Params
Name
Scope
Description
Example
Type
placementId
required
E-volution tech placement id
'1234asdf'
'string'
Prebid Server Bid Params
Name
Scope
Description
Example
Type
key
required
E-volution integration key
'cf64c93f277afdd928d8260653d7413d'
'string'
EMX Digital
Features
Bidder Code
emx_digital
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
identityLink, uid2
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emx_digital
hb_bidder_emx_digita
hb_adid_emx_digital
hb_size_emx_digital
hb_source_emx_digita
hb_format_emx_digita
hb_cache_host_emx_di
hb_cache_id_emx_digi
hb_uuid_emx_digital
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
Engage BDR
Features
Bidder Code
engagebdr
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_engagebdr
hb_bidder_engagebdr
hb_adid_engagebdr
hb_size_engagebdr
hb_source_engagebdr
hb_format_engagebdr
hb_cache_host_engage
hb_cache_id_engagebd
hb_uuid_engagebdr
hb_cache_path_engage
hb_deal_engagebdr
Bid Params
Name
Scope
Description
Example
Type
sspid
required
SSPID parameter
‘11111’
string
E-Planning
Features
Bidder Code
eplanning
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_eplanning
hb_bidder_eplanning
hb_adid_eplanning
hb_size_eplanning
hb_source_eplanning
hb_format_eplanning
hb_cache_host_eplann
hb_cache_id_eplannin
hb_uuid_eplanning
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
sn
optional
Uses space name instead of sizes
adunitName
string
Epom
Features
Bidder Code
epom
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_epom
hb_bidder_epom
hb_adid_epom
hb_size_epom
hb_source_epom
hb_format_epom
hb_cache_host_epom
hb_cache_id_epom
hb_uuid_epom
hb_cache_path_epom
hb_deal_epom
Note:
The Epom Bidding adapter requires setup before beginning. Please contact us at support@epom.com
Bid Params
Currently, Epom Bidding server do not support any bid parameters. We get all we need from the referring URL
These are 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 Epsilon.
'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
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. Epsilon adapter can read the id directly if the UserID module is absent. Default is _pubcid.
'_pubcid'
string
Video Params
Name
Scope
Description
Example
Type
position
optional
Ad position on screen. See details below. Only supported in bids.params.
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>
Video parameters can be included in either mediaTypes.video or bids.params except where noted.
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
First Party Data
Publishers should use the ortb2 method of setting for setting First Party Data.
Example first party data configuration that is available to all adUnits
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ergadx
hb_bidder_ergadx
hb_adid_ergadx
hb_size_ergadx
hb_source_ergadx
hb_format_ergadx
hb_cache_host_ergadx
hb_cache_id_ergadx
hb_uuid_ergadx
hb_cache_path_ergadx
hb_deal_ergadx
Note:
The eRGADX bidding adapter requires setup and approval before implementation. Please reach out to prashant.musale@erelego.com for more details.
Bid Params
Name
Scope
Description
Example
Type
host
required
RTB host
'cpm.ergadx.com'
string
zoneId
required
Zone Id
30164
integer
Evolution Technologies
Features
Bidder Code
evtech
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
no
Multi Format Support
will-bid-on-one
ORTB Blocking Support
yes
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_evtech
hb_bidder_evtech
hb_adid_evtech
hb_size_evtech
hb_source_evtech
hb_format_evtech
hb_cache_host_evtech
hb_cache_id_evtech
hb_uuid_evtech
hb_cache_path_evtech
hb_deal_evtech
Bid Params
Name
Scope
Description
Example
Type
host
required
Ad network’s RTB host
'e-volution.ai'
string
publisherId
required
Publisher ID
12345
integer
freeWheelssp
Features
Bidder Code
freewheelssp
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
partial
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_freewheelssp
hb_bidder_freewheels
hb_adid_freewheelssp
hb_size_freewheelssp
hb_source_freewheels
hb_format_freewheels
hb_cache_host_freewh
hb_cache_id_freewhee
hb_uuid_freewheelssp
hb_cache_path_freewh
hb_deal_freewheelssp
Bid Params
Name
Scope
Description
Example
Type
zoneId
required
string
FutureAds
Features
Bidder Code
futureads
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
AdmixerID
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_futureads
hb_bidder_futureads
hb_adid_futureads
hb_size_futureads
hb_source_futureads
hb_format_futureads
hb_cache_host_future
hb_cache_id_futuread
hb_uuid_futureads
hb_cache_path_future
hb_deal_futureads
Bid Params
Name
Scope
Description
Example
Type
zone
required
The unique identifier of the ad placement. Could be obtained from the FutureAds UI or from your account manager.
“e5ff8e48-4bd0-4a2c-9236-55530ab8981d”
string
kvTargeting
optional
Key/Value - a pair of the unique values that will be used for the custom targeting option.
{key1: value2, key2: value2}
object
Gamma
Features
Bidder Code
gamma
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gamma
hb_bidder_gamma
hb_adid_gamma
hb_size_gamma
hb_source_gamma
hb_format_gamma
hb_cache_host_gamma
hb_cache_id_gamma
hb_uuid_gamma
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 TCF Support
yes
User IDs
id5Id, unifiedId
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gamoshi
hb_bidder_gamoshi
hb_adid_gamoshi
hb_size_gamoshi
hb_source_gamoshi
hb_format_gamoshi
hb_cache_host_gamosh
hb_cache_id_gamoshi
hb_uuid_gamoshi
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.
Globalsun
Features
Bidder Code
globalsun
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
will-not-bid
ORTB Blocking Support
partial
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_globalsun
hb_bidder_globalsun
hb_adid_globalsun
hb_size_globalsun
hb_source_globalsun
hb_format_globalsun
hb_cache_host_global
hb_cache_id_globalsu
hb_uuid_globalsun
hb_cache_path_global
hb_deal_globalsun
Prebid Params
Name
Scope
Description
Example
Type
placementId
optional
Placement Id
'0'
'string'
Goldbach
Features
Bidder Code
goldbach
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
criteo, unifiedId, netId, identityLink, uid2
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
All Goldbach (Xandr) 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 Goldbach bidder will not return any demand for those placements. Note: This requirement does not apply to adapters that are aliasing the Goldbach adapter.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
The placement ID from Goldbach. 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 Goldbach. Must be used with invCode.
'12345'
string
invCode
optional
The inventory code from Goldbach. Must be used with member.
'abc123'
string
publisherId
optional
The publisher ID from Goldbach. It is used by the Goldbach 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
frameworks
optional
Array of integers listing API frameworks for Banner supported by the publisher.
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 (PBJS) or use_pmt_rule (PBS)
optional
If true, Xandr 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 Goldbach account manager.
keywords: { genre: ['rock', 'pop'] }
object
video
optional
Object containing video targeting parameters. See Video Object for details.
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 Goldbach Console, those settings will override what is configured here unless ‘Reserve Price Override’ is checked. See Xandr docs
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 Goldbach 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
generate_ad_pod_id
optional
Signal to Goldbach to split impressions by ad pod and add unique ad pod id to each request. Specific to long form video endpoint only. Supported by Prebid Server, not Prebid JS.
true
boolean
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"; "mouse_over"; "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; OMID 1.0 6.
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
Goldbach 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
Goldbach 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 = {
godlbach: {
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 Goldbach. 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.
The Goldbach 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 Goldbach.
Debug Auction
Enabling the Goldbach Debug Auction feature should only be done for diagnosing the Goldbach 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:
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
TheMediaGrid
Features
Bidder Code
grid
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
yes
Multi Format Support
will-bid-on-any
ORTB Blocking Support
check with bidder
GPP Support
yes
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_groupm
hb_bidder_groupm
hb_adid_groupm
hb_size_groupm
hb_source_groupm
hb_format_groupm
hb_cache_host_groupm
hb_cache_id_groupm
hb_uuid_groupm
hb_cache_path_groupm
hb_deal_groupm
This bidder is not available in PBJS 6.24 and later.
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
'32572'
string
adSlot
optional
Ad Slot Name (see below)
'38519891'
string
pmzoneid
optional
Zone ID
'zone1,zone2'
string
lat
optional
Latitude
'40.712775'
string
lon
optional
Longitude
'-74.005973'
string
yob
optional
Year of Birth
'1982'
string
gender
optional
Gender
'M'
string
kadpageurl
optional
Overrides Page URL
'http://www.yahoo.com/'
string
kadfloor
optional
Bid Floor
'1.75'
string
currency
optional
Bid currency
'AUD' (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
string
dctr
optional
Deal Custom Targeting (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
'key1=123\|key2=345'
string
bcat
optional
Blocked IAB Categories (Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]
array of strings
deals
optional
PMP deals (Values from each slot will be passed per slot. An array of strings only. Each deal-id should be a string of a length of more than 3 characters.)
[ 'deal-id-5', 'deal-id-6', 'deal-id-7' ]
array of strings
outstreamAU
optional
Oustream AdUnit described in Blue BillyWig UI. This field is mandatory if mimeType is described as video and context is outstream (i.e., for outstream videos)
'renderer_test_groupm'
string
GroupM is an aliased bidder of PubMatic
Prebid Server Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
"32572"
string
adSlot
optional
Ad Slot Name
"38519891"
string
pmzoneid
optional
Comma separated zone id. Used im deal targeting & site section targeting. e.g drama,sport
Specifies GroupM openwrap configuration for a publisher
"wrapper": { "profile": 123, "version": 1}
object
keywords
optional
A set of key-value pairs; A key can have one or more values associated with it. They are used in buy-side segment targeting.
"keywords": { "genre": ["rock", "pop"] }
object
Prebid Server Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the
GroupM adapter. This example includes an imp object with an GroupM test publisher ID, ad slot,
and sizes that would match with the test creative.
These are 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.
Client side and server side parameters differ slightly. For Server side (Prebid S2S) implementation,
we currently accept the zone parameter. For Client side (Prebid.js) implementation, we accept zone and
a long list of other parameters which are listed below.
Server Side Bid Params
Name
Scope
Description
Example
Type
zone
required for all bid requests tracking a single domain or site
Tracking ID
'ggumtest'
string
pubId
required for all bid requests tracking multiple domains or sites
Publisher ID
123
integer
irisid
optional
Iris.tv ID
'iris_6f9285823a4'
string
slot
optional
Placement ID
40
number
product
required for new supported products like ‘skins’
Product Type
skins
string
Client Side Bid Params
Name
Scope
Description
Example
Type
zone
required for all bid requests tracking a single domain or site
Tracking ID
'ggumtest'
string
pubId
required for all bid requests tracking multiple domains or sites
Publisher ID
123
integer
slot
required for slot placement only
Slot ID
9
integer
product
required for new supported products like ‘skins’
Product Type
skins
string
iriscat
optional
Iris.tv segments
'segment1,segment2'
string
irisid
optional
Iris.tv ID
'123'
string
bidfloor
optional
CPM bidfloor in USD
0.03
float
Legacy Client Side Bid Params
Name
Scope
Description
Example
Type
inScreen
required for in-screen placement only
Tracking ID
'ggumtest'
string
inScreenPubID
required for in-screen placement only
Publisher ID
123
integer
inSlot
required for slot placement only
Slot ID
9
integer
video
required for video placement only
Tracking ID
'ggumtest'
string
videoPubID
required for video placement only
Publisher ID
123
integer
inVideo
required for in-video placement only
Tracking ID
'ggumtest'
string
ICV
required for ICV placement only
ICV ID
19
integer
bidfloor
optional
CPM bidfloor in USD
0.03
float
Please note that both video and in-video products require a mediaType of video while all other products
require a mediaType of banner.
Client Side Examples
Client side integration currently supports slot, in-screen, video, and in-video products.
The following examples are based on the ‘Client Side Bid Params’ table.
All bid requests require a zone or pubId parameter:
Slot ad requests require the slot parameter in the params object:
{
bidder: 'gumgum',
params: {
zone: 'zone_id', // provided by GumGum
slot: 'slot_id' // provided by GumGum
}
}
Video and In-Video
For video and in-video products, please follow the configuration shown under the in-screen example.
Additionally, you will need to define a ‘video’ field in the ‘mediaTypes’ object. For example:
All fields under video (context, playerSize, minDuration etc) are the minimum requirements to make a video ad request.
You should replace playerSize, minduration, maxduration, startdelay, placement, and protocols values to your
specifications (see OpenRTB spec 2.5 for more information). linearity should be set to 1 for video product, and 2 for in-video.
Server Side Examples
At the moment, the only products supported via Prebid S2S are slot, in-screen, and video.
The configuration is similar to client side configuration.
Add the following object in your bids array:
The mediaTypes field should have ‘banner’ with sizes using standard IAB display sizes (as seen in the example below).
The zone id is provided by GumGum.
{
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]]
}
},
bids: [
{
bidder: 'gumgum',
params: {
zone: 'zone_id' // zone id is provided by GumGum
}
},
]
}
In-Screen
The adUnits settings for both in-screen and slot have a similar structure. The only difference between slot
and in-screen ad unit configuration is the sizes.
In-screen products require a non-standard IAB display size (e.g. [1, 1] as seen in the example below or any
other size you choose).
{
mediaTypes: {
banner: {
sizes: [[1, 1]]
}
},
bids: [
{
bidder: 'gumgum',
params: {
zone: 'zone_id' // zone id is provided by GumGum
}
},
]
}
Skins
The skins product requires a similar setup to its client side header bidding counterpart:
All fields under video (context, playerSize, minDuration etc) are the minimum requirements
to make a video ad request. Please replace playerSize, w, h, mimes, minduration, maxduration,
startdelay, and protocols values to your specifications (see OpenRTB spec 2.5 for more information).
HuaweiAds
Features
Bidder Code
huaweiads
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_huaweiads
hb_bidder_huaweiads
hb_adid_huaweiads
hb_size_huaweiads
hb_source_huaweiads
hb_format_huaweiads
hb_cache_host_huawei
hb_cache_id_huaweiad
hb_uuid_huaweiads
hb_cache_path_huawei
hb_deal_huaweiads
Note:
The Example Bidding adapter requires setup before beginning. Please contact us at hwads@huawei.com.
The following parameters need to be registered on the HuaweiAds platform, and at the same time, the permission to access the server interface needs to be opened on the HuaweiAds platform.
You can find ( publisherid, signkey, keyid ) on the platform after registration.
You need to create your advertising creative on the platform and get the corresponding ( slotid, adtype ).
We need OAID, GAID, IMEI (One must not be empty, you can collect OAID first, or use GAID) in our request, so when using prebidmobile, please add something like “TargetingParams.addUserData(“oaid”, “oaid-test”) TargetingParams.addUserData(“gaid”, “gaid-test”) TargetingParams.addUserData(“imei”, “imei-test”)”.
You can also send the clientTime to the HuaweiAds Adx server, like “TargetingParams.addUserData(“clientTime”, “2018-11-02 16:34:07.981+0800”)”. if not, it will use the prebid server time and zone.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iionads
hb_bidder_iionads
hb_adid_iionads
hb_size_iionads
hb_source_iionads
hb_format_iionads
hb_cache_host_iionad
hb_cache_id_iionads
hb_uuid_iionads
hb_cache_path_iionad
hb_deal_iionads
Bid Params
Name
Scope
Description
Example
Type
host
required
Ad network’s RTB host
'iionads.com'
string
adUnitId
required
Ad Unit Id will be generated on iionads Platform.
42
integer
adUnitType
required
Type of Ad Unit ('video', 'banner')
'banner'
string
publisherId
required
Publisher ID
'12345'
string
custom1
optional
Custom targeting field 1
'custom1'
string
custom2
optional
Custom targeting field 2
'custom2'
string
custom3
optional
Custom targeting field 3
'custom3'
string
custom4
optional
Custom targeting field 4
'custom4'
string
custom5
optional
Custom targeting field 5
'custom5'
string
iionads server-side Prebid Server adapter requires only publisherId and host parameters. But iionads client-side Prebid.js adapter requires only host, adUnitId, adUnitType.
iionads server-side Prebid Server adapter supports only banner, video, audio, native media types. But iionads client-side Prebid.js adapter supports only banner and video media types, doesn’t support audio and native.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_impactify
hb_bidder_impactify
hb_adid_impactify
hb_size_impactify
hb_source_impactify
hb_format_impactify
hb_cache_host_impact
hb_cache_id_impactif
hb_uuid_impactify
hb_cache_path_impact
hb_deal_impactify
Note:
The Impactify adaptator requires setup and validation from the Impactify team. Simply email us your contact details at support@impactify.io and we’ll make sure we’ll connect you within 48h.
Bid Params
Name
Scope
Description
Example
Type
appId
required
Impactify publisher id (Contact us)
'example.com'
string
format
required
Impactify ad format (screen or display)
'screen'
string
style
required
Impactify ad style (inline, impact or static)
'impact'
string
Configuration
Impactify recommends the UserSync configuration below. Without it, the Impactify adapter will not be able to perform user syncs, which lowers match rate and reduces monetization.
For Prebid.js v1.15.0 and later:
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// '*' represents all biddersfilter:'include'}}}});
Note: Combine the above configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only the last call for a given attribute will take effect.
Improve Digital
Features
Bidder Code
improvedigital
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
yes
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Name
Scope
Description
Example
Type
placementId
required
The placement ID from Improve Digital.
1234567
integer
publisherId
required
The publisher ID from Improve Digital.
4567
integer
keyValues
optional
Contains one or more key-value pairings for key-value targeting
Configuration object for JS renderer of the RAZR creatives. Provided by Improve Digital.
{ key1: value1 }
object
Configuration
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:
Global configuration for the special creative format renderer. Please use rendererConfig bid param for ad slot specific configuration.
pbjs.setConfig({
improvedigital: {
rendererConfig: {
// Global config object provided by Improve Digital
}
}
});
Extend Mode
Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information.
The Extend mode can be enabled:
Examples of different ad unit formats can be found in Prebid.js ad unit reference. Improve Digital bidder must be added in the ad unit’s bids array. Example:
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_infytv
hb_bidder_infytv
hb_adid_infytv
hb_size_infytv
hb_source_infytv
hb_format_infytv
hb_cache_host_infytv
hb_cache_id_infytv
hb_uuid_infytv
hb_cache_path_infytv
hb_deal_infytv
Note:
The Example Bidding adapter requires setup before beginning. Please contact us at adops@infy.tv
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
'11111'
string
placementId
optional
Placement ID
'11111'
string
InMobi
Features
Bidder Code
inmobi
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_inmobi
hb_bidder_inmobi
hb_adid_inmobi
hb_size_inmobi
hb_source_inmobi
hb_format_inmobi
hb_cache_host_inmobi
hb_cache_id_inmobi
hb_uuid_inmobi
hb_cache_path_inmobi
hb_deal_inmobi
Note:
The InMobi Prebid adapter requires a setup to create placement IDs. Please contact your InMobi partner manager for setup assistance.
For queries, write to us at prebid-support@inmobi.com
User Sync Disclosure:
InMobi has partnered with a third party, ID5, to use their ID as our primary user identifier for mobile web supply. We will also rely on ID5 IDs to handle compliance flows related to Data Subject Right requests in our systems. Hence, we require the publisher to use ID5’s sync URL for user syncing and passing the corresponding ID5 ID to InMobi in the bid request. For this purpose, we provide ID5’s sync URL in our Prebid adapter for User ID sync. Note that, InMobi has a direct contract with ID5 for consuming ID5 ID and the user sync via Prebid does not require the publisher to get into a contractual relationship with ID5.
To opt out of InMobi ads on mobile web inventory or for any other requests, the user needs to visit the Opt-out page on InMobi website (https://www.inmobi.com/page/opt-out/). For opting out of ID5 ID entirely, the user needs to visit ID5’s opt out page: https://id5.io/platform-privacy-policy/.
Bid Params
Name
Scope
Description
Example
Type
plc
required
Placement ID
'1234'
string
InteractiveOffers
Features
Bidder Code
interactiveOffers
Prebid.org Member
no
Media Types
display
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_interactiveOff
hb_bidder_interactiv
hb_adid_interactiveO
hb_size_interactiveO
hb_source_interactiv
hb_format_interactiv
hb_cache_host_intera
hb_cache_id_interact
hb_uuid_interactiveO
hb_cache_path_intera
hb_deal_interactiveO
Note:
Module that connects to interactiveOffers demand sources. Param partnerId is required.
These are 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
Disclosure
The bidder will use the Local Storage if allowed by the publisher and user gives consent on page with the following purposes:
- set an internal Invibes ID
- get the internal Invibes ID if it was set priorly for the user
The bidder will NOT set any cookies. The bidder will also try to read from Cookies if publisher gibes the internal ID if this wasn’t found in LocalStorage.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
The Invibes placement ID
'1234567'
string
domainId
optional
Id of domain
1001
integer
customEndpoint
optional
Custom test domain
https://bid.videostep.com/Bid/VideoAdContent
integer
debug
optional
Debug paramentes (only prebid server)
{ "testBvid": "1234", "testLog": true }
object
IQzone
Features
Bidder Code
iqzone
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iqzone
hb_bidder_iqzone
hb_adid_iqzone
hb_size_iqzone
hb_source_iqzone
hb_format_iqzone
hb_cache_host_iqzone
hb_cache_id_iqzone
hb_uuid_iqzone
hb_cache_path_iqzone
hb_deal_iqzone
Prebid.js Bid Params
Name
Scope
Description
Example
Type
placementId
optional
Placement Id
'0'
'string'
endpointId
optional
Endpoint Id
'0'
'string'
Note
For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
Publishers can use Prebid Server in any of the following ways with Index Exchange (Index). Index’s adapter supports all of the following methods:
If you want to call Index from a web environment, you can use Prebid.js to call Prebid Server, and then Prebid Server uses our server-side adapter to call Index. This reduces workload on the browser. For set up instructions, see Call Index from a web browser section on this page.
In mobile apps, you can use the Prebid Mobile SDK to call Prebid Server and then Prebid Server uses our server-side adapter to call Index. For set up instructions, see Call Index from Prebid Mobile SDK section on this page.
In CTV apps and other long-form video environments, you (or the SSAI vendor) can make a call to Prebid Server using OpenRTB, and then Prebid Server uses our server-side adapter to call Index. For set up instructions, see Call Index from CTV/long-form video environment section on this page.
Note about sending multiple ad slots in a single bid request: Index accepts up to 100 valid ad slots in a single bid request. If a single bid request contains more than 100 ad slots (including invalid ad slots), only the first 100 valid ad slots are accepted and the rest are ignored. For example streaming TV media owners can signal multiple ad pods for long-form programming in a single request.
Supported media types
The following table lists the media types that Index supports. For information about the the Time-To-Live (TTL) for each media type, see How Index counts impressions in our Knowledge Base.
Type
Prebid Server support
banner
Supported
video
Supported, including ad pods for OTT
native
Supported
Setup instructions to call Index through Prebid Server
Note: If you are hosting your own Prebid Server instance, you must contact your Index Exchange Representative to get an endpoint and setup instructions.
If you are using an existing Prebid Server instance that is already configured to call Index, depending on whether you want to call Index from the browser, mobile app, CTV, or long-form video, follow any of the below sections to complete the Index-specific configuration.
Call Index from a web browser
If you want to call Index from a web environment, you can use Prebid.js to call Prebid Server and then Prebid Server uses our server-side adapter to call Index. For setup instructions, see the Index-specific configuration steps in Set up instructions for Prebid.js in our Prebid.js documentation on the Prebid site.
Call Index from Prebid Mobile SDK
Before you begin: Contact your Index Exchange representative to get your siteId. You must provide this site ID to your Prebid Server host company.
Inform your Prebid Server hosting company to add ix as a bidder in the configuration and include the siteId that Index provides to you at the time of integration.
Define the Index-specific parameters at the bidder level. For information about these parameters, see the Bid request parameters section below.
Before you begin: Contact your Index Exchange Representative to get the siteId. You must provide this site ID to your Prebid Server host company.
Note: To implement CTV and long-form video using Prebid Server, follow Prebid’s Long Form Video documentation.
To add Index as a bidder:
Inform your Prebid Server hosting company to add ix as a bidder in the configuration and include the siteId that Index provides to you at the time of integration.
Define the Index-specific parameters at the bidder level. For information about these parameters, see the Bid request parameters section below.
Include any ad unit level required or optional parameters provided in Prebid’s /openrtb2/video documentation.
Call Index from any other server-to-server OpenRTB environment
To request bids from Index:
In requests that you make to your Prebid Server host, add imp.ext.ix and include the siteId that Index provides to you at the time of integration. Example:
You must include these parameters at the bidder level.
Key
Scope
Type
Description
siteId
Required
String
An Index-specific identifier that is associated with this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '3723', '6482', '3639'
Video
You must include these parameters at the bidder level.
Key
Scope
Type
Description
siteId
Required
String
An Index-specific identifier that is associated with this ad unit. It will be associated with the single size, if the size is provided. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '3723', '6482', '3639' Note: You can re-use the existing siteId within the same flex position or video size, if the video adapts to the containing <div> element.
If you are using Index’s outstream player and have placed the video object at the bidder level, you must include the Index required parameters at the bidder level. You can include the optional parameters to specify the outstream player configurations.
Key
Scope
Type
Description
video.w
Required
Integer
The width of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the video.w and video.h parameters, with a minimum video player size of 300 x 250.
video.h
Required
Integer
The height of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the video.w and video.h parameters, with a minimum video player size of 300 x 250.
video.playerSize
Required
Integer[]
The video player size that will be passed to demand partners.
video.playerConfig
Optional
Hash
The Index-specific outstream player configurations.
video.playerConfig.floatOnScroll
Optional
Boolean
A boolean specifying whether you want to use the player’s floating capabilities, where: - true: Use the Index player’s float capabilities. Note: If you set floatOnScroll to true, Index updates the placement value to 5. Note: We do not recommend using the player’s default float capabilities if you have more than one outstream ad unit per page. -false: Do not use the Index player’s float capabilities (default).
video.playerConfig.floatSize
Optional
Integer[]
The height and width of the floating player in pixels. If you do not specify a float size, the player adjusts to the aspect ratio of the player size that is defined when it is not floating. Index recommends that you review and test the float size to your user experience preference.
Examples
Banner
{"id":"ix-banner-id","imp":[{"id":"imp-id","banner":{"w":300,"h":250,"id":"1","pos":0,"format":[{"w":300,"h":250},{"w":300,"h":600}]},"instl":0,"tagid":"5602709","bidfloor":0.02,"bidfloorcur":"USD","secure":1,"ext":{"ix":{"siteId":"123456"}}}],"app":{"bundle":"555555555","storeurl":"https://apps.apple.com/us/app/test-app/id555555555","publisher":{"id":"123456"},"content":{"title":"Entertainment","genre":"IAB9-30,IAB6,IAB9-7,IAB1"}},"device":{"ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148","ip":"10.20.30.40","ifa":"2E2E2E2E-3B3B-4141-8A8A-181818181818"},"at":1,"tmax":200}
Video
{"id":"ix-video-example","imp":[{"id":"imp-id","video":{"mimes":["video/mp4","video/3gpp","video/webm"],"minduration":15,"maxduration":60,"startdelay":-1,"protocols":[2,3,5,6],"w":320,"h":480,"placement":1,"linearity":1,"minbitrate":1000,"api":[1,2,3,5]},"secure":1,"ext":{"ix":{"siteId":"654321"}}}],"app":{"bundle":"555555555","storeurl":"https://apps.apple.com/us/app/test-app/id555555555","publisher":{"id":"123456"},"content":{"title":"Entertainment","genre":"IAB9-30,IAB6,IAB9-7,IAB1"}},"device":{"ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E18","ip":"10.20.30.40","ifa":"2E2E2E2E-3B3B-4141-8A8A-181818181818"},"at":1,"tmax":1000}
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_janet
hb_bidder_janet
hb_adid_janet
hb_size_janet
hb_source_janet
hb_format_janet
hb_cache_host_janet
hb_cache_id_janet
hb_uuid_janet
hb_cache_path_janet
hb_deal_janet
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from janet.
529814
integer
Description
JANet header bidding adapter connects with JANet demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand.
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: {
janet: {
chunkSize: 1 // makes 1 http request per 1 adunit configured
}
}
});
Jixie
Features
Bidder Code
jixie
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
no
User IDs
uid2, unifiedId
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
'1000012-VyuoGmDQQQ'
string
accountid
optional
The accountid from jixie
'12345678901234567890'
string
jxprop1
optional
special property #1
'somethingspecial1'
string
jxprop2
optional
special property #2
'somethingspecial2'
string
Kargo
Features
Bidder Code
kargo
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
unifiedId
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
yes
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
will-bid-on-any
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kargo
hb_bidder_kargo
hb_adid_kargo
hb_size_kargo
hb_source_kargo
hb_format_kargo
hb_cache_host_kargo
hb_cache_id_kargo
hb_uuid_kargo
hb_cache_path_kargo
hb_deal_kargo
Disclosure:
This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.
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.
Bidder Settings
The Kargo bid adapter uses browser local storage. Since Prebid.js 7.x, the access to it must be explicitly set.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kidoz
hb_bidder_kidoz
hb_adid_kidoz
hb_size_kidoz
hb_source_kidoz
hb_format_kidoz
hb_cache_host_kidoz
hb_cache_id_kidoz
hb_uuid_kidoz
hb_cache_path_kidoz
hb_deal_kidoz
Registration
Kidoz is exclusively for Mobile app COPPA compatible ads, 100% kid relevant and appropriate.
In order for a company to receive bids from Kidoz, they must first open a publisher account at Kidoz.net
(https://accounts.kidoz.net/publishers/register) and accept the Kidoz Terms and Conditions and Privacy Policy.
Kidoz publishers must confirm that all of their content properties are COPPA and GDPR compliant and perform no monitoring
or tracking of U13 users in their operations. New publishers are provided a Publisher ID and AccessToken, this can also
be used to login to their dashboard at the Kidoz.net portal to monitor their account activity.
Bid Params
Name
Scope
Description
Example
Type
access_token
required
Kidoz access_token
‘123abc’
string
publisher_id
required
Kidoz publisher_id
‘44444’
string
Kivi
Features
Bidder Code
kiviads
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
no
Multi Format Support
will-not-bid
ORTB Blocking Support
partial
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kiviads
hb_bidder_kiviads
hb_adid_kiviads
hb_size_kiviads
hb_source_kiviads
hb_format_kiviads
hb_cache_host_kiviad
hb_cache_id_kiviads
hb_uuid_kiviads
hb_cache_path_kiviad
hb_deal_kiviads
Bid Params
Name
Scope
Description
Example
Type
placementId
optional
Placement Id
'0'
'string'
endpointId
optional
Endpoint Id
'0'
'string'
Krushmedia
Features
Bidder Code
krushmedia
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_krushmedia
hb_bidder_krushmedia
hb_adid_krushmedia
hb_size_krushmedia
hb_source_krushmedia
hb_format_krushmedia
hb_cache_host_krushm
hb_cache_id_krushmed
hb_uuid_krushmedia
hb_cache_path_krushm
hb_deal_krushmedia
Bid Params
Name
Scope
Description
Example
Type
key
required
Unique client id on krushmedia platform
0
string
Kubient
Features
Bidder Code
kubient
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.
These are 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
Limelight Digital
Features
Bidder Code
limelightDigital
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
all
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
no
Multi Format Support
will-bid-on-one
ORTB Blocking Support
yes
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_limelightDigit
hb_bidder_limelightD
hb_adid_limelightDig
hb_size_limelightDig
hb_source_limelightD
hb_format_limelightD
hb_cache_host_limeli
hb_cache_id_limeligh
hb_uuid_limelightDig
hb_cache_path_limeli
hb_deal_limelightDig
Bid Params
Name
Scope
Description
Example
Type
host
required
Ad network’s RTB host
'exchange.ortb.net'
string
adUnitId
required
Ad Unit Id will be generated on Limelight Digital Platform.
42
integer
adUnitType
required
Type of Ad Unit ('video', 'banner')
'banner'
string
publisherId
required
Publisher ID
'12345'
string
custom1
optional
Custom targeting field 1
'custom1'
string
custom2
optional
Custom targeting field 2
'custom2'
string
custom3
optional
Custom targeting field 3
'custom3'
string
custom4
optional
Custom targeting field 4
'custom4'
string
custom5
optional
Custom targeting field 5
'custom5'
string
Limelight Digital server-side Prebid Server adapter requires only publisherId and host parameters. But Limelight Digital client-side Prebid.js adapter requires only host, adUnitId, adUnitType.
Limelight Digital server-side Prebid Server adapter supports only banner, video, audio, native media types. But Limelight Digital client-side Prebid.js adapter supports only banner and video media types, doesn’t support audio and native.
LockerDome
Features
Bidder Code
lockerdome
Prebid.org Member
no
Media Types
display
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lockerdome
hb_bidder_lockerdome
hb_adid_lockerdome
hb_size_lockerdome
hb_source_lockerdome
hb_format_lockerdome
hb_cache_host_locker
hb_cache_id_lockerdo
hb_uuid_lockerdome
hb_cache_path_locker
hb_deal_lockerdome
Bid Params
Name
Scope
Description
Example
Type
adUnitId
required
The ad unit ID from LockerDome
'LD10809467961050726'
string
Logan
Features
Bidder Code
logan
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
no
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_logan
hb_bidder_logan
hb_adid_logan
hb_size_logan
hb_source_logan
hb_format_logan
hb_cache_host_logan
hb_cache_id_logan
hb_uuid_logan
hb_cache_path_logan
hb_deal_logan
Bid Params
Name
Scope
Description
Example
Type
placementId
required
Placement Id will be generated on Logan Platform.
'0'
string
Logicad for Publishers
Features
Bidder Code
logicad
Prebid.org Member
no
Media Types
display, native
GDPR TCF Support
no
User IDs
all
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_logicad
hb_bidder_logicad
hb_adid_logicad
hb_size_logicad
hb_source_logicad
hb_format_logicad
hb_cache_host_logica
hb_cache_id_logicad
hb_uuid_logicad
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
Madvertise
Features
Bidder Code
madvertise
Prebid.org Member
no
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
no
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_madvertise
hb_bidder_madvertise
hb_adid_madvertise
hb_size_madvertise
hb_source_madvertise
hb_format_madvertise
hb_cache_host_madver
hb_cache_id_madverti
hb_uuid_madvertise
hb_cache_path_madver
hb_deal_madvertise
Prebid.js Bid Params
Name
Scope
Description
Example
Type
zoneId
required Prebid version 5.x+
Zone code. This parameter should be the unique Publisher ID of your mobile application or website.
/1111111/banner
string
s
required in-scope only for 4.x
Zone code. This parameter should be the unique Publisher ID of your mobile application or website. Replace by zoneId starting 5.x
These are 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
Banner - Ad Unit Setup
varadUnits=[{code:'marsmedia-ad-123456-1',// ad slot HTML element ID mediaTypes:{banner:{sizes:[[300,250]]}}bids:[{bidder:'marsmedia',params:{zoneId:9999// required }}]}
Instream Video - Ad Unit Setup
varadUnits=[{code:'marsmedia-ad-123456-1',// ad slot HTML element ID mediaTypes:{video:{// We recommend setting the following video params// in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. playerSize:[300,250],// requiredcontext:'instream',// requiredmimes:['video/mp4','video/x-flv'],// requiredprotocols:[2,3],// required, set at least 1 value in arrayplacement:1,// optional, defaults to 1 when context = instreamstartdelay:0,// optional, defaults to 0 when context = instreamapi:[1,2],// optionalskip:0,// optionalminduration:5,// optionalmaxduration:30,// optionalplaybackmethod:[1,3],// optionalbattr:[13,14],// optionallinearity:1,// optionalminbitrate:10,// optionalmaxbitrate:10// optional}},bids:[{bidder:'marsmedia',params:{zoneId:9999// required }}],...}
MediaFuse
Features
Bidder Code
mediafuse
Prebid.org Member
yes
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
yes
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mediafuse
hb_bidder_mediafuse
hb_adid_mediafuse
hb_size_mediafuse
hb_source_mediafuse
hb_format_mediafuse
hb_cache_host_mediaf
hb_cache_id_mediafus
hb_uuid_mediafuse
hb_cache_path_mediaf
hb_deal_mediafuse
Prebid Server Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the server-side Mediafuse adapter. This example includes an Mediafuse test placement ID and sizes that would match with the test creative.
var adUnits = [
// Banner adUnit
{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
},
bids: [{
bidder: 'mediafuse',
params: {
placementId: 13144370
}
}]
},
// Native adUnit
{
code: 'native-div',
sizes: [[1, 1]],
mediaTypes: {
native: {
title: {
required: true
},
body: {
required: true
},
image: {
required: true
},
sponsoredBy: {
required: true
},
icon: {
required: false
}
}
},
bids: [{
bidder: 'mediafuse',
params: {
placementId: 13232354,
allowSmallerSizes: true
}
}]
},
// Video instream adUnit
{
code: 'video-instream',
sizes: [[640, 480]],
mediaTypes: {
video: {
playerSize: [[640, 480]],
context: 'instream'
},
},
bids: [{
bidder: 'mediafuse',
params: {
placementId: 13232361,
video: {
skippable: true,
playback_methods: ['auto_play_sound_off']
}
}
}]
},
// Video outstream adUnit
{
code: 'video-outstream',
sizes: [[300, 250]],
mediaTypes: {
video: {
playerSize: [[300, 250]],
context: 'outstream',
// Certain ORTB 2.5 video values can be read from the mediatypes object; below are examples of supported params.
// To note - mediafuse supports additional values for our system that are not part of the ORTB spec. If you want
// to use these values, they will have to be declared in the bids[].params.video object instead using the mediafuse syntax.
// Between the corresponding values of the mediaTypes.video and params.video objects, the properties in params.video will
// take precedence if declared; eg in the example below, the `skippable: true` setting will be used instead of the `skip: 0`.
minduration: 1,
maxduration: 60,
skip: 0, // 1 - true, 0 - false
skipafter: 5,
playbackmethod: [2], // note - we only support options 1-4 at this time
api: [1,2,3] // note - option 6 is not supported at this time
}
},
bids: [
{
bidder: 'mediafuse',
params: {
placementId: 13232385,
video: {
skippable: true,
playback_method: 'auto_play_sound_off'
}
}
}
]
},
// Banner adUnit in a App Webview
// Only use this for situations where prebid.js is in a webview of an App
// See Prebid Mobile for displaying ads via an SDK
{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
}
bids: [{
bidder: 'mediafuse',
params: {
placementId: 13144370,
app: {
id: "B1O2W3M4AN.com.prebid.webview",
geo: {
lat: 40.0964439,
lng: -75.3009142
},
device_id: {
idfa: "4D12078D-3246-4DA4-AD5E-7610481E7AE", // Apple advertising identifier
aaid: "38400000-8cf0-11bd-b23e-10b96e40000d", // Android advertising identifier
md5udid: "5756ae9022b2ea1e47d84fead75220c8", // MD5 hash of the ANDROID_ID
sha1udid: "4DFAA92388699AC6539885AEF1719293879985BF", // SHA1 hash of the ANDROID_ID
windowsadid: "750c6be243f1c4b5c9912b95a5742fc5" // Windows advertising identifier
}
}
}
}]
}
];
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_medianet
hb_bidder_medianet
hb_adid_medianet
hb_size_medianet
hb_source_medianet
hb_format_medianet
hb_cache_host_median
hb_cache_id_medianet
hb_uuid_medianet
hb_cache_path_median
hb_deal_medianet
Bid Params
Name
Scope
Description
Example
Type
cid
required
The customer id provided by Media.net.
'8CUX0H51C'
string
crid
required
The placement id provided by Media.net
'1234567'
string
bidfloor
optional
Bidfloor for the impression
1.0
float
video
required for video Ad units
Object containing video targeting parameters. See Video Object for details.
video: { maxduration: 60 }
object
Video Object
Name
Type
Description
Example
mimes
array of strings
(Recommended) Specifies the video content MIME types supported; for example, video/x-ms-wmv and video/x-flv.
[“video/x-ms-wmv”,”video/x-flv”]
minduration
integer
(Recommended) Specifies the minimum video ad duration, in seconds.
10
maxduration
integer
(Recommended) Specifies the maximum video ad duration, in seconds.
60
w
integer
(Recommended) Specifies the width of the video player, in pixels. Required if playerSize not present in mediaTypes.video
640
h
integer
(Recommended) Specifies the height of the video player, in pixels. Required if playerSize not present in mediaTypes.video
480
startdelay
integer
(Recommended) Specifies the start delay of the video ad
0
battr
array of integers
Specifies the video creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes.
[ 13, 14 ]
playbackmethod
array of integers
Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are: 1: Autoplay, sound on; 2: Autoplay, sound off; 3: Click to play; 4: Mouse over to play
[1, 3]
api
array of integers
Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are: 1: VPAID 1.0; 2: VPAID 2.0; 3: MRAID-1; 4: ORMMA; 5: MRAID-2
Placement type for the impression. Possible options: 1: In-Stream; 2: In-banner; 3: Outstream/In-article; 4: In-feed; 5: Interstitial/Slider/Floating; 6: Long-Form;
1
Besides the above-mentioned parameters, we support all other OpenRTB 2.x video objects as optional parameters.
In addition to bids[].params.video, Media.net adapter consumes parameters specified in the mediaTypes.video.
Example of Instream Video Ad-unit
var videoAdUnit = {
code: 'video1',
mediaTypes: {
video: {
context: "instream",
playerSize: [640, 480],
mimes: ['video/mp4'],
placement: 1
}
},
bids: [{
bidder: 'medianet',
params: {
cid: '8CUX0H51C',
crid: '776755783',
// Site member is to be used only for testing
site: {
page: 'http://smoketesting.net/prebidtest/',
domain: 'smoketesting.net',
ref: 'http://smoketesting.net/prebidtest/'
}
}
}]
};
Example of Native Ad-unit
var adUnits = [{
code: 'div-gpt-ad-1544091247692-0',
mediaTypes: {
native: {
image: {
required: true,
sizes: [300, 250],
wmin: 50,
},
title: {
required: true,
len: 80
}
}
},
bids: [{
bidder: 'medianet',
params: {
cid: '8CUX0H51C',
crid: '776755783',
// Site member is to be used only for testing
site: {
page: 'http://smoketesting.net/prebidtest/',
domain: 'smoketesting.net',
ref: 'http://smoketesting.net/prebidtest/'
}
}
}]
}];
Example of Banner Ad-unit
var adUnits = [{
code: 'div-gpt-ad-1460505748561-0',
mediaTypes: {
banner: {
sizes: [
[728, 90],
[300, 600],
[300, 250]
],
}
},
bids: [{
bidder: 'medianet',
params: {
cid: '8CUX0H51C',
crid: '451466393',
// Site member is to be used only for testing
site: {
page: 'http://smoketesting.net/prebidtest/',
domain: 'smoketesting.net',
ref: 'http://smoketesting.net/prebidtest/'
}
}
}]
}];
Mgid
Features
Bidder Code
mgid
Prebid.org Member
no
Media Types
display, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
will-bid-on-any
ORTB Blocking Support
partial
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
One of the easiest way to gain access to MGID demand sources - MGID header bidding adapter.
MGID header bidding adapter connects with MGID demand sources to fetch bids for display placements. Please reach out to your account manager or prebid@mgid.com for more information.
Bid params
Name
Scope
Description
Example
Type
accountId
required
The account ID from Mgid
'123'
string
placementId
optional
The placement ID from Mgid
'123456'
string
bidFloor
optional
Lowest value of expected bid price
1.1
float
currency
optional
Currency of request and response
'GBP'
string
Test Parameters
300x600 banner test
var adUnits = [{
code: 'div-prebid',
mediaTypes: {
banner: {
sizes: [[300, 600]]
}
},
// Replace this object to test a new Adapter!
bids: [{
bidder: 'mgid',
params : {
accountId : "219" //test accountId, please replace after test
}
}]
}];
300x250 banner test
var adUnits = [{
code: 'div-prebid',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
// Replace this object to test a new Adapter!
bids: [{
bidder: 'mgid',
params : {
accountId : "219" //test accountId, please replace after test
}
}]
}];
native test
var adUnits = [{
code: 'div-prebid',
mediaTypes: {
native: {
image: {
sendId: true,
required: true,
sizes: [80, 80]
},
clickUrl: {
sendId: true,
required: false
},
title: {
required: true,
len: 80
},
sponsored: {
required: false
}
}
},
// Replace this object to test a new Adapter!
bids: [{
bidder: 'mgid',
params : {
accountId : "219" //test accountId, please replace after test
}
}]
}];
User Sync
Mgid recommends UserSync configuration to be enabled. Without it, Mgid adapter will not be able to perform user syncs, which lowers match rate and reduces monetization.
For Prebid.js v1.15.0 and later:
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// '*' represents all biddersfilter:'include'}}}});
Note: Combine the above configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only the last call for a given attribute will take effect.
Mobfox_PB
Features
Bidder Code
mobfoxpb
Prebid.org Member
no
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
check with bidder
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mobfoxpb
hb_bidder_mobfoxpb
hb_adid_mobfoxpb
hb_size_mobfoxpb
hb_source_mobfoxpb
hb_format_mobfoxpb
hb_cache_host_mobfox
hb_cache_id_mobfoxpb
hb_uuid_mobfoxpb
hb_cache_path_mobfox
hb_deal_mobfoxpb
Prebid.JS Bid Params
Name
Scope
Description
Example
Type
placementId
required
Placement Id will be generated on Mobfox Platform.
'0'
string
Prebid Server Bid Params
Currently adapter doesn’t support multiimpression, so only the first impression will be delivered
Name
Scope
Description
Example
Type
TagID
required
Placement Id will be generated on Mobfox Platform. For direct integration
'0'
string
key
required
Endpoint id will be generated on Mobfox Platform. For s2s integration
'0'
string
MobileFuse
Features
Bidder Code
mobilefuse
Prebid.org Member
yes
Media Types
display, video, native
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
yes
COPPA Support
yes
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
no
Mobile App Support
yes
Prebid Server Adapter
yes
Floors Support
yes
First Party Data Support
check with bidder
Multi Format Support
check with bidder
ORTB Blocking Support
yes
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mobilefuse
hb_bidder_mobilefuse
hb_adid_mobilefuse
hb_size_mobilefuse
hb_source_mobilefuse
hb_format_mobilefuse
hb_cache_host_mobile
hb_cache_id_mobilefu
hb_uuid_mobilefuse
hb_cache_path_mobile
hb_deal_mobilefuse
Bid Params
Name
Scope
Description
Example
Type
placement_id
required
An ID which identifies this specific inventory placement
1111
integer
pub_id
required
An ID which identifies the publisher selling the inventory
2222
integer
tagid_src
optional
ext if passing publisher’s ids, empty if passing MobileFuse IDs in placement_id field. Defaults to empty
’’
string
NextMillennium
Features
Bidder Code
nextMillennium
Prebid.org Member
yes
Media Types
display, video
GDPR TCF Support
yes
User IDs
none
USP/CCPA Support
yes
Supply Chain Support
no
COPPA Support
no
Demand Chain Support
no
Safeframes OK
check with bidder
Supports Deals
yes
Prebid.js Adapter
yes
Mobile App Support
check with bidder
Prebid Server Adapter
yes
Floors Support
no
First Party Data Support
no
Multi Format Support
check with bidder
ORTB Blocking Support
check with bidder
GPP Support
no
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nextMillennium
hb_bidder_nextMillen
hb_adid_nextMillenni
hb_size_nextMillenni
hb_source_nextMillen
hb_format_nextMillen
hb_cache_host_nextMi
hb_cache_id_nextMill
hb_uuid_nextMillenni
hb_cache_path_nextMi
hb_deal_nextMillenni
Bid Params
Name
Scope
Description
Example
Type
placement_id
required
Placement ID, provided by nextMillennium
'12345'
String
group_id
optional
Group ID, provided by nextMillennium
'12345'
String
Required one of the two parameters placement_id or group_id.
Further information for the auction on NextMillennium side is generated automatically.
Additional options
disabledSendingStatisticData
The disabledSendingStatisticData parameter disables sending statistics data to the nextMillennium server, such as bidRequested, bidResponse, noBid and bidTimeout events.
An example of enabling this option:
If you are using Google Ad Manager (GAM), it is highly recommended to make sure the “Serve in Safeframe” box in creative settings is unchecked.
If you absolutely want to run NoBid in a Saferame creative, please contact your Nobid repsentative to coordinate this setup.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_openweb
hb_bidder_openweb
hb_adid_openweb
hb_size_openweb
hb_source_openweb
hb_format_openweb
hb_cache_host_openwe
hb_cache_id_openweb
hb_uuid_openweb
hb_cache_path_openwe
hb_deal_openweb
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from OpenWeb.
650342
integer
Description
OpenWeb.com official prebid adapter. Available in both client and server side versions.
OpenWeb header bidding adapter provides solution for accessing banner demand.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_openx
hb_bidder_openx
hb_adid_openx
hb_size_openx
hb_source_openx
hb_format_openx
hb_cache_host_openx
hb_cache_id_openx
hb_uuid_openx
hb_cache_path_openx
hb_deal_openx
Registration
If you have any questions regarding set up, please reach out to your account manager or support@openx.com.
Please note that OpenX is transitioning its serving architecture and currently has 2 bid adapters as of Prebid 7. The legacy adapter is named openxBidAdapter.
The newer of the two is openxOrtbBidAdapter. Publishers are welcome to test with openxOrtbBidAdapter and give feedback.
After the transition openxOrtbBidAdapter will replace openxBidAdapter.
IMPORTANT: only include either openxBidAdapter or openxOrtbBidAdapter in your build.
Bid Parameters
Banner
Name
Scope
Description
Example
Type
delDomainor platform**
required
OpenX delivery domain provided by your OpenX representative.
“PUBLISHER-d.openx.net”
String
unit
required
OpenX ad unit ID provided by your OpenX representative.
“1611023122”
String
customParams
optional
User-defined targeting key-value pairs. customParams applies to a specific unit.
{key1: "v1", key2: ["v2","v3"]}
Object
customFloor
optional
Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50
WARNING: Misuse of this parameter can impact revenue.
Note: OpenX suggests using the Price Floor Module instead of customFloor. The Price Floor Module is prioritized over customFloor if both are present.
1.50
Number
doNotTrack
optional
Prevents advertiser from using data for this user.
WARNING: Impacts all bids in the request. May impact revenue.
true
Boolean
coppa
optional
Enables Child’s Online Privacy Protection Act (COPPA) regulations. WARNING: Impacts all bids in the request. May impact revenue.
true
Boolean
** platform is deprecated. Please use delDomain instead. If you have any questions please contact your representative.
AdUnit Format for Banner
varadUnits=[{code:'test-div',sizes:[[728,90]],// a display sizemediaTypes:{'banner':{}},bids:[{bidder:'openx',params:{unit:'539439964',delDomain:'se-demo-d.openx.net',customParams:{key1:'v1',key2:['v2','v3']},}},{bidder:'openx',params:{unit:'539439964',delDomain:'se-demo-d.openx.net',customParams:{key1:'v1',key2:['v2','v3']},}}]}];
Video
Name
Scope
Description
Example
Type
unit
required
OpenX ad unit ID provided by your OpenX representative.
“1611023122”
String
delDomainor platform**
required
OpenX delivery domain provided by your OpenX representative.
“PUBLISHER-d.openx.net”
String
** platform is deprecated. Please use delDomain instead. If you have any questions please contact your representative.
mediaTypes.video
The following video parameters are supported here so publishers may fully declare their video inventory:
Name
Scope
Description
Example
Type
context
required
instream or outstream
“outstream”
string
playerSize
required
width, height of the player in pixels
[640,360] - will be translated to w and h in bid request
array
mimes
required
List of content MIME types supported by the player (see openRTB v2.5 for options)
OpenRTB2 linearity. 1: linear (in-stream ad), 2: non-linear (overlay ad)
1
integer
maxduration
recommended
Maximum video ad duration in seconds.
30
integer
minduration
recommended
Minimum video ad duration in seconds
6
integer
playbackmethod
recommended
Playback methods that may be in use. Only one method is typically used in practice. (see openRTB v2.5 section 5.10 for options)
[2]
array
minbitrate
optional
Minimum bit rate in Kbps.
300
integer
maxbitrate
optional
Maximum bit rate in Kbps.
9600
integer
battr
optional
Blocked creative attributes
[13,14]
array
startdelay
recommended
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. >0: Mid-Roll (value indicates start delay in second) 0: Pre-Roll -1: Generic Mid-Roll -2: Generic Post-Roll
0
integer
placement
recommended
Placement type for the impression. (see openRTB v2.5 section 5.9 for options)
varadUnits=[{code:'test-div',sizes:[[728,90]],// a display sizemediaTypes:{'banner':{}},bids:[{bidder:'openx',params:{unit:'539439964',delDomain:'se-demo-d.openx.net',customParams:{key1:'v1',key2:['v2','v3']},}},{bidder:'openx',params:{unit:'539439964',delDomain:'se-demo-d.openx.net',customParams:{key1:'v1',key2:['v2','v3']},}}]},{code:'video1',mediaTypes:{video:{playerSize:[640,480],context:'instream',mimes:['video/x-ms-wmv, video/mp4']}},bids:[{bidder:'openx',params:{unit:'1611023124',delDomain:'PUBLISHER-d.openx.net'}}]}];
First Party Data
OpenX supports FPD configured under ortb2.userand ortb2.site.content as described here.
Ad unit specific FPD is not supported, and segment taxonomies (segtax) are simply passed through. If you have any
questions, please reach out to us at prebid@openx.com
Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes.
OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the
OpenX bid rate and bid price. Be sure to call pbjs.setConfig() only once.
Similar to the Prebid.js configuration described above, our prebid server adapter requires you to configure the bidder and usersync URLs.
You will receive the URLs when contacting us.
Please note that you need to replace the <PREBID_SERVER_EXTERNAL_URL> part with the actual external URL of the prebid server host.
Note: Providing bcat and badv via Bid Params is deprecated, the First Party Data method should be preferred (see above). When both methods are provided, first party data values will be used and bid param values will be ignored.
Similar to the Prebid.js configuration described above, our prebid server adapter requires you to configure the bidder and usersync URLs.
You will receive the URLs when contacting us.
Please note that you need to replace the <PREBID_SERVER_EXTERNAL_URL> part with the actual external URL of the prebid server host.
Note: Providing bcat and badv via Bid Params is deprecated, the First Party Data method should be preferred (see above). When both methods are provided, first party data values will be used and bid param values will be ignored.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pgam
hb_bidder_pgam
hb_adid_pgam
hb_size_pgam
hb_source_pgam
hb_format_pgam
hb_cache_host_pgam
hb_cache_id_pgam
hb_uuid_pgam
hb_cache_path_pgam
hb_deal_pgam
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from PGAM.
529814
integer
Description
PGAM header bidding adapter connects with PGAM demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pubmatic
hb_bidder_pubmatic
hb_adid_pubmatic
hb_size_pubmatic
hb_source_pubmatic
hb_format_pubmatic
hb_cache_host_pubmat
hb_cache_id_pubmatic
hb_uuid_pubmatic
hb_cache_path_pubmat
hb_deal_pubmatic
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
'32572'
string
adSlot
optional
Ad Slot Name (see below)
'38519891'
string
pmzoneid
optional
Zone ID
'zone1,zone2'
string
lat
optional
Latitude
'40.712775'
string
lon
optional
Longitude
'-74.005973'
string
yob
optional
Year of Birth
'1982'
string
gender
optional
Gender
'M'
string
kadpageurl
optional
Overrides Page URL
'http://www.yahoo.com/'
string
kadfloor
optional
Bid Floor
'1.75'
string
currency
optional
Bid currency
'AUD' (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
string
dctr
optional
Deal Custom Targeting (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
'key1=123|key2=345'
string
acat
optional
Allowed categories (List of allowed categories for a given auction to be sent in either using ortb2 config (request.ext.prebid.bidderparams.pubmatic.acat) or using slot level params. If categories sent using both then priority will be given to ortb2 over slot level params.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]
array of strings
bcat
optional
Blocked IAB Categories (Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]
array of strings
deals
optional
PMP deals (Values from each slot will be passed per slot. An array of strings only. Each deal-id should be a string of a length of more than 3 characters.)
[ 'deal-id-5', 'deal-id-6', 'deal-id-7' ]
array of strings
outstreamAU
optional
Oustream AdUnit described in Blue BillyWig UI. This field is mandatory if mimeType is described as video and context is outstream (i.e., for outstream videos)
'renderer_test_pubmatic'
string
Configuration
PubMatic recommends the UserSync configuration below. Without it, the PubMatic adapter will not able to perform user syncs, which lowers match rate and reduces monetization.
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// '*' represents all biddersfilter:'include'}}}});
Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.
adSlot Specification and Multi-Size Ad Units
The adSlot parameter supports two different formats:
Format
Example
Without Size
'38519891'
With Size
'38519891@300x205'
adSlot parameter is optional. To omit the adSlot parameter, your publisher account must have default site and tag enabled. Consult your account manager to find out if default site and tag is enabled on your account. If used, both formats are supported. Without Size is the recommended option. Both options will send the ad request with all sizes specified in the Prebid ad unit configuration.
video parameters
The PubMatic adapter supports video as of Prebid v1.16.0
Name
Scope
Description
Example
video.mimes
required
Video MIME types
['video/mp4','video/x-flv']
video.skippable
optional
If ‘true’, user can skip ad
true
video.minduration
optional
Minimum ad duration in seconds
5
video.maxduration
optional
Maximum ad duration in seconds
30
video.startdelay
optional
Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements
5
video.playbackmethod
optional
Defines whether inventory is user-initiated or autoplay sound on/off Values: 1: Auto-play, sound on 2: Auto-play, sound off 3: Click-to-play 4: mouse-over
The following test parameters can be used to verify that Prebid Server is working properly with the
PubMatic adapter. This example includes an imp object with an PubMatic test publisher ID, ad slot,
and sizes that would match with the test creative.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pulsepoint
hb_bidder_pulsepoint
hb_adid_pulsepoint
hb_size_pulsepoint
hb_source_pulsepoint
hb_format_pulsepoint
hb_cache_host_pulsep
hb_cache_id_pulsepoi
hb_uuid_pulsepoint
hb_cache_path_pulsep
hb_deal_pulsepoint
Disclosure
This bidder sets adId on the bid response and hasn’t responded to the Prebid.js team to confirm uniqueness
of this value. See Issue 6381.
Bid Params
Name
Scope
Description
Example
Type
cf
required
Ad size identifier
'300X250'
string
cp
required
Publisher Id
12345
integer
ct
required
Ad Tag Id
12345
integer
bcat
optional
Blocked IAB Categories
[ 'IAB1-5', 'IAB1-6' ]
array of strings
battr
optional
Blocked Creative Attributes
[ 1, 2, 5 ]
array of integers
badv
optional
Blocked Advertisers by their domains
['ford.com', 'pepsi.com']
array of strings
bidfloor
optional
Bid floor price CPM
1.23
float
video
required
Required for video requests. OpenRTB Video object.
{ w: 400, h: 300 }
object
Video parameters
Parameters on the Video object in Bid params for PulsePoint. OpenRTB 2.5 Video object specification is used. Below are some sample parameters from the OpenRTB Video specs.
Please use mediaTypes.video to specify video params in place of this parameter for PBJS 5.0 and later.
Name
Scope
Description
Example
video.mimes
required
Content MIME types supported
['video/mp4','video/x-flv']
video.minduration
optional
Minimum video ad duration in seconds
8
video.maxduration
optional
Maximum video ad duration in seconds
20
video.protocols
optional
Array of supported video protocols
[2, 3]
video.w
optional
Width of the video player in device independent pixels
400
video.h
optional
Height of the video player in device independent pixels
300
video.startdelay
optional
Start delay in seconds
5
video.skip
optional
Indicates if the player will allow the video to be skipped
1
video.minbitrate
optional
Minumim bit rate in Kbps.
200
video.maxbitrate
optional
Maximum bit rate in Kbps.
500
video.api
optional
List of supported API frameworks for this impression