Prebid Server Bidder Params
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:
Features |
A table of features supported by the adapter. |
“Send All Bids” Ad Server Keys |
Used for sending all bids to the ad server, as described in Send All Bids vs Send Top Price |
Bid Params |
Ad request parameters required by a given bidder, such as the tag ID, site ID, or query string parameters |
You can also download the full CSV data file.
Publishers are advised to check with legal counsel before doing business with any particular bidder.
Prebid Server Bidder List
Bidder Documentation
33Across
Features
Bidder Code |
33across |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
58 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
var adUnits = [
{
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
var adUnits = [
{
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], // required
context: 'outstream', // required
mimes: ['video/mp4','video/x-flv'], // required
protocols: [ 2, 3 ], // required, set at least 1 value in array
plcmt: 2, // optional, defaults to 2 when context = outstream
api: [ 1, 2 ], // optional
skip: 0, // optional
minduration: 5, // optional
maxduration: 30, // optional
playbackmethod: [1,3], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: '33across',
params: {
siteId: 'examplePub123', // required
productId: 'siab' // required
}
}],
...
}
Ad Unit Setup for Instream Video
var adUnits = [
{
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], // required
context: 'instream', // required
mimes: ['video/mp4','video/x-flv'], // required
protocols: [ 2, 3 ], // required, set at least 1 value in array
plcmt: 1, // optional, defaults to 1 when context = instream
startdelay: 0, // optional, defaults to 0 when context = instream
api: [ 1, 2 ], // optional
skip: 0, // optional
minduration: 5, // optional
maxduration: 30, // optional
playbackmethod: [1,3], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: '33across',
params: {
siteId: 'examplePub123', // required
productId: 'instream' // required
}
}],
...
}
var adUnits = [
{
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], // required
context: 'outstream', // required
mimes: ['video/mp4','video/x-flv'], // required
protocols: [ 2, 3 ], // required, set at least 1 value in array
plcmt: 2, // optional, defaults to 2 when context = outstream
api: [ 1, 2 ], // optional
skip: 0, // optional
minduration: 5, // optional
maxduration: 30, // optional
playbackmethod: [1,3], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
minbitrate: 10, // optional
maxbitrate: 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
pbjs.setBidderConfig({
bidders: ['33across'],
config: {
ttxSettings: {
enableSRAMode: true
}
}
});
AAX
Features
Bidder Code |
aax |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
720 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
[1, 2] |
protocols |
array of integers |
Array of supported video protocols. Currently supported values are: 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 |
[1, 2] |
placement |
integer |
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
.
Example of Instream Video Ad-unit
var videoAdUnit = {
code: 'video1',
mediaTypes: {
video: {
context: "instream",
playerSize: [640, 480],
mimes: ['video/mp4'],
placement: 1
}
},
bids: [{
bidder: 'aax',
params: {
cid: 'aax_test_customer',
crid: 'aax_crid',
}
}]
};
Example of Native Ad-unit
var adUnits = [{
code: 'div-gpt-ad-6874091242345-0',
mediaTypes: {
native: {
image: {
required: true,
sizes: [300, 250],
wmin: 50,
},
title: {
required: true,
len: 80
}
}
},
bids: [{
bidder: 'aax',
params: {
cid: 'aax_test_customer',
crid: 'aax_crid'
}
}]
}];
Example of Banner Ad-unit
var adUnits = [{
code: 'div-gpt-ad-6874091242345-0',
mediaTypes: {
banner: {
sizes: [
[728, 90],
[300, 600],
[300, 250]
],
}
},
bids: [{
bidder: 'aax',
params: {
cid: 'aax_test_customer',
crid: 'aax_crid'
}
}]
}];
Aceex
Features
Bidder Code |
aceex |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aceex |
hb_bidder_aceex |
hb_adid_aceex |
hb_size_aceex |
hb_source_aceex |
hb_format_aceex |
hb_cache_host_aceex |
hb_cache_id_aceex |
hb_uuid_aceex |
hb_cache_path_aceex |
hb_deal_aceex |
|
Note
The Example Bidding adapter requires setup before beginning. Please contact us at tech@aceex.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
accountid |
required |
Endpoint id |
'hash' |
string |
AcuityAds
Features
Bidder Code |
acuityads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
231 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_acuityads |
hb_bidder_acuityads |
hb_adid_acuityads |
hb_size_acuityads |
hb_source_acuityads |
hb_format_acuityads |
hb_cache_host_acuity |
hb_cache_id_acuityad |
hb_uuid_acuityads |
hb_cache_path_acuity |
hb_deal_acuityads |
|
Note
The Example Bidding adapter requires setup before beginning. Please contact us at rafi.babler@acuityads.com
Prebid.JS Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement ID |
'123' |
string |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Region id |
'ep1' |
string |
accountid |
required |
Endpoint id / Placement id |
'hash' |
string |
AdElement
Features
Bidder Code |
adelement |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
196 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_adelement |
hb_bidder_adelement |
hb_adid_adelement |
hb_size_adelement |
hb_source_adelement |
hb_format_adelement |
hb_cache_host_adelem |
hb_cache_id_adelemen |
hb_uuid_adelement |
hb_cache_path_adelem |
hb_deal_adelement |
|
Note
Bidding adapter requires setup before beginning.
Please contact us at prebid@adelement.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
supply_id |
required |
Supply Id |
'1' |
string |
AdformOpenRTB
Features
Bidder Code |
adf |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
50 |
GPP Support |
check with bidder |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adf |
hb_bidder_adf |
hb_adid_adf |
hb_size_adf |
hb_source_adf |
hb_format_adf |
hb_cache_host_adf |
hb_cache_id_adf |
hb_uuid_adf |
hb_cache_path_adf |
hb_deal_adf |
|
This bidder previously had a bidder code of adformOpenRTB
, but prefers new configurations to use adf
.
Bid params
Name |
Scope |
Description |
Example |
Type |
mid |
required, if inv and nmane not set |
Placement ID |
12345 |
integer |
inv |
required, if mid not set |
Inventory source ID |
1234 |
integer |
mname |
required, if mid not set |
Placement name |
"Leaderboard" |
string |
adxDomain |
optional, Prebid.js only |
The Adform domain |
"adx.adform.net" |
string |
priceType |
optional |
Price type |
"gross" |
string |
Note: Bid placement should be defined using the mid
parameter or inv
and mname
parameters (dynamic master tag) but not both.
OpenRTB request config
OpenRTB bid request app
, site
, device
properties configured using prebid config.
pbjs.setConfig({
ortb2: {
app: {
name: 'My APP'
}
}
});
Ad Generation
Features
Bidder Code |
adgeneration |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
novatiq, criteo, id5Id |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
553 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
id5Id |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
Adhese will only respond to the first impression. Multiple ad formats in single request are not supported.
Bid Params
Pbjs param name |
Scope |
Description |
Example |
Type |
account |
required |
Adhese account name |
'demo' |
string |
location |
required |
Adhese location name |
'_adhese_prebid_demo_' |
string |
format |
required |
Adhese format name |
'leaderboard' |
string |
data |
optional |
(PBJS only) Custom target data |
{ 'ci': [9000, 9050] } |
object |
targets |
optional |
(PBS only) Custom target data |
{ 'ci': [9000, 9050] } |
object |
Configuration
Adhese supports ‘iframe’ UserSync configuration only.
For Prebid.js v1.15.0 and later:
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // '*' represents all bidders
filter: 'include'
}
}
}
});
For Prebid.js v1.14.0 and before:
pbjs.setConfig({
userSync: {
iframeEnabled: true,
enabledBidders: ['adhese']
}});
Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.
AdKernel
Features
Bidder Code |
adkernel |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
14 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
14 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
149 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
uid2, lotamePanoramaId, idx |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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' |
AdMatic
Features
Bidder Code |
admatic |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1281 |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admatic |
hb_bidder_admatic |
hb_adid_admatic |
hb_size_admatic |
hb_source_admatic |
hb_format_admatic |
hb_cache_host_admati |
hb_cache_id_admatic |
hb_uuid_admatic |
hb_cache_path_admati |
hb_deal_admatic |
|
Description
AdMatic header bidding adapter connects with AdMatic demand sources to fetch bids for banner network ID. Please reach out to your account manager or prebid@admatic.com.tr for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network ID from AdMatic |
12345 |
number |
host |
required |
RTB Host |
layer.serve.admatic.com.tr |
string |
Test Parameters
300x250 banner test
var adUnits = [{
code: 'your-slot_1-div',
mediaTypes: {
banner: { sizes: [[300, 250]] },
},
bids: [{
bidder: 'admatic',
params: {
networkId: 12345,
host: 'layer.serve.admatic.com.tr'
}
}]
},{
code: 'your-slot_2-div',
mediaTypes: {
native: { ... },
},
bids: [{
bidder: 'admatic',
params: {
networkId: 12345,
host: 'layer.serve.admatic.com.tr'
}
}]
},{
code: 'your-slot_3-div',
mediaTypes: {
video: { ... },
},
bids: [{
bidder: 'admatic',
params: {
networkId: 12345,
host: 'layer.serve.admatic.com.tr'
}
}]
}];
UserSync example
pbjs.setConfig({
userSync: {
iframeEnabled: true,
syncEnabled: true,
syncDelay: 1
}
});
AdMatic GMBH
Features
Bidder Code |
admaticde |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1281 (admatic) |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admaticde |
hb_bidder_admaticde |
hb_adid_admaticde |
hb_size_admaticde |
hb_source_admaticde |
hb_format_admaticde |
hb_cache_host_admati |
hb_cache_id_admaticd |
hb_uuid_admaticde |
hb_cache_path_admati |
hb_deal_admaticde |
|
Description
AdMatic GMBH header bidding adapter connects with AdMatic GMBH demand sources to fetch bids for network ID. Please reach out to your account manager or fatih.kaya@admatic.de for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network ID from AdMatic GMBH |
12345 |
number |
host |
required |
RTB Host |
rtb.network.admatic.de |
string |
Test Parameters
300x250 banner test
var adUnits = [{
code: 'your-slot_1-div',
mediaTypes: {
banner: { sizes: [[300, 250]] },
},
bids: [{
bidder: 'admaticde',
params: {
networkId: 12345,
host: 'rtb.network.admatic.de'
}
}]
},{
code: 'your-slot_2-div',
mediaTypes: {
native: { ... },
},
bids: [{
bidder: 'admaticde',
params: {
networkId: 12345,
host: 'rtb.network.admatic.de'
}
}]
},{
code: 'your-slot_3-div',
mediaTypes: {
video: { ... },
},
bids: [{
bidder: 'admaticde',
params: {
networkId: 12345,
host: 'rtb.network.admatic.de'
}
}]
}];
UserSync example
pbjs.setConfig({
userSync: {
iframeEnabled: true,
syncEnabled: true,
syncDelay: 1,
aliasSyncEnabled: true
}
});
AdMixer
Features
Bidder Code |
admixer |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
511 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
AdmixerID |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
855 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
userId |
optional |
Allows you to set a specific user id in the request. |
'userId' |
string |
targeting |
optional |
Targeting to be sent through to adnuntius with the request. |
{ c: ['prebids'] } |
string |
maxDeals |
optional |
The maximum number of deal bids to include. Default 0. |
1 |
Integer |
bidType |
optional |
Whether to use grossBid or netBid from the server response as the cpm bid. Default is grossBid . |
grossBid |
string |
The bidType
can also be set under config
in the bidderSettings.
Targeting
The Adnuntius Documentation provides detailed information on sending targeting data to the Adnuntius adserver.
Example
Here’s an example of sending targeting information about categories to adnuntius via the bid request:
{
"code": "0000000000072345",
"mediaTypes": {
"banner": {
"sizes": [[980, 360], [980, 300], [980, 240], [980, 120]]
}
},
"bids": [
{
"bidder": "adnuntius",
"params": {
"auId": "8b6bc",
"network": "adnuntius",
"userId": "<USERID>",
"targeting": {
"c": ["prebids"]
}
}
}
]
}
Sending segments to the ad server
There’s an option to send segment id in the bidder config that will be picked up and sent to the ad server. Below is an example on how to do this:
pbjs.setBidderConfig({
bidders: ['adnuntius', 'bidderB'],
config: {
ortb2: {
user: {
data: [{
name: "adnuntius",
segment: [
{ id: "1" },
{ id: "2" }
]
}]
}
}
}
});
Disable cookies for Adnuntius
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 Adnuntius will not set it for internal ads.
pbjs.setBidderConfig({
bidders: ['adnuntius'],
config: {
useCookie: false
}
});
Use cookie will always be set to true by default. Changing it to false will disable cookies.
Trigger Advertiser Transparency Mode in Adnuntius
You have the option to tell Adnuntius to only serve ads that have their Advertiser’s legal name specified.
pbjs.setBidderConfig({
bidders: ['adnuntius'],
config: {
advertiserTransparency: true
}
});
By default, advertiserTransparency
is set to false
, meaning there is no restriction on which ads can deliver. By setting advertiserTransparency
to true
, ad delivery is restricted to those that have their Advertiser’s legal name specified.
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.
{
"imp": [{
"id": "impression-id",
"banner": {
"format": [{
"w": 980,
"h": 240
}, {
"w": 980,
"h": 360
}]
},
"ext": {
"adnuntius": {
"auId": "abc123",
"maxDeals": 2 // Optional
}
}
}]
}
Passing no Cookie in Prebid Server request
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:
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:
{
"code": "video1",
"mediaTypes": {
"video": {
"playerSize": [640, 480],
"context": "instream"
}
},
"bids": [{
"bidder": "adnuntius",
"params": {
"auId": "00000000001cd429", //put your placement id here
"video": {
"skippable": true,
"playback_method": ["auto_play_sound_off"]
}
}
}]
};
AdOcean
Features
Bidder Code |
adocean |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
328 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Prebid.JS 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 |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
slaveId |
required |
slave ID |
'adoceanmyaozpniqismex' |
string |
masterId |
required |
master ID |
'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7' |
string |
emitterPrefix |
required |
AdOcean emitter prefix |
'myao' |
string |
Adoppler
Features
Bidder Code |
adoppler |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
272 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
pubProvidedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
Example
pbjs.setBidderConfig({
bidders: ['adot'],
config: {
adot: {
publisherId: '__MY_PUBLISHER_ID__'
}
}
});
Specific publisher path
You can set a specific publisher path using pbjs.setBidderConfig
for the bidder adot
The bidrequest will add this path to the bidder endpoint
Example
pbjs.setBidderConfig({
bidders: ['adot'],
config: {
adot: {
publisherPath: '__MY_PUBLISHER_PATH__'
}
}
});
Prebid server
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
optional |
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.
{
"id": "b967c495-adeb-4cf3-8f0a-0d86fa17aeb2",
"app": {
"id": "0",
"name": "test-adot-integration",
"publisher": {
"id": "1",
"name": "Test",
"domain": "test.com"
},
"bundle": "com.example.app",
"paid": 0,
"domain": "test.com",
"page": "https:\/\/www.test.com\/",
"cat": [
"IAB1",
"IAB6",
"IAB8",
"IAB9",
"IAB10",
"IAB16",
"IAB18",
"IAB19",
"IAB22"
]
},
"device": {
"ua": "Mozilla\/5.0 (Linux; Android 7.0; SM-G925F Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/80.0.3987.132 Mobile Safari\/537.36",
"make": "phone-make",
"model": "phone-model",
"os": "os",
"osv": "osv",
"ip": "0.0.0.0",
"ifa": "IDFA",
"carrier": "WIFI",
"language": "English",
"geo": {
"zip": "75001",
"country": "FRA",
"type": 2,
"lon": 48.2,
"lat": 2.32,
"accuracy": 100
},
"ext": {
"is_app": 1
},
"connectiontype": 2,
"devicetype": 4
},
"user": {
"id": "IDFA",
"buyeruid": ""
},
"imp": [
{
"id": "dec4147e-a63f-4d25-9fff-da9bfd05bd02",
"banner": {
"w": 320,
"h": 50,
"format": [
{
"w": 320,
"h": 50
}
],
"api": [
1,
2,
5,
6,
7
]
},
"bidfloorcur": "USD",
"bidfloor": 0.1,
"instl": 0,
"ext": {
"adot": {
}
}
}
],
"cur": [
"USD"
],
"regs": {
"ext": {
"gdpr": 1
}
},
"at": 1
}
Please contact admin@we-are-adot.com if you would like to build and deploy Prebid server and use it with Adot.
Adpone
Features
Bidder Code |
adpone |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
799 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adpone |
hb_bidder_adpone |
hb_adid_adpone |
hb_size_adpone |
hb_source_adpone |
hb_format_adpone |
hb_cache_host_adpone |
hb_cache_id_adpone |
hb_uuid_adpone |
hb_cache_path_adpone |
hb_deal_adpone |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placement ID from Adpone. |
234234 |
integer |
Adprime
Features
Bidder Code |
adprime |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_adprime |
hb_bidder_adprime |
hb_adid_adprime |
hb_size_adprime |
hb_source_adprime |
hb_format_adprime |
hb_cache_host_adprim |
hb_cache_id_adprime |
hb_uuid_adprime |
hb_cache_path_adprim |
hb_deal_adprime |
|
Note
The Adprime Bidding adapter requires setup before beginning. Please contact us at rafal@adprime.com
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Adprime placement id |
'1234asdf' |
string |
keywords |
optional |
page context keywords |
[‘car’,’sport’] |
array |
audiences |
optional |
publisher audiences |
[‘aud1’,’aud2’] |
array |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
TagID |
required |
Adprime ad tag id |
'1234asdf' |
string |
keywords |
optional |
page context keywords |
[‘car’,’sport’] |
array |
audiences |
optional |
publisher audiences |
[‘aud1’,’aud2’] |
array |
Adquery
Features
Bidder Code |
adquery |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
902 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
adQuery QiD |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adquery |
hb_bidder_adquery |
hb_adid_adquery |
hb_size_adquery |
hb_source_adquery |
hb_format_adquery |
hb_cache_host_adquer |
hb_cache_id_adquery |
hb_uuid_adquery |
hb_cache_path_adquer |
hb_deal_adquery |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement ID |
6d93f2a0e5f0fe2cc3a6e9e3ade964b43b07f897 |
string |
type |
required |
Ad Type |
banner |
string |
sizes |
required |
Allowed sizes |
320x100,300x250,336x280,300x50,300x100,320x50,320x480,300x150,320x180 |
string |
Adrino
Features
Bidder Code |
adrino |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1072 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adrino |
hb_bidder_adrino |
hb_adid_adrino |
hb_size_adrino |
hb_source_adrino |
hb_format_adrino |
hb_cache_host_adrino |
hb_cache_id_adrino |
hb_uuid_adrino |
hb_cache_path_adrino |
hb_deal_adrino |
|
Note
The Adrino bidder adapter requires setup and approval from the Adrino team. Please reach out to wydawcy@adrino.pl for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
hash |
required |
Identifier for specific ad placement |
'abcdef123456' |
string |
Native example
var adUnits = [
code: '/12345678/prebid_native_example_1',
mediaTypes: {
native: {
image: {
required: true,
sizes: [[300, 210],[300,150],[140,100]]
},
title: {
required: true
},
sponsoredBy: {
required: false
},
body: {
required: false
},
icon: {
required: false
}
}
},
bids: [{
bidder: 'adrino',
params: {
hash: 'abcdef123456'
}
}]
];
Ads Interactive
Features
Bidder Code |
ads_interactive |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1212 |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_ads_interactiv |
hb_bidder_ads_intera |
hb_adid_ads_interact |
hb_size_ads_interact |
hb_source_ads_intera |
hb_format_ads_intera |
hb_cache_host_ads_in |
hb_cache_id_ads_inte |
hb_uuid_ads_interact |
hb_cache_path_ads_in |
hb_deal_ads_interact |
|
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
AdsInteractive
Features
Bidder Code |
adsinteractive |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
1212 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsinteractive |
hb_bidder_adsinterac |
hb_adid_adsinteracti |
hb_size_adsinteracti |
hb_source_adsinterac |
hb_format_adsinterac |
hb_cache_host_adsint |
hb_cache_id_adsinter |
hb_uuid_adsinteracti |
hb_cache_path_adsint |
hb_deal_adsinteracti |
|
Registration
The AdsInteractive adapter requires setup and approval. Please reach out to it@adsinteractive.com to setup your account.
Bid Params
Name |
Scope |
Description |
Example |
Type |
adUnit |
required |
adUnit tag name |
'example_adunit_1' |
string |
AdsYield
Features
Bidder Code |
adsyield |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsyield |
hb_bidder_adsyield |
hb_adid_adsyield |
hb_size_adsyield |
hb_source_adsyield |
hb_format_adsyield |
hb_cache_host_adsyie |
hb_cache_id_adsyield |
hb_uuid_adsyield |
hb_cache_path_adsyie |
hb_deal_adsyield |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'open-adsyield.com' |
string |
adUnitId |
required |
Ad Unit Id will be generated on AdsYield Platform. |
42 |
integer |
adUnitType |
required |
Type of Ad Unit ('video' , 'banner' ) |
'banner' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
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 |
Adsyield server-side Prebid Server adapter requires only publisherId
and host
parameters. But Adsyield client-side Prebid.js adapter requires only host
, adUnitId
, adUnitType
.
Adsyield server-side Prebid Server adapter supports only banner
, video
, audio
, native
media types. But Adsyield client-side Prebid.js adapter supports only banner
and video
media types, doesn’t support audio
and native
.
Adtarget
Features
Bidder Code |
adtarget |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
779 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 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
Test Parameters
var adUnits = [
// Video adUnit
{
code: 'videoPlayer',
mediaTypes: {
video: {
playerSize:[640,480]
context: 'instream'
}
},
bids: [{
bidder: 'adtarget',
params: {
aid: 331133
}
}]
},
// Banner adUnit
{
code: 'bannerAd',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: 'adtarget',
params: {
aid: 529814
}
}]
}
];
Additional Configuration
It is possible to configure requests to be splitted in chunks to have less bid requests in single http request
(default value is 10)
pbjs.setBidderConfig({
config: {
adtarget: {
chunkSize: 1 // makes 1 http request per 1 adunit configured
}
}
});
Adtelligent
Features
Bidder Code |
adtelligent |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
410 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all (with commercial activation) |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
|
Prebid Server Note
This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams
function.
See prebid.js #6361 for more details.
Bid params
Name |
Scope |
Description |
Example |
Type |
aid |
required |
The source ID from Adtelligent. |
350975 |
integer |
Description
Get access to multiple demand partners across Adtelligent AdExchange and maximize your yield with Adtelligent header bidding adapter.
Adtelligent header bidding adapter connects with Adtelligent demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand.
Adtelligent now supports adpod.
Test Parameters
var adUnits = [
// Video instream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'adtelligent',
params: {
aid: 331133
}
}]
},
// Video outstream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'outstream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'adtelligent',
params: {
aid: 331133
}
}]
},
// Video ADPOD adUnit
{
code: 'test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'adpod',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'adtelligent',
params: {
aid: 331133
}
}]
},
// Banner adUnit
{
code: 'test-div',
mediaTypes:{
banner:{
sizes: [[300, 250]]
}
}
bids: [{
bidder: 'adtelligent',
params: {
aid: 350975
}
}]
}
];
Additional Configuration
It is possible to configure requests to be split into chunks so as to have fewer bid requests in a single http request
(default value is 10).
pbjs.setBidderConfig({
config: {
adtelligent: {
chunkSize: 1 // makes 1 http request per 1 adunit configured
}
}
});
AdTonos
Features
Bidder Code |
adtonos |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
682 |
GPP Support |
None |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtonos |
hb_bidder_adtonos |
hb_adid_adtonos |
hb_size_adtonos |
hb_source_adtonos |
hb_format_adtonos |
hb_cache_host_adtono |
hb_cache_id_adtonos |
hb_uuid_adtonos |
hb_cache_path_adtono |
hb_deal_adtonos |
|
Note
The AdTonos Bidding adapter requires setup before beginning. Please contact us at support@adtonos.com
Bid params
Name |
Scope |
Description |
Example |
Type |
supplierId |
required |
Supplier account id |
'1YZxxxyDMCXWv7SwY' |
string |
Adtarget.me
Features
Bidder Code |
adtrgtme |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
Bid Params
Name |
Scope |
Description |
Example |
Type |
site_id |
required |
Site ID |
1234567890 |
uint64 |
Advangelists
Features
Bidder Code |
advangelists |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1022 |
GPP Support |
tcfeu, usca |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
id5Id, identityLink, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams
function.
See prebid.js #6361 for more details.
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
259 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, sharedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
AIDEM
Features
Bidder Code |
aidem |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1218 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aidem |
hb_bidder_aidem |
hb_adid_aidem |
hb_size_aidem |
hb_source_aidem |
hb_format_aidem |
hb_cache_host_aidem |
hb_cache_id_aidem |
hb_uuid_aidem |
hb_cache_path_aidem |
hb_deal_aidem |
|
Description
This module connects publishers to AIDEM demand.
This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
Global Bid Params
Name |
Scope |
Description |
Example |
Type |
siteId |
required |
Unique site ID |
'ABCDEF' |
String |
publisherId |
required |
Unique publisher ID |
'FEDCBA' |
String |
placementId |
optional |
Unique publisher tag ID |
'ABCDEF' |
String |
rateLimit |
optional |
Limit the volume sent to AIDEM. Must be between 0 and 1 |
0.6 |
Number |
Banner Bid Params
Name |
Scope |
Description |
Example |
Type |
sizes |
required |
List of the sizes wanted |
[[300, 250], [300,600]] |
Array |
Video Bid Params
Name |
Scope |
Description |
Example |
Type |
context |
required |
One of instream, outstream, adpod |
'instream' |
String |
playerSize |
required |
Width and height of the player |
'[640, 480]' |
Array |
maxduration |
required |
Maximum video ad duration, in seconds |
30 |
Integer |
minduration |
required |
Minimum video ad duration, in seconds |
5 |
Integer |
mimes |
required |
List of the content MIME types supported by the player |
["video/mp4"] |
Array |
protocols |
required |
An array of supported video protocols. At least one supported protocol must be specified, where: 2 = VAST 2.0 3 = VAST 3.0 5 = VAST 2.0 wrapper 6 = VAST 3.0 wrapper |
2 |
Array |
Additional Config
Name |
Scope |
Description |
Example |
Type |
coppa |
optional |
Child Online Privacy Protection Act |
true |
Boolean |
consentManagement |
optional |
Consent Management Object |
{} |
Object |
Consent Management Object
Name |
Scope |
Description |
Example |
Type |
gdpr |
optional |
GDPR Object see Prebid.js doc |
{} |
Object |
usp |
optional |
USP Object see Prebid.js doc |
{} |
Object |
Example Banner ad unit
var adUnits = [{
code: 'banner-prebid-test-site',
mediaTypes: {
banner: {
sizes: [
[300, 600],
[300, 250]
]
}
},
bids: [{
bidder: 'aidem',
params: {
siteId: 'prebid-test-siteId',
publisherId: 'prebid-test-publisherId',
},
}]
}];
Example Video ad unit
var adUnits = [{
code: 'video-prebid-test-site',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
maxduration: 30,
minduration: 5,
mimes: ["video/mp4"],
protocols: 2
}
},
bids: [{
bidder: 'aidem',
params: {
siteId: 'prebid-test-siteId',
publisherId: 'prebid-test-publisherId',
},
}]
}];
Example GDPR Consent Management
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];
pbjs.que.push(function (){
pbjs.setConfig({
consentManagement: {
gdpr:{
cmpApi: 'iab'
}
}
});
})
Example USP Consent Management
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];
pbjs.que.push(function (){
pbjs.setConfig({
consentManagement: {
usp:{
cmpApi: 'static',
consentData:{
getUSPData:{
uspString: '1YYY'
}
}
}
}
});
})
Setting First Party Data (FPD)
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];
pbjs.que.push(function (){
pbjs.setConfig({
ortb2: {
site: {
cat: ['IAB2'],
sectioncat: ['IAB2-2'],
keywords: 'power tools, drills'
},
}
});
})
Setup / Dev Guide
nvm use
npm install
gulp build --modules=aidemBidAdapter
gulp serve --modules=aidemBidAdapter
# Open a chrome browser with no ad blockers enabled, and paste in this URL. The `pbjs_debug=true` is needed if you want to enable `loggerInfo` output on the `console` tab of Chrome Developer Tools.
http://localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true
If you need to run the tests suite but do not want to have to build the full adapter and serve it, simply run:
gulp test --file "test/spec/modules/aidemBidAdapter_spec.js"
For video: gulp serve –modules=aidemBidAdapter,dfpAdServerVideo
FAQs
How do I view AIDEM bid request?
Navigate to a page where AIDEM is setup to bid. In the network tab,
search for requests to zero.aidemsrv.com/bid/request
.
AJA
Features
Bidder Code |
aja |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
None |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
criteo, unifiedId, imuid |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aja |
hb_bidder_aja |
hb_adid_aja |
hb_size_aja |
hb_source_aja |
hb_format_aja |
hb_cache_host_aja |
hb_cache_id_aja |
hb_uuid_aja |
hb_cache_path_aja |
hb_deal_aja |
|
Note
The AJA Bidding adaptor requires setup and approval before beginning. Please reach out to ssp_support@aja-kk.co.jp for more details
Bid Params
Name |
Scope |
Description |
Example |
Type |
asi |
required |
ad spot hash code |
'123abc' |
string |
Configuration
AJA recommends setting UserSync by iframe for monetization.
For Prebid.js v1.15.0 and later:
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: "*", // '*' represents all bidders
filter: "include",
},
},
},
});
For Prebid.js v1.14.0 and before:
pbjs.setConfig({
userSync: {
iframeEnabled: true,
enabledBidders: ["aja"],
},
});
AlgoriX
Features
Bidder Code |
algorix |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1176 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1169 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
optional |
Minimum bid for this impression expressed in CPM. |
0 |
float |
instl |
optional |
Set to 1 if using interstitial (default: 0) |
1 |
integer |
exp |
optional |
Advisory as to the number of seconds that may elapse between the auction and the actual impression. |
10 |
integer |
AMX RTB
Features
Bidder Code |
amx |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
true |
TCF-EU Support |
yes |
IAB GVL ID |
737 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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:
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
pbjs.setBidderConfig({
bidders: ["amx"],
config: {
ortb2: {
site: {
keywords: "kw1,kw2",
cat: ["IAB2"],
sectioncat: ["IAB2-1"],
pagecat: ["IAB2-22"],
content: {
context: 5,
},
},
user: {
yob: 1981,
keywords: "kw3",
},
},
},
});
AndBeyond.Media
Features
Bidder Code |
beyondmedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_beyondmedia |
hb_bidder_beyondmedi |
hb_adid_beyondmedia |
hb_size_beyondmedia |
hb_source_beyondmedi |
hb_format_beyondmedi |
hb_cache_host_beyond |
hb_cache_id_beyondme |
hb_uuid_beyondmedia |
hb_cache_path_beyond |
hb_deal_beyondmedia |
|
Prebid Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement Id |
'0' |
'string' |
Apacdex
Features
Bidder Code |
apacdex |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_apacdex |
hb_bidder_apacdex |
hb_adid_apacdex |
hb_size_apacdex |
hb_source_apacdex |
hb_format_apacdex |
hb_cache_host_apacde |
hb_cache_id_apacdex |
hb_uuid_apacdex |
hb_cache_path_apacde |
hb_deal_apacdex |
|
Table of Contents
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId * |
required |
Placement ID provided by Apacdex |
'plc100000' |
string |
siteId * |
required |
Publisher site ID from Apacdex |
'apacdex1234' |
string |
floorPrice |
optional |
CPM bidfloor in USD |
0.03 |
float |
geo |
optional |
GEO data of device. See Geo Object for details. |
{"lat":17.98928,"lon":99.7741712,"accuracy":20} |
object |
(*) 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) |
["video/mp4"] |
array<string> |
protocols |
recommended |
Supported video bid response protocol values 1: VAST 1.0 2: VAST 2.0 3: VAST 3.0 4: VAST 1.0 Wrapper 5: VAST 2.0 Wrapper 6: VAST 3.0 Wrapper 7: VAST 4.0 8: VAST 4.0 Wrapper |
[2,3,5,6] |
array<integers> |
api |
recommended |
Supported API framework values: 1: VPAID 1.0 2: VPAID 2.0 3: MRAID-1 4: ORMMA 5: MRAID-2 |
[2] |
array<integers> |
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<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
}
}
]
}
];
Sample Video Ad Unit: Instream
var instreamAdUnit = {
code: 'test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
playerSize: [[640, 480]],
context: "instream"
api: [2],
placement: 1,
skip: 1,
linearity: 1,
minduration: 1,
maxduration: 120,
mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
playbackmethod: [6],
startdelay: 0,
protocols: [1, 2, 3, 4, 5, 6]
},
},
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
Sample Video Ad Unit: Outstream
var outstreamAdUnit = {
code: 'test-div',
sizes: [[410, 231]],
mediaTypes: {
video: {
playerSize: [[410, 231]],
context: "outstream"
api: [2],
placement: 5,
linearity: 1,
minduration: 1,
maxduration: 120,
mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
playbackmethod: [6],
startdelay: 0,
protocols: [1, 2, 3, 4, 5, 6]
},
},
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
Applogy
Features
Bidder Code |
applogy |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
32 |
GPP Support |
some (check with bidder) |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all (with commercial activation) |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appnexus |
hb_bidder_appnexus |
hb_adid_appnexus |
hb_size_appnexus |
hb_source_appnexus |
hb_format_appnexus |
hb_cache_host_appnex |
hb_cache_id_appnexus |
hb_uuid_appnexus |
hb_cache_path_appnex |
hb_deal_appnexus |
|
Table of Contents
All AppNexus (Microsoft/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 9.0, an update was made to the appnexusBidAdapter.js
file to remove the support for the transformBidParams
function. Previously this standard adapter function was used in conjunction of Prebid.js > PBS requests to modify any bid params for that bidder to the bid param format used by the PBS endpoint. Part of the changes for 9.0 in general were to remove these functions from the client-side adapter files, in order to reduce the build size of Prebid.js for those publishers who wanted to make the PBS requests. In the case of our adapter, we instead created a new module named anPspParamsConverter
that would mimic behavior of the transformBidParams
function. There’s no setup instructions needed on the Prebid.js configs, the module only needs to be included in the Prebid.js build file and it will perform the needed steps. If you have any questions on this change, please reach out to your Microsoft representative and they can help.
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. |
[1,2] |
array of 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. |
video: { playback_method: ['auto_play_sound_off'] } |
object |
app |
optional |
Object containing mobile app parameters. See the App Object for details. |
app : { id: 'app-id'} |
object |
reserve |
optional |
Sets a floor price for the bid that is returned. If floors have been configured in the AppNexus Console, those settings will override what is configured here unless ‘Reserve Price Override’ is checked. See Microsoft Learn |
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
For details on how these video params work with the params set in the adUnit.mediaTypes.video object, see Video Bid params and Video MediaTypes params section below.
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" ; "in-banner" , "in-feed" , "interstitial" , "accompanying_content_pre_roll" , "accompanying_content_mid_roll" , "accompanying_content_post_roll" . |
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;
}
}
]
}
}
It is possible to have setup video params within the adUnit’s AppNexus bid object as well as in the adUnit’s mediaTypes.video
object. In this case, there is a set of logic that the AppNexus bid adapter follows to resolve which values should be passed along to the ad server request. Generally speaking, the adapter prefers the values from bid param video object over the mediaTypes video object, in order to preserve historical setups. So for instance, if the playbackmethod field was set in both locations, then the bid params playback_method
would be chosen over the mediaTypes playbackmethod
. If there are different fields set between the two locations and they don’t overlap, then the mediaTypes.video
params would be included along with the bid params.
To note - not all the fields between the two locations have a single direct comparison, nor are all fields from the mediaTypes.video
object are supported by the ad server endpoint. The fields/values set in the mediaTypes.video
object follow the OpenRTB convention, while our bid params follow the convention for the ad server endpoint (which is not a straight OpenRTB endpoint). The AppNexus bid adapter converts the matching fields from the mediaTypes.video
object where there is a correlation to help support as much as possible. For example, to help infer the context
field, the adapter will look to the mediaTypes.video.plcmt
, mediaTypes.video.startdelay
, and mediaTypes.video.placement
fields to help determine the appropriate context
value. The startdelay
field is included here to help clarify the type of instream video that is used (ie pre/mid/post-roll).
If you want to transition from video bid params to use the mediaTypes.video
params (to simplify the adUnit setup), please contact your AppNexus contact to help identify the proper fields/values are populated to ensure a smooth transition.
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:
pbjs.setConfig({
appnexusAuctionKeywords: {
genre: ['classical', 'jazz'],
instrument: 'piano'
}
});
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.
keywords: {
color: ['red', 'blue', 'green'],
otherKeyword: ['']
}
First Party Data
Publishers should use the ortb2
method of setting First Party Data.
At this time however, the appnexus
bidder fully reads the First Party Data when using the Prebid Server and Prebid Server Premium endpoints. The client-side version of the appnexus
bidder has partial support to read all the various keywords parameters from the First Party Data fields. There is also some special support with the segment fields but only from known sources which are specifically configured. All other First Party Data fields are not read at this time.
PBS/PSP supports all first party data fields: site, user, segments, and imp-level first party data.
User Sync in AMP
If you are syncing user id’s with Prebid Server and are using AppNexus’ managed service, see AMP Implementation Guide cookie-sync instructions for details.
Mobile App Display Manager Version
The AppNexus endpoint expects imp.displaymanagerver
to be populated for mobile app sources
requests, however not all SDKs will populate this field. If the imp.displaymanagerver
field
is not supplied for an imp
, but request.app.ext.prebid.source
and request.app.ext.prebid.version
are supplied, the adapter will fill in a value for
diplaymanagerver
. It will concatenate the two app
fields as <source>-<version>
fo fill in
the empty displaymanagerver
before sending the request to AppNexus.
Debug Auction
Enabling the AppNexus Debug Auction feature should only be done for diagnosing the AppNexus auction. Do not enable this feature in a production setting where it may impact users.
To understand what is happening behind the scenes during an auction, you can enable a debug auction by adding an apn_prebid_debug
cookie with a JSON string. For example:
{ "enabled": true, "dongle": "QWERTY", "debug_timeout": 1000, "member_id": 958 }
To view the results of the debug auction, add the pbjs_debug=true
query string parameter and open your browser’s developer console.
Name |
Description |
Example |
Type |
enabled |
Toggle the debug auction to occur |
true |
boolean |
dongle |
Your account’s unique debug password. |
QWERTY |
string |
member_id |
The ID of the member running the debug auction |
958 |
integer |
debug_timeout |
The timeout for the debug auction results to be returned |
3000 |
integer |
Prebid Server Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the
server-side Appnexus adapter. This example includes an imp
object with an Appnexus test placement ID and sizes
that would match with the test creative.
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 600,
"h": 500
}, {
"w": 300,
"h": 600
}]
},
"ext": {
"appnexus": {
"placement_id": 13144370
}
}
}]
Appstock
Features
Bidder Code |
appstock |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appstock |
hb_bidder_appstock |
hb_adid_appstock |
hb_size_appstock |
hb_source_appstock |
hb_format_appstock |
hb_cache_host_appsto |
hb_cache_id_appstock |
hb_uuid_appstock |
hb_cache_path_appsto |
hb_deal_appstock |
|
Note
The Appstock Bidding adapter requires setup before beginning. Please contact us at moshiko@app-stock.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'pre.vr-tb.com' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
Appush
Features
Bidder Code |
appush |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
879 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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' |
Adserver.Online
Features
Bidder Code |
aso |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_aso |
hb_bidder_aso |
hb_adid_aso |
hb_size_aso |
hb_source_aso |
hb_format_aso |
hb_cache_host_aso |
hb_cache_id_aso |
hb_uuid_aso |
hb_cache_path_aso |
hb_deal_aso |
|
Note
For more information about Adserver.Online, please contact support@adsrv.org.
Bid Params
Name |
Scope |
Description |
Example |
Type |
zone |
required |
Zone ID |
73815 |
Integer |
server |
optional |
Custom bidder endpoint |
https://endpoint.url |
String |
Test Parameters
var adUnit = {
code: 'unit1',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [
{
bidder: 'aso',
params: {
zone: 73815,
}
}
]
}
Video Caching
Note that the Adserver.Online adapter expects a client-side Prebid Cache to be enabled for video bidding.
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Audience Network
Features
Bidder Code |
audienceNetwork |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Axis
Features
Bidder Code |
axis |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
1197 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_axis |
hb_bidder_axis |
hb_adid_axis |
hb_size_axis |
hb_source_axis |
hb_format_axis |
hb_cache_host_axis |
hb_cache_id_axis |
hb_uuid_axis |
hb_cache_path_axis |
hb_deal_axis |
|
Overview
For more information, visit the axis-marketplace website
Bid Params
Name |
Scope |
Description |
Example |
Type |
integration |
required |
Integration |
'000000' |
'string' |
token |
required |
Token |
'000000' |
'string' |
iabCat |
optional |
(Prebid.js only) Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(string) |
Axonix
Features
Bidder Code |
axonix |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
678 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Type |
supplyId |
required |
Supply UUID |
'2c426f78-bb18-4a16-abf4-62c6cd0ee8de' |
string |
region |
optional |
Cloud region |
'us-east-1' |
string |
endpoint |
optional |
Supply custom endpoint |
'https://open-rtb.axonix.com/custom' |
string |
instl |
optional |
Set to 1 if using interstitial (default: 0) |
1 |
integer |
BCM International
Features
Bidder Code |
bcmint |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_bcmint |
hb_bidder_bcmint |
hb_adid_bcmint |
hb_size_bcmint |
hb_source_bcmint |
hb_format_bcmint |
hb_cache_host_bcmint |
hb_cache_id_bcmint |
hb_uuid_bcmint |
hb_cache_path_bcmint |
hb_deal_bcmint |
|
Note
The BCM International adapter requires approval and setup. Please reach out to contact@bcm.ltd or visit us at bcm.ltd for more details.
Bid Params
Name |
Scope |
Description |
Example |
Type |
server |
required |
Server endpoint |
https://srv.datacygnal.io |
String |
zone |
required |
Zone ID |
73815 |
Integer |
Video Caching
Note that the BCM International adapter expects a client-side Prebid Cache to be enabled for video bidding.
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Beachfront
Features
Bidder Code |
beachfront |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
335 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
unifiedId, identityLink, uid2, hadronId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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. |
0.01 |
float |
video |
optional |
Object with video parameters. See the video section below for details. |
|
object |
banner |
optional |
Object with banner parameters. See the banner section below for details. |
|
object |
player |
optional |
Object with outstream player parameters. See the player section below for details. |
|
object |
video params
Name |
Scope |
Description |
Example |
Type |
appId |
optional |
Beachfront Exchange ID for video bids. |
'11bc5dd5-7421-4dd8-c926-40fa653bec76' |
string |
bidfloor |
optional |
Bid floor for video bids. |
0.01 |
float |
tagid |
optional |
Tag ID |
'placement-name' |
string |
responseType |
optional |
Video response type.
both : VAST URL and VAST XML
nurl : VAST URL only
adm : VAST XML only |
'both' |
string |
mimes |
optional |
Array of strings listing supported MIME types. |
["video/mp4", "application/javascript"] |
Array<string> |
playbackmethod |
optional |
Playback method supported by the publisher.
1 : Auto-play sound on
2 : Auto-play sound off
3 : Click-to-play
4 : Mouse-over |
1 |
integer |
maxduration |
optional |
Maximum video ad duration in seconds. |
30 |
integer |
placement |
optional |
Placement type for the impression.
1 : In-Stream
2 : In-Banner
3 : In-Article
4 : In-Feed
5 : Interstitial/Slider/Floating |
1 |
integer |
plcmt |
optional |
Placement type for the impression. See AdCOM v1 spec |
1 |
integer |
skip |
optional |
Indicates if the player will allow the video to be skipped. |
1 |
integer |
skipmin |
optional |
Videos of total duration greater than this number of seconds can be skippable. |
15 |
integer |
skipafter |
optional |
Number of seconds a video must play before skipping is enabled. |
5 |
integer |
banner params
Name |
Scope |
Description |
Example |
Type |
appId |
optional |
Beachfront Exchange ID for banner bids. |
'3b16770b-17af-4d22-daff-9606bdf2c9c3' |
string |
bidfloor |
optional |
Bid floor for banner bids. |
0.01 |
float |
tagid |
optional |
Tag ID |
'placement-name' |
string |
player params
Name |
Scope |
Description |
Example |
Type |
progressColor |
optional |
The color of the progress bar formatted as a CSS value. |
'#50A8FA' |
string |
adPosterColor |
optional |
The color of the ad poster formatted as a CSS value. |
'#FFFFFF' |
string |
expandInView |
optional |
Defines whether to expand the player when the ad slot is in view. Defaults to false . |
false |
boolean |
collapseOnComplete |
optional |
Defines whether to collapse the player when ad playback has completed. Defaults to true . |
true |
boolean |
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
- ortb2.site.*
- ortb2.app.*
- ortb2.user.*
Example first party data that’s available to all bidders and all adunits:
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2",
content: {
title: "title1",
series: "series1"
}
},
user: {
keywords: "a,b",
gender: "M",
yob: 1984
}
}
});
Prebid Server
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
618 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
Bematterfull
Features
Bidder Code |
bematterfull |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bematterfull |
hb_bidder_bematterfu |
hb_adid_bematterfull |
hb_size_bematterfull |
hb_source_bematterfu |
hb_format_bematterfu |
hb_cache_host_bematt |
hb_cache_id_bematter |
hb_uuid_bematterfull |
hb_cache_path_bematt |
hb_deal_bematterfull |
|
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
env |
required |
Environment name |
mtflll-stage |
string |
pid |
required |
unique placement ID |
cs230510321b516f0eb9a10e5913d3b1 |
string |
Between
Features
Bidder Code |
between |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
724 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Bidgency Group
Features
Bidder Code |
bidgency |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_bidgency |
hb_bidder_bidgency |
hb_adid_bidgency |
hb_size_bidgency |
hb_source_bidgency |
hb_format_bidgency |
hb_cache_host_bidgen |
hb_cache_id_bidgency |
hb_uuid_bidgency |
hb_cache_path_bidgen |
hb_deal_bidgency |
|
Note
The Bidgency Group adapter requires approval and setup. Please reach out to aso@bidgency.com or visit us at bidgency.com for more details.
Bid Params
Name |
Scope |
Description |
Example |
Type |
server |
required |
Server endpoint |
https://srv.bidgx.com |
String |
zone |
required |
Zone ID |
73815 |
Integer |
Video Caching
Note that the Bidgency Group adapter expects a client-side Prebid Cache to be enabled for video bidding.
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Bidmachine
Features
Bidder Code |
bidmachine |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
736 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Bidmatic
Features
Bidder Code |
bidmatic |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1134 |
GPP Support |
tcfeu, usp |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidmatic |
hb_bidder_bidmatic |
hb_adid_bidmatic |
hb_size_bidmatic |
hb_source_bidmatic |
hb_format_bidmatic |
hb_cache_host_bidmat |
hb_cache_id_bidmatic |
hb_uuid_bidmatic |
hb_cache_path_bidmat |
hb_deal_bidmatic |
|
Note
Unleash the power of fast client-oRTB connection.
Contact us at advertising@bidmatic.io.
Bid Params
Name |
Scope |
Description |
Example |
Type |
source |
required |
Traffic source origin id |
11111 |
int |
Test Parameters
var adUnits = [
// Banner adUnit
{
code: 'elemtId',
mediaTypes:{
banner:{
sizes: [[300, 250]]
}
}
bids: [{
bidder: 'bidmatic',
params: {
source: 886409
}
}]
}
];
BidMyAdz
Features
Bidder Code |
bidmyadz |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
462 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
BigoAd
Features
Bidder Code |
bigoad |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
none |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bigoad |
hb_bidder_bigoad |
hb_adid_bigoad |
hb_size_bigoad |
hb_source_bigoad |
hb_format_bigoad |
hb_cache_host_bigoad |
hb_cache_id_bigoad |
hb_uuid_bigoad |
hb_cache_path_bigoad |
hb_deal_bigoad |
|
Registration
The BigoAd Bidding adapter requires setup before beginning. Please contact us at bigoads-prebid@bigo.sg
Bid Params
Name |
Scope |
Description |
Example |
Type |
sspid |
required |
Ssp ID, This parameter expects all imps to be the same |
"123" |
string |
Blasto
Features
Bidder Code |
blasto |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_blasto |
hb_bidder_blasto |
hb_adid_blasto |
hb_size_blasto |
hb_source_blasto |
hb_format_blasto |
hb_cache_host_blasto |
hb_cache_id_blasto |
hb_uuid_blasto |
hb_cache_path_blasto |
hb_deal_blasto |
|
Note
The Example Bidding adapter requires setup before beginning. Please contact us at support@blasto.ai.
Blasto will only respond to the first impression.
Bid Params for Prebid Server
Blasto supports diffrent regions for the prebid server. By default US East.
Please deploy the prebid config in each of your datacenters with the appropriate regional subdomain.
Name |
Scope |
Description |
Example |
Type |
sourceId |
required |
Unique hash provided by blasto |
'6dllcEHSxYdSb6yLmCqE' |
string |
accountId |
required |
Unique name provided by blasto |
'blasto-test' |
string |
Bid Params for Prebid.js
Name |
Scope |
Description |
Example |
Type |
sourceId |
required |
Unique hash provided by blasto |
'6dllcEHSxYdSb6yLmCqE' |
string |
accountId |
required |
Unique name provided by blasto |
'blasto-test' |
string |
host |
optional |
Blasto server region. US East by default |
'us-e-node1' |
string |
BLIINK
Features
Bidder Code |
bliink |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
658 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
videoUrl |
optional |
The Video url on which the ad is displayed in case of video ad. |
'https://video.mp4' |
string |
Blockthrough
Features
Bidder Code |
blockthrough |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
815 |
GPP Support |
usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_blockthrough |
hb_bidder_blockthrou |
hb_adid_blockthrough |
hb_size_blockthrough |
hb_source_blockthrou |
hb_format_blockthrou |
hb_cache_host_blockt |
hb_cache_id_blockthr |
hb_uuid_blockthrough |
hb_cache_path_blockt |
hb_deal_blockthrough |
|
Note
The BT Bid Adapter makes requests to the BT Server which supports OpenRTB.
Publishers should use the ortb2
method of setting First Party Data. The BT adapter requires setup and approval from the Blockthrough team. Please reach out to marketing@blockthrough.com for more information.
Prebid JS
Bid Params
Name |
Scope |
Description |
Example |
Type |
bidderCode |
required |
Bidder configuration. Could configure several bidders this way. |
bidderA: {publisherId: 55555} |
object |
Bid Config
Make sure to set required orgID, websiteID values received after approval using pbjs.setBidderConfig
.
Name |
Scope |
Description |
Example |
Type |
orgID |
required |
A unique ID for your organization provided by the Blockthrough team. |
4829301576428910 |
string |
websiteID |
required |
A unique ID for your site provided by the Blockthrough team. |
5654012389765432 |
string |
Example
pbjs.setBidderConfig({
bidders: ['blockthrough'],
config: {
ortb2: {
site: {
ext: {
blockthrough: {
orgID: '4829301576428910',
websiteID: '5654012389765432',
},
},
},
},
},
});
AdUnits configuration example
var adUnits = [
{
code: 'banner-div-1',
mediaTypes: {
banner: {
sizes: [[728, 90]],
},
},
bids: [
{
bidder: 'blockthrough',
params: {
bidderA: {
publisherId: 55555,
},
bidderB: {
zoneId: 12,
},
},
},
],
},
];
Blue
Features
Bidder Code |
blue |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
620 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
id5Id, identityLink, pubProvidedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Bluesea
Features
Bidder Code |
bluesea |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_bluesea |
hb_bidder_bluesea |
hb_adid_bluesea |
hb_size_bluesea |
hb_source_bluesea |
hb_format_bluesea |
hb_cache_host_bluese |
hb_cache_id_bluesea |
hb_uuid_bluesea |
hb_cache_path_bluese |
hb_deal_bluesea |
|
Registration
If you have any question regarding the set up, please reach out to your account manager or prebid@blueseasx.com for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubid |
required |
Unique partner account id |
'254673' |
string |
token |
required |
Token for certification |
'3l2l2mbl2knw2ggc' |
string |
First Party Data
Publishers can use the ortb2 configuration to provide First Party Data. The following fields are supported:
- ortb2.site.*
- ortb2.user.*
Bright Mountain Media
Features
Bidder Code |
bmtm |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
id5Id, sharedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1151 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 support@bold-win.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
endpointId |
required |
Endpoint Id |
'0' |
string |
For both the Prebid Server and Prebid.js integrations it is required to use only one parameter: endpointId
.
endpointId
- should be sent in the Prebid bid request to Boldwin in case you integrate with Boldwin bidder.
Brave
Features
Bidder Code |
brave |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
869 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
BoldwinX
Features
Bidder Code |
bwx |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bwx |
hb_bidder_bwx |
hb_adid_bwx |
hb_size_bwx |
hb_source_bwx |
hb_format_bwx |
hb_cache_host_bwx |
hb_cache_id_bwx |
hb_uuid_bwx |
hb_cache_path_bwx |
hb_deal_bwx |
|
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
unique placement ID |
aa8210e2013wc095fe9dba67981040b0 |
string |
env |
optional |
Environment name |
bwx-stage |
string |
Cadent Aperture MX
Features
Bidder Code |
cadent_aperture_mx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
183 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
identityLink, uid2 |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cadent_apertur |
hb_bidder_cadent_ape |
hb_adid_cadent_apert |
hb_size_cadent_apert |
hb_source_cadent_ape |
hb_format_cadent_ape |
hb_cache_host_cadent |
hb_cache_id_cadent_a |
hb_uuid_cadent_apert |
hb_cache_path_cadent |
hb_deal_cadent_apert |
|
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 contactaperturemx@cadent.tv.
Bid Params
Name |
Scope |
Description |
Example |
Type |
tagid |
required |
The Tag ID from Cadent Aperture MX. |
test1 |
string |
bidfloor |
optional |
The CPM bid floor |
0.25 |
string |
Clickonometrics
Features
Bidder Code |
ccx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
773 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Configuration
pbjs.setConfig({
codefuel: {
bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
}
});
Cointraffic
Features
Bidder Code |
cointraffic |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cointraffic |
hb_bidder_cointraffi |
hb_adid_cointraffic |
hb_size_cointraffic |
hb_source_cointraffi |
hb_format_cointraffi |
hb_cache_host_cointr |
hb_cache_id_cointraf |
hb_uuid_cointraffic |
hb_cache_path_cointr |
hb_deal_cointraffic |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placement ID (Tracker key) |
|
string |
Coinzilla
Features
Bidder Code |
coinzilla |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolid, identityLink, unifiedId, id5Id, uid2 |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
|
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
883 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
Concert
Features
Bidder Code |
concert |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
sharedId, unifiedId, uid2 |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_concert |
hb_bidder_concert |
hb_adid_concert |
hb_size_concert |
hb_source_concert |
hb_format_concert |
hb_cache_host_concer |
hb_cache_id_concert |
hb_uuid_concert |
hb_cache_path_concer |
hb_deal_concert |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
partnerId |
required |
The partner id assigned by concert. |
'partner_name' |
string |
placementId |
optional |
The placement id. |
1234567 |
integer |
site |
optional |
The site name. |
'site_name' |
string |
slot |
optional |
The slot name. |
slot_name' |
string |
sizes |
optional |
All sizes this ad unit accepts. |
[[1030, 590]] |
array |
ConnectAd
Features
Bidder Code |
connectad |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
138 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams
function.
See prebid.js #6361 for more details.
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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
591 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 adapter requires setup and approval from your Consumable account manager, even for existing Consumable publishers. Please reach out to your account manager to enable Prebid 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 |
placementId |
required |
the placementid from Consumable. |
0421008445828ceb46f496700a5fa65e |
string |
Table of contents
Introduction
Publishers can use Prebid Server in any of the following ways with Consumable. Consumable’s adapter supports all of the following methods:
- If you want to call Consumable from a web environment, you can use Prebid.js to call Prebid Server, and then Prebid Server uses our server-side adapter to call Consumable. This reduces workload on the browser. For set up instructions, see Call Consumable 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 Consumable. For set up instructions, see Call Consumable 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 Consumable. For set up instructions, see Call Consumable from CTV/long-form video environment section on this page.
The following table lists the media types that Consumable supports. For information about the the Time-To-Live (TTL) for each media type, see How Consumable counts impressions in our Knowledge Base.
Type |
Prebid Server support |
banner |
Supported |
video |
Supported, including ad pods for OTT |
audio |
Supported |
Setup instructions to call Consumable through Prebid Server
Note: If you are hosting your own Prebid Server instance, you must contact your Consumable Exchange Representative to get an endpoint and setup instructions.
If you are using an existing Prebid Server instance that is already configured to call Consumable, depending on whether you want to call Consumable from the browser, mobile app, CTV, or long-form video, follow any of the below sections to complete the Consumable-specific configuration.
Call Consumable from a web browser
To call Consumable from a web browser using Prebid Server, you must first configure Prebid.js to call Consumable directly from the browser using our client-side adapter. Follow the quick start instructions provided in Prebid’s Getting Started for Developers documentation. Complete the following steps to complete the Consumable-specific configuration:
- Build the binary in one of the following ways:
Download Prebid.js from the Prebid site to use the standard compiled binary that Prebid includes in the download process and select Consumable Exchange as an adapter.
-
Define the Consumable-specific parameters at the bidder level which include adding consumable
as the bidder and the siteId
. For Consumable’s bidder-specific parameters, see the Bid request parameters section below.
{
bidder: 'consumable',
params: {
"networkId": 11,
"siteId": 32,
"unitId": 42,
"unitName": "cnsmbl-audio-728x90-slider"
}
}
- Define your ad units in the
adUnit
object. This includes the details about the ad slots such as the media types, ad size, and ad code. For more information about this object, see Prebid’s Ad Unit Reference documentation.
-
Enable user syncing by adding the following code in the pbjs.setConfig() function. Consumable strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Consumable bid rate and bid price. Make sure to call pbjs.setConfig()
only once. This configuration is optional in Prebid, but required by Consumable.
pbjs.setConfig({
userSync: {
iframeEnabled: true,
filterSettings: {
iframe: {
bidders: ['consumable'],
filter: 'include'
}
}
}
});
- (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the Set up First Party Data (FPD) section in our Prebid.js documentation on the Prebid site.
-
(Optional) If you want to monetize instream video, you need to enable a cache endpoint in the pbjs.setConfig() function as follows:
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Call Consumable from Prebid Mobile SDK
Before you begin: Contact your Consumable Exchange representative to get your placementId
. You must provide this placementID to your Prebid Server host company.
Note: To implement Prebid Mobile SDK, follow Prebid’s Getting Started with Prebid Mobile documentation.
To add Consumable as a bidder to your mobile app:
- Inform your Prebid Server hosting company to add
consumable
as a bidder in the configuration and include the placementId
that Consumable provides to you at the time of integration.
- Define the Consumable-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 Prebid Mobile API - iOS and Prebid Mobile API - Android documentation.
Before you begin: Contact your Consumable Exchange Representative to get the placementId
. You must provide this placement 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 Consumable as a bidder:
- Inform your Prebid Server hosting company to add
consumable
as a bidder in the configuration and include the placementId
that Consumable provides to you at the time of integration.
- Define the Consumable-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.
Bid request parameters
For a list of the OpenRTB fields that Consumable supports in bid requests, see List of supported OpenRTB bid request fields for sellers. The following are the required fields for the various supported media types.
Site (Banner, Video, Audio)
You must include these parameters at the bidder level.
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 |
App or CTV (Banner, Video, Audio)
You must include these parameters at the bidder level.
Key |
Scope |
Type |
Description |
placementId |
Required |
String |
An Consumable-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, '0421008445828ceb46f496700a5fa65e' |
Examples
Banner
{
"id": "cons-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": {
"consumable": {
"placementId": "0421008445828ceb46f496700a5fa65e"
}
}
}
],
"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": "cons-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": {
"consumable": {
"placementId": "0421008445828ceb46f496700a5fa65e"
}
}
}
],
"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
}
Audio
{
"id": "cons-audio-example",
"imp": [
{
"id": "imp-id",
"video": {
"mimes": [
"video/mp3"
],
"minduration": 15,
"maxduration": 60,
"startdelay": -1,
"protocols": [
2,
3,
5,
6
],
"placement": 1,
"linearity": 1,
"minbitrate": 1000,
"api": [
1,
2,
3,
5
]
},
"secure": 1,
"ext": {
"consumable": {
"placementId": "0421008445828ceb46f496700a5fa65e"
}
}
}
],
"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
}
SSP Copper6
Features
Bidder Code |
copper6 |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
410 (adtelligent) |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_copper6 |
hb_bidder_copper6 |
hb_adid_copper6 |
hb_size_copper6 |
hb_source_copper6 |
hb_format_copper6 |
hb_cache_host_copper |
hb_cache_id_copper6 |
hb_uuid_copper6 |
hb_cache_path_copper |
hb_deal_copper6 |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
aid |
required |
The source ID from Copper6 Media. |
12412 |
integer |
Description
Copper6 Media header bidding adapter connects with Copper6 Media demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand.
Test Parameters
var adUnits = [
// Video instream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'copper6',
params: {
aid: 472386
}
}]
},
// Video outstream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'outstream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'copper6',
params: {
aid: 472386
}
}]
},
// Video ADPOD adUnit
{
code: 'test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'adpod',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'copper6',
params: {
aid: 472386
}
}]
},
// Banner adUnit
{
code: 'test-div',
mediaTypes:{
banner:{
sizes: [[300, 250]]
}
}
bids: [{
bidder: 'copper6',
params: {
aid: 529814
}
}]
}
];
Copper6SSP
Features
Bidder Code |
copper6ssp |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_copper6ssp |
hb_bidder_copper6ssp |
hb_adid_copper6ssp |
hb_size_copper6ssp |
hb_source_copper6ssp |
hb_format_copper6ssp |
hb_cache_host_copper |
hb_cache_id_copper6s |
hb_uuid_copper6ssp |
hb_cache_path_copper |
hb_deal_copper6ssp |
|
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
CPMStar
Features
Bidder Code |
cpmstar |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1317 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cpmstar |
hb_bidder_cpmstar |
hb_adid_cpmstar |
hb_size_cpmstar |
hb_source_cpmstar |
hb_format_cpmstar |
hb_cache_host_cpmsta |
hb_cache_id_cpmstar |
hb_uuid_cpmstar |
hb_cache_path_cpmsta |
hb_deal_cpmstar |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placement ID from CPMStar. |
81006 |
integer |
Criteo
Features
Bidder Code |
criteo |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
91 |
GPP Support |
some (check with bidder) |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, pubProvidedId, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
pubid |
required |
publisher id |
'ABC123' |
string |
uid |
optional |
Ad Unit ID |
'8888' |
string |
nativeCallback |
optional |
(deprecated) (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
and ortb2Imp
methods to set First Party Data.
The standard Open RTB properties supported from ortb2
/ ortb2Imp
are described in the following table.
Name |
Scope |
Description |
Example |
Type |
ortb2.user |
optional |
Details via a Open RTB User object about the human user of the device; the advertising audience. |
N/A |
object |
ortb2.site |
optional |
Details via a Open RTB Site object about the publisher’s website. |
N/A |
object |
ortb2Imp.rwdd |
optional |
Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes. |
1 |
integer |
Besides these standard properties, ext
field can be used to send any publisher specific data which may have been discussed with a Criteo representative.
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 ; |
[4, 5] |
Array<integer> |
placement |
required |
Video placement type. In-Stream: 1 ; In-Banner: 2 ; In-Article: 3 : In-Feed: 4 ; Interstitial: 5 ; |
1 |
integer |
skip |
required |
Ability from the video player for the user to skip the video. Not skippable: 0 ; Skippable: 1 ; |
1 |
integer |
In addition, Criteo adapter relies on parameters specified in the mediaTypes.video definition of the video ad-units, namely:
Name |
Scope |
Description |
Example |
Type |
context |
required |
outstream , instream or long-form |
instream |
string |
mimes |
required |
List of the content MIME types supported by the player |
["video/mp4"] |
Array<string> |
playerSize |
required |
Width and height of the player |
[640, 480] |
Array<integer> |
protocols |
required |
Supported video bid response protocols. VAST 1.0: 1 ; VAST 2.0: 2 ; VAST 3.0: 3 ; VAST 1.0 Wrapper: 4 ; VAST 2.0 Wrapper: 5 ; VAST 3.0 Wrapper: 6 ; |
[5, 6] |
Array<integer> |
maxduration |
required |
Maximum ad duration in seconds |
20 |
integer |
api |
required |
API frameworks supported. VPAID 1.0: 1 ; VPAID 2.0: 2 ; MRAID 1.0: 3 ; ORMMA: 4 ; MRAID 2.0: 5 ; MRAID 3.0: 6 ; OMID 1.0: 7 ; |
[1, 2] |
Array<integer> |
plcmt |
optional |
1=in-stream, 2=accompanying content, 3=interstitial, 4=no content/standalone. Highly recommended to comply with new IAB video specifications. |
1 |
integer |
Example of Video Ad-unit
var adUnits = [
{
code: 'video1',
mediaTypes: {
video: {
playerSize: [640, 480],
context: 'instream',
mimes: ["video/mp4"],
maxduration: 30,
api: [1, 2],
playerSize: [640,480],
protocols: [2, 3],
skip: 0,
playbackmethod: [1],
placement: 1
}
},
bids: [{
bidder: 'criteo',
params: {
zoneId: 1455580
}
}]
}];
Additional Config (Optional)
If you don’t want to use the FastBid adapter feature, you can disable it via this configuration:
pbjs.setConfig({
'criteo': {
fastBidVersion: 'none',
}
});
Criteo teams are planning to completely remove this feature with Prebid 9.0
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1081 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
check with bidder |
Supply Chain Support |
no |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
optional |
C-WIRE page id (compatibility purposes) |
2453 |
integer |
placementId |
optional |
C-WIRE placement id |
113244 |
integer |
domainId |
required |
C-WIRE domain id |
2453 |
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
criteo,unifiedId,netId,pubcid |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
source_id |
required |
Website Source Id |
111 |
integer |
host |
optional |
Network Host to request from |
‘prebid.dblks.net’ |
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
541 |
GPP Support |
usp, usnat, usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
bidfloor |
optional |
bid floor price in USD |
1.5 |
number |
height |
optional |
height of the creative |
350 |
number |
width |
optional |
width of the creative |
250 |
number |
custom |
optional |
custom key value params |
'{"position":"right-box"}'' |
object |
user |
optional |
user params according to IAB standards |
'{"gender":"F"}'' |
object |
pos |
optional |
ad position as per IAB standards |
1 |
number |
Configuration
Deepintent recommends the UserSync configuration below. Without it, the Deepintent adapter will not able to perform user syncs, which lowers match rate and reduces monetization.
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // '*' represents all bidders
filter: 'include'
}
}
}
});
var adUnits = [
{
code: "div-22",
mediaTypes: {
banner: {
sizes: [
[300, 250],
[300, 600],
],
},
},
bids: [
{
bidder: "deepintent",
params: {
tagId: "1399",
bidfloor: 1.5,
height: 300,
width: 250,
pos: 1,
user: {
gender: "F",
uid: "publisher_uid",
buyeruid: "test_buyeruid",
yob: 2000,
},
custom: {
position: "right-box",
},
},
},
],
},
];
video parameters
Deepintent 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 |
1 |
video.api |
optional |
API frameworks supported Values:
1 : VPAID 1.0
2 : VPAID 2.0
3 : MRAID-1
4 : ORMMA
5 : MRAID-2 |
[1, 2] |
video.protocols |
optional |
Supported video bid response protocols Values
1 : VAST 1.0
2 : VAST 2.0
3 : VAST 3.0 4 : VAST 1.0 Wrapper
5 : VAST 2.0 Wrapper
6 : VAST 3.0 Wrapper |
[5, 6] |
video.battr |
optional |
Blocked creative attributes, See OpenRTB 2.5 specification, List 5.3 for values |
[3, 9] |
video.linearity |
optional |
Indicates if the impression is linear or nonlinear Values:
1 : Linear/In-Stream
2 : Non-Linear/Overlay. |
1 |
video.placement |
optional |
Video placement type. See OpenRTB 2.5 specification, List 5.9 for Values |
1 |
video.minbitrate |
optional |
Minumim bit rate in Kbps. |
50 |
video.maxbitrate |
optional |
Maximum bit rate in Kbps. |
70 |
var videoAdUnits = [
{
code: "test-div-video",
mediaTypes: {
video: {
playerSize: [640, 480],
context: "instream",
},
},
bids: [
{
bidder: "deepintent",
params: {
tagId: "1399", // required
publisherId: "32572", // required
adSlot: "38519891@300x250", // required
bidfloor: 1.5, // optional
video: {
mimes: ["video/mp4", "video/x-flv"], // required
skip: 1, // optional
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1, 3], // optional
api: [1, 2], // optional
protocols: [2, 3], // optional
battr: [13, 14], // optional
linearity: 1, // optional
placement: 2, // optional
minbitrate: 10, // optional
maxbitrate: 10, // optional
},
},
},
],
},
];
DEFINE MEDIA
Features
Bidder Code |
definemedia |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
440 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_definemedia |
hb_bidder_definemedi |
hb_adid_definemedia |
hb_size_definemedia |
hb_source_definemedi |
hb_format_definemedi |
hb_cache_host_define |
hb_cache_id_defineme |
hb_uuid_definemedia |
hb_cache_path_define |
hb_deal_definemedia |
|
Registration
Please reach out to our account management team to get started. Contact information is available under a link.
Bid Params
Name |
Scope |
Description |
Example |
Type |
mandantId |
required |
Mandant ID |
5 |
integer |
adslotId |
optional |
Adslot ID |
199 |
integer |
Dianomi
Features
Bidder Code |
dianomi |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
885 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dianomi |
hb_bidder_dianomi |
hb_adid_dianomi |
hb_size_dianomi |
hb_source_dianomi |
hb_format_dianomi |
hb_cache_host_dianom |
hb_cache_id_dianomi |
hb_uuid_dianomi |
hb_cache_path_dianom |
hb_deal_dianomi |
|
Note
- Supports
display
and banner
formats.
- Uses
OpenRTB
standard.
Registration
The Dianomi Adapter requires setup before beginning. Please contact us at eng@dianomi.com.
Bid params
Name |
Scope |
Description |
Example |
Type |
smartadId |
required |
Placement ID |
12345 |
integer |
endpoint |
optional |
for testing only |
www-prebid.dianomi.com |
string |
Note: smartadId is a pre agreed ID between the publisher and Dianomi.
Native example
var adUnits = [
code: 'your-native-container-id',
mediaTypes: {
native: {
image: {
required: false,
sizes: [100, 50]
},
title: {
required: false,
len: 140
},
sponsoredBy: {
required: false
},
clickUrl: {
required: false
},
body: {
required: false
},
icon: {
required: false,
sizes: [50, 50]
}
}
},
bids: [{
bidder: 'dianomi',
params: {
smartadId: 9607
}
}]
];
Banner example
var adUnits = [
code: 'your-banner-container-id',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: 'dianomi',
params: {
smartadId: 9607
}
}]
];
Video example
var adUnits = [
code: 'your-video-container-id',
mediaTypes: {
video: {
playerSize: [[640, 480]]
}
},
bids: [{
bidder: 'dianomi',
params: {
smartadId: 9607
}
}]
];
Displayio
Features
Bidder Code |
displayio |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_displayio |
hb_bidder_displayio |
hb_adid_displayio |
hb_size_displayio |
hb_source_displayio |
hb_format_displayio |
hb_cache_host_displa |
hb_cache_id_displayi |
hb_uuid_displayio |
hb_cache_path_displa |
hb_deal_displayio |
|
Note
Before configuring the display.io adapter you must reach out your account manager from display.io team (or send a request to contact@display.io) for approval and setup steps.
Prebid.js params
Name |
Scope |
Type |
Description |
Example |
siteId |
required |
Number |
SiteId and PlacementID are your inventory IDs on the display.io platform (please ask your Account Manager for your site and placement IDs). |
7753 |
placementId |
required |
Number |
SiteId and PlacementID are your inventory IDs on the display.io platform (please ask your Account Manager for your site and placement IDs). |
5375 |
adsSrvDomain |
required |
String |
|
“appsrv.display.io” |
cdnDomain |
required |
String |
|
“cdn.display.io” |
renderURL |
optional |
String |
|
“https://cdn.display.io/webis/webis-prebid.min.js” |
pageCategory |
optional |
String |
Comma-separated list of IAB content categories that describe the current page or view of the site, list of available values. |
“pageCategory1, pageCategory2” |
keywords |
optional |
String |
Comma-separated list of keywords describing the content. |
“keyword1, keyword2, keyword3” |
custom |
optional |
Object |
User-defined targeting key-value pairs. custom applies to a specific unit. |
{headerTextColor: "red", fixedHeaderSelector: '.site-header'} |
custom.headerText |
optional |
String |
Ad container header text. By default, text is “Scroll to continue with content”. Limited to 50 characters. |
“Our awesome advertisement” |
custom.headerTextColor |
optional |
String |
Ad container header text color, “white” by default |
“#2196f3” |
custom.headerBackgroundColor |
optional |
String |
Ad container header background color, “black” by default |
“#fff” |
custom.adContainerBackgroundColor |
optional |
String |
Ad container body background color, “transparent” by default |
“#000” |
custom.fixedHeaderSelector |
optional |
String |
In case your webpage has a fixed header – the header Id attribute or header class attribute should be defined as a value for parameter fixedHeaderSelector. |
“.site-header” |
Prebid Server Params
Name |
Scope |
Type |
Description |
Example |
publisherId |
required |
String |
Publisher Id on the display.io platform (please ask your Account Manager for your publisher id). |
“101” |
inventoryId |
required |
String |
Inventory Id on the display.io platform (please ask your Account Manager for your inventory id). |
“1011” |
placementId |
required |
String |
Placement Id on the display.io platform (please ask your Account Manager for your placement id). |
“1011” |
DistrictM DMX
Features
Bidder Code |
dmx |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
144 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dmx |
hb_bidder_dmx |
hb_adid_dmx |
hb_size_dmx |
hb_source_dmx |
hb_format_dmx |
hb_cache_host_dmx |
hb_cache_id_dmx |
hb_uuid_dmx |
hb_cache_path_dmx |
hb_deal_dmx |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
seller_id |
required |
The DMX Partner ID provided upon onboarding, this is for specific setup BURL, NURL or ADM support |
‘seller_id’ |
string |
publisher_id |
required |
Boost MemberId from DistrictM UI |
‘member1’ |
string |
tagid |
required |
Represent the placement ID from DistrictM or your own |
‘123abc’ |
string |
bidfloor |
optional |
The minimum price acceptable for a bid |
‘1.0’ |
string |
memberid |
optional |
MemberId from DistrictM UI (legacy: replaced by publisher_id) |
‘member1’ |
string |
dmxid |
optional |
Placement ID from DistrictM (legacy: replaced by tagid) |
‘123abc’ |
string |
(See districtmDMX for Prebid.js)
driftpixel
Features
Bidder Code |
driftpixel |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_driftpixel |
hb_bidder_driftpixel |
hb_adid_driftpixel |
hb_size_driftpixel |
hb_source_driftpixel |
hb_format_driftpixel |
hb_cache_host_driftp |
hb_cache_id_driftpix |
hb_uuid_driftpixel |
hb_cache_path_driftp |
hb_deal_driftpixel |
|
Prebid.js Bid params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Placement ID |
test-banner |
string |
env |
required |
Environment name |
driftpixel |
string |
ext |
optional |
Specific integration config |
{} |
object |
Prebid Server Bid params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Unique placement ID |
pid1 |
string |
env |
optional |
Driftpixel environment |
test |
string |
Duration Media
Features
Bidder Code |
duration |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
816 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_duration |
hb_bidder_duration |
hb_adid_duration |
hb_size_duration |
hb_source_duration |
hb_format_duration |
hb_cache_host_durati |
hb_cache_id_duration |
hb_uuid_duration |
hb_cache_path_durati |
hb_deal_duration |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
siteId |
required |
siteId is provided by your Duration Media account manager(s) |
|
integer |
placementId |
optional |
placementId is provided by your Duration Media account manager(s). This parameter allows to report on a specific ad unit |
|
integer |
video |
optional |
Object containing video targeting parameters. Note that this parameter is not used in Prebid Server. See Video Object for details. |
video: { playback_method: ['auto_play_sound_off'] } |
object |
Note
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.
Test Parameters
var adUnits = [
{
code: 'test-div1',
mediaTypes: {
banner: {
sizes: [[300, 250]], // a display size
}
},
bids: [
{
bidder: "duration",
params: {
siteId: 2,
placementId: 3
}
}
]
},{
code: 'test-div2',
mediaTypes: {
banner: {
sizes: [[320, 50]], // a mobile size
}
},
bids: [
{
bidder: "duration",
params: {
siteId: 2
}
}
]
}
];
Video Object
Name |
Description |
Type |
skippable |
Boolean which, if true , means the user can click a button to skip the video ad. Defaults to false . |
boolean |
playback_method |
Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on" ; "auto_play_sound_off" ; "click_to_play" ; "mouseover" ; "auto_play_sound_unknown" ; "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> |
DXKulture
Features
Bidder Code |
dxkulture |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dxkulture |
hb_bidder_dxkulture |
hb_adid_dxkulture |
hb_size_dxkulture |
hb_source_dxkulture |
hb_format_dxkulture |
hb_cache_host_dxkult |
hb_cache_id_dxkultur |
hb_uuid_dxkulture |
hb_cache_path_dxkult |
hb_deal_dxkulture |
|
Integration Note
The DXKulture Header Bidding adapter requires approval from the DXKulture team. Please reach out to devops@dxkulture.com for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement Id |
'1234abcd' |
string |
publisherId |
required |
Publisher Id |
'12345' |
string |
bidfloor |
optional |
Bid Floor |
2.3 |
float |
bidfloorcur |
optional |
Bid Floor Currency |
'USD' |
string |
E-volution tech
Features
Bidder Code |
e_volution |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
957 |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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' |
Edge226
Features
Bidder Code |
edge226 |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
1202 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_edge226 |
hb_bidder_edge226 |
hb_adid_edge226 |
hb_size_edge226 |
hb_source_edge226 |
hb_format_edge226 |
hb_cache_host_edge22 |
hb_cache_id_edge226 |
hb_uuid_edge226 |
hb_cache_path_edge22 |
hb_deal_edge226 |
|
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
Embi Media
Features
Bidder Code |
embimedia |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_embimedia |
hb_bidder_embimedia |
hb_adid_embimedia |
hb_size_embimedia |
hb_source_embimedia |
hb_format_embimedia |
hb_cache_host_embime |
hb_cache_id_embimedi |
hb_uuid_embimedia |
hb_cache_path_embime |
hb_deal_embimedia |
|
Note
The Embi Media Bidding adapter requires setup before beginning.
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'bidder-embi.media' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
emetriq
Features
Bidder Code |
emetriq |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
213 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emetriq |
hb_bidder_emetriq |
hb_adid_emetriq |
hb_size_emetriq |
hb_source_emetriq |
hb_format_emetriq |
hb_cache_host_emetri |
hb_cache_id_emetriq |
hb_uuid_emetriq |
hb_cache_path_emetri |
hb_deal_emetriq |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placement_id (PBS+PBJS) or placementId (PBJS) |
required |
Placement id |
'32068254' |
string |
emetriq is an aliased bidder for AppNexus.
Note
For setup with emetriq, please reach out to admins@emetriq.com
EMTV
Features
Bidder Code |
emtv |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_emtv |
hb_bidder_emtv |
hb_adid_emtv |
hb_size_emtv |
hb_source_emtv |
hb_format_emtv |
hb_cache_host_emtv |
hb_cache_id_emtv |
hb_uuid_emtv |
hb_cache_path_emtv |
hb_deal_emtv |
|
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
Engage BDR
Features
Bidder Code |
engagebdr |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
90 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
'pbjs.e-planning.net' |
string |
isv |
optional |
Indicates a CDN URL different than default |
'i.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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
849 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
yes |
Supply Chain Support |
no |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
Epsilon
Features
Bidder Code |
conversant |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
24 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId, publinkId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
pbjs.setConfig({
debug: true,
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
},
ortb2: {
site: {
content: {
series: 'MySeries',
season: 'My Season',
episode: 3,
title: 'My Title'
}
}
}
});
Example AdUnit specific data using the ortb2Imp
object
var videoAdUnit = {
code: 'video1',
mediaTypes: {
video: {
playerSize: [[640, 480]]
}
},
ortb2Imp: {
instl: 1,
ext: {
data: {
adUnitSpecificAttribute: "123"
}
}
},
bids: [{
bidder: 'conversant',
params: {
site_id: '108060',
mimes: ['video/mp4', 'video/webm']
}
}]
}
pbjs.que.push(function(){
pbjs.addAdUnits(videoAdUnits);
}
Equativ
Features
Bidder Code |
equativ |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
45 |
GPP Support |
tcfeu, usp |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_equativ |
hb_bidder_equativ |
hb_adid_equativ |
hb_size_equativ |
hb_source_equativ |
hb_format_equativ |
hb_cache_host_equati |
hb_cache_id_equativ |
hb_uuid_equativ |
hb_cache_path_equati |
hb_deal_equativ |
|
Registration
The Equativ bidder adapter requires setup and approval from the Equativ service team. Please reach out to your account manager for more information to start using it.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network identifier you have been provided with. See Bid Parameter Usage notes below for more information. |
1234 |
integer |
siteId |
required |
The placement site ID. See Bid Parameter Usage notes below for more information. |
1234 |
integer |
pageId |
required |
The placement page ID. See Bid Parameter Usage notes below for more information. |
1234 |
integer |
formatId |
required |
The placement format ID. See Bid Parameter Usage notes below for more information. |
1234 |
integer |
Bid Parameter Usage
Different combinations of parameters are required depending upon which ones you choose to use.
There are three options for passing bidder parameters:
- Option 1. Specify
networkId
by itself (without siteId
, pageId
and formatId
), or
- Option 2. Specify
siteId
and pageId
and formatId
(all together) without networkId
, or
- Option 3. Specify none of the above parameters, and instead use either
ortb2.site.publisher.id
, ortb2.app.publisher.id
or ortb2.dooh.publisher.id
See Sample Banner Setup for examples of these parameter options.
Type |
Support |
banner |
Supported |
video |
Not currently supported |
native |
Not currently supported |
User Syncing
To enable cookie syncing, make sure their configuration setup is properly invoked.
This involves adding an entry for setConfig()
that allows user syncing for iframes with 'equativ'
included as a bidder:
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: ['equativ'],
},
},
},
});
And also making sure that storage is enabled for equativ
:
pbjs.bidderSettings = {
equativ: {
storageAllowed: true,
},
};
Configuration Example
Sample Banner Setup
As mentioned in the Bid Parameter Usage section, when including 'equativ'
as one of your available bidders your adunit setup, there are three general approaches to how you can specify parameters. Below are examples that illustrate them.
Option 1 – Using networkId as the only bid param
<script>
var adUnits = [
{
code: 'div-123',
mediaTypes: {
banner: {
sizes: [
[600, 500],
[300, 600],
],
},
},
bids: [
{
bidder: 'equativ',
// siteId, pageId and formatId are NOT
// required if networkId is provided instead
params: {
networkId: 42,
},
},
],
},
];
pbjs.que.push(function () {
pbjs.addAdUnits(adUnits);
});
</script>
Option 2 - Using siteId, pageId and formatId as bid params
<script>
var adUnits = [
{
code: 'div-123',
mediaTypes: {
banner: {
sizes: [
[600, 500],
[300, 600],
],
},
},
bids: [
{
bidder: 'equativ',
// all 3 of the below params are required
// when used together in place of networkId
params: {
siteId: 1,
pageId: 2,
formatId: 3,
},
},
],
},
];
pbjs.que.push(function () {
pbjs.addAdUnits(adUnits);
});
</script>
Option 3 - Using ortb2 for parameter info
You can also, as an alternative to using bidder params, specify a value for publisher.id
that may be nested under an app
, site
or dooh
object. The Equativ adapter will, in turn, look for these property paths under the ortb2
property of the request:
ortb2.app.publisher.id
ortb2.site.publisher.id
ortb2.dooh.publisher.id
Additional Resources
Information about how Equativ supports the oRTB specification, along with additional examples, can be found on our OpenRTB API support site.
eRGADX
Features
Bidder Code |
ergadx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
14 (adkernel) |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Escalax
Features
Bidder Code |
escalax |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_escalax |
hb_bidder_escalax |
hb_adid_escalax |
hb_size_escalax |
hb_source_escalax |
hb_format_escalax |
hb_cache_host_escala |
hb_cache_id_escalax |
hb_uuid_escalax |
hb_cache_path_escala |
hb_deal_escalax |
|
Note
The Escalax Bidding adapter requires setup before beginning. Please contact us at connect@escalax.io
Bid Params
Name |
Scope |
Description |
Example |
Type |
sourceId |
required |
Patner name |
'partner' |
string |
accountId |
required |
Hash |
'0800fc577294' |
string |
Evolution Technologies
Features
Bidder Code |
evtech |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
FelixAds
Features
Bidder Code |
felixads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_felixads |
hb_bidder_felixads |
hb_adid_felixads |
hb_size_felixads |
hb_source_felixads |
hb_format_felixads |
hb_cache_host_felixa |
hb_cache_id_felixads |
hb_uuid_felixads |
hb_cache_path_felixa |
hb_deal_felixads |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
Filmzie
Features
Bidder Code |
filmzie |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_filmzie |
hb_bidder_filmzie |
hb_adid_filmzie |
hb_size_filmzie |
hb_source_filmzie |
hb_format_filmzie |
hb_cache_host_filmzi |
hb_cache_id_filmzie |
hb_uuid_filmzie |
hb_cache_path_filmzi |
hb_deal_filmzie |
|
Note
The Filmzie Bidding adapter requires setup before beginning.
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'ortb.filmzie.com' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
flipp
Features
Bidder Code |
flipp |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_flipp |
hb_bidder_flipp |
hb_adid_flipp |
hb_size_flipp |
hb_source_flipp |
hb_format_flipp |
hb_cache_host_flipp |
hb_cache_id_flipp |
hb_uuid_flipp |
hb_cache_path_flipp |
hb_deal_flipp |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherNameIdentifier |
required |
Publisher name identifier |
test-publisher-name |
string |
creativeType |
required |
Type of the creative |
NativeX |
NativeX\|DTX |
siteId |
required |
ID associated with the site |
123456 |
integer |
zoneIds |
optional |
Zones to request from bidder |
[789, 123] |
array[integer] |
userKey |
optional |
User Key to power experience optimization and frequency capping. Publishers: please confirm with legal counsel before using this feature. |
4188d8a3-22d1-49cb-8624-8838a22562bd |
uuidv4 |
options |
optional |
Additional integration specific context |
options: { "startCompact": true } |
map[string]interface{} |
Current available integration options are as follows:
Name |
Scope |
Description |
Example |
Type |
startCompact |
optional |
Height of the experience will be reduced |
true |
boolean |
dwellExpand |
optional |
Auto expand the experience after a certain time passes |
true |
boolean |
contentCode |
optional |
Force show a certain experience. Generally used for testing and debugging purposes. |
publisher-test |
string |
FreeWheelssp
Features
Bidder Code |
freewheelssp |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
285 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
The zone ID for the ad. |
“2003” |
string |
format |
optional |
The format to use for displaying the ad. Can be one of the following: screen-roll intext-roll sliderad floorad expand-banner instream * inbanner Note: The screen-roll, intext-roll, sliderad and floorad formats are all FreeWheel outstream formats. Default value: “instream” |
“screen-roll” |
string |
bidfloor |
optional |
Bid floor price. |
13.2118 |
float |
bidfloorcur |
optional |
Bid floor currency. |
“USD” |
string |
vastUrlParams |
optional |
Add query parameters to the vast request. Should be a single item level JSON. Works with formats: instream, inbanner |
{ protocolVersion:’3.0’ } |
object |
When the following params are used with instream or inbanner formats, they should be included in the vastUrlParams
object. For other formats, they should be included directly in the params
object:
Name |
Scope |
Description |
Example |
Type |
soundButton |
optional |
If enabled, the sound will be off by default and the user will be able to turn it on/off by clicking on a button. (disabled on iOS devices) Default value: false |
true |
boolean |
defaultMute |
optional |
If “soundButton=true” is set, controls if the video will start with the sound muted. Default value: true |
false |
boolean |
timeline |
optional |
Display a progress bar to the bottom of the ad unit. Default value: false |
true |
boolean |
protocolVersion |
optional |
Specify the VAST version that will be used for the vastVersion parameter value on AdsSetup request. Default Value: 4.2 |
3 .0 |
float |
onOver |
optional |
Allows to enable the sound only when the mouse is over the ad container. Works with formats: screen-roll, intext-roll, sliderad, floorad, expand-banner Default value: false |
true |
boolean |
closeTimeout |
optional |
The duration in milliseconds before displaying the close button. Works with formats: screen-roll, intext-roll, sliderad, floorad Default value: 5000 |
2000 |
integer |
animated |
optional |
Enable an animation on opening and on closing of the video. Works with formats: intext-roll, sliderad Default value: true |
false |
boolean |
animationSpeed |
optional |
If the animated parameter is set to true, allows to choose the animation speed in milliseconds. Works with formats: intext-roll, sliderad Default value: 700 |
500 |
integer |
contentId |
optional |
Displays the ad inside the content-id dom element (dom id). Requires an ‘auto’, ‘p’ or ‘article’ param. Works with format: intext-roll |
“element-id” |
string |
auto |
optional |
If value is set to “v2”, position the intext-roll automatically. If contentId is set, the auto positioning will find a position inside the ‘contentId’ dom element. If contentId is not set, the auto positionaing will search the best position to display the ad based on the page semantic. It will select several possible position and show the intext-roll at the time one of them is made visible. Works with format: intext-roll Default value: null |
“v2” |
string |
article |
optional |
Set the location of the ad just after the given article tag in the page (0 is for the first article tag). If content-id is set, the article index is relative to articles inside the ‘content-id’ dom element |
“element-id” Works with format: intext-roll |
string |
p |
optional |
Set the location of the ad just after the given paragraph tag in the page (0 is for the first p tag). If content-id is set, the p index is relative to paragraphs inside the ‘content-id’ dom element. Works with format: intext-roll |
“element-id” |
string |
iframeMode |
optional |
Indicate to intext-roll that it is served in a friendly hidden iframe. Can be one of the following: normal - place ad in friendly iframe dfp - place ad in iframe on dfp platform Works with format: intext-roll |
“normal” |
string |
inRead |
optional |
When true, will keep the ad slot window on the page when the ad is done. Works with format: intext-roll Default value: false |
true |
boolean |
lang |
optional |
Text language. Can be one of: [fr,en,es,it,de,nl,pt] Works with format: intext-roll Default value: “fr” |
“en” |
string |
openingTime |
optional |
The time in milliseconds to display the opening animation. Works with format: intext-roll Default value: 0 |
100 |
integer |
pauseRatio |
optional |
Specify the viewabilityratio where the ad is paused. This can be a float between 0 and 1, or “never” which means never paused. The default value will pause when the ad has less than 50% viewability. Works with formats: intext-roll, expand-banner Default value: 0.5 |
0.9 |
float | string |
closeAction |
optional |
Define what to do for the banner after all ads complete. Can be one of: collapse - will set the target css display property to “none”. hide - will leave the target element in place, empty. Works with formats: intext-roll, expand-banner Default value: “collapse” |
“hide” |
string |
domId |
optional |
id of the dom element containing the text. If this targeted div is empty, be sure it has the needed width or a width of 0px will be used. Note that the script tag should be added in the page AFTER the targeted dom element so the target will be ready when the script runs. Works with formats: intext-roll, expand-banner |
“element-id” |
string |
errorAction |
optional |
Define what to do for the banner after an ad error. Can be one of: collapse - will set the target css display property to “none”. hide - will leave the target element in place, empty. Works with formats: intext-roll, expand-banner Default value: “collapse” |
“hide” |
string |
stickToTop |
optional |
Controls if the ad will stick to the top of the browser window. Can be one of the following: true - The ad will stick to the top of the browser window upon scroll. “bottom” - The ad will stick to the top and will be hidden again when reaching the bottom of the page. * number - The ad will stick to the top for the given distance in pixels. Works with formats: intext-roll, expand-banner |
300 |
boolean \| string \| number |
blurDisplay |
optional |
Allow to choose between too blur effects for the sides of the banner. Can be one of: big - will show the blured video only once in the background. duplicate - will show the blured video twice: once for each side. Works with format: expand-banner Default value: “big” |
“duplicate” |
string |
expandDirection |
optional |
Allows to force the expansion direction. Can be one of the following: before - Expand to the left if the banner is vertical and to the top if the banner is horizontal. after - Expand to the right if the banner is vertical and to the bottom if the banner is horizontal. center - Expand to left and right if the banner is vertical. Expand to the top and bottom if the banner is horizontal. auto - Expand based on the space available on the page. Expand to the left and/or right if the banner is vertical. and expand to the top and bottom if the banner is horizontal, depending on the space available. * none - Banner will not expand Works with format: expand-banner Default value: “auto” |
“before” |
string |
zIndex |
optional |
Force the z-index value on the ad container. The default value is around 4100 (see IAB guidelines). Use this parameter if it doesn’t fit your needs. Works with format: expand-banner Default value: ~4100 |
1000 |
integer |
hAlign |
optional |
Horizontal side where to display the video. Can be one of: left - horizontal align to the left of the page. middle - horizontal align to the middle of the page. * right - horizontal align to the right of the page. Works with format: sliderad Default value: “right” |
“left” |
string |
hSpacing |
optional |
Set a horizontal spacing between the hAlign side and the video. Works with format: sliderad Default value: 10 |
20 |
integer |
vAlign |
optional |
Vertical side where to display the video. Can be one of: top - vertical align to the top of the page. middle - vertical align to the middle of the page. * bottom - vertical align to the bottom of the page. Works with format: sliderad Default value: “bottom” |
“top” |
string |
vSpacing |
optional |
Set a vertical spacing between the vAlign side and the video. Works with format: sliderad Default value: 10 |
20 |
integer |
mod |
optional |
Ad trigger mode. Can be one of: asap - play the ad asap click - play the ad when the user clicks a link * scroll - play the ad when the user scrolls Works with format: screen-roll Default value: “asap” |
“click” |
string |
opacity |
optional |
Define the opacity of the background. This is a number between 0 (completely transparent) and 1 (totally black). Works with format: screen-roll Default value: 0.4 |
.5 |
float |
smartPlay |
optional |
Enable to use autoPlay on mobile devices. Works with format: screen-roll Default value: false |
true |
boolean |
bannerHeight |
optional |
The height in pixel of the bottom banner. The video ad takes this height when its not expanded. Works with format: floorad Default value: 250 |
500 |
integer |
FRVR Ad Network
Features
Bidder Code |
frvradn |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1107 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_frvradn |
hb_bidder_frvradn |
hb_adid_frvradn |
hb_size_frvradn |
hb_source_frvradn |
hb_format_frvradn |
hb_cache_host_frvrad |
hb_cache_id_frvradn |
hb_uuid_frvradn |
hb_cache_path_frvrad |
hb_deal_frvradn |
|
Registration
FRVR Ad Network Bidding adapter requires setup before beginning. Please contact us at info@frvr.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisher_id |
required |
Publisher ID |
'11111' |
string |
ad_unit_id |
required |
Ad Unit ID |
'22222' |
string |
FutureAds
Features
Bidder Code |
futureads |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
511 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
AdmixerID |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
644 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
id5Id, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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' |
gothamads
Features
Bidder Code |
gothamads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gothamads |
hb_bidder_gothamads |
hb_adid_gothamads |
hb_size_gothamads |
hb_source_gothamads |
hb_format_gothamads |
hb_cache_host_gotham |
hb_cache_id_gothamad |
hb_uuid_gothamads |
hb_cache_path_gotham |
hb_deal_gothamads |
|
Note
Gothamads will bid only on first impresion in bid request.
The Example Bidding adapter requires setup before beginning. Please contact us at support@gothamads.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
accountId |
required |
account id |
'hash' |
string |
GreedyGame
Features
Bidder Code |
greedygame |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_greedygame |
hb_bidder_greedygame |
hb_adid_greedygame |
hb_size_greedygame |
hb_source_greedygame |
hb_format_greedygame |
hb_cache_host_greedy |
hb_cache_id_greedyga |
hb_uuid_greedygame |
hb_cache_path_greedy |
hb_deal_greedygame |
|
Note
The GreedyGame Bidding adapter requires setup before beginning. Please contact us at arpit@greedygame.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'rtb-greedygame.com' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
TheMediaGrid
Features
Bidder Code |
grid |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
686 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_grid |
hb_bidder_grid |
hb_adid_grid |
hb_size_grid |
hb_source_grid |
hb_format_grid |
hb_cache_host_grid |
hb_cache_id_grid |
hb_uuid_grid |
hb_cache_path_grid |
hb_deal_grid |
|
Table of Contents
Bid Params
Name |
Scope |
Description |
Example |
Type |
uid |
required |
Represents the MediaGrid bidder system Ad Slot ID associated with the respective div id from the site page. |
1 |
integer |
bidFloor |
optional |
Floor of the impression opportunity. If present in the request overrides XML info. |
0.8 |
float |
Bidder Config
You can allow writing in localStorage pbjs.setBidderConfig
for the bidder grid
pbjs.setBidderConfig({
bidders: ["grid"],
config: {
localStorageWriteAllowed: true
}
})
If it will be “true” this allow TheMediaGrid Bid Adapter to write userId in first party localStorage
First Party Data
Publishers should use the ortb2
method of setting First Party Data.
Global site or user data using setConfig()
, or Bidder-specific using setBidderConfig()
supports following fields:
ortb2.user.data[]
: Standard IAB segment taxonomy user data
ortb2.user.ext.device
: Non standard arbitrary user device
ortb2.user.keywords
: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2
ortb2.site.keywords
: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2
ortb2.site.cat[]
: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array
ortb2.site.pagecat[]
: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array
ortb2.site.content.genre
: Standard IAB OpenRTB 2.5 site.content.genre field
AdUnit-specific data using AdUnit.ortb2Imp
supports following fields:
ortb2.imp[].ext.data.*
ortb2.imp[].instl
Native setup example (s2s only)
Setup native in adUnit mediaTypes, for example:
...
mediaTypes: {
native: {
ortb: {
ver: '1.2',
"assets": [
{
"id": 1,
"img": {
"hmin": 180,
"wmin": 216,
"type": 3
},
"required": 1
},
{
"title": {
"len": 140
},
"id": 2,
"required": 1
},
{
"id": 3,
"data": {
"len": 25,
"type": 1
},
"required": 1
}
],
}
}
},
...
GumGum
Features
Bidder Code |
gumgum |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
61 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
unifiedId, identityLink |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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:
{
bidder: 'gumgum',
params: {
zone: 'zone_id' // provided by GumGum
}
}
To enable ad requests at a publisher level, instead of zone
use pubId
:
{
bidder: 'gumgum',
params: {
pubId: pub_id // provided by GumGum
}
}
In-Screen
To enable ad requests for in-screen, either zone
or pubId
must be present in the params object:
{
bidder: 'gumgum',
params: {
zone: 'zone_id' // provided by GumGum
}
}
Skins
Skins ad requests require the product
parameter with the value of skins
in the params object:
{
bidder: 'gumgum',
params: {
zone: 'zone_id', // provided by GumGum
product: 'skins'
}
}
Slot
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:
{
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
minduration: 1,
maxduration: 2,
linearity: 1, // ** Change this to 2 for in-video
startdelay: 1,
placement: 1,
protocols: [1, 2]
}
}
}
Please note:
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:
{
bidder: 'gumgum',
params: {
zone: 'zone_id', // provided by GumGum
}
}
Slot
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:
{
bids: [
{
bidder: 'gumgum',
params: {
zone: 'zone_id', // provided by GumGum
product: 'skins'
}
},
]
}
Video
The video product requires nearly the same setup as with Prebid client side header bidding:
{
mediaTypes: {
video: {
context: 'instream',
mimes: ['video/mp4'],
playerSize: [640, 480],
w: 640,
h: 480,
minduration: 1,
maxduration: 2,
linearity: 1,
startdelay: 1,
placement: 1,
protocols: [1, 2]
}
},
bids: [
{
bidder: 'gumgum',
params: {
zone: 'zone_id' // zone id is provided by GumGum
}
},
]
}
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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
856 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 Huawei Bidding adapter requires setup and approval before implementation. Please contact us at developereu@huawei.com, also you can submit a ticket online.
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherid |
required |
Publisher Id |
'2001000399' |
string |
signkey |
required |
Sign Key |
'5d********82c38594f8b2bdfd9f********a398dca734932898e3********8d' |
string |
keyid |
required |
Key Id |
'2' |
string |
slotid |
required |
Slot Id |
'u42ohmaufh' |
string |
adtype |
required |
Ad Type |
'banner','native','interstitial','rewarded' |
string |
Notes:
- 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, and keyid on the platform after registration.
- You need to create your advertising creative on the platform and get the corresponding slotid and adtype.
- We require OAID (Open Advertising ID) or GAID (Google Advertising ID) in the request. OAID and GAID are non-permanent device identifiers that allow personalized ads to be served to users while protecting user data privacy. In most cases, OAID is used for HMS phones and GAID is used for GMS phones. GAID is collected by default. For OAID on HMS phones, app developers should call the AdvertisingIdClient.getAdvertisingIdInfo(mContext) method to obtain the OAID, then add the OAID to the request using the Prebid SDK as shown below.
- The auction will use the Prebid Server time zone, but this can be by developers if they send the
clientTime
targeting parameter to the HuaweiAds Adx server using the Prebid SDK. For example: TargetingParams.addUserData("clientTime", "2018-11-02 16:34:07.981+0800")
.
Obtain the OAID
// Add the OAID to user data in prebid initialization
if ( isHmsAvailable() ) {
TargetingParams.addUserData("oaid", AdvertisingIdClient.Info info = AdvertisingIdClient.getAdvertisingIdInfo(getApplicationContext()).getId());
}
//Determine the HMS availability
public static boolean isHmsAvailable(Context context) {
boolean isAvailable = false;
if (null != context) {
int result = HuaweiApiAvailability.getInstance().isHuaweiMobileServicesAvailable(context);
isAvailable = (com.huawei.hms.api.ConnectionResult.SUCCESS == result);
}
Log.i(TAG, "isHmsAvailable: " + isAvailable);
return isAvailable;
}
iion
Features
Bidder Code |
iionads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
.
iMedia Digital Services (iMDS)
Features
Bidder Code |
imds |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_imds |
hb_bidder_imds |
hb_adid_imds |
hb_size_imds |
hb_source_imds |
hb_format_imds |
hb_cache_host_imds |
hb_cache_id_imds |
hb_uuid_imds |
hb_cache_path_imds |
hb_deal_imds |
|
Note
The iMedia Digital Services bidder adapter requires setup and approval from iMedia Digital Services. Please reach out to your account manager for more information and to start using it.
Configuration
iMedia Digital Services requires that iframe
is used for user syncing.
Example configuration:
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // represents all bidders
filter: 'include'
}
}
}
});
DFP Video Creative
To use video, setup a VAST redirect
creative within Google Ad Manager with the following VAST tag URL:
If using the new imds
adapter with x8.x or later:
https://track.technoratimedia.com/openrtb/tags?ID=%%PATTERN:hb_uuid_imds%%&AUCTION_PRICE=%%PATTERN:hb_pb_imds%%
If using the legacy synacormedia
adapter with v7.x or earlier:
https://track.technoratimedia.com/openrtb/tags?ID=%%PATTERN:hb_uuid_synacormedia%%&AUCTION_PRICE=%%PATTERN:hb_pb_synacormedia%%
Bid params
Name |
Scope |
Description |
Example |
Type |
seatId |
required |
The seat ID from iMedia Digital Services. This will be the same for all ad units. |
'prebid' |
string |
tagId |
required |
The placement ID or tag ID from iMedia Digital Services. |
'demo1' |
string |
placementId |
optional |
Legacy parameter replaced by tagId |
'demo1' |
string |
bidfloor |
optional |
Legacy parameter for floor price for the request. Replaced by Price Floors Module |
0.1 |
float |
Example Ad Unit
var adUnits = [{
"code": "test-div",
"mediaTypes": {
"video": {
"pos": 1,
"playerSize": [300, 250],
"context": "instream",
"mimes": ["video/mp4"],
"protocols": [2, 3, 5, 6, 7, 8],
"playbackmethod": [2],
"skip": 0,
"minduration": 15,
"maxduration": 30,
"startdelay": 0,
"linearity": 1
}
},
"bids": [{
"bidder": "imds",
"params": {
"seatId": "prebid",
"tagId": "demo1",
"bidfloor": 0.20
}
}]
}]
Impactify
Features
Bidder Code |
impactify |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
606 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, pubCommonId, unifiedId, uid2, netId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Note : Impactify adapter needs storage access to work properly (Do not forget to set storageAllowed to true).
For Prebid.js v1.15.0 and later:
pbjs.bidderSettings = {
impactify: {
storageAllowed: true // Mandatory
}
};
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // '*' represents all bidders
filter: 'include'
}
}
}
});
For Prebid.js v1.14.0 and before:
pbjs.bidderSettings = {
impactify: {
storageAllowed: true // Mandatory
}
};
pbjs.setConfig({
userSync: {
iframeEnabled: true,
enabledBidders: ['impactify']
}});
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
253 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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 |
{ testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] } |
object |
bidFloor |
optional |
Bid floor price |
0.01 |
float |
bidFloorCur |
optional |
Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK |
'USD' |
string |
extend |
optional |
See the Extend mode section |
true |
boolean |
rendererConfig |
optional |
Configuration object for JS renderer of the RAZR creatives. Provided by Improve Digital. |
{ key1: value1 } |
object |
Configuration
Sizes
By default, the adapter sends Prebid ad unit sizes to Improve Digital’s ad server. If the ad server should only respond with creative sizes as defined for each placement in the Origin platform, turn off usePrebidSizes
adapter parameter like this:
pbjs.setConfig({
improvedigital: { usePrebidSizes: false }
});
Renderer Config
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:
- per ad unit via the
extend
bid param
- for all ad units via
setConfig()
:
pbjs.setConfig({
improvedigital: {
extend: true
}
});
Examples
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:
pbjs.addAdUnits({
code: 'banner1',
sizes: [[728, 90], [970, 250]],
bids: [
{
bidder: 'improvedigital',
params: {
placementId: 1111111,
publisherId: 1234
}
}
]
});
Example for Key-Values
pbjs.addAdUnits({
code: 'banner1',
sizes: [[600, 290]],
bids: [
{
bidder: 'improvedigital',
params: {
placementId: 1111111,
publisherId: 1234,
keyValues: {
testKey1: ["testValueA"],
testKey2: ["testValueB", "testValueC"]
}
}
}
]
});
Indicue
Features
Bidder Code |
indicue |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_indicue |
hb_bidder_indicue |
hb_adid_indicue |
hb_size_indicue |
hb_source_indicue |
hb_format_indicue |
hb_cache_host_indicu |
hb_cache_id_indicue |
hb_uuid_indicue |
hb_cache_path_indicu |
hb_deal_indicue |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
aid |
required |
The source ID from Indicue Media. |
12412 |
integer |
Description
Indicue Media header bidding adapter connects with Indicue Media demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand.
Test Parameters
var adUnits = [
// Video instream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'indicue',
params: {
aid: 472386
}
}]
},
// Video outstream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'outstream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'indicue',
params: {
aid: 472386
}
}]
},
// Video ADPOD adUnit
{
code: 'test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'adpod',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'indicue',
params: {
aid: 472386
}
}]
},
// Banner adUnit
{
code: 'test-div',
mediaTypes:{
banner:{
sizes: [[300, 250]]
}
}
bids: [{
bidder: 'indicue',
params: {
aid: 529814
}
}]
}
];
InfyTV
Features
Bidder Code |
infytv |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
333 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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
Third-party cookie syncing helps publishers leverage their audience data, enhance targeting capabilities, and drive better ad performance. InMobi third party cookie syncing improves monetization for publishers by giving them a competitive positioning in the digital advertising ecosystem.
Ids for third parties can be synced through our pixel: https://sync.inmobi.com/prebid?gdpr={GDPR}&gdpr_consent={GDPR_CONSENT}&us_privacy={US_PRIVACY}&redirect={RedirectURL}
.
The RedirectURL should contain uuid macro, which is {ID5UID}.
To opt out of InMobi ads on web inventory the user needs to visit the Opt-out page on InMobi website https://www.inmobi.com/page/opt-out/
.
Bid Params
Name |
Scope |
Description |
Example |
Type |
plc |
required |
Placement ID |
'1234' |
string |
InteractiveOffers
Features
Bidder Code |
interactiveOffers |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Bid Params
Name |
Scope |
Description |
Example |
Type |
partnerId |
required |
Partner id |
‘abc123’ |
string |
Example:
{
bidder: "interactiveOffers",
params: {
partnerId: "abc123"
}
}
intertech
Features
Bidder Code |
intertech |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_intertech |
hb_bidder_intertech |
hb_adid_intertech |
hb_size_intertech |
hb_source_intertech |
hb_format_intertech |
hb_cache_host_intert |
hb_cache_id_intertec |
hb_uuid_intertech |
hb_cache_path_intert |
hb_deal_intertech |
|
Registration
The Intertech Bidding adapter requires setup before beginning. Please contact us at prebid@intertechsrvcs.com.
Bid params
Name |
Scope |
Description |
Example |
Type |
pageId |
required |
Page ID |
123456 |
Integer |
impId |
required |
Block ID |
12 |
Integer |
Invibes
Features
Bidder Code |
invibes |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
436 |
GPP Support |
tcfeu |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are 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 |
IQX
Features
Bidder Code |
iqx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iqx |
hb_bidder_iqx |
hb_adid_iqx |
hb_size_iqx |
hb_source_iqx |
hb_format_iqx |
hb_cache_host_iqx |
hb_cache_id_iqx |
hb_uuid_iqx |
hb_cache_path_iqx |
hb_deal_iqx |
|
Prebid.js Bid params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Placement ID |
test-banner |
string |
env |
required |
Environment name |
iqx |
string |
ext |
optional |
Specific integration config |
{} |
object |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
env |
required |
Environment name |
iqx-stage |
string |
pid |
required |
unique placement ID |
aa8217e20131c095fe9dba67981040b0 |
string |
IQzone
Features
Bidder Code |
iqzone |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
|
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
Index Exchange (Prebid Server)
Features
Bidder Code |
ix |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
true |
TCF-EU Support |
yes |
IAB GVL ID |
10 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
idl, netId, fabrickId, zeotapIdPlus, uid2, TDID, id5Id, lotamePanoramaId, publinkId, hadronId, pubcid, utiq, criteoID, euid, imuid, 33acrossId, nonID, pairid |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
paapi |
Prebid Server App 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_ix |
hb_bidder_ix |
hb_adid_ix |
hb_size_ix |
hb_source_ix |
hb_format_ix |
hb_cache_host_ix |
hb_cache_id_ix |
hb_uuid_ix |
hb_cache_path_ix |
hb_deal_ix |
|
Table of contents
Introduction
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.
- In any other server-to-server OpenRTB environment, you can send OpenRTB bid requests to the Prebid Server host of your choice. For set up instructions, see Call Index from any other server-to-server OpenRTB 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.
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 |
Before you begin: Contact your Index Exchange Representative to get an endpoint and setup instructions.
If you are hosting your own Prebid Server instance, depending on whether you are using Prebid Server Go or Prebid Server Java version, complete one of the following steps:
-
If you are using the Prebid Server Go version, in the static/bidder-info/ix.yaml
file, complete the following:
- Enable the adapter by deleting the
disabled: true
entry.
-
Add the following new entry and include the regional endpoint provided to you by Index:
endpoint: "https://<ENDPOINT URL>"
-
Edit the below existing entry and include your publisher ID in the s
parameter:
userSync:
redirect:
url: "https://ssum.casalemedia.com/usermatchredir?s=<PUBLISHER ID>&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb={{.RedirectURL}}"
-
Edit the below existing entry and include your publisher ID in the s
parameter:
userSync:
redirect:
iframe: "https://ssum.casalemedia.com/usermatch?s=<PUBLISHER ID>&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb={{.RedirectURL}}"
-
If you are using Prebid Server Java version, edit the prebid-server-java
entry in the src/main/resources/bidder-config/ix.yaml
file as follows:
-
Edit the below existing entry and include the endpoint URL provided to you by Index.
adapters:
ix:
endpoint: "https://<ENDPOINT URL>"
-
Edit the below existing entry and include your publisher ID in the s
parameter:
adapters:
ix:
usersync:
redirect:
url: "https://ssum.casalemedia.com/usermatchredir?s=<PUBLISHER ID>&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb={{.RedirectURL}}"
-
Add the below entry and include your publisher ID in the s
parameter:
adapters:
ix:
usersync:
iframe:
url: "https://ssum.casalemedia.com/usermatch?s=<PUBLISHER ID>&gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb={{.RedirectURL}}"
Publisher instructions to call Index through Prebid Server
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
To call Index from a web browser using Prebid Server, you must first configure Prebid.js to call Index directly from the browser using our client-side adapter. Follow the quick start instructions provided in Prebid’s Getting Started for Developers documentation. Complete the following steps to complete the Index-specific configuration:
- Build the binary in one of the following ways:
- Download Prebid.js from the Prebid site to use the standard compiled binary that Prebid includes in the download process and select Index Exchange as an adapter.
- Build it on your own from the source code by following the instructions in Prebid.js project README. If you use this method, you will need to include several modules in your build process. See the Index modules to include in your build process section in our Prebid.js documentation on the Prebid site.
-
Define the Index-specific parameters at the bidder level which include adding ix
as the bidder and the siteId
. For Index’s bidder-specific parameters, see the Bid request parameters section below.
{
bidder: 'ix',
params: {
siteId: '9999990'
}
}
- Define your ad units in the
adUnit
object. This includes the details about the ad slots such as the media types, ad size, and ad code. For more information about this object, see Prebid’s Ad Unit Reference documentation.
-
Enable user syncing by adding the following code in the pbjs.setConfig() function. Index strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Index bid rate and bid price. Make sure to call pbjs.setConfig()
only once. This configuration is optional in Prebid, but required by Index.
pbjs.setConfig({
userSync: {
iframeEnabled: true,
filterSettings: {
iframe: {
bidders: ['ix'],
filter: 'include'
}
}
}
});
- (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the Set up First Party Data (FPD) section in our Prebid.js documentation on the Prebid site.
-
(Optional) If you want to monetize instream video, you need to enable a cache endpoint in the pbjs.setConfig() function as follows:
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
- (Optional) If you want to monetize outstream video, you can choose among the following options:
- (Optional) Configure Prebid Native with Index. For more information, see the Prebid Native section in our Prebid.js documentation on the Prebid site. Prebid Native is available from Prebid.js version 7.4.0 or higher.
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.
Note: To implement Prebid Mobile SDK, follow Prebid’s Getting Started with Prebid Mobile documentation.
To add Index as a bidder to your mobile app:
- 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 Prebid Mobile API - iOS and Prebid Mobile API - Android documentation.
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:
"imp": [{
"ext": {
"ix": {
"siteId": "9999990"
}
}
}],
Bid request parameters
For a list of the OpenRTB fields that Index supports in bid requests, see List of supported OpenRTB bid request fields for sellers. The following are the required fields for the various supported media types.
Banner
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, '9999990' , '9999991' , '9999992' |
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, '9999990' , '9999991' , '9999992' 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 ad unit 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 ad unit 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. We strongly recommend video sizes to be 256 x 256 or greater, 300 x 250 , or 320 x 180 . |
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. We strongly recommend video sizes to be 256 x 256 or greater, 300 x 250 , or 320 x 180 . |
video.playerSize |
Required |
Integer[] |
The video player size that will be passed to demand partners. |
video.playerConfig |
Optional |
Hash |
The Index-specific outstream ad unit 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. |
video.plcmt |
Required |
Integer[] |
The video’s placement type, where: - 1 = Instream - 2 = Accompanying Content - 3 = Interstitial - 4 = No Content/Standalone |
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": "9999990"
}
}
}
],
"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": "9999990"
}
}
}
],
"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
}
JANet
Features
Bidder Code |
janet |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
410 (adtelligent) |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Test Parameters
var adUnits = [
// Video instream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'janet',
params: {
aid: 472386
}
}]
},
// Video outstream adUnit
{
code: 'test-div',
mediaTypes: {
video: {
context: 'outstream',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'janet',
params: {
aid: 472386
}
}]
},
// Video ADPOD adUnit
{
code: 'test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'adpod',
playerSize: [640, 480]
}
},
bids: [{
bidder: 'janet',
params: {
aid: 472386
}
}]
},
// Banner adUnit
{
code: 'test-div',
mediaTypes:{
banner:{
sizes: [[300, 250]]
}
}
bids: [{
bidder: 'janet',
params: {
aid: 529814
}
}]
}
];
Additional Configuration
It is possible to configure requests to be split into chunks so as to have fewer bid requests in a single http request
(default value is 10).
pbjs.setBidderConfig({
config: {
janet: {
chunkSize: 1 // makes 1 http request per 1 adunit configured
}
}
});
JDPMedia
Features
Bidder Code |
jdpmedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
true |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_jdpmedia |
hb_bidder_jdpmedia |
hb_adid_jdpmedia |
hb_size_jdpmedia |
hb_source_jdpmedia |
hb_format_jdpmedia |
hb_cache_host_jdpmed |
hb_cache_id_jdpmedia |
hb_uuid_jdpmedia |
hb_cache_path_jdpmed |
hb_deal_jdpmedia |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
Jixie
Features
Bidder Code |
jixie |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
uid2, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
972 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
no |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kargo |
hb_bidder_kargo |
hb_adid_kargo |
hb_size_kargo |
hb_source_kargo |
hb_format_kargo |
hb_cache_host_kargo |
hb_cache_id_kargo |
hb_uuid_kargo |
hb_cache_path_kargo |
hb_deal_kargo |
|
Note
Kargo is an invitation-only marketplace. Please reach out to your Kargo account manager to get setup. Also, you must test on a mobile device, or emulate a mobile device by manipulating the user agent string sent to the server.
Bidder Settings
The Kargo bid adapter uses browser local storage. Since Prebid.js 7.x, the access to it must be explicitly set.
// https://docs.prebid.org/dev-docs/publisher-api-reference/bidderSettings.html
pbjs.bidderSettings = {
kargo: {
storageAllowed: true
}
}
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placementId of the ad slot. |
'_jWuc8Hks' |
string |
ORTB Blocking
Kargo supports blocking advertisers in badv
and categories in bcat
parameters.
The blocked advertisers/categories list has no length limitation, but response timeout is more likely to occur as the number of entries grow.
Blocked advertisers list (badv
) is an array of domains as strings.
Blocked categories list (bcat
) is an array of IAB categories as strings.
For example:
Globally defined ORTB Blocking
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
)};
ORTB Blocking specific only to the Kargo bidder
pbjs.setBidderConfig({
bidders: ['kargo'],
config:{
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
Kidoz
Features
Bidder Code |
kidoz |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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' |
Note
For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
Krushmedia
Features
Bidder Code |
krushmedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
794 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Banner Settings:
var adUnits = [
{
code: ‘banner-ad-unit’,
mediaTypes: {
banner: {
sizes: [[300, 100]]
}
},
bids: [{
bidder: ‘kubient’,
params: {
zoneid: “5fbb948f1e22b”,
}
}]
}
];
Video Settings:
var adUnits = [
{
code: ‘video-ad-unit’,
mediaTypes: {
video: {
playerSize: [300, 250], // required
context: ‘instream’, // required
mimes: [‘video/mp4’,’video/x-flv’], // required
protocols: [ 2, 3 ], // required, set at least 1 value in array
placement: 1, // optional, defaults to 2 when context = outstream
api: [ 1, 2 ], // optional
skip: 0, // optional
minduration: 5, // optional
maxduration: 30, // optional
playbackmethod: [1,3], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: ‘kubient’,
params: {
zoneid: “60ad1c0b35864”,
}
}]
}
];
Bid Params
Name |
Scope |
Description |
Example |
Type |
zoneid |
required |
The AdUnit or Tag specific ID |
'5fbb948f1e22b' |
string |
LemmaDigital
Features
Bidder Code |
lemmadigital |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_lemmadigital |
hb_bidder_lemmadigit |
hb_adid_lemmadigital |
hb_size_lemmadigital |
hb_source_lemmadigit |
hb_format_lemmadigit |
hb_cache_host_lemmad |
hb_cache_id_lemmadig |
hb_uuid_lemmadigital |
hb_cache_path_lemmad |
hb_deal_lemmadigital |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
pid |
required (for prebid-server) |
Lemmadigital publisher Id provided by your Lemma representative |
1 |
integer |
aid |
required (for prebid-server) |
Lemmadigital ad unit Id provided by your Lemma representative |
3768 |
integer |
pubId |
required (for prebid.js) |
Lemmadigital publisher Id provided by your Lemma representative |
1 |
integer |
adunitId |
required (for prebid.js) |
Lemmadigital ad unit Id provided by your Lemma representative |
3768 |
string |
device_type |
optional (for prebid.js) |
Device Type |
'2' |
integer |
latitude |
optional (for prebid.js) |
Latitude |
'40.712775' |
string |
longitude |
optional (for prebid.js) |
Longitude |
'-74.005973' |
string |
currency |
optional (for prebid.js) |
Currency |
'USD' |
string |
bidFloor |
optional (for prebid.js) |
Bid Floor |
1.00 |
integer |
category |
optional (for prebid.js) |
Allowed categories |
[ 'IAB1-5', 'IAB1-6' ] |
array of strings |
page_category |
optional (for prebid.js) |
Allowed page categories |
[ 'IAB1-5', 'IAB1-6' ] |
array of strings |
Description
Get access to multiple demand partners across lemmadigital AdExchange and maximize your yield with lemmadigital header bidding adapter.
lemmadigital header bidding adapter connects with lemmadigital demand sources in order to fetch bids. This adapter provides a solution for accessing Video demand and display demand.
video parameters
The Lemmadigital adapter supports video
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.protocols |
optional |
Supported video bid response protocols Values
1 : VAST 1.0
2 : VAST 2.0
3 : VAST 3.0 4 : VAST 1.0 Wrapper
5 : VAST 2.0 Wrapper
6 : VAST 3.0 Wrapper |
[5, 6] |
var videoAdUnits = [
{
code: 'test-div-video',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream'
}
},
bids: [{
bidder: 'lemmadigital',
params: {
pubId: 1, // required
adunitId: '3769' // required
latitude: 37.3230, // optional
longitude: -122.0322, // optional
device_type: 4, // optional
video: {
mimes: ['video/mp4','video/x-flv'], // required
skip: 1, // optional
minduration: 5, // optional
maxduration: 30, // optional
protocols: [ 2, 3 ], // optional
}
},
}]
}]
var bannerAdUnits = [
{
code: 'test-div-banner',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600]], // required
}
},
bids: [{
bidder: 'lemmadigital',
params: {
pubId: 1, // required
adunitId: '3769' // required
latitude: 37.3230, // optional
longitude: -122.0322, // optional
device_type: 2, // optional
},
}]
}]
Additional Configuration
Lemmadigital recommends setting UserSync by iframe for monetization.
Prebid Server Test Request
The following test request can be used to verify that Prebid Server is working properly with the lemmadigital adapter. This example includes an imp
object with a Lemma test publisher id, and ad id.
{
"id": "test-request-id",
"imp": [{
"id": "test-imp-id",
"banner": {
"format": [{
"w": 1920,
"h": 1080
}],
"w": 1920,
"h": 1080
},
"ext": {
"lemmadigital": {
"aid": 3768,
"pid": 1
}
},
"bidfloor": 0.1
}],
"device": {
"ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36"
},
"site": {
"id": "siteID",
"publisher": {
"id": "1"
}
}
}
Lifestreet
Features
Bidder Code |
lifestreet |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
67 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
.
LM KiviAds
Features
Bidder Code |
lm_kiviads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lm_kiviads |
hb_bidder_lm_kiviads |
hb_adid_lm_kiviads |
hb_size_lm_kiviads |
hb_source_lm_kiviads |
hb_format_lm_kiviads |
hb_cache_host_lm_kiv |
hb_cache_id_lm_kivia |
hb_uuid_lm_kiviads |
hb_cache_path_lm_kiv |
hb_deal_lm_kiviads |
|
Prebid.js Bid params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Placement ID |
test-banner |
string |
env |
required |
Environment name |
lm_kiviads |
string |
ext |
optional |
Specific integration config |
{} |
object |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
env |
required |
Environment name |
lm_kiviads-stage |
string |
pid |
required |
Unique placement ID |
cs230510321b516f0eb9a10e5913d3b1 |
string |
LockerDome
Features
Bidder Code |
lockerdome |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
|
Disclosure
Note: This bidder appears to only consider gdprApplies if a consent string is available. This may result in some incorrect GDPR processing, such as when the consent string is not yet available but the publisher has decided GDPR always applies. See https://github.com/prebid/Prebid.js/issues/7775
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 |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_logicad |
hb_bidder_logicad |
hb_adid_logicad |
hb_size_logicad |
hb_source_logicad |
hb_format_logicad |
hb_cache_host_logica |
hb_cache_id_logicad |
hb_uuid_logicad |
hb_cache_path_logica |
hb_deal_logicad |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
tid |
required |
Logicad for Publishers placement ID |
'PJ2P' |
string |
page |
optional |
Url of the webpage where the request is originating from |
'url' |
string |
cur |
optional |
Currency of request and response (Default: JPY ) |
'JPY' |
string |
test |
optional |
Indicates bidding for testing purposes |
true |
boolean |
Loopme
Features
Bidder Code |
loopme |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
109 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_loopme |
hb_bidder_loopme |
hb_adid_loopme |
hb_size_loopme |
hb_source_loopme |
hb_format_loopme |
hb_cache_host_loopme |
hb_cache_id_loopme |
hb_uuid_loopme |
hb_cache_path_loopme |
hb_deal_loopme |
|
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
A ID which identifies Loopme partner. |
'45qkf5s9zf' |
string |
bundleId |
optional |
A ID which identifies app/site in Loopme. |
'v5qvf9fx4f' |
string |
placementId |
optional |
A placement ID in Loopme. |
'x6fnvfd7ty' |
string |
Loyal
Features
Bidder Code |
loyal |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_loyal |
hb_bidder_loyal |
hb_adid_loyal |
hb_size_loyal |
hb_source_loyal |
hb_format_loyal |
hb_cache_host_loyal |
hb_cache_id_loyal |
hb_uuid_loyal |
hb_cache_path_loyal |
hb_deal_loyal |
|
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
Lunamedia
Features
Bidder Code |
lunamedia |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lunamedia |
hb_bidder_lunamedia |
hb_adid_lunamedia |
hb_size_lunamedia |
hb_source_lunamedia |
hb_format_lunamedia |
hb_cache_host_luname |
hb_cache_id_lunamedi |
hb_uuid_lunamedia |
hb_cache_path_luname |
hb_deal_lunamedia |
|
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
pubid |
required |
An id used to identify LunaMedia publisher. |
'd2b5502f83b65719d29ed4fa86e411ea' |
string |
placement |
optional |
A placement created on adserver. |
'cs230510321b516f0eb9a10e5913d3b1' |
string |
mabidder
Features
Bidder Code |
mabidder |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mabidder |
hb_bidder_mabidder |
hb_adid_mabidder |
hb_size_mabidder |
hb_source_mabidder |
hb_format_mabidder |
hb_cache_host_mabidd |
hb_cache_id_mabidder |
hb_uuid_mabidder |
hb_cache_path_mabidd |
hb_deal_mabidder |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
ppid |
required |
Mabidder publisher placement ID |
“1234” |
string |
Madvertise
Features
Bidder Code |
madvertise |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
153 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
/1111111/banner |
string |
lat |
optional |
Latitude |
48.866667 |
float |
long |
optional |
Longitude |
2.333333 |
float |
age |
optional |
Age |
19 |
integer |
gender |
optional |
Gender m or f |
'f' |
string |
locale |
optional |
Locale |
'fr' |
string |
floor |
optional |
Bid floor |
1.0 |
float |
Example
{
bidder: 'madvertise',
params: {
zoneId: "/4543756/prebidadaptor/madvertiseHB",
tgt:'aa=a;bb=b'
}
}
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
zoneId |
required |
The zone ID provided by Madvertise. |
'/1111111/banner' |
string |
Example
{
"id": "some-request-id",
"test": 1,
"site": {
"page": "prebid.org"
},
"imp": [
{
"id": "some-impression-id",
"banner": {
"format": [
{
"w": 320,
"h": 50
}
]
},
"ext": {
"prebid": {
"bidder": {
"madvertise": {
"zoneId": "/1111111/banner"
}
}
}
}
}
],
"tmax": 1000
}
MarkApp
Features
Bidder Code |
markapp |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_markapp |
hb_bidder_markapp |
hb_adid_markapp |
hb_size_markapp |
hb_source_markapp |
hb_format_markapp |
hb_cache_host_markap |
hb_cache_id_markapp |
hb_uuid_markapp |
hb_cache_path_markap |
hb_deal_markapp |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
Marsmedia
Features
Bidder Code |
marsmedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
776 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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
var adUnits = [
{
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
var adUnits = [
{
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], // required
context: 'instream', // required
mimes: ['video/mp4','video/x-flv'], // required
protocols: [ 2, 3 ], // required, set at least 1 value in array
placement: 1, // optional, defaults to 1 when context = instream
startdelay: 0, // optional, defaults to 0 when context = instream
api: [ 1, 2 ], // optional
skip: 0, // optional
minduration: 5, // optional
maxduration: 30, // optional
playbackmethod: [1,3], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'marsmedia',
params: {
zoneId: 9999 // required
}
}],
...
}
MediaFuse
Features
Bidder Code |
mediafuse |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 Note
This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams
function.
See prebid.js #6361 for more details.
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
}
}
}
}]
}
];
MediaGo
Features
Bidder Code |
mediago |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1020 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all (with commercial activation) |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mediago |
hb_bidder_mediago |
hb_adid_mediago |
hb_size_mediago |
hb_source_mediago |
hb_format_mediago |
hb_cache_host_mediag |
hb_cache_id_mediago |
hb_uuid_mediago |
hb_cache_path_mediag |
hb_deal_mediago |
|
Modules
SharedID: We need you to include SharedID module,which is used to get prebid user commonid.It can better differentiating users to bid on ads.
Note
The MediaGo Bidding adapter requires setup before beginning. Please contact us at ext_mediago_cm@baidu.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
token |
required |
publisher token, This parameter expects all imps to be the same |
'1e100887dd614b7f69fdd1360437' |
string |
region |
recommend |
Server region for PBS request: US for US Region, EU for EU Region, APAC for APAC Region, default is US. This parameter expects all imps to be the same. This parameter is available for PBS only. |
'US' |
string |
test |
recommend |
0(default): production env mode. 1: dev env mode and no charge.we will bid Higher frequency to make debug easier. This parameter is available for PBJS only. |
1/0 |
Number |
bidfloor |
recommend |
Sets a floor price for the bid. This parameter is available for PBJS only. |
0.05 |
float |
placementId |
recommend |
The AD placement ID |
12341234 |
string |
Media.net
Features
Bidder Code |
medianet |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
142 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
[1, 2] |
protocols |
array of integers |
Array of supported video protocols. Currently supported values are: 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 |
[1, 2] |
placement |
integer |
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/'
}
}
}]
}];
Protected Audience API (FLEDGE)
To enable PAAPI auctions follow the instructions below:
- Add the
paapiForGpt
and paapi
modules to your prebid bundle.
- Add the following configuration for the module
pbjs.que.push(function() {
pbjs.setConfig({
paapi: {
enabled: true,
bidders: ['medianet'],
defaultForSlots: 1
}
});
});
For a detailed guide to enabling PAAPI auctions follow Prebid’s documentation
on paapiForGpt
MeloZen
Features
Bidder Code |
melozen |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
check with bidder |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_melozen |
hb_bidder_melozen |
hb_adid_melozen |
hb_size_melozen |
hb_source_melozen |
hb_format_melozen |
hb_cache_host_meloze |
hb_cache_id_melozen |
hb_uuid_melozen |
hb_cache_path_meloze |
hb_deal_melozen |
|
Note
The MeloZen Bidding adapter requires setup before beginning. Please contact us at DSP@meldong.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubId |
required |
The publisher’s ID provided by MeloZen |
'386276e072' |
string |
MetaX
Features
Bidder Code |
metax |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1301 |
GPP Support |
tcfeu, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_metax |
hb_bidder_metax |
hb_adid_metax |
hb_size_metax |
hb_source_metax |
hb_format_metax |
hb_cache_host_metax |
hb_cache_id_metax |
hb_uuid_metax |
hb_cache_path_metax |
hb_deal_metax |
|
Note
The MetaX Bidding adapter requires setup before beginning. Please contact us at adops@metaxsoft.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
MetaX’s publisher ID. |
12345678 |
integer |
adunit |
required |
MetaX’s AdUnit. |
223344 |
integer |
Mgid
Features
Bidder Code |
mgid |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
358 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mgid |
hb_bidder_mgid |
hb_adid_mgid |
hb_size_mgid |
hb_source_mgid |
hb_format_mgid |
hb_cache_host_mgid |
hb_cache_id_mgid |
hb_uuid_mgid |
hb_cache_path_mgid |
hb_deal_mgid |
|
Table of Contents
Description
One of the easiest way to gain access to MGID demand sources - MGID header bidding adapter.
MGID header bidding adapter connects with MGID demand sources to fetch bids for display placements. Please reach out to your account manager or prebid@mgid.com for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
accountId |
required |
The account ID from Mgid |
'123' |
string |
placementId |
optional |
The placement ID from Mgid |
'123456' |
string |
bidFloor |
optional |
Lowest value of expected bid price |
1.1 |
float |
currency |
optional |
Currency of request and response |
'GBP' |
string |
Test Parameters
300x600 banner test
var adUnits = [{
code: 'div-prebid',
mediaTypes: {
banner: {
sizes: [[300, 600]]
}
},
// Replace this object to test a new Adapter!
bids: [{
bidder: 'mgid',
params : {
accountId : "219" //test accountId, please replace after test
}
}]
}];
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 bidders
filter: 'include'
}
}
}
});
For Prebid.js v1.14.0 and before:
pbjs.setConfig({
userSync: {
iframeEnabled: true,
enabledBidders: ['mgid']
}});
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.
MgidX
Features
Bidder Code |
mgidX |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
358 |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_mgidX |
hb_bidder_mgidX |
hb_adid_mgidX |
hb_size_mgidX |
hb_source_mgidX |
hb_format_mgidX |
hb_cache_host_mgidX |
hb_cache_id_mgidX |
hb_uuid_mgidX |
hb_cache_path_mgidX |
hb_deal_mgidX |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
optional |
Placement Id |
'0' |
'string' |
endpointId |
optional |
Endpoint Id |
'0' |
'string' |
region |
optional |
Region (for Prebid.js) |
'us-east' (default) or 'eu' |
'string' |
Note
For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
MinuteMedia
Features
Bidder Code |
minutemedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
918 |
GPP Support |
tcfeu, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_minutemedia |
hb_bidder_minutemedi |
hb_adid_minutemedia |
hb_size_minutemedia |
hb_source_minutemedi |
hb_format_minutemedi |
hb_cache_host_minute |
hb_cache_id_minuteme |
hb_uuid_minutemedia |
hb_cache_path_minute |
hb_deal_minutemedia |
|
Note
The MinuteMedia adapter requires setup and approval. Please reach out to hb@minutemedia.com to setup an MinuteMedia account.
Bid Parameters
Banner ,Video
Name |
Scope |
Type |
Description |
Example |
org |
required |
String |
MinuteMedia publisher Id provided by your MinuteMedia representative |
“1234567890abcdef12345678” |
floorPrice |
optional |
Number |
Minimum price in USD.
WARNING: Misuse of this parameter can impact revenue |
2.00 |
placementId |
optional |
String |
A unique placement identifier |
“12345678” |
testMode |
optional |
Boolean |
This activates the test mode |
false |
Example
var adUnits = [{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[728, 90]
]
}
},
bids: [{
bidder: 'minutemedia',
params: {
org: '1234567890abcdef12345678', // Required
floorPrice: 0.05, // Optional
placementId: '12345678', // Optional
testMode: false // Optional
}
}]
},
{
code: 'dfp-video-div',
sizes: [
[640, 480]
],
mediaTypes: {
video: {
playerSize: [
[640, 480]
],
context: 'instream'
}
},
bids: [{
bidder: 'minutemedia',
params: {
org: '1234567890abcdef12345678', // Required
floorPrice: 5.00, // Optional
placementId: '12345678', // Optional
testMode: false // Optional
}
}]
}
];
Configuration
MinuteMedia recommends setting UserSync by iframe for monetization.
Missena
Features
Bidder Code |
missena |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
867 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_missena |
hb_bidder_missena |
hb_adid_missena |
hb_size_missena |
hb_source_missena |
hb_format_missena |
hb_cache_host_missen |
hb_cache_id_missena |
hb_uuid_missena |
hb_cache_path_missen |
hb_deal_missena |
|
Note
The Missena Bidding adapter requires setup before beginning. Please contact us at jney@missena.com
Bid params
Name |
Scope |
Description |
Example |
Type |
apiKey |
required |
Missena’s publisher token |
'PA-34745704' |
string |
placement |
optional |
Placement Type, default: ‘sticky’ |
'sticky' |
string |
Mobfox_PB
Features
Bidder Code |
mobfoxpb |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
311 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
optional |
Placement Id will be generated on Mobfox Platform. For direct integration |
'0' |
string |
key |
optional |
Endpoint id will be generated on Mobfox Platform. For s2s integration |
'0' |
string |
Note
For the prebid server you only need to use one parameter: either TagID or key
MobileFuse
Features
Bidder Code |
mobilefuse |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
909 |
GPP Support |
tcfca, usnat, usstate_all, usp |
DSA Support |
no |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
Monetix Ads
Features
Bidder Code |
monetixads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1281 (admatic) |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_monetixads |
hb_bidder_monetixads |
hb_adid_monetixads |
hb_size_monetixads |
hb_source_monetixads |
hb_format_monetixads |
hb_cache_host_moneti |
hb_cache_id_monetixa |
hb_uuid_monetixads |
hb_cache_path_moneti |
hb_deal_monetixads |
|
Description
Monetix Ads header bidding adapter connects with Monetix Ads demand sources to fetch bids for network ID. Please reach out to your account manager or team@monetixads.com for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network ID from Monetix Ads |
12345 |
number |
host |
required |
RTB Host |
rtb.network.monetixads.com |
string |
Test Parameters
300x250 banner test
var adUnits = [{
code: 'your-slot_1-div',
mediaTypes: {
banner: { sizes: [[300, 250]] },
},
bids: [{
bidder: 'monetixads',
params: {
networkId: 12345,
host: 'rtb.network.monetixads.com'
}
}]
},{
code: 'your-slot_2-div',
mediaTypes: {
native: { ... },
},
bids: [{
bidder: 'monetixads',
params: {
networkId: 12345,
host: 'rtb.network.monetixads.com'
}
}]
},{
code: 'your-slot_3-div',
mediaTypes: {
video: { ... },
},
bids: [{
bidder: 'monetixads',
params: {
networkId: 12345,
host: 'rtb.network.monetixads.com'
}
}]
}];
UserSync example
pbjs.setConfig({
userSync: {
iframeEnabled: true,
syncEnabled: true,
syncDelay: 1,
aliasSyncEnabled: true
}
});
Motorik
Features
Bidder Code |
motorik |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_motorik |
hb_bidder_motorik |
hb_adid_motorik |
hb_size_motorik |
hb_source_motorik |
hb_format_motorik |
hb_cache_host_motori |
hb_cache_id_motorik |
hb_uuid_motorik |
hb_cache_path_motori |
hb_deal_motorik |
|
Note
The Example Bidding adapter requires setup before beginning. Please contact us at support@motorik.io.
Motorik will only respond to the first impression. Multiple ad formats in single request are not supported.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
placement id |
'a7402708185f6a0c00700fd21c4260d2' |
string |
accountId |
required |
account id |
'motorikTest' |
string |
Nativo
Features
Bidder Code |
nativo |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
263 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nativo |
hb_bidder_nativo |
hb_adid_nativo |
hb_size_nativo |
hb_source_nativo |
hb_format_nativo |
hb_cache_host_nativo |
hb_cache_id_nativo |
hb_uuid_nativo |
hb_cache_path_nativo |
hb_deal_nativo |
|
Note
The Nativo Bidder adapter requires setup before beginning. Please contact us at prebiddev@nativo.com beforehand.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
optional |
Publication placement ID value from the Nativo Platform |
13144370 |
integer |
url |
optional |
Publication url value associated with placement ID value in the Nativo Platform |
https://test-sites.internal.nativo.net/testing/prebid_adpater.html |
string |
NetAddiction
Features
Bidder Code |
netaddiction |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1281 (admatic) |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_netaddiction |
hb_bidder_netaddicti |
hb_adid_netaddiction |
hb_size_netaddiction |
hb_source_netaddicti |
hb_format_netaddicti |
hb_cache_host_netadd |
hb_cache_id_netaddic |
hb_uuid_netaddiction |
hb_cache_path_netadd |
hb_deal_netaddiction |
|
Description
NetAddiction header bidding adapter connects with NetAddiction demand sources to fetch bids for network ID. Please reach out to your account manager or publishers-support@netaddiction.it for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network ID from NetAddiction |
12345 |
number |
host |
required |
RTB Host |
netaddiction.rtb.netaddiction.tech |
string |
Test Parameters
300x250 banner test
var adUnits = [{
code: 'your-slot_1-div',
mediaTypes: {
banner: { sizes: [[300, 250]] },
},
bids: [{
bidder: 'netaddiction',
params: {
networkId: 12345,
host: 'rtb.network.netaddiction.tech'
}
}]
},{
code: 'your-slot_2-div',
mediaTypes: {
native: { ... },
},
bids: [{
bidder: 'netaddiction',
params: {
networkId: 12345,
host: 'rtb.network.netaddiction.tech'
}
}]
},{
code: 'your-slot_3-div',
mediaTypes: {
video: { ... },
},
bids: [{
bidder: 'netaddiction',
params: {
networkId: 12345,
host: 'rtb.network.netaddiction.tech'
}
}]
}];
UserSync example
pbjs.setConfig({
userSync: {
iframeEnabled: true,
syncEnabled: true,
syncDelay: 1,
aliasSyncEnabled: true
}
});
NextMillennium
Features
Bidder Code |
nextMillennium |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
dev-docs/bidders/nextMillennium.md |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are 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.
For video ad requests, we recommend that you configure the mediaTypes.video
parameters in your Ad Units (https://docs.prebid.org/dev-docs/adunit-reference.html#video).
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:
pbjs.setBidderConfig({
bidders: ['nextMillennium'],
config: {
disabledSendingStatisticData: true,
},
})
Currency
By default, the currency used for requires is USD
. But you can use any other currency in the request. To do this, you must set this currency through the Prebid.js configuration and all responses will be returned in this currency.
pbjs.setConfig({
// ...
"currency": {
"adServerCurrency": "JPY",
}
// ...
});
OpenRTB 2.5 supported parameters
The adapter for Prebid.js supports the following options:
site.pagecat
site.content.cat
site.content.language
device.sua
site.keywords
site.content.keywords
user.keywords
bcat
badv
wlang
wlangb
You can set these parameters through the Prebid.js configuration setup functions: pbjs.setConfig or pbjs.setBidderConfig.
An example of setting openrtb parameters for the entire prebid.js script.
pbjs.setConfig({
ortb2: {
site: {
pagecat: ['IAB2-11', 'IAB2-12', 'IAB2-14'],
content: {
cat: ['IAB2-11', 'IAB2-12', 'IAB2-14'],
language: 'EN'
},
}
}
});
An example of setting openrtb parameters only for the NextMillennium adapter.
pbjs.setBidderConfig({
bidders: ['bidderB'],
config: {
ortb2: {
site: {
pagecat: ['IAB2-11', 'IAB2-12', 'IAB2-14'],
content: {
cat: ['IAB2-11', 'IAB2-12', 'IAB2-14'],
language: 'EN'
},
}
}
}
});
NinthDecimal
Features
Bidder Code |
ninthdecimal |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ninthdecimal |
hb_bidder_ninthdecim |
hb_adid_ninthdecimal |
hb_size_ninthdecimal |
hb_source_ninthdecim |
hb_format_ninthdecim |
hb_cache_host_ninthd |
hb_cache_id_ninthdec |
hb_uuid_ninthdecimal |
hb_cache_path_ninthd |
hb_deal_ninthdecimal |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubid |
required |
An id used to identify NinthDecimal publisher |
‘abcd1234’ |
string |
placement |
optional |
A placement created on adserver. |
‘1111’ |
string |
Nobid
Features
Bidder Code |
nobid |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
816 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nobid |
hb_bidder_nobid |
hb_adid_nobid |
hb_size_nobid |
hb_source_nobid |
hb_format_nobid |
hb_cache_host_nobid |
hb_cache_id_nobid |
hb_uuid_nobid |
hb_cache_path_nobid |
hb_deal_nobid |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
siteId |
required |
siteId is provided by your NoBid account manager(s) |
|
integer |
placementId |
optional |
placementId is provided by your NoBid account manager(s). This parameter allows to report on a specific ad unit |
|
integer |
video |
optional |
Object containing video targeting parameters. Note that this parameter is not used in Prebid Server. See Video Object for details. |
video: { playback_method: ['auto_play_sound_off'] } |
object |
Note
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.
Test Parameters
var adUnits = [
{
code: 'test-div1',
mediaTypes: {
banner: {
sizes: [[300, 250]], // a display size
}
},
bids: [
{
bidder: "nobid",
params: {
siteId: 2,
placementId: 3
}
}
]
},{
code: 'test-div2',
mediaTypes: {
banner: {
sizes: [[320, 50]], // a mobile size
}
},
bids: [
{
bidder: "nobid",
params: {
siteId: 2
}
}
]
}
];
Video Object
Name |
Description |
Type |
skippable |
Boolean which, if true , means the user can click a button to skip the video ad. Defaults to false . |
boolean |
playback_method |
Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on" ; "auto_play_sound_off" ; "click_to_play" ; "mouseover" ; "auto_play_sound_unknown" ; "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> |
Online Media Solutions
Features
Bidder Code |
oms |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
883 |
GPP Support |
tcfeu, usnat |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
id5Id, identityLink, pubProvidedId |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_oms |
hb_bidder_oms |
hb_adid_oms |
hb_size_oms |
hb_source_oms |
hb_format_oms |
hb_cache_host_oms |
hb_cache_id_oms |
hb_uuid_oms |
hb_cache_path_oms |
hb_deal_oms |
|
Note
The bidder requires setup before usage. Please get in touch with our team at prebid@onlinemediasolutions.com to get started.
Prebid.JS Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Unique publisher ID |
12345 |
integer |
bidFloor |
optional |
The minimum bid value desired |
1.23 |
float |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Unique publisher ID |
'12345' |
string |
OneTag
Features
Bidder Code |
onetag |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
241 |
GPP Support |
some (check with bidder) |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
topics |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onetag |
hb_bidder_onetag |
hb_adid_onetag |
hb_size_onetag |
hb_source_onetag |
hb_format_onetag |
hb_cache_host_onetag |
hb_cache_id_onetag |
hb_uuid_onetag |
hb_cache_path_onetag |
hb_deal_onetag |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubId |
required |
The publisher’s ID provided by OneTag |
'386276e072' |
string |
ext |
optional |
A set of custom key-value pairs |
{ customKey: customValue } |
object |
Note that right now video support is only provided when the context is “instream” or “outstream”.
OpenWeb
Features
Bidder Code |
openweb |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
280 |
GPP Support |
tcfeu, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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 |
|
Note
The OpenWeb adapter requires setup and approval. Please reach out to monetization@openweb.com to setup an OpenWeb account.
Bid Parameters
Banner, Video
Name |
Scope |
Type |
Description |
Example |
org |
required |
String |
OpenWeb publisher Id provided by your OpenWeb representative |
“1234567890abcdef12345678” |
placementId |
required |
String |
A unique placement identifier |
“12345678” |
floorPrice |
optional |
Number |
Minimum price in USD.
WARNING: Misuse of this parameter can impact revenue |
2.00 |
testMode |
optional |
Boolean |
This activates the test mode |
false |
Example
var adUnits = [{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[728, 90]
]
}
},
bids: [{
bidder: 'openweb',
params: {
org: '1234567890abcdef12345678', // Required
placementId: '12345678', // Required
floorPrice: 0.05, // Optional
testMode: false // Optional
}
}]
},
{
code: 'dfp-video-div',
sizes: [
[640, 480]
],
mediaTypes: {
video: {
playerSize: [
[640, 480]
],
context: 'instream'
}
},
bids: [{
bidder: 'openweb',
params: {
org: '1234567890abcdef12345678', // Required
placementId: '12345678', // Required
floorPrice: 5.00, // Optional
testMode: false // Optional
}
}]
}
];
Configuration
OpenWeb recommends setting UserSync by iframe for monetization.
OpenX
Features
Bidder Code |
openx |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
69 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
admixerId, adtelligentId, amxId, britepoolId, criteo, dapId, deepintentId, dmdId, fabrickId, hadronId, id5Id, identityLink, idxId, imuId, intentIqId, kinessoId, liveIntentId, lotamePanoramaId, merkleId, mwOpenLinkId, naveggId, netId, novatiq, parrableId, pubCommonId, publinkId, quantcastId, sharedId, tapadId, uid2, unifiedId, verizonMediaId, zeotapIdPlus |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are 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.
Prebid Server Note
This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams
function.
See prebid.js #6361 for more details.
Bid Parameters
Banner
Name |
Scope |
Description |
Example |
Type |
delDomain or 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.
var adUnits = [
{
code: 'test-div',
sizes: [[728, 90]], // a display size
mediaTypes: {'banner': {}},
bids: [
{
bidder: 'openx',
params: {
unit: '539439964',
delDomain: 'se-demo-d.openx.net',
customParams: {
key1: 'v1',
key2: ['v2', 'v3']
},
}
}, {
bidder: 'openx',
params: {
unit: '539439964',
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 |
delDomain or 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.
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) |
[“video/mp4”] |
array |
protocols |
recommended |
Supported video bid response protocol values 1: VAST 1.0 2: VAST 2.0 3: VAST 3.0 4: VAST 1.0 Wrapper 5: VAST 2.0 Wrapper 6: VAST 3.0 Wrapper 7: VAST 4.0 8: VAST 4.0 Wrapper |
[2,3,5,6] |
array |
api |
recommended |
Supported API framework values: 1: VPAID 1.0 2: VPAID 2.0 3: MRAID-1 4: ORMMA 5: MRAID-2 |
[2] |
array |
linearity |
recommended |
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) |
1 |
integer |
|
|
|
|
|
var videoAdUnits = [
{
code: 'test-div-video',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream',
mimes: ['video/mp4','video/x-flv'], // required
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1,3], // optional
api: [ 1, 2 ], // optional
protocols: [ 2, 3 ], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
placement: 2, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'openx',
params: {
unit: '1611023124',
delDomain: 'PUBLISHER-d.openx.net'
}
}]
}]
Example
var adUnits = [
{
code: 'test-div',
sizes: [[728, 90]], // a display size
mediaTypes: {'banner': {}},
bids: [
{
bidder: 'openx',
params: {
unit: '539439964',
delDomain: 'se-demo-d.openx.net',
customParams: {
key1: 'v1',
key2: ['v2', 'v3']
},
}
}, {
bidder: 'openx',
params: {
unit: '539439964',
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.user
and 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]
Example:
pbjs.setConfig({
...
ortb2: {
site: {
content: {
data: [{
name: "www.dataprovider1.com",
ext: { segtax: 4 },
segment: [
{ id: "687" },
{ id: "123" }
]
}]
},
},
user: {
data: [{
name: "dataprovider.com",
ext: { segtax: 4 },
segment: [
{ id: "1" }
]
}],
}
}
...
});
Configuration
Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes.
OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the
OpenX bid rate and bid price. Be sure to call pbjs.setConfig()
only once.
pbjs.setConfig({
userSync: {
iframeEnabled: true
}
});
Additional Details
OperaAds
Features
Bidder Code |
operaads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1135 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_operaads |
hb_bidder_operaads |
hb_adid_operaads |
hb_size_operaads |
hb_source_operaads |
hb_format_operaads |
hb_cache_host_operaa |
hb_cache_id_operaads |
hb_uuid_operaads |
hb_cache_path_operaa |
hb_deal_operaads |
|
Registration
If you have any questions regarding set up, please reach out to your account manager or adtech-prebid-group@opera.com.
Bid Parameters
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement Id |
s12345678 |
string |
endpointId |
required |
Endpoint ID |
ep1234566 |
string |
publisherId |
required |
Publisher ID |
pub123456 |
string |
Opt Out Advertising
Features
Bidder Code |
optout |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
227 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_optout |
hb_bidder_optout |
hb_adid_optout |
hb_size_optout |
hb_source_optout |
hb_format_optout |
hb_cache_host_optout |
hb_cache_id_optout |
hb_uuid_optout |
hb_cache_path_optout |
hb_deal_optout |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisher |
required |
Opt Out publisher ID |
8 |
string |
adslot |
required |
Opt Out Adslot |
prebid_demo |
string |
Oraki
Features
Bidder Code |
oraki |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_oraki |
hb_bidder_oraki |
hb_adid_oraki |
hb_size_oraki |
hb_source_oraki |
hb_format_oraki |
hb_cache_host_oraki |
hb_cache_id_oraki |
hb_uuid_oraki |
hb_cache_path_oraki |
hb_deal_oraki |
|
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
Orbidder
Features
Bidder Code |
orbidder |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
559 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_orbidder |
hb_bidder_orbidder |
hb_adid_orbidder |
hb_size_orbidder |
hb_source_orbidder |
hb_format_orbidder |
hb_cache_host_orbidd |
hb_cache_id_orbidder |
hb_uuid_orbidder |
hb_cache_path_orbidd |
hb_deal_orbidder |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
accountId |
required |
Orbidder Account ID |
“someAccount” |
string |
placementId |
required |
Placement Id |
“somePlacement” |
string |
bidfloor |
optional |
Placement floor price |
1.23 |
float |
keyValues |
optional |
Custom key/value object |
{ “key”: “value” } |
object |
Outbrain
Features
Bidder Code |
outbrain |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
164 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
id5Id, identityLink |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_outbrain |
hb_bidder_outbrain |
hb_adid_outbrain |
hb_size_outbrain |
hb_source_outbrain |
hb_format_outbrain |
hb_cache_host_outbra |
hb_cache_id_outbrain |
hb_uuid_outbrain |
hb_cache_path_outbra |
hb_deal_outbrain |
|
Registration
The Outbrain Adapter requires setup before beginning. Please contact us at prebid.org@outbrain.com.
Configuration
Prebid.js
The Outbrain adapter does not work without setting the correct bidder and usersync URLs.
You will receive the URLs when contacting us.
pbjs.setConfig({
outbrain: {
bidderUrl: 'http://bidder-url.com',
usersyncUrl: 'http://usersync-url.com'
}
});
Prebid server
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.
adapters:
outbrain:
endpoint: http://bidder-url.com
syncurl: http://usersync-url.com?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb=<PREBID_SERVER_EXTERNAL_URL>%2Fsetuid%3Fbidder%3Doutbrain%26uid%3D__ZUID__
First Party Data
Publishers can use the ortb2
configuration parameter to provide First Party Data.
OpenRTB Parameters
The following table contains currently supported parameters.
Name |
Scope |
Description |
Example |
Type |
bcat |
optional |
Blocked advertiser categories using the IAB content categories |
['IAB1-1'] |
string array |
badv |
optional |
Block list of advertisers by their domains |
['example.com'] |
string array |
wlang |
optional |
Allow list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions. |
['en', 'de'] |
string array |
Example configuration:
pbjs.setConfig({
ortb2: {
bcat: ['IAB1-1'],
badv: ['example.com'],
wlang: ['en', 'de']
}
});
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisher.id |
required |
The publisher account ID |
'2706' |
string |
publisher.name |
optional |
The publisher name |
'Publisher Name' |
string |
publisher.domain |
optional |
The publisher domain |
'publisher.com' |
string |
tagid |
optional |
Identifier for specific ad placement or ad tag |
'tag-id' |
string |
bcat |
optional |
(Deprecated) |
['IAB1-1'] |
string array |
badv |
optional |
(Deprecated) |
['example.com'] |
string array |
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.
Native example
var adUnits = [
code: '/19968336/prebid_native_example_1',
mediaTypes: {
native: {
image: {
required: false,
sizes: [100, 50]
},
title: {
required: false,
len: 140
},
sponsoredBy: {
required: false
},
clickUrl: {
required: false
},
body: {
required: false
},
icon: {
required: false,
sizes: [50, 50]
}
}
},
bids: [{
bidder: 'outbrain',
params: {
publisher: {
id: '2706',
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Banner example
var adUnits = [
code: '/19968336/prebid_display_example_1',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: 'outbrain',
params: {
publisher: {
id: '2706',
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Video example
var adUnits = [
code: '/19968336/prebid_video_example_1',
mediaTypes: {
video: {
context: "outstream",
playerSize: [[640, 480]],
mimes: ['video/mp4'],
protocols: [1, 2, 3, 4, 5, 6, 7, 8],
playbackmethod: [1],
skip: 1,
api: [2],
minbitrate: 1000,
maxbitrate: 3000,
minduration: 3,
maxduration: 10,
startdelay: 2,
placement: 4,
linearity: 1
},
},
bids: [{
bidder: 'outbrain',
params: {
publisher: {
id: '2706',
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Outbrain - Old
Features
Bidder Code |
outbrain |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
164 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_outbrain |
hb_bidder_outbrain |
hb_adid_outbrain |
hb_size_outbrain |
hb_source_outbrain |
hb_format_outbrain |
hb_cache_host_outbra |
hb_cache_id_outbrain |
hb_uuid_outbrain |
hb_cache_path_outbra |
hb_deal_outbrain |
|
Registration
The Outbrain Adapter requires setup before beginning. Please contact us at prebid.org@outbrain.com.
Configuration
Prebid.js
The Outbrain adapter does not work without setting the correct bidder and usersync URLs.
You will receive the URLs when contacting us.
pbjs.setConfig({
outbrain: {
bidderUrl: 'http://bidder-url.com',
usersyncUrl: 'http://usersync-url.com'
}
});
Prebid server
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.
adapters:
outbrain:
endpoint: http://bidder-url.com
syncurl: http://usersync-url.com?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&cb=<PREBID_SERVER_EXTERNAL_URL>%2Fsetuid%3Fbidder%3Doutbrain%26uid%3D__ZUID__
First Party Data
Publishers can use the ortb2
configuration parameter to provide First Party Data.
OpenRTB Parameters
The following table contains currently supported parameters.
Name |
Scope |
Description |
Example |
Type |
bcat |
optional |
Blocked advertiser categories using the IAB content categories |
['IAB1-1'] |
string array |
badv |
optional |
Block list of advertisers by their domains |
['example.com'] |
string array |
wlang |
optional |
Allow list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions. |
['en', 'de'] |
string array |
Example configuration:
pbjs.setConfig({
ortb2: {
bcat: ['IAB1-1'],
badv: ['example.com'],
wlang: ['en', 'de']
}
});
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisher.id |
required |
The publisher account ID |
'2706' |
string |
publisher.name |
optional |
The publisher name |
'Publisher Name' |
string |
publisher.domain |
optional |
The publisher domain |
'publisher.com' |
string |
tagid |
optional |
Identifier for specific ad placement or ad tag |
'tag-id' |
string |
bcat |
optional |
(Deprecated) |
['IAB1-1'] |
string array |
badv |
optional |
(Deprecated) |
['example.com'] |
string array |
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.
Native example
var adUnits = [
code: '/19968336/prebid_native_example_1',
mediaTypes: {
native: {
image: {
required: false,
sizes: [100, 50]
},
title: {
required: false,
len: 140
},
sponsoredBy: {
required: false
},
clickUrl: {
required: false
},
body: {
required: false
},
icon: {
required: false,
sizes: [50, 50]
}
}
},
bids: [{
bidder: 'outbrain',
params: {
publisher: {
id: '2706',
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
Banner example
var adUnits = [
code: '/19968336/prebid_display_example_1',
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: 'outbrain',
params: {
publisher: {
id: '2706',
name: 'Publishers Name',
domain: 'publisher.com'
},
tagid: 'tag-id',
bcat: ['IAB1-1'],
badv: ['example.com']
}
}]
];
OwnAdX
Features
Bidder Code |
ownadx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
None |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_ownadx |
hb_bidder_ownadx |
hb_adid_ownadx |
hb_size_ownadx |
hb_source_ownadx |
hb_format_ownadx |
hb_cache_host_ownadx |
hb_cache_id_ownadx |
hb_uuid_ownadx |
hb_cache_path_ownadx |
hb_deal_ownadx |
|
Note
The OwnAdX Bidding adapter requires setup before beginning. Please contact us at support@techbravo.com.
Bid Params
Name |
Scope |
Description |
Example |
Type |
sspId |
required |
Supply side ID |
'1816w0' |
string |
seatId |
required |
Seat Id |
'4' |
string |
tokenId |
required |
Token Id |
'QjBZdHs6bhFHBT1nd1AJ' |
string |
Pangle
Features
Bidder Code |
pangle |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
yes |
Supply Chain Support |
no |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
sharedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_pangle |
hb_bidder_pangle |
hb_adid_pangle |
hb_size_pangle |
hb_source_pangle |
hb_format_pangle |
hb_cache_host_pangle |
hb_cache_id_pangle |
hb_uuid_pangle |
hb_cache_path_pangle |
hb_deal_pangle |
|
Note
The Pangle Bidding adapter requires setup before beginning. Please contact the Pangle team.
Media type support:
- Pangle Prebid.js adapter supports banner and video, native is not supported yet.
- Pangle Prebid Server adapter supports banner, video and native media types.
Bid Params
Name |
Scope |
Description |
Example |
Type |
token |
required |
Prebid.js: please fill ‘pangle’ by default. Prebid Server: access token, please contact Pangle team to get your token |
‘Pangle’ |
string |
appid |
optional |
(Required for Prebid.js) The app id on Pangle platform, please get them from the platform or contact Pangle team |
‘5123400’ |
string |
placementid |
optional |
(Required for Prebid.js) The placement id created on Pangle platform, please get them from the platform or contact Pangle team |
‘912340000’ |
string |
test |
optional |
For testing, please set it to ‘1’ so that you can test the integration. Pangle strongly recommends testing before going live. |
1 |
number |
Pangle server-side Prebid Server adapter supports banner
, video
, native
media types. But Pangle client-side Prebid.js adapter supports banner
and video
media types, doesn’t support native
.
Test Parameters
var adUnits = [
// Banner adUnit
{
code: 'test-div',
mediaTypes: {
banner: {
sizes: [[300, 250]], // a display size
}
},
bids: [
{
bidder: "pangle",
params: {
token: "aaaaa",
placementid: '1234', // string
appid: '1234' // string
}
}
]
},
// Video adUnit
{
code: 'div-1',
mediaTypes: {
video: {
context: 'outstream',
playerSize: [[300, 250]],
mimes: ['video/mp4'],
},
},
bids: [
{
bidder: 'pangle',
params: {
appid: '8149678',
placementid: '980589944',
token: '111111',
},
},
],
},
// multi format adUnit
{
code: 'div-1',
mediaTypes: {
banner: {
sizes: [[300, 250]]
},
video: {
context: 'outstream',
playerSize: [[300, 250]],
mimes: ['video/mp4'],
},
},
bids: [
{
bidder: 'pangle',
params: {
token: "Pangle",
appid: "8168169", //{YOUR_APP_ID}
placementid: "980649718", //{YOUR_PLACEMENT_ID}
test: 1 // For test ads
},
},
],
},
];
User Sync
Add the following code to enable user sync. Pangle strongly recommends enabling user syncing through iFrames. This functionality improves partners’ user match rates and increases the Pangle bid rate and bid price. Be sure to call pbjs.setConfig()
only once.
pbjs.setConfig({
userSync: {
iframeEnabled: true,
userIds: [
{
name: 'sharedId',
storage: {
name: 'sharedId', // name of the 1st party cookie
type: 'cookie',
expires: 365,
},
},
],
}
});
PGAMSSP
Features
Bidder Code |
pgamssp |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_pgamssp |
hb_bidder_pgamssp |
hb_adid_pgamssp |
hb_size_pgamssp |
hb_source_pgamssp |
hb_format_pgamssp |
hb_cache_host_pgamss |
hb_cache_id_pgamssp |
hb_uuid_pgamssp |
hb_cache_path_pgamss |
hb_deal_pgamssp |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Placement Id |
'0' |
'string' |
Pixad
Features
Bidder Code |
pixad |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1281 (admatic) |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pixad |
hb_bidder_pixad |
hb_adid_pixad |
hb_size_pixad |
hb_source_pixad |
hb_format_pixad |
hb_cache_host_pixad |
hb_cache_id_pixad |
hb_uuid_pixad |
hb_cache_path_pixad |
hb_deal_pixad |
|
Description
Pixad header bidding adapter connects with Pixad demand sources to fetch bids for network ID. Please reach out to your account manager or prebid@pixad.com.tr for more information.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required |
The network ID from Pixad |
12345 |
number |
host |
required |
RTB Host |
rtb.network.pixad.com.tr |
string |
Test Parameters
300x250 banner test
var adUnits = [{
code: 'your-slot_1-div',
mediaTypes: {
banner: { sizes: [[300, 250]] },
},
bids: [{
bidder: 'pixad',
params: {
networkId: 12345,
host: 'rtb.network.pixad.com.tr'
}
}]
},{
code: 'your-slot_2-div',
mediaTypes: {
native: { ... },
},
bids: [{
bidder: 'pixad',
params: {
networkId: 12345,
host: 'rtb.network.pixad.com.tr'
}
}]
},{
code: 'your-slot_3-div',
mediaTypes: {
video: { ... },
},
bids: [{
bidder: 'pixad',
params: {
networkId: 12345,
host: 'rtb.network.pixad.com.tr'
}
}]
}];
UserSync example
pbjs.setConfig({
userSync: {
iframeEnabled: true,
syncEnabled: true,
syncDelay: 1,
aliasSyncEnabled: true
}
});
Playdigo
Features
Bidder Code |
playdigo |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
1302 |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_playdigo |
hb_bidder_playdigo |
hb_adid_playdigo |
hb_size_playdigo |
hb_source_playdigo |
hb_format_playdigo |
hb_cache_host_playdi |
hb_cache_id_playdigo |
hb_uuid_playdigo |
hb_cache_path_playdi |
hb_deal_playdigo |
|
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
PubMatic
Features
Bidder Code |
pubmatic |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
76 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
|
Prebid Server Note
{% include dev-docs/pbjs-adapter-required-for-pbs.md %}
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 (Supported until Prebid version 7.54.4 and starting from Prebid version 8.11.0 we have option to configure this using ortb2.(device OR user)) |
'40.712775' |
string |
lon |
optional |
Longitude (Supported until Prebid version 7.54.4 and starting from Prebid version 8.11.0 we have option to configure this using ortb2.(device OR user)) |
'-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 in each adunit will be passed on inside adunit configs i.e. imp.ext), '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 bidders
filter: 'include'
}
}
}
});
Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.
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 |
1 |
video.api |
optional |
API frameworks supported Values:
1 : VPAID 1.0
2 : VPAID 2.0
3 : MRAID-1
4 : ORMMA
5 : MRAID-2 |
[1, 2] |
video.protocols |
optional |
Supported video bid response protocols Values
1 : VAST 1.0
2 : VAST 2.0
3 : VAST 3.0 4 : VAST 1.0 Wrapper
5 : VAST 2.0 Wrapper
6 : VAST 3.0 Wrapper |
[5, 6] |
video.battr |
optional |
Blocked creative attributes, See OpenRTB 2.5 specification, List 5.3 for values |
[3, 9] |
video.linearity |
optional |
Indicates if the impression is linear or nonlinear Values:
1 : Linear/In-Stream
2 : Non-Linear/Overlay. |
1 |
video.placement |
optional |
Video placement type. See OpenRTB 2.5 specification, List 5.9 for Values |
1 |
video.plcmt |
optional |
Video placement type. See OpenRTB 2.6 specification - github, For values plcmt subtypes |
1 |
video.minbitrate |
optional |
Minumim bit rate in Kbps. |
50 |
video.maxbitrate |
optional |
Maximum bit rate in Kbps. |
70 |
var videoAdUnits = [
{
code: 'test-div-video',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream',
mimes: ['video/mp4','video/x-flv'], // required
skip: 1, // optional
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1,3], // optional
api: [ 1, 2 ], // optional
protocols: [ 2, 3 ], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
placement: 2, // optional
plcmt: 1, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'pubmatic',
params: {
publisherId: '32572', // required
adSlot: '38519891@300x250' // required
}
}]
}]
var adUnits = [
{
code: 'test-div',
mediaTypes: {
native: {
image: {
required: true,
sizes: [150, 50]
},
title: {
required: true,
len: 80
},
sponsoredBy: {
required: true
},
body: {
required: true
}
}
},
bids: [{
bidder: 'pubmatic',
params: {
publisherId: '156295', // required
adSlot: 'pubmatic_test2@1x1', // required
}
}]
}];
Configuration for video
For Video ads, prebid cache needs to be enabled for PubMatic adapter.
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Prebid Server Test Request
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.
{
"imp":[
{
"id":"some-impression-id",
"banner":{
"format":[
{
"w":300,
"h":250
},
{
"w":300,
"h":600
}
]
},
"ext":{
"pubmatic":{
"publisherId": "156276",
"adSlot":"pubmatic_test"
}
}
}
]
}
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
ortb2.site.*
ortb2.user.*
AdUnit-specific data is supported using AdUnit.ortb2Imp.ext.*
PubNative
Features
Bidder Code |
pubnative |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pubnative |
hb_bidder_pubnative |
hb_adid_pubnative |
hb_size_pubnative |
hb_source_pubnative |
hb_format_pubnative |
hb_cache_host_pubnat |
hb_cache_id_pubnativ |
hb_uuid_pubnative |
hb_cache_path_pubnat |
hb_deal_pubnative |
|
Registration
Before adding PubNative as a new bidder, there are 3 prerequisites:
- As a Publisher, you need to have Prebid Mobile SDK integrated.
- You need a configured Prebid Server (either self-hosted or hosted by 3rd party).
- You need to be integrated with Ad Server SDK or internal product which communicates with Prebid Mobile SDK.
Please see documentation for more info.
Bid Params
Name |
Scope |
Description |
Example |
Type |
zone_id |
required |
The ad zone identifier |
1 |
integer |
app_auth_token |
required |
The app’s authentication token |
‘aaaabbbbcccc’ |
string |
Test Parameters
Please consult with our Account Manager for testing.
We need to confirm that your ad request is correctly received by our system.
The following test parameters can be used to verify that Prebid Server is working properly with the
Pubnative adapter.
The following json can be used to do a request to prebid server for verifying its integration with Pubnative adapter.
{
"id": "some-impression-id",
"site": {
"page": "https://good.site/url"
},
"imp": [
{
"id": "test-imp-id",
"banner": {
"format": [
{
"w": 300,
"h": 250
}
]
},
"ext": {
"pubnative": {
"zone_id": 1,
"app_auth_token": "b620e282f3c74787beedda34336a4821"
}
}
}
],
"device": {
"os": "android",
"h": 700,
"w": 375
},
"tmax": 500,
"test": 1
}
Pubrise
Features
Bidder Code |
pubrise |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_pubrise |
hb_bidder_pubrise |
hb_adid_pubrise |
hb_size_pubrise |
hb_source_pubrise |
hb_format_pubrise |
hb_cache_host_pubris |
hb_cache_id_pubrise |
hb_uuid_pubrise |
hb_cache_path_pubris |
hb_deal_pubrise |
|
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
PulsePoint
Features
Bidder Code |
pulsepoint |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
81 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_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 |
|
Prebid Server Note
{% include dev-docs/pbjs-adapter-required-for-pbs.md %}
Bid Params
Name |
Scope |
Description |
Example |
Type |
cp |
required |
Publisher Id |
12345 |
integer |
ct |
required |
Ad Tag Id |
12345 |
integer |
battr |
optional |
Blocked Creative Attributes |
[ 1, 2, 5 ] |
array of integers |
deals |
required |
Required for PMP requests. Array of OpenRTB Deal object. |
[{ id: 'DEAL_ONE', bidfloor: 1.23 }, ...] |
array of objects |
PubWise
Features
Bidder Code |
pwbid |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
842 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, pubProvidedId, sharedId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pwbid |
hb_bidder_pwbid |
hb_adid_pwbid |
hb_size_pwbid |
hb_source_pwbid |
hb_format_pwbid |
hb_cache_host_pwbid |
hb_cache_id_pwbid |
hb_uuid_pwbid |
hb_cache_path_pwbid |
hb_deal_pwbid |
|
Note
The PubWise bid adapter is now availalbe self service. Visit http://www.PubWise.io/ to get started.
Global Bid params
siteID is sufficient for bidding.
Name |
Scope |
Description |
Example |
Type |
siteId |
required |
The site ID provided by the PubWise system |
'XXXXXX' |
string |
bidFloor |
optional |
Value to pass as the bidfloor for this bid |
2.50 |
currency |
isTest |
optional |
A boolean to indicate 100% fill test placement request |
false |
boolean |
video parameters
The PubWise adapter supports video as of Prebid v7.39.0. Outstream is NOT supported currently.
Name |
Scope |
Description |
Example |
video.mimes |
required |
Video MIME types |
['video/mp4','video/x-flv'] |
video.skippable |
optional |
If ‘true’, user can skip ad |
true |
video.minduration |
optional |
Minimum ad duration in seconds |
5 |
video.maxduration |
optional |
Maximum ad duration in seconds |
30 |
video.startdelay |
optional |
Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements |
5 |
video.playbackmethod |
optional |
Defines whether inventory is user-initiated or autoplay sound on/off Values:
1 : Auto-play, sound on
2 : Auto-play, sound off
3 : Click-to-play
4 : mouse-over |
1 |
video.api |
optional |
API frameworks supported Values:
1 : VPAID 1.0
2 : VPAID 2.0
3 : MRAID-1
4 : ORMMA
5 : MRAID-2 |
[1, 2] |
video.protocols |
optional |
Supported video bid response protocols Values
1 : VAST 1.0
2 : VAST 2.0
3 : VAST 3.0 4 : VAST 1.0 Wrapper
5 : VAST 2.0 Wrapper
6 : VAST 3.0 Wrapper |
[5, 6] |
video.battr |
optional |
Blocked creative attributes, See OpenRTB 2.5 specification, List 5.3 for values |
[3, 9] |
video.linearity |
optional |
Indicates if the impression is linear or nonlinear Values:
1 : Linear/In-Stream
2 : Non-Linear/Overlay. |
1 |
video.placement |
optional |
Video placement type. See OpenRTB 2.5 specification, List 5.9 for Values |
1 |
video.minbitrate |
optional |
Minumim bit rate in Kbps. |
50 |
video.maxbitrate |
optional |
Maximum bit rate in Kbps. |
70 |
Example
Banner
var adUnits = [
{
code: "div-gpt-ad-1460505748561-0",
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: 'pwbid',
params: {
siteId: "xxxxxx",
isTest: true
}
}]
}
]
Native
var adUnits = [
{
code: 'div-gpt-ad-1460505748561-1',
sizes: [[1, 1]],
mediaTypes: {
native: {
title: {
required: true,
len: 80
},
body: {
required: true
},
image: {
required: true,
sizes: [150, 50]
},
sponsoredBy: {
required: true
},
icon: {
required: false
}
}
},
bids: [{
bidder: 'pwbid',
params: {
siteId: "xxxxxx",
isTest: true,
},
}]
}
]
Video
var videoAdUnits = [
{
code: 'div-gpt-ad-1460505748561-1',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream',
mimes: ['video/mp4','video/x-flv'], // required
skip: 1, // optional
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1,3], // optional
api: [ 1, 2 ], // optional
protocols: [ 2, 3 ], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
placement: 2, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'pwbid',
params: {
siteId: 'xxxxxx', // required
isTest: 'true' // required
}
}]
}]
QT
Features
Bidder Code |
qt |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1331 |
GPP Support |
usstate_all |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_qt |
hb_bidder_qt |
hb_adid_qt |
hb_size_qt |
hb_source_qt |
hb_format_qt |
hb_cache_host_qt |
hb_cache_id_qt |
hb_uuid_qt |
hb_cache_path_qt |
hb_deal_qt |
|
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
Quantumdex
Features
Bidder Code |
quantumdex |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_quantumdex |
hb_bidder_quantumdex |
hb_adid_quantumdex |
hb_size_quantumdex |
hb_source_quantumdex |
hb_format_quantumdex |
hb_cache_host_quantu |
hb_cache_id_quantumd |
hb_uuid_quantumdex |
hb_cache_path_quantu |
hb_deal_quantumdex |
|
Description
Quantumdex is an aliased bidder of Apacdex bid adapter. Please refer to Apacdex documentation for bid parameters and implementation guide.
Readpeak
Features
Bidder Code |
readpeak |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
290 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_readpeak |
hb_bidder_readpeak |
hb_adid_readpeak |
hb_size_readpeak |
hb_source_readpeak |
hb_format_readpeak |
hb_cache_host_readpe |
hb_cache_id_readpeak |
hb_uuid_readpeak |
hb_cache_path_readpe |
hb_deal_readpeak |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Publisher ID provided by Readpeak |
'c2aca92893d1b989' |
string |
siteId |
recommended |
Site/Media ID provided by Readpeak |
'5d1aef6a9088ced0' |
string |
bidfloor |
optional |
CPM Bid Floor |
0.5 |
float |
tagId |
optional |
Ad placement identifier |
'placement-1' |
string |
Relevant Digital
Features
Bidder Code |
relevantdigital |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
true |
TCF-EU Support |
yes |
IAB GVL ID |
1100 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_relevantdigita |
hb_bidder_relevantdi |
hb_adid_relevantdigi |
hb_size_relevantdigi |
hb_source_relevantdi |
hb_format_relevantdi |
hb_cache_host_releva |
hb_cache_id_relevant |
hb_uuid_relevantdigi |
hb_cache_path_releva |
hb_deal_relevantdigi |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placement id. |
'6204e83a077_620f9e8e4fe' |
String |
pbsHost |
required if not set in config |
Host name of the server. |
'pbs-example.relevant-digital.com' |
String |
accountId |
required if not set in config |
The account id. |
'6204e5fa70e3ad108' |
String |
useSourceBidderCode |
optional |
Set to true in order to use the bidder code of the actual server-side bidder in bid responses. You MUST also use allowAlternateBidderCodes: true in bidderSettings if you enabled this - as otherwise the bids will be rejected. |
true |
Boolean |
Config Parameters
Name |
Scope |
Description |
Example |
Type |
pbsHost |
required if not set in bid parameters |
Host name of the server. |
'pbs-example.relevant-digital.com' |
String |
accountId |
required if not set in bid parameters |
The account id. |
'6204e5fa70e3ad108' |
String |
pbsBufferMs |
optional |
How much less in milliseconds the server’s internal timeout should be compared to the normal Prebid timeout. Default is 250. To be increased in cases of frequent timeouts. |
250 |
Integer |
useSourceBidderCode |
optional |
Set to true in order to use the bidder code of the actual server-side bidder in bid responses. You MUST also use allowAlternateBidderCodes: true in bidderSettings if you enabled this - as otherwise the bids will be rejected. |
true |
Boolean |
Example setup using pbjs.setConfig()
This is the recommended method to set the global configuration parameters.
pbjs.setConfig({
relevantdigital: {
pbsHost: 'pbs-example.relevant-digital.com',
accountId: '6204e5fa70e3ad10821b84ff',
},
});
var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'relevantdigital',
params: {
placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
}
}
],
}
];
Example setup using only bid params
This method to set the global configuration parameters (like pbsHost) in params could simplify integration of a provider for some publishers. Setting different global config-parameters on different bids is not supported in general*, as the first settings found will be used and any subsequent global settings will be ignored.
* The exception is useSourceBidderCode
which can be overriden individually per ad unit.
var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'relevantdigital',
params: {
placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
pbsHost: 'pbs-example.relevant-digital.com',
accountId: '6204e5fa70e3ad10821b84ff',
}
}
],
}
];
Example setup with multiple providers
Notice: Placements below are not live test placements
pbjs.aliasBidder('relevantdigital', 'providerA');
pbjs.aliasBidder('relevantdigital', 'providerB');
pbjs.setConfig({
providerA: {
pbsHost: 'pbs-example-a.relevant-digital.com',
accountId: '620533ae7f5bbe1691bbb815',
},
providerB: {
pbsHost: 'pbs-example-b.relevant-digital.com',
accountId: '990533ae7f5bbe1691bbb815',
},
});
var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'providerA',
params: {
placementId: '610525862d7517bfd4bbb81e_620523b7d1dbed6b0fbbb817',
}
},
{
bidder: 'providerB',
params: {
placementId: '990525862d7517bfd4bbb81e_770523b7d1dbed6b0fbbb817',
}
},
],
}
];
ResetDigital
Features
Bidder Code |
resetdigital |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1162 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
check with bidder |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_resetdigital |
hb_bidder_resetdigit |
hb_adid_resetdigital |
hb_size_resetdigital |
hb_source_resetdigit |
hb_format_resetdigit |
hb_cache_host_resetd |
hb_cache_id_resetdig |
hb_uuid_resetdigital |
hb_cache_path_resetd |
hb_deal_resetdigital |
|
Note
Prebid adapter for Reset Digital requires approval and account setup, please contact us at biddersupport@resetdigital.co. Video is supported but requires a publisher supplied renderer at this time.
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubId |
required |
Publisher Account ID provided by ResetDigital |
'123pubId' |
string |
siteID |
optional |
Publisher Site ID |
'123siteId' |
string |
zoneId |
optional |
Used for extra fields |
{} |
object |
zoneId.placementId |
optional |
ID used for reporting purposes |
"<id>" |
string |
zoneId.deals |
optional |
Deal IDs comma-separated |
"deal123,deal456" |
string |
zoneId.test |
optional |
Flag to force bidder response with a creative |
1 |
integer |
forceBid |
optional |
Returns test bid |
true |
boolean |
position |
optional |
Override the Prebid.js page position. Valid values are “atf” and “btf”. |
'atf' |
string |
inventory |
optional |
This parameter allows the definition of an object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays of strings. |
{"rating":["5-star"],"prodtype":["tech","mobile"]} |
object |
visitor |
optional |
This parameter allows the definition of an object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays of strings. |
{"ucat":["new"], "search":["iphone"]} |
object |
keywords |
optional |
This can be used to influence reports for client-side display. To get video or server-side reporting, please use First Party data or the inventory/visitor parameters. |
["travel", "tourism"] |
Array<string> |
bidFloor |
optional |
Override the Prebid.js bid floor – no bids will be made under this value. |
0.50 |
float |
latLong |
optional |
Override the Prebid.js latitude and longitude for the visitor. |
[40.7608, 111.8910] |
Array<float> |
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) |
[“video/mp4”] |
array |
protocols |
required |
Supported video bid response protocol values 1: VAST 1.0 2: VAST 2.0 3: VAST 3.0 4: VAST 1.0 Wrapper 5: VAST 2.0 Wrapper 6: VAST 3.0 Wrapper 7: VAST 4.0 8: VAST 4.0 Wrapper |
[2,3,5,6] |
array |
api |
required |
Supported API framework values: 1: VPAID 1.0 2: VPAID 2.0 3: MRAID-1 4: ORMMA 5: MRAID-2 |
[2] |
array |
linearity |
required |
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 |
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 |
Code Examples
Banner Ad Unit
Define the ad units for banner ads:
var adUnits = [
{
code: 'your-div', // Replace with the actual ad unit code``
mediaTypes: {
banner: {
sizes: [[300, 250]] // Define the sizes for banner ads
}
},
bids: [
{
bidder: "resetdigital",
params: {
pubId: "your-pub-id", // Replace with your publisher ID
siteID: "your-site-id", // Replace with your site ID
endpoint: 'https://ads.resetsrv.com', // Optional: Endpoint URL for the ad server
forceBid: true, // Optional parameter to force the bid
zoneId: {
placementId: "abc123", // Optional ID used for reports
deals: "deal123,deal456", // Optional string of deal IDs, comma-separated
test: 1 // Set to 1 to force the bidder to respond with a creative
}
}
}
]
}
];
Video Ad Unit
Define the ad units for video ads
var videoAdUnits = [
{
code: 'your-div', // Replace with the actual video ad unit code
mediaTypes: {
video: {
playerSize: [640, 480] // Define the player size for video ads
}
},
bids: [
{
bidder: "resetdigital",
params: {
pubId: "your-pub-id", // (required) Replace with your publisher ID
site_id: "your-site-id", // Replace with your site ID
forceBid: true, // Optional parameter to force the bid
zoneId: { // (optional) Zone ID parameters
placementId: "<id>", // Optional ID used for reports
deals: "<deal ids>", // Optional string of deal IDs, comma-separated
test: 1 // Set to 1 to force the bidder to respond with a creative
}
}
}
]
}
];
RevContent
Features
Bidder Code |
revcontent |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
203 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_revcontent |
hb_bidder_revcontent |
hb_adid_revcontent |
hb_size_revcontent |
hb_source_revcontent |
hb_format_revcontent |
hb_cache_host_revcon |
hb_cache_id_revconte |
hb_uuid_revcontent |
hb_cache_path_revcon |
hb_deal_revcontent |
|
Note
To use RevContent bidder, you need to have an existing RevContent account. To create a new account visit https://www.RevContent.com. If you are an existing user, contact the account rep for api access and information.
For prebid server, Revcontent only uses basic OpenRTB requests, so only the endpoint will need to be customized. Your request must contain either app.name
or site.domain
to be considered valid. Revcontent will provide you with a custom endpoint that will contain your account details that you will specify in your adapater configuration, and you must manually enable the adapter. For example, your pbs.yaml would contain the following:
adapters:
revcontent:
disabled: false
endpoint: https://trends.revcontent.com/rtb?apiKey=<api key here>&userId=<account user id here>
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
apiKey |
required |
API key. |
'8a33sdfsdfdsfsdfssss544f8sdfsdfsdfd3b1c' |
string |
userId |
required |
Account User ID |
69565 |
number |
widgetId |
recommended |
Widget ID. |
599995 |
number |
domain |
recommended |
Domain Name - Default referral hostname |
'test.com' |
string |
endpoint |
optional |
Api Endpoint - Used for testing |
'trends.revcontent.com' |
string |
bidfloor |
optional |
Bid Floor |
0.1 |
float |
template |
optional |
Format of the display ad |
'<a href="{clickUrl}">{title}</a>' |
string |
RhythmOne
Features
Bidder Code |
rhythmone |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
36 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rhythmone |
hb_bidder_rhythmone |
hb_adid_rhythmone |
hb_size_rhythmone |
hb_source_rhythmone |
hb_format_rhythmone |
hb_cache_host_rhythm |
hb_cache_id_rhythmon |
hb_uuid_rhythmone |
hb_cache_path_rhythm |
hb_deal_rhythmone |
|
The rhythmone bidder is deprecated, and will be removed in a future release of Prebid.js and Prebid Server.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The ID issued by RhythmOne to the publisher |
'34887' |
string |
zone |
optional |
Optional string issued by RhythmOne to the publisher |
'1r' |
string |
path |
optional |
Optional string issued by RhythmOne to the publisher |
'mvo' |
string |
Rich Audience
Features
Bidder Code |
richaudience |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
108 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
criteo, id5Id, identityLink, liveIntentId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_richaudience |
hb_bidder_richaudien |
hb_adid_richaudience |
hb_size_richaudience |
hb_source_richaudien |
hb_format_richaudien |
hb_cache_host_richau |
hb_cache_id_richaudi |
hb_uuid_richaudience |
hb_cache_path_richau |
hb_deal_richaudience |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
The placement ID from Rich Audience. |
'ADb1f40rmi' |
string |
supplyType |
required |
Define if site or app. |
'site / app' |
string |
ifa |
optional |
Identifier For Advertisers |
'AAAAAAAAA-BBBB-CCCC-1111-222222220000234234234234234' |
string |
bidfloor |
optional |
Bid Floor |
0.80 |
float |
keywords |
optional |
A key-value applied only to the configured bid. This value is optional. Strings separated by semicolon. |
car=mercedes;car=audi; |
string |
player |
optional |
Object containing video targeting parameters. See Video Object for details. |
player: {init: 'open', end: 'close', skin: 'dark'} |
object |
Video Object
Name |
Scope |
Description |
Example |
Type |
init |
optional |
Start mode of the player open or close |
'open / close' |
string |
end |
optional |
End mode of the player open or close |
'open / close' |
string |
skin |
optional |
Choose the background color |
'dark / light' |
string |
Rise
Features
Bidder Code |
rise |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
1043 |
GPP Support |
tcfeu, usstate_all, usp |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_rise |
hb_bidder_rise |
hb_adid_rise |
hb_size_rise |
hb_source_rise |
hb_format_rise |
hb_cache_host_rise |
hb_cache_id_rise |
hb_uuid_rise |
hb_cache_path_rise |
hb_deal_rise |
|
Note
The Rise adapter requires setup and approval. Please reach out to [prebid-rise-engage@risecodes.com] to setup an Rise account.
Bid Parameters
Banner, Video
Name |
Scope |
Type |
Description |
Example |
org |
required |
String |
Rise publisher Id provided by your Rise representative |
“1234567890abcdef12345678” |
floorPrice |
optional |
Number |
Minimum price in USD.
WARNING: Misuse of this parameter can impact revenue |
2.00 |
placementId |
optional |
String |
A unique placement identifier |
“12345678” |
testMode |
optional |
Boolean |
This activates the test mode |
false |
rtbDomain |
optional |
String |
Sets the seller end point |
“www.test.com” |
is_wrapper |
private |
Boolean |
Please don’t use unless your account manager asked you to |
false |
Example
var adUnits = [{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[728, 90]
]
}
},
bids: [{
bidder: 'rise',
params: {
org: '1234567890abcdef12345678', // Required
floorPrice: 0.05, // Optional
placementId: '12345678', // Optional
testMode: false, // Optional,
rtbDomain: 'www.test.com' //Optional
}
}]
},
{
code: 'dfp-video-div',
sizes: [
[640, 480]
],
mediaTypes: {
video: {
playerSize: [
[640, 480]
],
context: 'instream'
}
},
bids: [{
bidder: 'rise',
params: {
org: '1234567890abcdef12345678', // Required
floorPrice: 5.00, // Optional
placementId: '12345678', // Optional
testMode: false, // Optional,
rtbDomain: 'www.test.com' //Optional
}
}]
}
];
Configuration
Rise recommends setting UserSync by iframe for monetization.
Versions
Prebid versions 5.0-5.3 are not supported
Banner >= 6.14.0
Roundel
Features
Bidder Code |
roundel |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
10 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
identityLink, netId, fabrickId, zeotapIdPlus |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_roundel |
hb_bidder_roundel |
hb_adid_roundel |
hb_size_roundel |
hb_source_roundel |
hb_format_roundel |
hb_cache_host_rounde |
hb_cache_id_roundel |
hb_uuid_roundel |
hb_cache_path_rounde |
hb_deal_roundel |
|
Overview
Roundel is an aliased bidder for Index Exchange and must be configured alongside the IdentityLink user ID module.
Bid Params
Bidder params for roundel follow the same structure as the Index Exchange bidder. Please reference configuration examples here.
RTBHouse
Features
Bidder Code |
rtbhouse |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
16 |
GPP Support |
check with bidder |
DSA Support |
yes |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
id5Id, identityLink, pubProvidedId |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_rtbhouse |
hb_bidder_rtbhouse |
hb_adid_rtbhouse |
hb_size_rtbhouse |
hb_source_rtbhouse |
hb_format_rtbhouse |
hb_cache_host_rtbhou |
hb_cache_id_rtbhouse |
hb_uuid_rtbhouse |
hb_cache_path_rtbhou |
hb_deal_rtbhouse |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Unique publisher ID |
'ABCDEF' |
string |
region |
required |
Assigned region |
'prebid-eu' |
string |
bidfloor |
optional |
Minimal CPM value |
0.01 |
float |
channel |
optional |
Inventory channel identifier, limited to 50 characters |
Partner 1 - News |
string |
Please note
-
Since 4.43 the bidfloor param will be ignored if a value is specified via floor module.
-
The channel param is available starting from Prebid 6.6.0. Please reach your RTBHouse representative for details on how to enable and use the channel param.
ORTB Blocking
RTB House supports blocking advertisers in badv
and categories in bcat
parameters.
The blocked advertisers/categories list has no length limitation, but response timeout is more likely to occur as the number of entries grow.
Blocked advertisers list (badv
) is an array of domains as strings.
Blocked categories list (bcat
) is an array of IAB categories as strings.
For example:
Globally defined ORTB Blocking
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
)};
ORTB Blocking specific only to rtbhouse bidder
pbjs.setBidderConfig({
bidders: ['rtbhouse'],
config:{
ortb2: {
badv: ["domain1.com", "domain2.com"],
bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
}
}
});
Setting up the Prebid Server Adapter
If you’re a Prebid Server host company looking to enable the RTB House server-side adapter, you’ll need to contact prebid@rtbhouse.com. They will guide you through the process. Do not use the default bidder config file as it will require custom partner code to be entered. It will be provided by RTB House.
Protected Audience API (PAAPI) support
There’s an option to receive demand for Protected Audience API (FLEDGE/PAAPI)
ads using RTB House bid adapter.
Prebid’s paapiForGpt
module and Google Ad Manager is currently required.
The following steps should be taken to setup Protected Audience for RTB House:
-
Reach out to your RTB House representative for setup coordination.
-
Build and enable PAAPI module as described in
paapiForGpt
module documentation.
a. Make sure to enable RTB House bidder to participate in PAAPI. If there are any other bidders to be allowed for that, add them to the bidders array:
pbjs.setConfig({
paapi: {
enabled: true,
bidders: ["rtbhouse"]
}
})
b. If you as a publisher have your own decisionLogicUrl
you may utilize it by setting up a dedicated fledgeConfig
object:
pbjs.setBidderConfig({
bidders: ["rtbhouse"],
config: {
fledgeConfig: {
seller: 'https://seller.domain',
decisionLogicUrl: 'https://seller.domain/decisionLogicFile.js',
sellerTimeout: 100
}
}
});
The decisionLogicUrl
must be in the same domain as seller
and has to respond with X-Allow-FLEDGE: true
http header.
sellerTimeout
is optional, defaults to 50 as per spec, will be clamped to 500 if greater.
Rubicon Project
Features
Bidder Code |
rubicon |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
52 |
GPP Support |
tcfeu, usnat, usstate_all, usp |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
partial |
Privacy Sandbox |
paapi, topics |
Prebid Server App Support |
yes |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rubicon |
hb_bidder_rubicon |
hb_adid_rubicon |
hb_size_rubicon |
hb_source_rubicon |
hb_format_rubicon |
hb_cache_host_rubico |
hb_cache_id_rubicon |
hb_uuid_rubicon |
hb_cache_path_rubico |
hb_deal_rubicon |
|
Registration
For both Prebid.js and Prebid Server, the Rubicon Project adapter requires setup and approval from the Magnite team, even for existing accounts. Please reach out to your account manager for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
accountId |
required |
The publisher account ID |
4934 |
integer |
siteId |
required |
A unique ID for your site |
13945 |
integer |
zoneId |
required |
A unique ID for your site’s ad placements |
23948 |
integer |
position |
optional |
Set the page position. Valid values are “atf” and “btf”. |
'atf' |
string |
userId |
optional |
Site-specific user ID may be reflected back in creatives for analysis. Note that userId needs to be the same for all slots. |
'12345abc' |
string |
floor |
optional |
Sets the global floor – no bids will be made under this value. |
0.50 |
float |
latLong |
optional |
Sets the latitude and longitude for the visitor (avail since PBJS 1.10) |
[40.7608, 111.8910] |
Array<float> |
inventory |
optional |
See below for details on First Party Data. In release 4.29 and earlier, this parameter allows the definition of an object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays of strings. |
{"rating":["5-star"], "prodtype":["tech","mobile"]} |
object |
visitor |
optional |
See below for details on First Party Data. In release 4.29 and earlier, this parameter allows the definition of an object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays of strings. |
{"ucat":["new"], "search":["iphone"]} |
object |
keywords |
optional |
See below for details on First Party Data. In release 4.29 and earlier, this can be used to influence reports for client-side display. To get video or server-side reporting, please use First Party data or the inventory/visitor parameters. |
["travel", "tourism"] |
Array<string> |
video |
required for video |
Video targeting parameters. See the video section below. |
{"language": "en"} |
object |
pchain |
optional |
deprecated option that was an early alternative to schain |
“GAM:11111-reseller1:22222” |
string |
bidonmultiformat |
optional |
By default, the Magnite exchange will bid on only one media type in this order: video, banner, native. Setting this flag to true will cause it to bid on all mediatypes. |
boolean |
true |
First Party Data
In release 4.30 and later, publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
- ortb2.site.ext.data.*
- ortb2.site.keywords
- ortb2.site.content.data[]
- ortb2.user.ext.data.*
- ortb2.user.data[]
With regards to Contextual and Audience segments, the Magnite exchange supports the IAB standard taxonomies. See the segment management user guide for more information.
Example first party data that’s available to all bidders and all adunits:
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2", // sent to Rubicon as 'keywords' available in reports for client-side display ads
ext: {
data: {
prodtype: ["tech","mobile"] // site.ext.data is sent to Rubicon as "inventory" data
}
}
},
user: {
ext: {
data: {
ucat:["new"] // user.ext.data is sent to Rubicon as "visitor" data
}
}
}
}
};
Example of first party data available only to the Rubicon Project bidder. Applies across all ad units.
pbjs.setBidderConfig({
bidders: ["rubicon"],
config: {
ortb2: {
site: {
keywords: "kw1,kw2", // sent to Rubicon as 'keywords' available in reports for client-side display ads
ext: {
data: {
prodtype: ["tech","mobile"] // site.ext.data is sent to Rubicon as "inventory" data
}
}
},
user: {
ext: {
data: {
ucat:["new"] // user.ext.data is sent to Rubicon as "visitor" data
}
}
}
}
}
};
For Prebid.js 4.29 and before, use the bidder specific AdUnit parameters noted above:
var adUnit = {
...
bids: [{
bidder: 'rubicon',
params: {
accountId: 7780, // replace account/site/zone params
siteId: 87184,
zoneId: 413290,
inventory: {
prodtype: ["tech","mobile"]
},
visitor: {
ucat:["new"]
}
}
}]
};
ORTB Blocking
Rubicon supports passing up to 50 domains in badv
for anything hitting Prebid Server, which includes these scenarios:
- client-side video
- s2sConfig
- App
- AMP
For example:
pbjs.setConfig({
ortb2: {
badv: ["domain1.com", "domain2.com"]
}
});
Video
The following video parameters are supported here so publishers may fully declare their video inventory. These apply to both instream and outstream.
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) |
[“video/mp4”] |
array |
protocols |
required |
Supported video bid response protocol values 1: VAST 1.0 2: VAST 2.0 3: VAST 3.0 4: VAST 1.0 Wrapper 5: VAST 2.0 Wrapper 6: VAST 3.0 Wrapper 7: VAST 4.0 8: VAST 4.0 Wrapper |
[2,3,5,6] |
array |
linearity |
required |
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 |
api |
optional |
Supported API framework values: 1: VPAID 1.0 2: VPAID 2.0 3: MRAID-1 4: ORMMA 5: MRAID-2 |
[2] |
array |
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 |
plcmt |
recommended |
Placement type for the impression. (See OpenRTB v2.6 Plcmt Subtypes - Video) |
1 |
integer |
bids.params.video
The following Rubicon Project-specific video parameters are supported:
Name |
Scope |
Description |
Example |
Type |
size_id |
optional |
Integer indicating the Rubicon Project video ad format ID. If not set, will be inferred from mediaTypes.video.context, placement, startDelay |
201 |
integer |
language |
recommended |
Indicates the language of the content video, in ISO 639-1/alpha2. Highly recommended for successful monetization for pre-, mid-, and post-roll video ads. Not applicable for interstitial and outstream. |
'en' |
string |
Here’s a video example for Prebid.js 2.5 or later:
var videoAdUnit = {
code: 'myVideoAdUnit',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
mimes: ['video/mp4', 'video/x-ms-wmv'] // you must review all video
protocols: [2,3,5,6], // parameters to ensure validity
api: [2], // for your player and DSPs
maxduration:30,
linearity: 1
}
},
bids: [{
bidder: 'rubicon',
params: {
accountId: 7780, // replace params
siteId: 87184,
zoneId: 413290,
video: {
language: 'en'
}
}
}]
};
This example adunit will also work in Prebid.js 2.4 and earlier, but mimes, protocols and api are not required.
We recommend discussing video demand with your Magnite account representative.
Lists of values are in the OpenRTB 2.5 documentation as referenced above.
Outstream Video
As of Prebid.js 4.37 Magnite’s Rubicon Project adapter supports outstream video in two ways: using your own renderer or using ours. See the Prebid.org Outstream documentation for more information on using your own renderer.
Outstream Renderer
The Magnite outstream renderer is a JavaScript tag that will load our outstream video player and render when it is 50% or more in view, pause when it’s more than 50% out of view, and close when the ad has completed playing.
The renderer appearance can be configured with the following parameters, all of them optional. If any parameter is missing, the default value will be used. All options are case-sensitive and unknown options will be ignored. Additional advanced options are available by calling your Magnite account representative.
pbjs.setConfig({
rubicon: {
rendererConfig: {
align: 'center', // player placement: left|center|right (default is center)
position: 'append', // position relative to ad unit: append|prepend|before|after (default is after)
closeButton: true, // display 'Close' button (default is false)
label: 'Advertisement', // custom text to display above the player (default is '-')
collapse: true // remove the player from the page after ad playback (default is true)
}
}
});
Native
Note: the client-side adapter supports native as of PBJS 7.39.
We recommend using the ORTB Native spec 1.2, but do support versions 1.0 and 1.1. Here the parameters required for each version:
Native Version |
Required Fields |
1.0 and 1.1 |
layout, adunit, assets |
1.2 |
context, plcmttype, assets, eventtrackers. privacy is a recommended field. |
Here’s an example for Prebid.js 7.39 or later:
var nativeAdUnit = {
code: 'myNativeAdUnit',
mediaTypes: {
native: {
sendTargetingKeys: false,
ortb: {
ver:"1.2",
context: 2, // required for 1.2
plcmttype: 11, // required for 1.2
privacy: 1, // recommended for 1.2
assets: [{
id: 1,
required: 1,
img: {
type: 3,
w: 150,
h: 50,
}
},{
... other assets ...
}],
eventtrackers: [{ // required for 1.2
event:1, methods:[1,2]
}]
}
},
bids: [{
bidder: 'rubicon',
params: {
accountId: 7780, // replace params
siteId: 87184,
zoneId: 413290
}
}]
};
Setting up the Prebid Server Adapter
If you’re a Prebid Server host company looking to enable the Rubicon server-side adapter, you’ll need to contact your Magnite account team. They will provide:
- a Magnite DV+ XAPI login and password that you’ll place in the PBS config
- a partner code you can use for cookie-syncing with Magnite’s service
Configuration Options
Single-Request
By default, the Rubicon Project adapter sends one request to rubiconproject.com for each AdUnit. For example, if there are 4 PBJS AdUnits defined on the page, you’ll see 4 calls out to rubiconproject.com/fastlane.json.
As of PBJS 1.12, the Rubicon Project adapter supports Single Request
mode, where all AdUnit requests are made in a single call to rubiconproject.com. To turn this feature on, call setConfig
:
pbjs.setConfig({
rubicon: {singleRequest: true}
});
Net Revenue
Bids through the Magnite Exchange are by default ‘net’. For certain use cases it is possible for publishers to define a bid as either ‘net’ or ‘gross’. In either case the Rubicon platform does not signal externally to other systems either bid state.
For Prebid, the Rubicon Project bid adapter reports the revenue type as ‘gross’ by default before 2.35 and ‘net’ by default in 2.35 and later (as the vast majority of accounts are net and all new accounts are net).
It’s important to note that what the Rubicon Prebid bid adapter reports is not directly related to the setting with the Magnite exchange. If you are a publisher who has set your Magnite exchange revenue type set to ‘gross’ and you’d like the Rubicon bid adapter to also report ‘gross’, you can change the 2.35+ default ‘net’ setting in Prebid.js with:
pbjs.setConfig({ rubicon: {netRevenue: false} });
Notes
- There can only be one siteId and zoneId in an AdUnit bid. To get bids on multiple sitesIds or zoneIds, just add more ‘rubicon’ entries in the bids array.
- PAAPI and Topics support released in PBJS 8.23
SA Lunamedia
Features
Bidder Code |
sa_lunamedia |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
998 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_sa_lunamedia |
hb_bidder_sa_lunamed |
hb_adid_sa_lunamedia |
hb_size_sa_lunamedia |
hb_source_sa_lunamed |
hb_format_sa_lunamed |
hb_cache_host_sa_lun |
hb_cache_id_sa_lunam |
hb_uuid_sa_lunamedia |
hb_cache_path_sa_lun |
hb_deal_sa_lunamedia |
|
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
key |
required |
Placement integration key |
'1234' |
string |
type |
required |
Supported values are publisher and network . |
'publisher' |
string |
Screencore
Features
Bidder Code |
screencore |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_screencore |
hb_bidder_screencore |
hb_adid_screencore |
hb_size_screencore |
hb_source_screencore |
hb_format_screencore |
hb_cache_host_screen |
hb_cache_id_screenco |
hb_uuid_screencore |
hb_cache_path_screen |
hb_deal_screencore |
|
Note
The Screencore Bidding adapter requires setup before beginning. Please contact us at connect@screencore.io.
Screencore will bid on first impression in request.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
placement id |
'hash' |
string |
accountId |
required |
account id |
'id' |
string |
Seeding Alliance
Features
Bidder Code |
seedingAlliance |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
371 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_seedingAllianc |
hb_bidder_seedingAll |
hb_adid_seedingAllia |
hb_size_seedingAllia |
hb_source_seedingAll |
hb_format_seedingAll |
hb_cache_host_seedin |
hb_cache_id_seedingA |
hb_uuid_seedingAllia |
hb_cache_path_seedin |
hb_deal_seedingAllia |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
adUnitId |
required |
ID of the Ad Unit |
8ao |
string |
accountId |
optional |
Your identifier for the account (Prebid Server only) |
12345 |
string |
url |
optional |
URL from the Page |
example.tld |
string |
Sharethrough
Features
Bidder Code |
sharethrough |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
80 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sharethrough |
hb_bidder_sharethrou |
hb_adid_sharethrough |
hb_size_sharethrough |
hb_source_sharethrou |
hb_format_sharethrou |
hb_cache_host_sharet |
hb_cache_id_sharethr |
hb_uuid_sharethrough |
hb_cache_path_sharet |
hb_deal_sharethrough |
|
Before You Begin
The Sharethrough bidder adapter requires additional setup and approval from the Sharethrough Integrations team. Please reach out to your account manager for more information to start using it.
Bid Params
Name |
Scope |
Description |
Example |
Type |
pkey |
required |
The placement key |
'DfFKxpkRGPMS7A9f71CquBgZ' |
string |
bcat |
optional |
(deprecated) Array of blocked IAB Categories |
['IAB1-2', 'IAB1-3'] |
string[] |
badv |
optional |
(deprecated) Array of blocked Advertisers by their domains |
['ford.com', 'pepsi.com'] |
string[] |
Note: Providing bcat
and badv
via Bid Params is deprecated, the First Party Data method should be preferred (see below).
When both methods are provided (i.e. when badv
and bcat
are specified both as bid params and through the first party ortb2 method), first party data values will be used and bid param values will be ignored.
Configuration
Sample banner setup:
<script>
var adUnits = [
{
code: "div-123",
ortb2Imp: {
ext: {
gpid: "/1111/homepage-leftnav#div-123",
}
},
mediaTypes: {
banner: {
sizes: [[250,250],[300,300]]
}
},
bids: [
{
bidder: "sharethrough",
params: {
pkey: "pkey1",
// you can set badv and bcat here too, but it is not recommended
// see the "ORTB Blocking" section for a preferred alternate setup for
// badv and bcat
}
}
]
}
]
pbjs.que.push(function() {
pbjs.addAdUnits(adUnits);
});
</script>
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
ortb2.site.*
ortb2.user.*
For example:
pbjs.setConfig({
ortb2: {
site: {
name: "example",
cat: ["IAB2"],
keywords: "power tools, drills",
content: {
userrating: "4"
}
},
user: {
yob: 1985,
gender: "m",
keywords: "a,b",
ext: {
data: {
registered: true,
interests: ["cars"]
}
}
}
}
});
ORTB Blocking
Sharethrough supports blocking advertiser domains (badv
) and/or IAB Categories (bcat
) via First Party Data.
For example:
pbjs.setConfig({
ortb2: {
bcat: ["IAB1", "IAB2-1"],
badv: ["domain1.com", "domain2.com"],
}
});
Additional Notes
Request and Response Attributes
- TTL is 360 for display and native, 3600 for video (in milliseconds).
- Safeframes are supported.
- Advertiser domains are available in bid responses at
meta.advertiserDomains
- Bids are returned in net - that is, the bids returned reflect the bid amount with revenue sharing already taken into account. No adjustment is necessary.
- Sharethrough is GDPR and COPPA compliant.
- Banner
- Native
- Video (instream and outstream)
Default Ad Server Key Value
Prebid Module Support
For publishers using PBJS version 5 and above, current module support includes:
- Price Floors
- Supply Chain Object
- User ID
SilverMob
Features
Bidder Code |
silvermob |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
1058 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_silvermob |
hb_bidder_silvermob |
hb_adid_silvermob |
hb_size_silvermob |
hb_source_silvermob |
hb_format_silvermob |
hb_cache_host_silver |
hb_cache_id_silvermo |
hb_uuid_silvermob |
hb_cache_path_silver |
hb_deal_silvermob |
|
Note
The SilverMob Bidding adapter requires setup before beginning. Please contact us at partners@silvermob.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
zoneid |
required |
Placement id |
'3011' |
string |
host |
required |
Data center location |
'us' |
string |
Silverpush
Features
Bidder Code |
silverpush |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_silverpush |
hb_bidder_silverpush |
hb_adid_silverpush |
hb_size_silverpush |
hb_source_silverpush |
hb_format_silverpush |
hb_cache_host_silver |
hb_cache_id_silverpu |
hb_uuid_silverpush |
hb_cache_path_silver |
hb_deal_silverpush |
|
Registration
The Silverpush Bidding adapter requires setup before beginning. Please contact us at prebid@silverpush.co.
Bid Parameters
Banner
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Publisher id provided by silverpush |
“123456” |
String |
bidFloor |
optional |
Minimum price in USD. bidFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50.
|
1.50 |
Number |
The following banner parameters are supported here so publishers may fully declare their banner inventory:
Name |
Scope |
Description |
Example |
Type |
sizes |
required |
Avalaible sizes supported for banner ad unit |
[ [300, 250], [300, 600] ] |
[[Integer, Integer], [Integer, Integer]] |
const adUnits = [{
code: 'div-1',
mediaTypes: {
banner: {
sizes: [ [300, 250], [300,600] ]
}
},
bids: [{
bidder: 'silverpush',
params: {
publisherId: "123456",
bidFloor: 1.2
}
}]
}];
Video
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Publisher id provided by silverpush |
“123456” |
String |
bidFloor |
optional |
Minimum price in USD. bidFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50. |
1.50 |
Number |
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 |
Avalaible sizes supported for video ad unit. |
[300, 250] |
[Integer, Integer] |
mimes |
required |
List of content MIME types supported by the player. |
[“video/mp4”] |
[String] |
protocols |
required |
Supported video bid response protocol values. |
[2,3,5,6] |
[integers] |
api |
required |
Supported API framework values. |
[2] |
[integers] |
maxduration |
required |
Maximum video ad duration in seconds. |
30 |
Integer |
minduration |
required |
Minimum video ad duration in seconds. |
6 |
Integer |
startdelay |
required |
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. |
0 |
Integer |
placement |
required |
Placement type for the impression. |
1 |
Integer |
minbitrate |
optional |
Minimum bit rate in Kbps. |
300 |
Integer |
maxbitrate |
optional |
Maximum bit rate in Kbps. |
9600 |
Integer |
playbackmethod |
optional |
Playback methods that may be in use. Only one method is typically used in practice. |
[2] |
[Integers] |
linearity |
optional |
OpenRTB2 linearity. in-strea,overlay… |
1 |
Integer |
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. |
5 |
Integer |
delivery |
optional |
OpenRTB2 delivery. Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. |
1 |
[Integer] |
var videoAdUnits = [{
code: 'video-1',
mediaTypes: {
video: {
api: [1, 2, 4, 6],
mimes: ['video/mp4'],
context: 'instream', // or 'outstream'
playerSize: [ 640, 480 ],
protocols: [4,5,6,7],
placement: 1,
minduration: 0,
maxduration: 60,
startdelay: 0
}
},
bids: [
{
bidder: 'silverpush',
params: {
publisherId: "123456",
bidfloor: 2.5
}
}
]
}]
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
Prebid Server
pbjs.setConfig({
s2sConfig : {
accountId:"someaccountId" // replace with accountId
bidders : ['silverpush'],
timeout : 1000, //default value is 1000
adapter : 'prebidServer', //if we have any other s2s adapter, default value is s2s
},
ortb2: {
user: {
ext: {
data: {
eids: [{
source: "pubcid.org",
uids:[
{
id:"01EAJWWNEPN3CYMM5N8M5VXY22",
atype:1
}
]
}]}
}
}
}
});
Additional Details
For any queries, reach us at prebid@silverpush.co.
Smaato
Features
Bidder Code |
smaato |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
82 |
GPP Support |
some (check with bidder) |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_smaato |
hb_bidder_smaato |
hb_adid_smaato |
hb_size_smaato |
hb_source_smaato |
hb_format_smaato |
hb_cache_host_smaato |
hb_cache_id_smaato |
hb_uuid_smaato |
hb_cache_path_smaato |
hb_deal_smaato |
|
Table of Contents
Registration
The Smaato adapter requires setup and approval from the Smaato team, even for existing Smaato publishers. Please reach out to your account team or prebid@smaato.com for more information.
Note
The Smaato adapter will convert bidfloors to ‘USD’ currency as needed.
Bid Params
Name |
Scope |
Description |
Example |
Type |
publisherId |
required |
Your Smaato publisher id |
'1100012345' |
string |
adspaceId |
required |
Your Smaato adspace id. Required for non adpod requests |
'11002234' |
string |
adbreakId |
required |
Your Smaato adbreak id. Required for adpod (long-form video) requests |
'41002234' |
string |
app |
optional |
Object containing mobile app parameters. See the App Object for details. |
app : { ifa: '56700000-9cf0-22bd-b23e-46b96e40003a'} |
object |
Note
In case of AdPods, the Smaato adapter will only read the first imp[].skadn
entry for each AdPod, such that there should only be one skadn
occurrence per AdPod.
App Object
Smaato supports using prebid within a mobile app’s webview.
Name |
Description |
Example |
Type |
ifa |
String that contains the advertising identifier of the user (e.g. idfa or aaid). |
'56700000-9cf0-22bd-b23e-46b96e40003a' |
string |
geo |
Object that contains the latitude (lat ) and longitude (lon ) of the user. |
{ lat: 33.3, lon: -88.8 } |
object |
Example Ad Units
Example Banner Ad Unit
var adUnit = {
"code": "banner unit",
"mediaTypes": {
"banner": {
"sizes": [320, 50]
}
},
"bids": [{
"bidder": "smaato",
"params": {
"publisherId": "1100012345",
"adspaceId": "11002234"
}
}]
}
Example Video Ad Unit
var adUnit = {
"code": "video unit",
"mediaTypes": {
"video": {
"context": "instream",
"playerSize": [640, 480],
"mimes": ["video/mp4"],
"minduration": 5,
"maxduration": 30,
"startdelay": 0,
"linearity": 1,
"protocols": [7],
"skip": 1,
"skipmin": 5,
"api": [7],
"ext": {"rewarded": 0}
}
},
"bids": [{
"bidder": "smaato",
"params": {
"publisherId": "1100012345",
"adspaceId": "11002234"
}
}]
};
Example Native Ad Unit
var adUnit = {
"code": "native unit",
"mediaTypes": {
native: {
sendTargetingKeys: false,
image: {
required: true,
sizes: [150, 50]
},
icon: {
required: true,
sizes: [50, 50]
},
title: {
required: true,
len: 80
},
sponsoredBy: {
required: true
},
body: {
required: true
},
cta: {
required: false
},
rating: {
required: false
}
}
},
"bids": [{
"bidder": "smaato",
"params": {
"publisherId": "1100012345",
"adspaceId": "11002234"
}
}]
};
var adUnit = {
"code": "adpod unit",
"mediaTypes": {
"video": {
"context": "adpod",
"playerSize": [640, 480],
"adPodDurationSec": 300,
"durationRangeSec": [15, 30],
"requireExactDuration": false,
"mimes": ["video/mp4"],
"startdelay": 0,
"linearity": 1,
"protocols": [7],
"skip": 1,
"skipmin": 5,
"api": [7],
}
},
"bids": [{
"bidder": "smaato",
"params": {
"publisherId": "1100042525",
"adbreakId": "400000000"
}
}]
};
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
- ortb2.site.keywords
- ortb2.site.content
- ortb2.user.keywords
- ortb2.user.yob
- ortb2.user.gender
- ortb2.user.ext.eids
- ortb2.device.geo
- ortb2.device.ifa
The IAB standard taxonomies are not supported.
Example first party data that’s available to all bidders and all adunits:
pbjs.setConfig({
ortb2: {
site: {
keywords: "kw1,kw2",
content: {
title: "title1",
series: "series1"
}
},
user: {
keywords: "a,b",
gender: "M",
yob: 1984
},
device: {
ifa: "identifier",
geo: {
lat: 53.5488,
lon: 9.9872
}
}
}
});
Test Parameters
Following example includes sample imp
object with publisherId and adSlot which can be used to test Smaato Adapter
"imp":[
{
"id":"1C86242D-9535-47D6-9576-7B1FE87F282C",
"banner":{
"format":[
{
"w":300,
"h":50
},
{
"w":300,
"h":250
}
]
},
"ext":{
"smaato":{
"publisherId":"1100042525",
"adspaceId":"130563103"
}
}
}
]
Smart AdServer
Features
Bidder Code |
smartadserver |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
45 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartadserver |
hb_bidder_smartadser |
hb_adid_smartadserve |
hb_size_smartadserve |
hb_source_smartadser |
hb_format_smartadser |
hb_cache_host_smarta |
hb_cache_id_smartads |
hb_uuid_smartadserve |
hb_cache_path_smarta |
hb_deal_smartadserve |
|
Registration
The Smart AdServer bidder adapter requires setup and approval from the Equativ (former Smart AdServer) service team. Please reach out to your account manager for more information and start using it.
Bid params
Name |
Scope |
Description |
Example |
Type |
networkId |
required for Prebid Server |
The network identifier you have been provided with |
1234 |
integer |
siteId |
required for Prebid.js |
The placement site ID |
1234 |
integer |
pageId |
required for Prebid.js |
The placement page ID |
1234 |
integer |
formatId |
required for Prebid.js |
The placement format ID |
1234 |
integer |
domain |
optional |
The network domain (default see example) |
'http://prg.smartadserver.com', 'https://prg.smartadserver.com' |
string |
target |
optional |
The keyword targeting |
'sport=tennis' |
string |
bidfloor |
optional |
Bid floor for this placement in USD or in the currency specified by the currency parameter. (Default: 0.0 ) |
0.42 |
float |
appName |
optional |
Mobile application name |
'Smart AdServer Preview' |
string |
buId |
optional |
Mobile application bundle ID |
'com.smartadserver.android.dashboard' |
string |
ckId |
optional |
Unique Smart AdServer user ID |
1234567890123456789 |
integer |
video |
optional |
Parameter object for instream video. See video Object |
{} |
object |
schain |
optional |
Supply Chain |
'1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com' |
string |
Note: The site, page and format identifiers have to all be provided (for Prebid.js) or all empty (for Prebid Server).
Video Object
Name |
Scope |
Description |
Example |
Type |
protocol |
optional |
Maximum open RTB video protocol supported |
8 (VAST 4.0 wrapper) |
integer |
startDelay |
optional |
Allowed values: 1 (generic pre-roll, default), 2 (generic mid-roll), 3 (generic post-roll) |
1 |
integer |
Type |
Support |
banner |
Supported |
video |
Supported |
native |
Not currently supported |
Type |
Support |
banner |
Supported |
video |
Supported |
native |
Supported |
Examples
Without site/page/format:
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 600,
"h": 500
}, {
"w": 300,
"h": 600
}]
},
"ext": {
"smartadserver": {
"networkId": 73
}
}
}]
With site/page/format:
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 600,
"h": 500
}, {
"w": 300,
"h": 600
}]
},
"ext": {
"smartadserver": {
"networkId": 73
"siteId": 1,
"pageId": 2,
"formatId": 3
}
}
}]
SmartHub
Features
Bidder Code |
smarthub |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_smarthub |
hb_bidder_smarthub |
hb_adid_smarthub |
hb_size_smarthub |
hb_source_smarthub |
hb_format_smarthub |
hb_cache_host_smarth |
hb_cache_id_smarthub |
hb_uuid_smarthub |
hb_cache_path_smarth |
hb_deal_smarthub |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
partnerName |
required |
Unique partner name |
'partnertest' |
string |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
partnerName |
required |
Unique partner name |
'partnertest' |
string |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
smartx
Features
Bidder Code |
smartx |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
115 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
no |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartx |
hb_bidder_smartx |
hb_adid_smartx |
hb_size_smartx |
hb_source_smartx |
hb_format_smartx |
hb_cache_host_smartx |
hb_cache_id_smartx |
hb_uuid_smartx |
hb_cache_path_smartx |
hb_deal_smartx |
|
Registration
This adapter requires setup and approval from the smartclip team. Please contact us at — bidding@smartclip.tv
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
tagId |
required |
A unique ID. |
'Nu68JuOWAvrbzoyrOR9a7A' |
string |
publisherId |
required |
A unique PublisherID. Is provided by smartclip |
'publisher_Id' |
string |
siteId |
required |
A unique SiteID or AppID. Is provided by smartclip |
'site_id' |
string |
secure |
optional |
Boolean identifying whether the requests should be https or not (used to override the protocol if the page isn’t secure). |
true |
boolean |
mimes |
optional |
List of MIME types to allow in ad. |
['application/javascript', 'video/mp4', 'video/webm'] |
array |
price_floor |
optional |
Set the current channel price floor in real time. |
10 |
integer |
min_duration |
optional |
Minimum video ad duration in seconds |
15 |
integer |
max_duration |
optional |
Maximum video ad duration in seconds |
60 |
integer |
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
tagId |
required |
A unique ID. |
'Nu68JuOWAvrbzoyrOR9a7A' |
string |
publisherId |
required |
A unique PublisherID. Is provided by smartclip |
'publisher_Id' |
string |
siteId |
required |
A unique SiteID or AppID. Is provided by smartclip |
'site_id' |
string |
bidfloor |
required |
Value of Bidfloor. |
0.3 |
float |
bidfloorcur |
required |
Used Currency. (e.g. EUR, USD etc.) |
'EUR' |
string |
context |
optional |
Token that describes which context to play: ‘instream’ or ‘outstream’ |
'outstream' |
string |
secure |
optional |
Boolean identifying whether the requests should be https or not (used to override the protocol if the page isn’t secure). |
true |
boolean |
mimes |
optional |
List of MIME types to allow in ad. |
['application/javascript', 'video/mp4', 'video/webm'] |
array |
price_floor |
optional |
Set the current channel price floor in real time. |
10 |
integer |
min_duration |
optional |
Minimum video ad duration in seconds |
15 |
integer |
max_duration |
optional |
Maximum video ad duration in seconds |
60 |
integer |
sitekey |
optional |
Sitekey provided by smartclip. |
'foo.bar.baz' |
string |
outstream_options |
required |
Object to set options on the smartx renderer, see below. Only required when setting mediaType.video.context = ‘outstream’. |
{} |
object |
outstream_options
Name |
Scope |
Description |
Example |
Type |
slot |
required |
ID of element that video ad should be rendered into. |
'adSlot1' |
string |
minAdWidth |
optional |
If the visible area is narrower than this size, no ad will be requested. The value is given in pixels. Default is 280 . |
290 |
integer |
maxAdWidth |
optional |
The player will fill the whole width of the element it gets, to have it narrower a different maximum width can be defined in pixels. Default is 800 . |
900 |
integer |
title |
optional |
The player can show a freely definable text, a macro [remainingTime] in this string will be replaced with the remaining play time of the ad in seconds. |
'Advertisement [remainingTime]s' |
string |
skipOffset |
optional |
In order to enable skipping from the start set the delay to 0 , to show the skip button after 5 seconds set it to 5 . Setting a general skipOffset is discouraged. Note that linear creatives carrying a skipsoffet attribute will override the general player setting. By default the player does not set a general skipoffset, so a skip button will only be shown, if an ad has a specific skipoffset attached. |
0 |
integer |
startOpen |
optional |
Per default the player will start fully expanded, if a valid ad can be played. Setting this option to false will trigger an expand animation instead once the player comes into view. Default is true . |
'false' |
string |
endingScreen |
optional |
By default the player will not close, but show the ending screen when an advertisement is complete (last frame of the ad and a replay button, if an advertisment comes with an endcard that will be shown). If set to false the player will collapse. Some VPAID creatives can cause issues with ending screen or replay behaviour. Default is true . |
'true' |
string |
desiredBitrate |
optional |
You can specify a target bitrate for the creative, higher values will increase video quality but will cost bandwidth. Value is given in kpbs. Default is 700 . |
800 |
integer |
visibilityThreshold |
optional |
Defines the percentage of the player which has to be in the visible area to play and pause the advertisment. The default is 50 . |
50 |
integer |
SmartyAds
Features
Bidder Code |
smartyads |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
534 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartyads |
hb_bidder_smartyads |
hb_adid_smartyads |
hb_size_smartyads |
hb_source_smartyads |
hb_format_smartyads |
hb_cache_host_smarty |
hb_cache_id_smartyad |
hb_uuid_smartyads |
hb_cache_path_smarty |
hb_deal_smartyads |
|
Note
The Example Bidding adapter requires setup before beginning. Please contact us at sales@smartyads.com
Prebid.JS Bid Params
Name |
Scope |
Description |
Example |
Type |
sourceid |
required |
placement ID |
'0' |
string |
host |
required |
const value, set to “prebid” |
'prebid' |
string |
accountid |
optional |
publisher ID |
'1901' |
string |
traffic |
optional |
Configures the mediaType that should be used. Values can be 'banner' , 'native' or 'video' |
'banner' |
string |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Region id |
'ns1' |
string |
sourceid |
required |
Partner id |
'smartyads' |
string |
accountid |
required |
Endpoint id |
'hash' |
string |
Smile Wanted
Features
Bidder Code |
smilewanted |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
639 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smilewanted |
hb_bidder_smilewante |
hb_adid_smilewanted |
hb_size_smilewanted |
hb_source_smilewante |
hb_format_smilewante |
hb_cache_host_smilew |
hb_cache_id_smilewan |
hb_uuid_smilewanted |
hb_cache_path_smilew |
hb_deal_smilewanted |
|
Disclosure
Note: This bidder appears to only consider gdprApplies if a consent string is available.. This may result in some incorrect TCF2 processing, such as when the consent string is not yet available but the publisher has decided GDPR always applies. See https://github.com/prebid/Prebid.js/issues/7775
Note
To use us as a bidder you must have an account and an active “zoneId” on our Smile Wanted platform.
Bid params
Name |
Scope |
Description |
Example |
Type |
zoneId |
required |
The placement zone ID |
'test.com_header_bidding_display_atf' |
string |
Testing
You can add #sw_test_campaign
to the end of any URL. This will have the effect of responding with a Smile Wanted creative with a high CPM, which means you’ll win every auction so you can see if the ad displays correctly.
(Please note that impressions and revenues of this test ad will not be recorded and not be paid.)
User Sync
Add the following code to enable user sync. Smile Wanted strongly recommends enabling user syncing through iFrames. This functionality improves partners’ user match rates and increases the Smile Wanted bid rate and bid price. Be sure to call pbjs.setConfig()
only once.
pbjs.setConfig({
userSync: {
iframeEnabled: true,
filterSettings: {
iframe: {
bidders: '*', // '*' means all bidders
filter: 'include'
}
}
}
});
Smrtconnect
Features
Bidder Code |
smrtconnect |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
none |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_smrtconnect |
hb_bidder_smrtconnec |
hb_adid_smrtconnect |
hb_size_smrtconnect |
hb_source_smrtconnec |
hb_format_smrtconnec |
hb_cache_host_smrtco |
hb_cache_id_smrtconn |
hb_uuid_smrtconnect |
hb_cache_path_smrtco |
hb_deal_smrtconnect |
|
Note
Bidding adapter requires setup before beginning.
Please contact us at prebid@smrtconnect.com
Bid Params
Name |
Scope |
Description |
Example |
Type |
supply_id |
required |
Supply Id |
'1' |
string |
Sonobi
Features
Bidder Code |
sonobi |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
104 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId, lotamePanoramaID |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_sonobi |
hb_bidder_sonobi |
hb_adid_sonobi |
hb_size_sonobi |
hb_source_sonobi |
hb_format_sonobi |
hb_cache_host_sonobi |
hb_cache_id_sonobi |
hb_uuid_sonobi |
hb_cache_path_sonobi |
hb_deal_sonobi |
|
Note
The Sonobi Bidder adapter requires setup and approval from your Sonobi Account Manager. If you require assistance
implementing our adapter please don’t hesitate to contact us at apex.prebid@sonobi.com.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placement_id |
required* |
The placement ID |
'1a2b3c4d5e6f1a2b3c4d' |
string |
ad_unit |
required* |
The adunit ID |
'/1234567/example/adUnit/code' |
string |
floor |
optional |
Bid floor for this placement in USD |
0.50 |
float |
sizes |
optional |
Adunit sizes that will override global sizes |
[[300, 250], [300, 600]] |
Array<Array> |
hfa |
optional |
Publisher Unique Identifier |
'123985' |
string |
referrer |
optional |
Overrides the default value for the ref param in a bid request |
'prebid.org' |
string |
keywords |
optional |
Comma separated list of keywords about the site |
'sports,news,food' |
string |
bid_request_url |
optional |
String representing the url the Sonobi adapter should make to request bids |
'https://iad-2-apex.go.sonobi.com/trinity.json' |
string |
Configuration
Youmust* only include one ID field - either placement_id
or ad_unit
, not both. If you have questions on which parameter to use, please reach out to your Account Manager.
The ad_unit
and placement_id
are mutually exclusive but at least one is required. If you pass both, ad_unit
takes precedence.
If you pass the optional sizes
Array in your bid params it will override the global config sizes for the Sonobi Adapter only.
The hfa
parameter requires your Sonobi Account Manager to enable this feature for you. Please contact them for further information.
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
TagID |
required |
The placement ID or The adunit ID |
'1a2b3c4d5e6f1a2b3c4d' or '/1234567/example/adUnit/code' |
string |
Sovrn
Features
Bidder Code |
sovrn |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
13 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sovrn |
hb_bidder_sovrn |
hb_adid_sovrn |
hb_size_sovrn |
hb_source_sovrn |
hb_format_sovrn |
hb_cache_host_sovrn |
hb_cache_id_sovrn |
hb_uuid_sovrn |
hb_cache_path_sovrn |
hb_deal_sovrn |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
tagid |
required |
The sovrn Ad Tag ID |
'315045' |
string |
bidfloor |
optional |
Bid floor in dollars |
0.04 |
float |
adunitcode |
optional |
Ad unit identifier |
'example_code' |
string |
Bid Params for video ads. These params should be added to mediatype.video
.
Name |
Scope |
Description |
Example |
Type |
mimes |
required |
Content MIME types supported |
['video/mp4'] |
string array |
minduration |
recommended |
Minimum video ad duration in seconds |
5 |
integer |
maxduration |
required |
Maximum video ad duration in seconds |
10 |
integer |
protocols |
required |
The array of supported video protocols |
[1, 2] |
integer array |
w |
recommended |
Width of the video player in device independent pixels (DIPS) |
5 |
integer |
h |
recommended |
Height of the video player in device independent pixels (DIPS) |
5 |
integer |
startdelay |
recommended |
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements |
5 |
integer |
placement |
recommended |
Placement type for the impression. Refer to List 5.9 |
5 |
integer |
linearity |
recommended |
Indicates if the impression must be linear, nonlinear, etc. Allowed by default |
0 |
integer |
skip |
optional |
Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes |
0 |
integer |
skipmin |
optional |
Only if the ad is skippable. Videos of total duration greater than this number of seconds can be skippable |
5 |
integer |
skipafter |
optional |
Only if the ad is skippable. Number of seconds a video must play before skipping is enabled |
5 |
integer |
sequence |
optional |
For multiple ad in the same bid request. This value allow will for the coordinated delivery of multiple ad |
5 |
integer |
battr |
optional |
Blocked creative attributes |
[1] |
integer array |
maxextended |
optional |
Max extended ad duration beyond the maxduration if extension is allowed. Blank or 0 - blocked. -1 - allowed without time limit |
5 |
integer |
minbitrate |
optional |
Minimum bit rate in Kbps |
5 |
integer |
maxbitrate |
optional |
Maximum bit rate in Kbps |
5 |
integer |
boxingallowed |
optional |
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes |
5 |
integer |
playbackmethod |
optional |
Playback methods that may be in use. See Video Playback Methods |
[1] |
integer array |
playbackend |
optional |
The event that causes playback to end. Refer to Playback Cessation Modes |
5 |
integer |
delivery |
optional |
Supported delivery methods (1 = streaming, 2 = progressive, 3 = download). If none specified, assume all are supported. |
[1, 2] |
integer array |
pos |
recommended |
Ad position on screen. Refer to Ad Position |
5 |
integer |
api |
recommended |
List of supported API frameworks for this impression. Refer to API Frameworks |
[1, 2, 3] |
integer array |
Note
Protocols list
MIME types
With VPAID2
video/mp4,
video/3gpp,
application/javascript
Without VPAID2
video/mp4,
video/3gpp
Video Playback Methods
Value |
Description |
1 |
Initiates on Page Load with Sound On |
2 |
Initiates on Page Load with Sound Off by Default |
3 |
Initiates on Click with Sound On |
4 |
Initiates on Mouse-Over with Sound On |
5 |
Initiates on Entering Viewport with Sound On |
6 |
Initiates on Entering Viewport with Sound Off by Default |
Playback Cessation Modes
Value |
Description |
1 |
On Video Completion or when Terminated by User |
2 |
On Leaving Viewport or when Terminated by User |
3 |
On Leaving Viewport Continues as a Floating/Slider Unit until Video Completion or when Terminated by User |
Ad Position
Value |
Description |
0 |
Unknown |
1 |
Above the Fold |
2 |
DEPRECATED |
3 |
Below the Fold |
4 |
Header |
5 |
Footer |
6 |
Sidebar |
7 |
Full Screen |
API Frameworks
Value |
Description |
1 |
VPAID 1.0 |
2 |
VPAID 2.0 |
3 |
MRAID-1 |
4 |
ORMMA |
5 |
MRAID-2 |
6 |
MRAID-3 |
Source: OpenRTB scpecification
Example
Video instream adUnit
var instreamAdUnit = {
code: 'instream-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
mimes: ['video/mp4'],
minduration: 4,
maxduration: 6,
context: 'instream'
}
},
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
}
Video outstream adUnit
var outstreamAdUnit = {
code: 'outstream-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
mimes: ['video/mp4'],
minduration: 4,
maxduration: 6,
context: 'outstream'
}
},
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
}
Banner adUnit
var bannerAdUnit = {
code: 'banner-div',
sizes: [[300, 250]],
bids: [{
bidder: 'sovrn',
params: {
tagid: '315045'
}
}]
}
sspBC
Features
Bidder Code |
sspBC |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
676 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sspBC |
hb_bidder_sspBC |
hb_adid_sspBC |
hb_size_sspBC |
hb_source_sspBC |
hb_format_sspBC |
hb_cache_host_sspBC |
hb_cache_id_sspBC |
hb_uuid_sspBC |
hb_cache_path_sspBC |
hb_deal_sspBC |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
id |
optional |
placement id |
'006' |
string |
siteId |
optional |
site id |
'235911' |
string |
publisherId |
optional |
publisher id |
'728' |
string |
domain |
optional |
site domain |
'somesite.com' |
string |
page |
optional |
page url |
'somesite.com/index.html' |
string |
tmax |
optional |
tmax for server connection |
400 |
integer |
stailamedia
Features
Bidder Code |
stailamedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
32 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_stailamedia |
hb_bidder_stailamedi |
hb_adid_stailamedia |
hb_size_stailamedia |
hb_source_stailamedi |
hb_format_stailamedi |
hb_cache_host_staila |
hb_cache_id_stailame |
hb_uuid_stailamedia |
hb_cache_path_staila |
hb_deal_stailamedia |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placement_id (PBS+PBJS) or placementId (PBJS) |
required |
Placement id |
'33037108' |
string |
stailamedia is an aliased bidder for AppNexus.
Note
For setup with stailamedia, please reach out to prebid@stailamedia.com
Streamkey
Features
Bidder Code |
streamkey |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
410 (adtelligent) |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_streamkey |
hb_bidder_streamkey |
hb_adid_streamkey |
hb_size_streamkey |
hb_source_streamkey |
hb_format_streamkey |
hb_cache_host_stream |
hb_cache_id_streamke |
hb_uuid_streamkey |
hb_cache_path_stream |
hb_deal_streamkey |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
aid |
required |
The traffic source ID |
232131 |
integer |
Test Parameters
var adUnits = [
// Video instream adUnit
{
code: 'div-test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'instream'
}
},
bids: [{
bidder: 'streamkey',
params: {
aid: 331133
}
}]
},
// Video outstream adUnit
{
code: 'outstream-test-div',
sizes: [[640, 480]],
mediaTypes: {
video: {
context: 'outstream'
}
},
bids: [{
bidder: 'streamkey',
params: {
aid: 331133
}
}]
},
];
Streamlyn
Features
Bidder Code |
streamlyn |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_streamlyn |
hb_bidder_streamlyn |
hb_adid_streamlyn |
hb_size_streamlyn |
hb_source_streamlyn |
hb_format_streamlyn |
hb_cache_host_stream |
hb_cache_id_streamly |
hb_uuid_streamlyn |
hb_cache_path_stream |
hb_deal_streamlyn |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'rtba.bidsxchange.com' |
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 |
Streamlyn server-side Prebid Server adapter requires only publisherId
and host
parameters.
Streamlyn server-side Prebid Server adapter supports only banner
, video
, audio
, native
media types.
StroeerCore
Features
Bidder Code |
stroeerCore |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
yes |
IAB GVL ID |
136 |
GPP Support |
check with bidder |
DSA Support |
yes |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
criteo, id5Id, netId, pubCommonId, sharedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_stroeerCore |
hb_bidder_stroeerCor |
hb_adid_stroeerCore |
hb_size_stroeerCore |
hb_source_stroeerCor |
hb_format_stroeerCor |
hb_cache_host_stroee |
hb_cache_id_stroeerC |
hb_uuid_stroeerCore |
hb_cache_path_stroee |
hb_deal_stroeerCore |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
sid |
required |
Slot ID |
'06b782cc-091b-4f53-9cd2-0291679aa1ac' |
string |
sfp |
optional |
Params for rendering special ad formats like Dynamic Sitebar. Contact your Account Manager for more information. |
{} |
object |
Ad Unit Configuration
Banner
- The server will ignore sizes that are not supported by the slot or by the platform (such as 987x123).
Example
var adUnits = [
{
code: 'your-banner-adunit-code',
mediaTypes: {
banner: {
sizes: [[300, 250]],
}
},
bids: [{
bidder: 'stroeerCore',
params: {
sid: '06b782cc-091b-4f53-9cd2-0291679aa1ac'
}
}]
}
];
Video
- Both instream and outstream contexts are supported.
- We do not provide an outstream renderer. You will need to set up your own. See Show Outstream Video Ads for more information.
- On
mediaTypes.video
, the fields context
and mediaTypes
are required.
Example
var adUnits = [
{
code: 'your-video-adunit-code',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
mimes: ['video/mp4', 'video/quicktime', 'video/x-ms-wmv']
}
},
bids: [{
bidder: 'stroeerCore',
params: {
sid: '35d4225e-f8e3-4f45-b1ea-77913afd00d1'
}
}]
}
];
SUNT Content
Features
Bidder Code |
suntContent |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
1097 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
no |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
no |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_suntContent |
hb_bidder_suntConten |
hb_adid_suntContent |
hb_size_suntContent |
hb_source_suntConten |
hb_format_suntConten |
hb_cache_host_suntCo |
hb_cache_id_suntCont |
hb_uuid_suntContent |
hb_cache_path_suntCo |
hb_deal_suntContent |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
adUnitId |
required |
ID of the Ad Unit |
8ao |
string |
url |
optional |
URL from the Page |
example.tld |
string |
Synacor Media
Features
Bidder Code |
synacormedia |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
none |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_synacormedia |
hb_bidder_synacormed |
hb_adid_synacormedia |
hb_size_synacormedia |
hb_source_synacormed |
hb_format_synacormed |
hb_cache_host_synaco |
hb_cache_id_synacorm |
hb_uuid_synacormedia |
hb_cache_path_synaco |
hb_deal_synacormedia |
|
Note
The Synacor Media bidder adapter has been renamed to the iMedia Digital Services (iMDS) adapter, using an bidder code of imds
. Please update your implementation accordingly.
Taboola
Features
Bidder Code |
taboola |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
42 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
no |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
no |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_taboola |
hb_bidder_taboola |
hb_adid_taboola |
hb_size_taboola |
hb_source_taboola |
hb_format_taboola |
hb_cache_host_tabool |
hb_cache_id_taboola |
hb_uuid_taboola |
hb_cache_path_tabool |
hb_deal_taboola |
|
Note
- Prebid.js Supports
display
format only.
- Prebid Server Supports
native+display
formats.
- Uses
OpenRTB
standard.
Bidder Config
We recommend allowing us access to localStorage.
You can allow writing in localStorage pbjs.bidderSettings
for the bidder taboola
pbjs.bidderSettings = {
taboola: {
storageAllowed : true
}
}
Registration
The Taboola Adapter requires setup before beginning. Please contact us at prebid@taboola.com.
Prebid Server
Please provide to your relevant Taboola contact person the prebid server host domain, so we enable it before the integration starts.
First Party Data
Publishers can use the ortb2
configuration parameter to provide First Party Data.
OpenRTB Parameters
The following table contains currently supported parameters we parse.
Name |
Scope |
Description |
Example |
Type |
bcat |
optional |
List of blocked advertiser categories (IAB) |
['IAB1-1'] |
string array |
badv |
optional |
Blocked Advertiser Domains |
['example.com'] |
string array |
wlang |
optional |
Allow List of languages for creatives using ISO-639-1-alpha-2 |
['fr', 'en'] |
string array |
Notes:
- will extract the page,ref,domain if passed within
ortb2.site
- will extract the pageType if passed within the preferred field
ortb2.ext.data.pageType
or ortb2.ext.data.section
Example configuration:
pbjs.setConfig({
ortb2: {
bcat: ['IAB1-1'],
badv: ['example.com'],
wlang: ['fr', 'en']
}
});
Bid Params
Name |
Scope |
Description |
Example |
Type |
tagId |
required |
Tag ID / Unique Placement Name
|
'Below The Article' |
String |
publisherId |
required |
Numeric Publisher ID (as provided by Taboola) |
'1234567' |
String |
pageType |
optional, recommended |
Kind of content present in the page |
'homepage' |
String |
position |
optional, recommended |
Identify the placement position on screen. Possible values: 0 - 7 0 Unknown 1 Above The Fold 2 Locked (i.e., fixed position) 3 Below The Fold 4 Header 5 Footer 6 Sidebar 7 Fullscreen
|
2 |
Integer |
publisherDomain |
optional |
Publisher Domain (server-side adapter only) |
'example.com' |
String |
bidfloor |
optional |
CPM bid floor |
0.25 |
Float |
bcat |
optional |
List of blocked advertiser categories (IAB) |
['IAB1-1'] |
Array |
badv |
optional |
Blocked Advertiser Domains |
'example.com' |
String Url |
Notes:
- Preferred to provide the
bcat
and badv
within the first party data (above). When both methods are provided, first party data values will be prioritized.
- If
pageType
or publisherDomain
provided within the first party data (as explained above), first party data properties will be prioritized.
tagId
is an identifier for specific ad placement, and should be the same unique tagId
per placement/ad unit in all Bid Requests.
Example Ad Unit
var adUnits = [{
code: 'your-unit-container-id',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
},
bids: [{
bidder: 'taboola',
params: {
tagId: 'Placement Name',
publisherId: 'your-publisher-id',
publisherDomain: 'example.com',// Optional (server-side adapter only)
pageType: 'news',// Optional
position: 6,// Optional
bidfloor: 0.25, // Optional - default is null
bcat: ['IAB1-1'], // Optional - default is []
badv: ['example.com'] // Optional - default is []
}
}]
}];
tappx
Features
Bidder Code |
tappx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
628 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_tappx |
hb_bidder_tappx |
hb_adid_tappx |
hb_size_tappx |
hb_source_tappx |
hb_format_tappx |
hb_cache_host_tappx |
hb_cache_id_tappx |
hb_uuid_tappx |
hb_cache_path_tappx |
hb_deal_tappx |
|
Registration
Please contact tappx@tappx.com to get set up.
Bid Params
Name |
Scope |
Description |
Example |
Type |
tappxkey |
required |
An ID which identifies the adunit |
‘key1’ |
string |
endpoint |
required |
Endpoint provided to publisher |
‘endpoint1’ |
string |
host |
required(pbjs) optional(pbserver) |
Tappx host |
‘host1’ |
string |
bidfloor |
optional |
Minimum bid for this impression expressed in CPM (USD) |
1.2 |
number |
mktag |
optional |
An ID which identifies a group of adunits |
‘key1’ |
string |
bcid |
optional |
Block list of CID |
[“1234”] |
array of strings |
bcrid |
optional |
Block list of CRID |
[“1234”] |
array of strings |
Test Parameters
Use the official test parameter specified in the oRTB standard (https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/OpenRTB%20v3.0%20FINAL.md#object_request)
Other notes
- Parameters host is required in prebidjs and the old versions of prebid server. In case of doubt, always add the parameter.
Teads
Features
Bidder Code |
teads |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
132 |
GPP Support |
tcfeu, tcfca, usnat, usstate_all, usp |
DSA Support |
yes |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
uid2Id, identityLinkId, lotamePanoramaId, id5Id, criteoId, connectId, quantcastId, publinkId, sharedId, merkleId, kinessoId |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_teads |
hb_bidder_teads |
hb_adid_teads |
hb_size_teads |
hb_source_teads |
hb_format_teads |
hb_cache_host_teads |
hb_cache_id_teads |
hb_uuid_teads |
hb_cache_path_teads |
hb_deal_teads |
|
Notes
- The Teads Bidding adapter requires setup before beginning. Please contact us on https://teads.tv/teads-contact/
- When this adapter is enabled and Prebid.js is used in an iOS WebView, the WebView should allow videos to play inline. This is required because the Teads adapter delivers video ads and starts by detecting the autoplay capability of the device.
Bid Params
Name |
Scope |
Description |
Example |
Type |
pageId |
required(pbjs) |
Teads page id |
2453 |
integer |
placementId |
required(pbs,pbjs) |
Teads placement id |
113244 |
integer |
TGM
Features
Bidder Code |
tgm |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_tgm |
hb_bidder_tgm |
hb_adid_tgm |
hb_size_tgm |
hb_source_tgm |
hb_format_tgm |
hb_cache_host_tgm |
hb_cache_id_tgm |
hb_uuid_tgm |
hb_cache_path_tgm |
hb_deal_tgm |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'ads-gmd.ortb.net' |
string |
adUnitId |
required |
Ad Unit Id will be generated on TGM 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 |
TGM server-side Prebid Server adapter requires only publisherId
and host
parameters. But TGM client-side Prebid.js adapter requires only host
, adUnitId
, adUnitType
.
TGM server-side Prebid Server adapter supports only banner
, video
, audio
, native
media types. But TGM client-side Prebid.js adapter supports only banner
and video
media types, doesn’t support audio
and native
.
TheAdx
Features
Bidder Code |
theadx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
556 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_theadx |
hb_bidder_theadx |
hb_adid_theadx |
hb_size_theadx |
hb_source_theadx |
hb_format_theadx |
hb_cache_host_theadx |
hb_cache_id_theadx |
hb_uuid_theadx |
hb_cache_path_theadx |
hb_deal_theadx |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
pid |
required |
Publisher GUID from theadx.com |
'1000' |
int |
wid |
required |
Web Site ID from theadx.com |
'2000' |
int |
tagId |
required |
Tag ID from theadx.com |
'3000' |
int |
|
|
|
|
|
TPMN
Features
Bidder Code |
tpmn |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_tpmn |
hb_bidder_tpmn |
hb_adid_tpmn |
hb_size_tpmn |
hb_source_tpmn |
hb_format_tpmn |
hb_cache_host_tpmn |
hb_cache_id_tpmn |
hb_uuid_tpmn |
hb_cache_path_tpmn |
hb_deal_tpmn |
|
Note
TPMN Support media types
Name |
banner |
video |
native |
audio |
Prebid.js |
O |
O |
X |
X |
Prebid Server Adapter |
O |
O |
O |
X |
Registration
To use this bidder you will need an account and a valid unit from us.
For further information, please contact info@tpmn.io
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
inventoryId |
required |
Inventory ID |
1 |
integer |
User Sync
Add the following code to enable user sync.
TPMN strongly recommends enabling user syncing through iFrames.
This functionality improves partners’ user match rates and increases the TPMN bid rate and bid price.
Even if iFrame is not active, user sync of some partners is performed.
Be sure to call pbjs.setConfig()
only once.
pbjs.setConfig({
userSync: {
iframeEnabled: true,
filterSettings: {
iframe: {
bidders: '*', // '*' means all bidders
filter: 'include'
}
}
}
});
Prebid Server Adapter Bid Params
Name |
Scope |
Description |
Example |
Type |
inventoryId |
required |
Inventory ID |
1 |
integer |
Prebid Server Adapter Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the
TPMN adapter.
{
"id": "request_id",
"imp": [
{
"id": "imp_id",
"banner": {
"w": 300,
"h": 250
},
"ext": {
"tpmn": {
"inventoryid": 1
}
}
}
],
"device": {
"os": "some-Os",
"ua": "some-agent"
},
"tmax": 500,
"test": 1
}
TrafficGate
Features
Bidder Code |
trafficgate |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_trafficgate |
hb_bidder_trafficgat |
hb_adid_trafficgate |
hb_size_trafficgate |
hb_source_trafficgat |
hb_format_trafficgat |
hb_cache_host_traffi |
hb_cache_id_trafficg |
hb_uuid_trafficgate |
hb_cache_path_traffi |
hb_deal_trafficgate |
|
Note
{% include dev-docs/pbjs-adapter-required-for-pbs.md %}
The TrafficGate 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 |
host |
required |
Host |
'example' |
string |
customFloor |
optional |
Custom Bid Floor |
2.55 |
number |
var adUnits = [{
code: 'test-banner-div ',
mediaTypes: {
banner: {
sizes: [[300, 250]],
}
},
bids: [{
bidder: 'trafficgate',
params: {
placementId: '16',
host: 'example'
}
}]
}];
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) |
[“video/mp4”] |
array |
protocols |
recommended |
Supported video bid response protocol values 1: VAST 1.0 2: VAST 2.0 3: VAST 3.0 4: VAST 1.0 Wrapper 5: VAST 2.0 Wrapper 6: VAST 3.0 Wrapper 7: VAST 4.0 8: VAST 4.0 Wrapper |
[2,3,5,6] |
array |
api |
recommended |
Supported API framework values: 1: VPAID 1.0 2: VPAID 2.0 3: MRAID-1 4: ORMMA 5: MRAID-2 |
[2] |
array |
linearity |
recommended |
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) |
1 |
integer |
|
|
|
|
|
var videoAdUnits = [{
code: 'test-div-video',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream', // required
mimes: ['video/mp4','video/x-flv'], // required
minduration: 5, // optional
maxduration: 30, // optional
startdelay: 5, // optional
playbackmethod: [1,3], // optional
api: [ 1, 2 ], // optional
protocols: [ 2, 3 ], // optional
battr: [ 13, 14 ], // optional
linearity: 1, // optional
placement: 2, // optional
minbitrate: 10, // optional
maxbitrate: 10 // optional
}
},
bids: [{
bidder: 'trafficgate',
params: {
placementId: '10',
host: 'example'
}
}]
}]
Tredio
Features
Bidder Code |
tredio |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
true |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_tredio |
hb_bidder_tredio |
hb_adid_tredio |
hb_size_tredio |
hb_source_tredio |
hb_format_tredio |
hb_cache_host_tredio |
hb_cache_id_tredio |
hb_uuid_tredio |
hb_cache_path_tredio |
hb_deal_tredio |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
TripleLift
Features
Bidder Code |
triplelift |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
28 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
criteo, identityLink, unifiedId, pubCommonId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_triplelift |
hb_bidder_triplelift |
hb_adid_triplelift |
hb_size_triplelift |
hb_source_triplelift |
hb_format_triplelift |
hb_cache_host_triple |
hb_cache_id_tripleli |
hb_uuid_triplelift |
hb_cache_path_triple |
hb_deal_triplelift |
|
Table of Contents
Overview
Publishers may integrate with Triplelift through our Prebid.js and/or Prebid Server adapters. See below for more information.
The Triplelift Prebid Server bidding adapter and user sync endpoint require setup before beginning. Please contact us at prebid@triplelift.com.
Bid Params
Banner
Name |
Scope |
Description |
Example |
Type |
inventoryCode |
required |
TripleLift inventory code for this ad unit (provided to you by your partner manager) |
'pubname_top_banner' |
string |
floor |
optional |
Bid floor |
1.00 |
float |
Video
Triplelift bid params for video mediaTypes are identical, but be sure to include the appropriate video.placement value to indicate instream/outstream format. Speak with your partner manager about which value to place here based on what formats are enabled.
See the Ad Unit Reference for more info.
Name |
Scope |
Description |
Example |
Type |
adUnit.mediaTypes.video.placement |
required |
Instream: 1; Outstream: 3, 4, 5. |
3 |
int |
adUnit.mediaTypes.video.playerSize |
required |
Video player dimensions or size in pixels |
[640, 480] |
integer array |
Example Configuration
Banner Configuration
var adUnits = [
{
code: 'top-banner',
mediaTypes: {
banner: {
sizes: [
[728, 90],
[970, 250]
]
}
},
bids: [{
bidder: 'triplelift',
params: {
inventoryCode: 'pubname_top_banner'
}
}]
}];
Video (Instream)
var videoAdUnit = {
code: 'video1',
mediaTypes: {
video: {
playerSize: [640, 480],
context: 'instream',
placement: 1,
mimes: ['video/mp4']
}
},
bids: [{
bidder: 'triplelift',
params: {
inventoryCode: 'pubname_instream1'
}
}]
};
Video (Outstream)
var videoAdUnit = {
code: 'video1',
mediaTypes: {
video: {
playerSize: [640, 480],
context: 'outstream',
placement: 3,
mimes: ['video/mp4']
}
},
bids: [{
bidder: 'triplelift',
params: {
inventoryCode: 'pubname_outstream',
}
}]
};
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
ortb2.site.*
: Standard IAB OpenRTB 2.5 site fields
ortb2.user.*
: Standard IAB OpenRTB 2.5 user fields
AdUnit-specific data is supported using AdUnit.ortb2Imp.ext.*
Programmatic DMP
Triplelift provides audience and contextual targeting via the integration of a Programmatic DMP tag. Please reach out to your Triplelift representative to discuss specifics of the integration.
Requirements
- Prebid v7.1.0 or later
-
In Prebid’s bidderSettings
, the storageAllowed
parameter must be set to true. In Prebid v7.0 and later, storageAllowed
defaults to false, so you will need to explicitly set this value to true.
pbjs.bidderSettings = {
triplelift: {
storageAllowed: true
}
}
- The Programmatic DMP tag must be included at the top of every webpage in order to collect audience and contextual information on the respective page.
- The Programmatic DMP tag should be as high up in
<head>
as possible.
TripleLift Native
Features
Bidder Code |
triplelift_native |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
28 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
criteo, identityLink, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_triplelift_nat |
hb_bidder_triplelift |
hb_adid_triplelift_n |
hb_size_triplelift_n |
hb_source_triplelift |
hb_format_triplelift |
hb_cache_host_triple |
hb_cache_id_tripleli |
hb_uuid_triplelift_n |
hb_cache_path_triple |
hb_deal_triplelift_n |
|
This is a Prebid Server adapter for running component native only. For the standard Prebid JS Triplelift bid adapter, see the “Triplelift” bidder. If you are interested in running component native via Prebid JS, please contact us at prebid@triplelift.com.
The Triplelift Prebid Server bidding adapter and user sync endpoint require setup before beginning. Please contact us at prebid@triplelift.com.
Table of Contents
Bid Params
Name |
Scope |
Description |
Example |
Type |
inventoryCode |
required |
TripleLift inventory code for this ad unit (provided to you by your partner manager) |
‘code1’ |
string |
floor |
optional |
the bid floor, in usd |
1.2 |
number |
First Party Data
Triplelift supports standard IAB OpenRTB 2.5 First Party Data fields, including:
TrustedStack
Features
Bidder Code |
trustedstack |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
1288 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trustedstack |
hb_bidder_trustedsta |
hb_adid_trustedstack |
hb_size_trustedstack |
hb_source_trustedsta |
hb_format_trustedsta |
hb_cache_host_truste |
hb_cache_id_trusteds |
hb_uuid_trustedstack |
hb_cache_path_truste |
hb_deal_trustedstack |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
cid |
required |
The customer id provided by TrustedStack. |
'trustedstack_test_customer' |
string |
crid |
required |
The placement id provided by TrustedStack. |
'trustedstack_crid' |
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 |
[1, 2] |
protocols |
array of integers |
Array of supported video protocols. Currently supported values are: 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 |
[1, 2] |
placement |
integer |
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
, TrustedStack 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: 'trustedstack',
params: {
cid: 'trustedstack_test_customer',
crid: 'trustedstack_crid',
}
}]
};
Example of Banner Ad-unit
var adUnits = [{
code: 'div-gpt-ad-6874091242345-0',
mediaTypes: {
banner: {
sizes: [
[728, 90],
[300, 600],
[300, 250]
],
}
},
bids: [{
bidder: 'trustedstack',
params: {
cid: 'trustedstack_test_customer',
crid: 'trustedstack_crid'
}
}]
}];
TrustX
Features
Bidder Code |
trustx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
686 (grid) |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trustx |
hb_bidder_trustx |
hb_adid_trustx |
hb_size_trustx |
hb_source_trustx |
hb_format_trustx |
hb_cache_host_trustx |
hb_cache_id_trustx |
hb_uuid_trustx |
hb_cache_path_trustx |
hb_deal_trustx |
|
Table of Contents
Bid Params
Name |
Scope |
Description |
Example |
Type |
uid |
required |
Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. |
42 |
integer |
keywords |
optional |
A set of key-value pairs applied to all ad slots on the page. Values can be empty. |
keywords: { topic: ['stress', 'fear'] } |
object |
bidFloor |
optional |
Floor of the impression opportunity. If present in the request overrides XML info. |
0.8 |
float |
Parameter keywords
must have following format:
{
"site":{
"publisher1":[
{
"name":"SomeKeywordsBlockName",
"segment1Name":[
"segment2Value"
],
"segment2Name":[
"segment2Value1",
"segment2Value2",
...
],
...
}
],
...
}
}
Bidder Config
You can allow writing in localStorage pbjs.setBidderConfig
for the bidder trustx
pbjs.setBidderConfig({
bidders: ["trustx"],
config: {
localStorageWriteAllowed: true
}
})
If it will be “true” this allow TheMediaGrid Bid Adapter to write userId in first party localStorage
If you want to make alias on TrustX Bid Adapter, you must set forceBidderName
in bidderConfig as "trustx"
.
pbjs.setBidderConfig({
bidders: ["aliasName"],
config: {
forceBidderName: 'trustx'
}
})
First Party Data
Publishers should use the ortb2
method of setting First Party Data.
Global site or user data using setConfig()
, or Bidder-specific using setBidderConfig()
supports following fields:
ortb2.user.data[]
: Standard IAB segment taxonomy user data
ortb2.user.ext.device
: Non standard arbitrary user device
ortb2.user.keywords
: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2
ortb2.site.keywords
: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2
ortb2.site.cat[]
: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array
ortb2.site.pagecat[]
: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array
ortb2.site.content.genre
: Standard IAB OpenRTB 2.5 site.content.genre field
AdUnit-specific data using AdUnit.ortb2Imp
supports following fields:
ortb2.imp[].ext.data.*
ortb2.imp[].instl
The Trade Desk
Features
Bidder Code |
ttd |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-not-bid |
TCF-EU Support |
yes |
IAB GVL ID |
21 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_ttd |
hb_bidder_ttd |
hb_adid_ttd |
hb_size_ttd |
hb_source_ttd |
hb_format_ttd |
hb_cache_host_ttd |
hb_cache_id_ttd |
hb_uuid_ttd |
hb_cache_path_ttd |
hb_deal_ttd |
|
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: The Trade Desk Header Bidding adapter requires setup and approval before beginning. Please reach out to OpenPathPublishers@thetradedesk.com for more details.
Bid Params
Name |
Scope |
Description |
Example |
Type |
supplySourceId |
required |
The TTD-provided supply source name. |
'supplier' |
String |
publisherId |
required |
The publisher ID. If there is a sellers.json, this should be the same as the seller_id in the sellers.json for the site being trafficked. If there is no sellers.json, this should be hardcoded to “1”. |
'1427ab10f2e448057ed3b422' |
String |
placementId |
optional |
This field is optional if GPID is passed through the GPT module https://docs.prebid.org/dev-docs/modules/gpt-pre-auction.html. If that module isn’t used, the GPID value should be passed in this field. |
'/1111/home#header' |
String |
banner |
optional |
Display banner targeting parameters. See the banner section below. |
{} |
object |
bidfloor |
optional |
Sets a bid floor price |
0.95 |
Float |
Banner Object
The following banner parameters are supported:
Name |
Scope |
Description |
Example |
Type |
expdir |
optional |
Directions in which the banner may expand. See “Expandable Direction” in the OpenRTB 2.5 docs for possible values. |
[1, 3] |
Array[integer] |
The TTD adapter for banner uses certain parameters in the AdUnit’s
mediaTypes.banner definition. Specifically, sizes
is required for banner ad units. pos
is recommended.
Here’s a banner ad unit example:
var bannerAdUnit = {
code: 'myBannerAdUnit',
mediaTypes: {
banner: {
sizes: [400, 600],
pos: 1
}
},
bids: [
{
bidder: 'ttd',
params: {
supplySourceId: 'supplier'
publisherId: '1427ab10f2e448057ed3b422',
siteId: 'site-123',
placementId: 'sidebar_1',
banner: {
expdir: [1, 3]
},
bidfloor: 0.95
}
}
]
}
Video
The TTD adapter for video requires certain parameters in the AdUnit’s
mediaTypes.video definition. Specifically, maxduration
, api
, mimes
, placement
, and protocols
are all required for video ad units. playerSize
, startdelay
, playbackmethod
, and pos
are recommended. minduration
, minbitrate
, maxbitrate
, skip
, skipmin
, and skipafter
are optional.
Note: TTD does not currently support adpod
video contexts.
Here’s a video ad unit example:
var videoAdUnit = {
code: 'myVideoAdUnit',
mediaTypes: {
video: {
minduration: 1,
maxduration: 60,
playerSize: [640, 480],
api: [1, 3],
mimes: ['video/mp4'],
placement: 3,
protocols: [2, 3, 5, 6],
startdelay: -1,
playbackmethod: [1],
pos: 1,
minbitrate: 0,
maxbitrate: 5000,
skip: 1,
skipmin: 5,
skipafter: 10
}
},
bids: [
{
bidder: "ttd",
params: {
supplySourceId: 'supplier',
publisherId: '1427ab10f2e448057ed3b422',
siteId: 'site-123',
placementId: 'video1',
bidfloor: 0.95
}
}
]
}
Lists of api
, playbackmethod
, protocols
, pos
, and expdir
potential values are in the OpenRTB 2.5 docs, copied here for convenience:
api
1
: VPAID 1.0
2
: VPAID 2.0
3
: MRAID-1
4
: ORMMA
5
: MRAID-2
6
: MRAID-3
7
: OMID-1
playbackmethod
1
: Initiates on Page Load with Sound On
2
: Initiates on Page Load with Sound Off by Default
3
: Initiates on Click with Sound On
4
: Initiates on Mouse-Over with Sound On
5
: Initiates on Entering Viewport with Sound On
6
: Initiates on Entering Viewport with Sound Off by Default
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
11
: VAST 4.1
12
: VAST 4.1 Wrapper
pos
0
: Unknown
1
: Above the Fold
3
: Below the Fold
4
: Header
5
: Footer
6
: Sidebar
7
: Full Screen
expdir
1
: Left
2
: Right
3
: Up
4
: Down
5
: Full Screen
First Party Data (Supported starting prebid v7.49)
Publishers should set First Party Data in the ortb2
and ortb2Imp
objects. These fields are supported:
ortb2.site.ext.data
ortb2.user.ext.data
AdUnit.ortb2Imp.ext.data
(for AdUnit data)
ucfunnel
Features
Bidder Code |
ucfunnel |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
607 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_ucfunnel |
hb_bidder_ucfunnel |
hb_adid_ucfunnel |
hb_size_ucfunnel |
hb_source_ucfunnel |
hb_format_ucfunnel |
hb_cache_host_ucfunn |
hb_cache_id_ucfunnel |
hb_uuid_ucfunnel |
hb_cache_path_ucfunn |
hb_deal_ucfunnel |
|
Prebid JS
Bid params (Prebid.js)
Name |
Scope |
Description |
Example |
Type |
adid |
required |
The ad unit ID retrived from ucfunnel dashboard |
|
string |
var adUnits = [{
code: 'div-gpt-ad-1460505748511-01',
sizes: [
[300, 250]
],
bids: [{
bidder: 'ucfunnel',
params: {
adid: '123456789'
}
}]
}]
Sizes set in the adUnit
object will also apply to the ucfunnel bid requests.
Examples
Prebid server
Bid params (Prebid Server)
Name |
Scope |
Description |
Example |
Type |
adunitid |
required |
ID for ad unit |
|
string |
partnerid |
required |
ID for partner |
|
string |
Undertone
Features
Bidder Code |
undertone |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
677 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_undertone |
hb_bidder_undertone |
hb_adid_undertone |
hb_size_undertone |
hb_source_undertone |
hb_format_undertone |
hb_cache_host_undert |
hb_cache_id_underton |
hb_uuid_undertone |
hb_cache_path_undert |
hb_deal_undertone |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Your placement ID (provided by undertone) |
1234 |
integer |
publisherId |
required |
publisher ID (provided by undertone) |
12345 |
integer |
Video Object
Name |
Scope |
Description |
Example |
Type |
playbackMethod |
optional |
Playback method supported by the publisher.
1 : Auto-play sound on
2 : Auto-play sound off
3 : Click-to-play sound on
4 : Mouse-over sound on |
1 |
integer |
maxDuration |
optional |
Maximum video ad duration in seconds. |
30 |
integer |
skippable |
optional |
Skippability of the inventory. Possible values: true - only skippable inventory is allowed, false - skippable inventory is not allowed, null/missing - all inventory is allowed (default value). |
true |
boolean |
Supported from version 3.27.0 and above
Configuration
To maximize revenue efficiency, please enable iframe-based user syncing. This functionality will improve user match rates and will help increasing the bid rate.
Example code to enable iframe user-sync for Undertone:
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: ['undertone'],
filter: 'include'
}
}
}
});
Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.
UNICORN
Features
Bidder Code |
unicorn |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_unicorn |
hb_bidder_unicorn |
hb_adid_unicorn |
hb_size_unicorn |
hb_source_unicorn |
hb_format_unicorn |
hb_cache_host_unicor |
hb_cache_id_unicorn |
hb_uuid_unicorn |
hb_cache_path_unicor |
hb_deal_unicorn |
|
bid params
Name |
Scope |
Description |
Example |
Type |
placementId |
optional |
Your placement ID |
'rectangle-ad-1' |
string |
accountId |
required |
Account ID for charge request (provided by UNICORN) |
12345 |
integer |
publisherId |
optional |
Account specific publisher id. |
'67890' |
string |
mediaId |
optional |
Publisher specific media id. |
'example' |
string |
bcat |
optional for Prebid.js |
Blocked IAB categories |
['IAB-1', 'IAB-2'] |
[string] |
publisherId
as integer
is also supported on Prebid.js
Unruly
Features
Bidder Code |
unruly |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
36 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_unruly |
hb_bidder_unruly |
hb_adid_unruly |
hb_size_unruly |
hb_source_unruly |
hb_format_unruly |
hb_cache_host_unruly |
hb_cache_id_unruly |
hb_uuid_unruly |
hb_cache_path_unruly |
hb_deal_unruly |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
siteId |
required |
The site ID from Unruly(Nexxen). This will be provided to you by your Unruly account manager, this is prefered. |
123456 |
integer |
siteid |
deprecated |
The site ID from Unruly. This will be provided to you by your Unruly account manager, this is backward compability. |
123456 |
integer |
featureOverrides |
optional |
This param is a generic object for configuring Unruly outstream demand. To run UNmissable, set ‘canRunUnmissable’ to true. |
"featureOverrides": {"canRunUnmissable": true} |
object |
Protected Audience API (PAAPI) support
There’s an option to receive demand for Protected Audience API (FLEDGE/PAAPI)
ads using Unruly’s (Nexxen) bid adapter.
Prebid’s paapiForGpt
module and Google Ad Manager is currently required.
The following steps should be taken to setup Protected Audience for Unruly(Nexxen):
-
Reach out to your account manager to coordinate set up:
-
Build and enable PAAPI module as described in
paapiForGpt
module documentation.
Make sure to enable Unruly bidder to participate in PAAPI. If there are any other bidders to be allowed for that, add them to the bidders array:
pbjs.setConfig({
paapi: {
bidders: ["unruly"],
enabled: true
}
})
First Party Data
Publishers should use the ortb2
method of setting First Party Data. The following fields are supported:
AdUnit-specific data is supported using AdUnit.ortb2Imp.ext.*
Example of first party data available only to the Unruly (Nexxen) bidder. Applies across all ad units. We support up to 5 custom keys.
pbjs.setBidderConfig({
bidders: ["unruly"],
config: {
ortb2: {
site: {
ext: {
data: {
customkey1: "value1",
customkey2: "value2",
customkey3: "value3",
customkey4: "value4",
customkey5: "value5"
}
}
}
}
}
});
Valueimpression
Features
Bidder Code |
valueimpression |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_valueimpressio |
hb_bidder_valueimpre |
hb_adid_valueimpress |
hb_size_valueimpress |
hb_source_valueimpre |
hb_format_valueimpre |
hb_cache_host_valuei |
hb_cache_id_valueimp |
hb_uuid_valueimpress |
hb_cache_path_valuei |
hb_deal_valueimpress |
|
Description
Valueimpression is an aliased bidder of Apacdex bid adapter. Please refer to Apacdex documentation for bid parameters and implementation guide.
Vidazoo
Features
Bidder Code |
vidazoo |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
744 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vidazoo |
hb_bidder_vidazoo |
hb_adid_vidazoo |
hb_size_vidazoo |
hb_source_vidazoo |
hb_format_vidazoo |
hb_cache_host_vidazo |
hb_cache_id_vidazoo |
hb_uuid_vidazoo |
hb_cache_path_vidazo |
hb_deal_vidazoo |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
cId |
required |
The connection ID from Vidazoo. |
'562524b21b1c1f08117fc7f9' |
string |
pId |
required |
The publisher ID from Vidazoo (pbjs only). |
'59ac17c192832d0011283fe3' |
string |
bidFloor |
optional |
The minimum bid value desired. Vidazoo will not respond with bids lower than this value. |
0.90 |
float |
subDomain |
optional |
Sets the server subdomain, default: ‘prebid’. |
'prebid' |
string |
VideoByte
Features
Bidder Code |
videobyte |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
104 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_videobyte |
hb_bidder_videobyte |
hb_adid_videobyte |
hb_size_videobyte |
hb_source_videobyte |
hb_format_videobyte |
hb_cache_host_videob |
hb_cache_id_videobyt |
hb_uuid_videobyte |
hb_cache_path_videob |
hb_deal_videobyte |
|
Note
The VideoByte Prebid.js client adapter only supports video ads while our Prebid Server adapter supports both display and video.
See Videobyte Prebid Client Documentation
for more details about Prebid Client integration.
See Videobyte Prebid Server Documentation
for more details about Prebid Server integration.
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubId |
required |
Publisher ID |
'vb12345' |
string |
placementId |
optional |
Placement ID |
'1234567' |
string |
nid |
optional |
Network ID |
'1234' |
string |
VideoHeroes
Features
Bidder Code |
videoheroes |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_videoheroes |
hb_bidder_videoheroe |
hb_adid_videoheroes |
hb_size_videoheroes |
hb_source_videoheroe |
hb_format_videoheroe |
hb_cache_host_videoh |
hb_cache_id_videoher |
hb_uuid_videoheroes |
hb_cache_path_videoh |
hb_deal_videoheroes |
|
Note
The VideoHeroes Header Bidding adapter requires setup and approval from the VideoHeroes team. Please reach out to your account manager or support@videoheroes.tv for more information
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
VideoHeroes platform placement id |
'1a8d9c22db19906cb8a5fd4518d05f62' |
string |
Vidoomy
Features
Bidder Code |
vidoomy |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
380 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vidoomy |
hb_bidder_vidoomy |
hb_adid_vidoomy |
hb_size_vidoomy |
hb_source_vidoomy |
hb_format_vidoomy |
hb_cache_host_vidoom |
hb_cache_id_vidoomy |
hb_uuid_vidoomy |
hb_cache_path_vidoom |
hb_deal_vidoomy |
|
Note
Vidoomy, for more info please contact support@vidoomy.com
Client Side Bid Params
Name |
Scope |
Description |
Example |
Type |
id |
required |
id |
'123123' |
string |
pid |
required |
pid |
'123123' |
string |
bidfloor |
optional |
CPM bidfloor in USD |
0.08 |
float |
Server Side Bid Params (Prebid Server)
Name |
Scope |
Description |
Example |
Type |
zoneId |
required |
Zone Id |
'123123' |
string |
bcat |
optional |
List of blocked advertiser categories (IAB) |
['IAB1-1'] |
string array |
badv |
optional |
Blocked Advertiser Domains |
['example.com'] |
string array |
bapp |
optional |
blocked advertiser mobile app bundles |
['app.com'] |
string array |
btype |
optional |
blocked creative types (e.g. XHTML) |
[1, 2, 3] |
int array |
battr |
optional |
blocked creative attributes (e.g. audio) |
[1, 2, 3] |
int array |
Notes:
- Preferred to provide the
bcat
, badv
, bapp
, btype
and battr
within the first party data (above). When both
methods are provided, first
party data values will be prioritized.
First Party Data
Publishers can use the ortb2
configuration parameter to provide First Party Data.
OpenRTB Parameters
The following table contains currently supported parameters we parse.
Name |
Scope |
Description |
Example |
Type |
bcat |
optional |
List of blocked advertiser categories (IAB) |
['IAB1-1'] |
Array |
badv |
optional |
Blocked Advertiser Domains |
['example.com'] |
Array |
bapp |
optional |
blocked advertiser mobile app bundles |
['app.com'] |
Array |
btype |
optional |
blocked creative types (e.g. XHTML) |
[1, 2, 3] |
Array |
battr |
optional |
blocked creative attributes (e.g. audio) |
[1, 2, 3] |
Array |
Notes:
- will extract the bcat,badv,bapp,btype,battr if passed within
ortb2
Example configuration:
pbjs.setConfig({
ortb2: {
bcat: ['IAB1-1'],
badv: ['example.com'],
bapp: ['app.com'],
btype: [1, 2, 3],
battr: [1, 2, 3]
}
});
Viewdeos Server
Features
Bidder Code |
viewdeos |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
924 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_viewdeos |
hb_bidder_viewdeos |
hb_adid_viewdeos |
hb_size_viewdeos |
hb_source_viewdeos |
hb_format_viewdeos |
hb_cache_host_viewde |
hb_cache_id_viewdeos |
hb_uuid_viewdeos |
hb_cache_path_viewde |
hb_deal_viewdeos |
|
Bid params
Name |
Scope |
Description |
Example |
Type |
aid |
required |
The source ID from member zone |
350975 |
integer |
Test Parameters
var adUnits = [
// Banner adUnit
{
code: 'div-test-div',
mediaTypes: {
banner: {
sizes:[[300, 250]]
}
},
bids: [{
bidder: 'viewdeos',
params: {
aid: 672854
}
}]
}
];
VimayX
Features
Bidder Code |
vimayX |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
yes |
Safeframes OK |
yes |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_vimayX |
hb_bidder_vimayX |
hb_adid_vimayX |
hb_size_vimayX |
hb_source_vimayX |
hb_format_vimayX |
hb_cache_host_vimayX |
hb_cache_id_vimayX |
hb_uuid_vimayX |
hb_cache_path_vimayX |
hb_deal_vimayX |
|
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
iabCat |
optional |
Array of IAB content categories that describe the content producer |
['IAB1-1', 'IAB3-1', 'IAB4-3'] |
Array(String) |
minBidfloor |
optional |
Minimal CPM value |
0.03 |
float |
pos |
optional |
The position of the placement on the page, see Open RTB spec v2.5. |
4 |
number |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
seat |
required |
Seat value |
'9Q20EdGxzgWdfPYShScl' |
string |
token |
required |
Token |
'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW' |
string |
VisibleMeasures
Features
Bidder Code |
visiblemeasures |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-not-bid |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
yes |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_visiblemeasure |
hb_bidder_visiblemea |
hb_adid_visiblemeasu |
hb_size_visiblemeasu |
hb_source_visiblemea |
hb_format_visiblemea |
hb_cache_host_visibl |
hb_cache_id_visiblem |
hb_uuid_visiblemeasu |
hb_cache_path_visibl |
hb_deal_visiblemeasu |
|
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
YOC VIS.X
Features
Bidder Code |
visx |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
154 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_visx |
hb_bidder_visx |
hb_adid_visx |
hb_size_visx |
hb_source_visx |
hb_format_visx |
hb_cache_host_visx |
hb_cache_id_visx |
hb_uuid_visx |
hb_cache_path_visx |
hb_deal_visx |
|
Note
To be able to use the full bandwidth of VIS.X high impact ad products, we strongly recommend disabling SafeFrames:
- If you are using Google Ad Manager (GAM), make sure the “Serve in Safeframe” box in creative settings is unchecked,
- If you are using AppNexus Seller Tag, make sure the enableSafeFrame parameter is set to False.
If you require SafeFrames to be activated, please reach out to your YOC account manager to obtain further details.
If a single bid request contains more than 20 impression objects, this request will be ignored.
The YOC VIS.X adapter requires setup and approval from your YOC account manager team, even for existing YOC publishers.
Please reach out to your account manager to enable Prebid.js for your account.
Configuration: Currency
Name |
Scope |
Description |
Example |
Type |
uid |
required |
The publisher’s ad unit ID in VIS.X. The parameter can be either an integer or string for Prebid.js, however integer is preferred. |
903536 |
integer |
Configuration
The YOC VIS.X adapter has the ability to work in different currencies. Currently, this adapter supports EUR
, USD
,
GBP
, PLN
, CHF
, SEK
. Defaults to EUR
. If your Ad Server uses EUR
, you don’t need any additional currency settings.
If you would like to trade with VIS.X in a currency different from EUR
, you should implement some additional settings.
- Download and configure the Prebid.js Currency module
http://prebid.org/dev-docs/modules/currency.html
- Setup the currency in Currency config
a) If your Ad Server uses the currency from the list of VIS.X supported currencies (e.g. GBP
), use the following settings:
pbjs.setConfig({
currency: {
adServerCurrency: 'GBP',
bidderCurrencyDefault: {
visx: 'GBP'
}
}
});
b) If your Ad Server uses an unsupported currency for VIS.X (e.g. JPY
), use the following settings:
pbjs.setConfig({
currency: {
adServerCurrency: 'JPY',
bidderCurrencyDefault: {
visx: 'EUR'
}
}
});
Best practices:
- Please make sure that the currency module is set up and configured in order to trade with YOC in a currency that is not supported by the YOC VIS.X bidder.
- You should set
EUR
in bidderCurrencyDefault
parameter if you use unsupported currencies for VIS.X.
- Feel free to reach out to your contact at YOC if you need additional support setting up Prebid.js and the currency config.
Configuration: Video
The YOC VIS.X Prebid.js adapter responds with VAST XML (in the vastXml
field) and expects client-side caching enabled. To enable it, use the following settings:
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
Requirements
-
In Prebid’s bidderSettings
, the storageAllowed
parameter must be set to true. In Prebid v7.0 and later, storageAllowed
defaults to false, so you will need to explicitly set this value to true.
pbjs.bidderSettings = {
visx: {
storageAllowed: true
}
}
Bid params
Name |
Scope |
Description |
Example |
Type |
uid |
required |
The publisher’s ad unit ID in VIS.X. The parameter can be either an integer or string for Prebid.js, however integer is preferred. |
903536 |
integer |
Name |
Scope |
Description |
Example |
Type |
sizes |
required |
All sizes this ad unit can accept. |
[[300, 250], [300, 600]] |
array of integer arrays |
Name |
Scope |
Description |
Example |
Type |
context |
required |
The video context, only ‘instream’ is allowed. |
'instream' |
string |
playerSize |
required |
The size (width, height) of the video player on the page, in pixels. |
[640, 480] |
integer array |
mimes |
optional |
Content MIME types supported. |
['video/mp4', 'video/x-ms-wmv'] |
string array |
Example of Banner Ad unit
var bannerAdUnit = {
code: 'bannerAdUnit1',
mediaTypes: {
banner: {
sizes: [[320, 480], [728, 90]] // required
}
},
bids: [{
bidder: 'visx',
params: {
uid: 903536 // required
}
}]
};
Example of Video Ad unit
var videoAdUnit = {
code: 'videoAdUnit1',
mediaTypes: {
video: {
context: 'instream', // required
playerSize: [400, 300], // required
mimes: ['video/mp4'] // optional, required by Prebid Server
}
},
bids: [{
bidder: 'visx',
params: {
uid: 921068 // required
}
}]
};
VOX
Features
Bidder Code |
vox |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
206 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vox |
hb_bidder_vox |
hb_adid_vox |
hb_size_vox |
hb_source_vox |
hb_format_vox |
hb_cache_host_vox |
hb_cache_id_vox |
hb_uuid_vox |
hb_cache_path_vox |
hb_deal_vox |
|
Note
You can use this adapter to get a bid from partners.hybrid.ai
Please reach out to your partners account team before using this plugin to get placementId.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The place id. |
‘5af45ad34d506ee7acad0c26’ |
string |
placement |
required |
Adunit placement, possible values: banner, video, inImage |
‘banner’ |
string |
imageUrl |
required for inImage |
URL of the image on which the banner will be displayed |
'https://example.com/images/image.jpg' |
string |
displaySizes |
optional, only supported by inImage format |
An array of strings. Each string should be in <Width>x<Height> format (currently, this parameter is supported only by PrebidServer vox adapter) |
["123x90", "720x100"] |
string[] |
Sample Banner Ad Unit
var adUnits = [{
code: 'banner_ad_unit',
mediaTypes: {
banner: {
sizes: [[728, 90]]
}
},
bids: [{
bidder: "vox",
params: {
placement: "banner", // required
placementId: "5af45ad34d506ee7acad0c26" // required
}
}]
}];
Sample Video Ad Unit
var adUnits = [{
code: 'video_ad_unit',
mediaTypes: {
video: {
context: 'outstream', // required, possible values: instream, outstream
playerSize: [[640, 480]] // required
}
},
bids: [{
bidder: "vox",
params: {
placement: "video", // required
placementId: "5af45ad34d506ee7acad0c26" // required
}
}]
}];
Sample In-Image Ad Unit
var adUnits = [{
code: 'test-div',
mediaTypes: {
banner: {
sizes: [0, 0]
}
},
bids: [{
bidder: "vox",
params: {
placement: "inImage",
placementId: "102030405060708090000020",
imageUrl: "https://hybrid.ai/images/image.jpg"
}
}]
}];
VRTCAL Markets Inc.
Features
Bidder Code |
vrtcal |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
706 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vrtcal |
hb_bidder_vrtcal |
hb_adid_vrtcal |
hb_size_vrtcal |
hb_source_vrtcal |
hb_format_vrtcal |
hb_cache_host_vrtcal |
hb_cache_id_vrtcal |
hb_uuid_vrtcal |
hb_cache_path_vrtcal |
hb_deal_vrtcal |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
(none) |
optional |
no params required |
'' |
n/a |
vungle
Features
Bidder Code |
vungle |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
None |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
no |
Safeframes OK |
no |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
none |
ORTB Blocking Support |
partial |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_vungle |
hb_bidder_vungle |
hb_adid_vungle |
hb_size_vungle |
hb_source_vungle |
hb_format_vungle |
hb_cache_host_vungle |
hb_cache_id_vungle |
hb_uuid_vungle |
hb_cache_path_vungle |
hb_deal_vungle |
|
Note
The Vungle Bidding adapter requires setup before beginning. Please contact us at vxssp@liftoff.io.
Bid Params
Name |
Scope |
Description |
Example |
Type |
bid_token |
required |
super token |
‘aaaa123’ |
string |
app_store_id |
optional |
pub appstore id |
‘5123400’ |
string |
placement_reference_id |
optional |
placement reference id |
‘912340000’ |
string |
xe.works
Features
Bidder Code |
xe |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_xe |
hb_bidder_xe |
hb_adid_xe |
hb_size_xe |
hb_source_xe |
hb_format_xe |
hb_cache_host_xe |
hb_cache_id_xe |
hb_uuid_xe |
hb_cache_path_xe |
hb_deal_xe |
|
Note
The Xe.works adapter requires setup before beginning. Please contact us at team@xe.works
Prebid.js Bid params
Name |
Scope |
Description |
Example |
Type |
placement |
required |
Placement ID |
test-banner |
string |
env |
required |
Environment name |
xe |
string |
ext |
optional |
Specific integration config |
{} |
object |
Prebid Server Bid Params
Name |
Scope |
Description |
Example |
Type |
env |
required |
Environment name |
xe-stage |
string |
pid |
required |
Uniq placement ID |
dc230510222b516f0eb9a10e5913d3b5 |
string |
XTRM QB
Features
Bidder Code |
xtrmqb |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-one |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
no |
First Party Data Support |
no |
User IDs |
all |
ORTB Blocking Support |
yes |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_xtrmqb |
hb_bidder_xtrmqb |
hb_adid_xtrmqb |
hb_size_xtrmqb |
hb_source_xtrmqb |
hb_format_xtrmqb |
hb_cache_host_xtrmqb |
hb_cache_id_xtrmqb |
hb_uuid_xtrmqb |
hb_cache_path_xtrmqb |
hb_deal_xtrmqb |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
host |
required |
Ad network’s RTB host |
'ortb.tech' |
string |
publisherId |
required |
Publisher ID |
12345 |
integer |
Yahoo Advertising
Features
Bidder Code |
yahooAds |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
25 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
yes |
First Party Data Support |
no |
User IDs |
All |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yahooAds |
hb_bidder_yahooAds |
hb_adid_yahooAds |
hb_size_yahooAds |
hb_source_yahooAds |
hb_format_yahooAds |
hb_cache_host_yahooA |
hb_cache_id_yahooAds |
hb_uuid_yahooAds |
hb_cache_path_yahooA |
hb_deal_yahooAds |
|
Important Notice (JS vs PBS)
There are differences between our Prebid.js & Prebid-Server Yahoo Advertising adapters.
The Prebid-server adapter currently does not support:
- Integration via the
pubId
method.
Prebid.js Mandatory Bid Params
The Prebid.js Yahoo Advertising bid adapter supports 2 alternate integration types:
- dcn & pos (Site/App & Position explicit targeting) - For legacy “aol”, “oneMobile” adapter partners/publishers.
- pubId (Publisher ID) - For new partners/publishers joining Yahoo Advertising and legacy “oneVideo” partners/publishers migrating to Yahoo Advertising.
Prebid-Server Mandatory Bid Params
Prebid-server Yahoo Advertising bid adapter supports one integration method:
- dcn & pos (Site/App & Position explicit targeting) - For legacy “aol”, “oneMobile” adapter partners/publishers.
DCN & POS Integration Parameters (JS & PBS)
For legacy “aol”, “oneMobile” adapter partners/publishers.
Name |
Scope |
Description |
Example |
Type |
dcn |
Required |
Site ID provided by Yahoo Advertising |
‘site1’ |
string |
pos |
Required |
Placement ID provided by Yahoo Advertising |
‘placement1’ |
string |
PubId Integration Parameters (JS Only)
For new partners/publishers joining Yahoo Advertising and legacy “oneVideo” partners/publishers migrating to Yahoo Advertising.
Name |
Scope |
Description |
Example |
Type |
pubId |
Required |
Your Publisher External ID provided by Yahoo Advertising |
‘DemoPublisher’ |
string |
siteId |
Optional |
Ability to target a specific Site using an External ID provided by Yahoo Advertising |
‘1234567’ |
string |
placementId |
Optional |
Ability to target a specific Placement using an External ID provided by Yahoo Advertising |
‘header’ |
string |
Prebid.js Adapter Supported Features
For further setup details & examples please see https://github.com/prebid/Prebid.js/blob/master/modules/yahooAdsBidAdapter.md
- Media Types: Banner & Video
- Outstream renderer
- Multi-format adUnits
- Schain module
- Price floors module
- Advertiser domains
- End-2-End self-served testing mode
- Outstream renderer/Player
- User ID Modules - ConnectId and others
- First Party Data (ortb2 & ortb2Imp)
- Custom TTL (time to live)
Yandex
Features
Bidder Code |
yandex |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
topics |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yandex |
hb_bidder_yandex |
hb_adid_yandex |
hb_size_yandex |
hb_source_yandex |
hb_format_yandex |
hb_cache_host_yandex |
hb_cache_id_yandex |
hb_uuid_yandex |
hb_cache_path_yandex |
hb_deal_yandex |
|
Prebid Client
This Adapter integrates with Yandex’s ad services.
For detailed auction analytics, check out our Analytics Adapter.
To improve the personalization of ads for publishers’ users, check out our User ID Module.
Client Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Ad unit ID. Prebid versions > 7.30 |
R-A-1234567-1 |
String |
cur |
optional |
CPM currency to be received. Prebid versions > 8.4 |
CHF , GBP , USD , EUR , TRY |
String |
pageId |
optional, deprecated in favor of placementId |
Page ID |
123 |
Integer |
impId |
optional, deprecated in favor of placementId |
Imp ID |
1 |
Integer |
Client Test Parameters
// Simple banner
const adUnits = [{
code: 'banner-1',
mediaTypes: {
banner: {
sizes: [[240, 400]],
}
},
bids: [
{
bidder: 'yandex',
params: {
placementId: 'R-A-1234567-1',
cur: 'USD',
},
}
]
}];
// Native
const adUnits = [{
code: 'native-1',
mediaTypes: {
native: {
sendTargetingKeys: false,
ortb: {
assets: [{
id: 1,
required: 1,
img: {
type: 3,
w: 300,
h: 300,
}
},
{
id: 2,
required: 1,
title: {
len: 80
}
},
{
id: 3,
required: 1,
data: {
type: 1
}
}
]
}
}
},
bids: [
{
bidder: 'yandex',
params: {
placementId: 'R-A-346580-140', // native adunit ID
cur: 'USD' // EUR, TRY, etc.
},
}
]
}];
Topics Iframe Configuration
Topics First Party Data (FPD) Module topicsFpdModule
should be included in prebid final package to call topics API.
pbjs.setConfig({
userSync: {
// ...,
topics: {
bidders: [{
bidder: 'yandex',
iframeURL: 'https://yandex.ru/ads/prebid/topics_frame.html'
}]
}
// ...
}
})
Prebid Server
We maintain both PBS Java and PBS Go adapters, but PBS Go is recommended for integration and will receive updates first
Server Bid Params
These params are basically the same that you’d use for
Name |
Scope |
Description |
Example |
Type |
Supported in |
placement_id |
required |
Ad unit ID. Prebid versions > 7.30 |
R-A-1234567-1 |
String |
PBS Go |
page_id |
optional, deprecated in favor of placement_id |
Page ID |
123 |
Integer |
PBS Go, PBS Java |
imp_id |
optional, deprecated in favor of placement_id |
Imp ID |
1 |
Integer |
PBS Go, PBS Java |
Prebid Server Test Request
The following test parameters can be used to verify that Prebid Server is working properly with the
server-side adapter.
"imp": [{
"id": "imp_id",
"banner": {
"w": 300,
"h": 600
},
"ext": {
"bidder": {
"placement_id": "R-A-1234567-1"
}
}
}]
YeahMobi
Features
Bidder Code |
yeahmobi |
Prebid.org Member |
yes |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display, native |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yeahmobi |
hb_bidder_yeahmobi |
hb_adid_yeahmobi |
hb_size_yeahmobi |
hb_source_yeahmobi |
hb_format_yeahmobi |
hb_cache_host_yeahmo |
hb_cache_id_yeahmobi |
hb_uuid_yeahmobi |
hb_cache_path_yeahmo |
hb_deal_yeahmobi |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
pubId |
required |
Publisher ID |
‘pub1’ |
string |
zoneId |
required |
Zone Id |
‘zone1’ |
string |
Yieldlab
Features
Bidder Code |
yieldlab |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video, native |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
yes |
IAB GVL ID |
70 |
GPP Support |
check with bidder |
DSA Support |
yes |
USP/CCPA Support |
no |
COPPA Support |
no |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
yes |
Floors Module Support |
yes |
First Party Data Support |
yes |
User IDs |
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId |
ORTB Blocking Support |
no |
Privacy Sandbox |
check with bidder |
Prebid Server App 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_yieldlab |
hb_bidder_yieldlab |
hb_adid_yieldlab |
hb_size_yieldlab |
hb_source_yieldlab |
hb_format_yieldlab |
hb_cache_host_yieldl |
hb_cache_id_yieldlab |
hb_uuid_yieldlab |
hb_cache_path_yieldl |
hb_deal_yieldlab |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
adslotId |
required |
Yieldlab Adslot ID |
'12345' |
string |
supplyId |
required |
Yieldlab Supply ID. Please reach out to your account management for more information. |
'12345' |
string |
targeting |
optional |
Key-Value Targeting |
{ 'key1': 'value1', 'key2': 'value2' } |
object |
extId |
optional |
External Id |
'abc' |
string |
iabContent |
optional |
Object of content information, see IAB Content Object for details. It will override the content object passed in First Party Data |
{ 'id': 'foo', 'title': 'bar' } |
object |
customParams |
optional |
Custom parameters to append to the query string of the bidding endpoint. |
{ 'param': 'value1', 'param2': 'value2' } |
object |
IAB Content Object
Yieldlab supports passing the IAB content object according to section 3.2.16
of the OpenRTB 2.6 specification. The following attributes are
supported, and all of them are optional:
id
episode
title
series
season
artist
genre
album
isrc
producer
id
name
cattax
cat
domain
url
cattax
cat
prodq
context
contentrating
userrating
qagmediarating
keywords
livestream
sourcerelationship
len
language
embeddable
data
network
channel
Yieldmo
Features
Bidder Code |
yieldmo |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
173 |
GPP Support |
some (check with bidder) |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
check with bidder |
Supply Chain Support |
yes |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
pubCommonId, unifiedId, criteo, sharedId |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldmo |
hb_bidder_yieldmo |
hb_adid_yieldmo |
hb_size_yieldmo |
hb_source_yieldmo |
hb_format_yieldmo |
hb_cache_host_yieldm |
hb_cache_id_yieldmo |
hb_uuid_yieldmo |
hb_cache_path_yieldm |
hb_deal_yieldmo |
|
Registration
Note: In order to use Yieldmo adapter please reach out to your Yieldmo account’s person or support@yieldmo.com for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
Yieldmo placement id |
'825209316101005155' |
string |
bidFloor |
optional |
Bid Floor |
0.1 |
float |
lr_env |
optional |
Live Ramp ATS envelope |
e3b0c44298fc1c149a |
string |
video parameters
The Yieldmo adapter supports in-stream video as of Prebid v4.18. Out-stream will be supported as of Prebid v4.35.0.
Name |
Scope |
Description |
Example |
Type |
placement |
required |
Video placement type. In-Stream: 1 ; Out-stream types: In-Article - 3 : In-Feed - 4 ; Interstitial - 5 ;
Currently we are not supporting 2 - in-banner.
See OpenRTB 2.5 specification, List 5.9 for more details |
1 |
integer |
maxduration |
required |
Maximum ad duration in seconds |
20 |
integer |
minduration |
optional |
Minimum ad duration in seconds |
5 |
integer |
pos |
optional |
Ad position on screen; see OpenRTB 2.5 specification, List 5.4 for more details |
1 |
integer |
startdelay |
required for in-stream |
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 ;
For out-stream is’ always 0 |
5 |
integer |
protocols |
required |
Supported video bid response protocols. VAST 1.0: 1 ; VAST 2.0: 2 ; VAST 3.0: 3 ; VAST 1.0 Wrapper: 4 ; VAST 2.0 Wrapper: 5 ; VAST 3.0 Wrapper: 6 ; |
[2, 3] |
Array<integer> |
api |
required |
API frameworks supported. VPAID 1.0: 1 ; VPAID 2.0: 2 ; MRAID-1: 3 ; ORMMA: 4 ; MRAID-2: 5 ; MRAID-3: 6 ; |
[1, 2] |
Array<integer> |
playbackmethod |
required |
Playback methods that may be in use; see OpenRTB 2.5 specification, List 5.10 for more details. Out-stream is only always 2 |
[2,6] |
Array<integer> |
skippable |
optional |
If ‘true’, user can skip ad |
true |
boolean |
skipafter |
optional |
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable |
5 |
integer |
mimes |
required |
List of the content MIME types supported by the player |
["video/mp4"] |
Array<string> |
Following video parameters might be also defined in mediaTypes.video
in order to simplify bidders configuration. If the same parameters was also defined in params.video
it will be overriten by params.video
. More details - https://docs.prebid.org/dev-docs/adunit-reference.html
In addition, Yieldmo adapter relies on parameters specified in the mediaTypes.video
definition of the video ad-units, namely:
Name |
Scope |
Description |
Example |
Type |
playerSize |
required |
Width and height of the player |
[640, 480] |
Array<integer> |
context |
required |
instream or outstream are only supported |
instream |
string |
Example of in-stream Video Ad-unit
var videoAdUnits = [{
code: 'div-video-ad-1234567890',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'instream',
mimes: ['video/mp4'], // required, array of strings
placement: 1, // required, integer
maxduration: 30, // required, integer
minduration: 15, // optional, integer
pos: 1, // optional, integer
startdelay: 10, // required if placement == 1
protocols: [2, 3], // required, array of integers
api: [2, 3], // required, array of integers
playbackmethod: [2,6], // required, array of integers
skip: 1, // optional, boolean
skipafter: 10 // optional, integer
}
},
bids: [{
bidder: 'yieldmo',
params: {
placementId: '1524592390382976659',// required,
}
}]
}];
Example of out-stream Video Ad-unit
var videoAdUnit = [{
code: 'div-video-ad-1234567890',
mediaTypes: {
video: {
playerSize: [640, 480], // required
context: 'outstream',
mimes: ['video/mp4'], // required, array of strings
placement: 3, // required, integer ( 3,4,5 )
maxduration: 30, // required, integer
protocols: [2, 3], // required, array of integers
api: [2, 3], // required, array of integers
playbackmethod: [1,2] // required, array of integers
}
},
bids: [{
bidder: 'yieldmo',
params: {
placementId: '1524592390382976659', // required
}
}]
}];
Prebid out-stream demo
YieldOne
Features
Bidder Code |
yieldone |
Prebid.org Member |
no |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
will-bid-on-any |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
identityLink, imuid, AudienceOne ID, ID5 |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldone |
hb_bidder_yieldone |
hb_adid_yieldone |
hb_size_yieldone |
hb_source_yieldone |
hb_format_yieldone |
hb_cache_host_yieldo |
hb_cache_id_yieldone |
hb_uuid_yieldone |
hb_cache_path_yieldo |
hb_deal_yieldone |
|
Note
THE YieldOne adapter requires setup and approval from the YieldOne team.
Please reach out to your account team or y1s@platform-one.co.jp for more information.
Bid Params
Name |
Scope |
Description |
Example |
Type |
placementId |
required |
The placement ID |
"36891" |
string |
playerSize |
optional |
Video Resolution Size (This field is mandatory if mediaTypes.video.playerSize is [1, 1]) |
[640, 360] |
array of number |
playerParams |
optional |
Video Player Params (see below) |
{} |
object |
playerParams.wrapperWidth |
optional |
Video Player Width |
"320px" |
string |
playerParams.wrapperHeight |
optional |
Video Player Height |
"180px" |
string |
If you use Multi-Format Ad Units, “video” bid object should be placed before “banner” bid object.
And if Bid Params contains playerParams, it will request a “video” media type ad.
If it does not, it will request a “banner” media type ad.
var bannerAdUnits = [{
code: "test-div-banner",
mediaTypes: {
banner: {
sizes: [
[300, 250],
[1, 1]
]
},
},
bids: [{
bidder: "yieldone",
params: {
placementId: "36891" // required
}
}]
}]
var videoAdUnits = [{
code: "test-div-video",
mediaTypes: {
video: {
playerSize: [640, 360],
context: "outstream"
}
},
bids: [{
bidder: "yieldone",
params: {
placementId: "36892", // required
playerParams: { // optional
wrapperWidth: "320px", // optional
wrapperHeight: "180px" // optional
},
}
}]
}]
var multiAdUnits = [{
code: "test-div-multi",
mediaTypes: {
banner: {
sizes: [
[300, 250],
[1, 1]
]
},
video: {
playerSize: [640, 360],
context: "outstream"
}
},
bids: [{
// * "video" bid object should be placed before "banner" bid object.
// This bid will request a "video" media type ad.
bidder: "yieldone",
params: {
placementId: "36892", // required
playerParams: { // required
wrapperWidth: "320px", // optional
wrapperHeight: "180px" // optional
},
}
},
{
// This bid will request a "banner" media type ad.
bidder: "yieldone",
params: {
placementId: "36891" // required
}
}]
}];
var videoAdUnits = [{
code: "test-div-video",
mediaTypes: {
video: {
playerSize: [1, 1],
context: "outstream"
}
},
bids: [{
bidder: "yieldone",
params: {
placementId: "36892", // required
playerSize: [640, 360], // required
playerParams: { // optional
wrapperWidth: "320px", // optional
wrapperHeight: "180px" // optional
},
}
}]
}]
var multiAdUnits = [{
code: "test-div-multi",
mediaTypes: {
banner: {
sizes: [
[300, 250],
[1, 1]
]
},
video: {
playerSize: [1, 1],
context: "outstream"
}
},
bids: [{
// * "video" bid object should be placed before "banner" bid object.
// This bid will request a "video" media type ad.
bidder: "yieldone",
params: {
placementId: "36892", // required
playerSize: [640, 360], // required
playerParams: { // required
wrapperWidth: "320px", // optional
wrapperHeight: "180px" // optional
},
}
},
{
// This bid will request a "banner" media type ad.
bidder: "yieldone",
params: {
placementId: "36891" // required
}
}]
}];
ZeroClickFraud
Features
Bidder Code |
zeroclickfraud |
Prebid.org Member |
no |
Prebid.js Adapter |
no |
Prebid Server Adapter |
yes |
Media Types |
display |
Multi Format Support |
check with bidder |
TCF-EU Support |
no |
IAB GVL ID |
check with bidder |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
check with bidder |
COPPA Support |
check with bidder |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
check with bidder |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
none |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_zeroclickfraud |
hb_bidder_zeroclickf |
hb_adid_zeroclickfra |
hb_size_zeroclickfra |
hb_source_zeroclickf |
hb_format_zeroclickf |
hb_cache_host_zerocl |
hb_cache_id_zeroclic |
hb_uuid_zeroclickfra |
hb_cache_path_zerocl |
hb_deal_zeroclickfra |
|
Bid Params
Name |
Scope |
Description |
Example |
Type |
sourceId |
required |
Website Source Id |
111 |
integer |
host |
required |
Network Host to request from |
‘host1’ |
string |
Zeta Global SSP
Features
Bidder Code |
zeta_global_ssp |
Prebid.org Member |
yes |
Prebid.js Adapter |
yes |
Prebid Server Adapter |
yes |
Media Types |
display, video |
Multi Format Support |
check with bidder |
TCF-EU Support |
yes |
IAB GVL ID |
469 |
GPP Support |
check with bidder |
DSA Support |
check with bidder |
USP/CCPA Support |
yes |
COPPA Support |
yes |
Supply Chain Support |
check with bidder |
Demand Chain Support |
check with bidder |
Safeframes OK |
check with bidder |
Supports Deals |
no |
Floors Module Support |
check with bidder |
First Party Data Support |
check with bidder |
User IDs |
all |
ORTB Blocking Support |
check with bidder |
Privacy Sandbox |
check with bidder |
Prebid Server App Support |
check with bidder |
"Send All Bids" Ad Server Keys
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_zeta_global_ss |
hb_bidder_zeta_globa |
hb_adid_zeta_global_ |
hb_size_zeta_global_ |
hb_source_zeta_globa |
hb_format_zeta_globa |
hb_cache_host_zeta_g |
hb_cache_id_zeta_glo |
hb_uuid_zeta_global_ |
hb_cache_path_zeta_g |
hb_deal_zeta_global_ |
|
Registration
All references to the OpenRTB spec refer to OpenRtb v2.5 (https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf)
The Zeta Global SSP adapter requires setup and approval from the Zeta Global SSP team. Please reach out to your account team or rcomolli@zetaglobal.com for more information.
Bid Params
Prebid.js Bid Params
Name |
Scope |
Description |
Example |
Type |
sid |
required |
Seller ID. The identifier associated with the seller or reseller account within the advertising system |
123 |
integer |
tagid |
optional |
Identifier for specific ad placement or ad tag that was used to initiate the auction |
"footer" |
string |
tags |
optional |
The object containing set of Zeta’s custom tags witch publisher have to supply |
tags: {} |
object |
site |
optional |
The object containing site data (See OpenRTB spec) |
site: {} |
object |
app |
optional |
The object containing app data (See OpenRTB spec) |
app: {} |
object |
bidfloor |
optional |
The minimum bid value desired |
0.2 |
float |
test |
optional |
Flag which will induce a sample bid response when true; only set to true for testing purposes (1 = true, 0 = false) |
1 |
integer |
Prebid Server Bid Params
Prebid Server Adapter does not support any parameters.
You must get sid
value from Zeta Global and use it instead of the placeholder in the URL.