This page contains documentation on the specific parameters required by each supported bidder.
These docs only apply to Prebid.js bidders. For Prebid Server, AMP, or Prebid Mobile, see the
Prebid Server Bidders page.
For each bidder listed below, you’ll find the following information:
Bidder Code
The unique code Prebid.js uses to identify the bidder
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adagio
hb_bidder_adagio
hb_adid_adagio
hb_size_adagio
hb_source_adagio
hb_format_adagio
hb_cache_host_adagio
hb_cache_id_adagio
hb_uuid_adagio
"Deal ID" Ad Server Key
hb_deal_adagio
Note
The Adagio bidder adaptor requires setup and approval from the Adagio team. Please reach out to contact@adagio.io for more information.
Bid Params
Important: Adagio needs to collect attention data about the ads displayed on a page and must listen to some specifics ad-server events. Please refer to the Adagio user guide for details.
Name
Scope
Description
Example
Type
organizationId
required
Id of the Organization. Handed out by Adagio.
'1010'
string
site
required
Name of the site. Handed out by Adagio. - max length: 50
'mysite-com'
string
adUnitElementId
required
Refers to the adunit html attribute id in a page.
'gpt-ban-atf'
string
environment*
highly recommended
Environment where the page is displayed. - max length: 30 - max distinctives values: 10
'desktop'
string
placement*
highly recommended
Refers to the placement of an adunit in a page. Must not contain any information about the type of device. - max length: 30 - max distinctives values: 10
'ban_atf'
string
pagetype*
recommended
Describes what kind of content will be present in the page. - max length: 30 - max distinctives values: 50
'article'
string
category*
recommended
Category of the content displayed in the page. - max length: 30 - max distinctives values: 50
'sport'
string
subcategory*
optional
Subcategory of the content displayed in the page. - max length: 30 - max distinctives values: 50
'handball'
string
postBid
optional
Used in Post-Bid context only.
true
boolean
*These parameters will have its accentuated characters converted to their non-accentuated version: é => e
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adhese
hb_bidder_adhese
hb_adid_adhese
hb_size_adhese
hb_source_adhese
hb_format_adhese
hb_cache_host_adhese
hb_cache_id_adhese
hb_uuid_adhese
"Deal ID" Ad Server Key
hb_deal_adhese
Note
The Adhese bid adapter may require an additional setup from the Adhese team, even for existing Adhese customers. Please reach out to your support team or info@adhese.com for more information.
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.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtelligent
hb_bidder_adtelligen
hb_adid_adtelligent
hb_size_adtelligent
hb_source_adtelligen
hb_format_adtelligen
hb_cache_host_adtell
hb_cache_id_adtellig
hb_uuid_adtelligent
"Deal ID" Ad Server Key
hb_deal_adtelligent
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from Adtelligent.
350975
integer
Description
Get access to multiple demand partners across Adtelligent AdExchange and maximize your yield with Adtelligent header bidding adapter.
Adtelligent header bidding adapter connects with Adtelligent demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aduptech
hb_bidder_aduptech
hb_adid_aduptech
hb_size_aduptech
hb_source_aduptech
hb_format_aduptech
hb_cache_host_adupte
hb_cache_id_aduptech
hb_uuid_aduptech
"Deal ID" Ad Server Key
hb_deal_aduptech
Note:
The AdUp Technology bidding adapter requires setup and approval before beginning.
For more information visit www.adup-tech.com or contact info@adup-tech.com.
Bid params
Name
Scope
Description
Example
publisher
required
Unique publisher id
'1234'
placement
required
Unique placement id per publisher
'5678'
query
optional
Semicolon separated list of keywords
'urlaub;ibiza;mallorca'
adtest
optional
Impressions and clicks will not be tracked if enabled
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adyoulike
hb_bidder_adyoulike
hb_adid_adyoulike
hb_size_adyoulike
hb_source_adyoulike
hb_format_adyoulike
hb_cache_host_adyoul
hb_cache_id_adyoulik
hb_uuid_adyoulike
"Deal ID" Ad Server Key
hb_deal_adyoulike
Note:
The Adyoulike Header Bidding adaptor requires setup and approval from the Adyoulike team. Please reach out to your account manager or prebid@adyoulike.com for more information.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aol
hb_bidder_aol
hb_adid_aol
hb_size_aol
hb_source_aol
hb_format_aol
hb_cache_host_aol
hb_cache_id_aol
hb_uuid_aol
"Deal ID" Ad Server Key
hb_deal_aol
Note:
This adapter allows use of both ONE by AOL: Display and ONE by AOL: Mobile platforms. In order to differentiate these sources of demand in your ad server and reporting, you may use the optional onedisplay and onemobile adapter aliases instead.
Bid Params
ONE by AOL: Display
Name
Scope
Description
Example
Type
placement
required
The placement ID from AOL.
'23324932'
string
network
required
The network ID from AOL.
'5071.1'
string
alias
optional
The placement alias from AOL.
'desktop_articlepage_something_box_300_250'
string
server
optional
The server domain name. Default is adserver-us.adtech.advertising.com. EU customers must use adserver-eu.adtech.advertising.com, and Asia customers adserver-as.adtech.advertising.com.
'adserver-eu.adtech.advertising.com'
string
bidFloor
optional
Dynamic bid floor (added in Prebid 0.8.1)
'0.80'
string
ONE by AOL: Mobile
Name
Scope
Description
Example
Type
dcn
required
Site ID provided by ONE.
'2c9d2b50015a5aa95b70a9b0b5b10012'
string
pos
required
Position on a page where an ad will appear.
'header'
string
ext
optional
Object that allows the client to send any extra parameters.
All AppNexus placements included in a single call to requestBids must belong to the same parent Publisher. If placements from two different publishers are included in the call, the AppNexus bidder will not return any demand for those placements. Note: This requirement does not apply to adapters that are aliasing the AppNexus adapter.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. The placementID parameter can be either a string or integer for Prebid.js, however integer is preferred. Legacy code can retain the stringvalue. Prebid Server requires an integer value.
234234
integer
member
optional
The member ID from AppNexus. Must be used with invCode.
'12345'
string
invCode
optional
The inventory code from AppNexus. Must be used with member.
'abc123'
string
user
optional
Object that specifies information about an external user. See User Object for details.
user: { age: 25, gender: 0, dnt: true}
object
allowSmallerSizes
optional
If true, ads smaller than the values in your ad unit’s sizes array will be allowed to serve. Defaults to false.
true
boolean
usePaymentRule
optional
If true, Appnexus will return net price to Prebid.js after publisher payment rules have been applied.
Object containing mobile app parameters. See the App Object for details.
app : { id: 'app-id'}
object
reserve
optional
Sets a floor price for the bid that is returned. If floors have been configured in the AppNexus Console, those settings will override what is configured here.
0.90
float
position
optional
Identify the placement as above or below the fold. Allowed values: Unknown: unknown; Above the fold: above; Below the fold: below
'above'
string
trafficSourceCode
optional
Specifies the third-party source of this impression.
'my_traffic_source'
string
supplyType
optional
Indicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app
'web'
string
pubClick
optional
Specifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using AppNexus click tracking properly.
'http://click.adserver.com/'
string
extInvCode
optional
Specifies predefined value passed on the query string that can be used in reporting. The value must be entered into the system before it is logged.
'10039'
string
externalImpId
optional
Specifies the unique identifier of an externally generated auction.
'bacbab02626452b097f6030b3c89ac05'
string
Video Object
Name
Description
Type
mimes
Array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"].
Array<string>
minduration
Integer that defines the minimum video ad duration in seconds.
integer
maxduration
Integer that defines the maximum video ad duration in seconds.
integer
startdelay
Integer that determines whether to show the ad before, during, or after video content. If > 0, position is mid-roll and value indicates start delay, in seconds. Allowed values: Pre-roll: 0 (default); Mid-roll: -1 ; Post-roll: -2.
integer
skippable
Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false.
boolean
playback_method
Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown".
Array<string>
frameworks
Array of integers listing API frameworks supported by the publisher. Allowed values: None: 0; VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5.
Array<integer>
User Object
Name
Description
Example
Type
age
The age of the user.
35
integer
externalUid
Specifies a string that corresponds to an external user ID for this user.
'1234567890abcdefg'
string
segments
Specifies the segments to which the user belongs.
[1, 2]
Array<integer>
gender
Specifies the gender of the user. Allowed values: Unknown: 0; Male: 1; Female: 2
1
integer
dnt
Do not track flag. Indicates if tracking cookies should be disabled for this auction
true
boolean
language
Two-letter ANSI code for this user’s language.
EN
string
App Object
AppNexus supports using prebid within a mobile app’s webview. If you are interested in using an SDK, please see Prebid Mobile instead.
Name
Description
Example
Type
id
The App ID.
'B1O2W3M4AN.com.prebid.webview'
string
device_id
Object that contains the advertising identifiers of the user (idfa, aaid, md5udid, sha1udid, or windowsadid).
{ aaid: "38400000-8cf0-11bd-b23e-10b96e40000d" }
object
geo
Object that contains the latitude (lat) and longitude (lng) of the user.
{ lat: 40.0964439, lng: -75.3009142 }
object
Custom Targeting keys
AppNexus returns custom keys that can be sent to the adserver through bidderSettings: buyerMemberId, dealPriority, and dealCode. The following snippet demonstrates how to add these custom keys as key-value pairs.
pbjs.bidderSettings = {
appnexus: {
adserverTargeting: [
{
key: "apn_buyer_memberid", // Use key configured in your adserver
val: function(bidResponse) {
return bidResponse.appnexus.buyerMemberId;
}
},
{
key: "apn_prio", // Use key configured in your adserver
val: function(bidResponse) {
return bidResponse.appnexus.dealPriority;
}
}, {
key: "apn_dealcode", // Use key configured in your adserver
val: function(bidResponse) {
return bidResponse.appnexus.dealCode;
}
}
]
}
}
Passing Keys Without Values
It’s possible to use the keywords parameter to define keys that do not have any associated values. Keys with empty values can be created in Prebid.js and can also be sent through Prebid Server to AppNexus. The following are examples of sending keys with empty values:
keywords: {
myKeyword: '',
myOtherKeyword: ['']
}
The preceding example passes the key myKeyword with an empty value. The key myOtherKeyword contains an empty value array.
You can define keys with values and without values in the same keywords definition. In this next example, we’ve defined the key color with an array of values: red, blue, and green. We’ve followed that with the key otherKeyword with an empty value array.
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:
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_astraone
hb_bidder_astraone
hb_adid_astraone
hb_size_astraone
hb_source_astraone
hb_format_astraone
hb_cache_host_astrao
hb_cache_id_astraone
hb_uuid_astraone
"Deal ID" Ad Server Key
hb_deal_astraone
Note
You can use this adapter to get a bid from AstraOne.
Please reach out to your AstraOne account team before using this plugin to get placeId.
The code below returns a demo ad.
Bid Params
Name
Scope
Description
Example
Type
placeId
required
The place id.
‘5af45ad34d506ee7acad0c26’
string
imageUrl
required
URL of the image on which the banner will be displayed.
These are 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
"Deal ID" Ad Server Key
hb_deal_beintoo
Bid Params
| Name | Scope | Description | Example | Type |
|—————|———-|————-|———|———-|
| placementId | required | | | string |
Beintoo is an aliased bidder for AppNexus
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brightcom
hb_bidder_brightcom
hb_adid_brightcom
hb_size_brightcom
hb_source_brightcom
hb_format_brightcom
hb_cache_host_bright
hb_cache_id_brightco
hb_uuid_brightcom
"Deal ID" Ad Server Key
hb_deal_brightcom
Note:
The Brightcom bidder adapter requires setup and approval from the Brightcom team. Please reach out to your account manager for more information and to start using it.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cedato
hb_bidder_cedato
hb_adid_cedato
hb_size_cedato
hb_source_cedato
hb_format_cedato
hb_cache_host_cedato
hb_cache_id_cedato
hb_uuid_cedato
"Deal ID" Ad Server Key
hb_deal_cedato
Bid params
Name
Scope
Description
Example
Type
player_id
required
The player ID from Cedato
1450133326
integer
bidfloor
optional
Bid floor value
0.01
integer
Note
The Cedato adapter requires setup and approval from the Cedato team.
Please reach out to your account team or publishers@cedato.com for more information.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_consumable
hb_bidder_consumable
hb_adid_consumable
hb_size_consumable
hb_source_consumable
hb_format_consumable
hb_cache_host_consum
hb_cache_id_consumab
hb_uuid_consumable
"Deal ID" Ad Server Key
hb_deal_consumable
Note:
The Consumable adaptor requires setup and approval from your Consumable account manager, even for existing Consumable publishers. Please reach out to your account manager to enable Prebid.js for your account.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cosmos
hb_bidder_cosmos
hb_adid_cosmos
hb_size_cosmos
hb_source_cosmos
hb_format_cosmos
hb_cache_host_cosmos
hb_cache_id_cosmos
hb_uuid_cosmos
"Deal ID" Ad Server Key
hb_deal_cosmos
Integration Note:
Cosmos bidder adapter requires setup and approval from the Cosmos team. Please reach out to your account manager for more information and to start using it.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_criteo
hb_bidder_criteo
hb_adid_criteo
hb_size_criteo
hb_source_criteo
hb_format_criteo
hb_cache_host_criteo
hb_cache_id_criteo
hb_uuid_criteo
"Deal ID" Ad Server Key
hb_deal_criteo
Note
For Native Ads, in order to avoid further decoding issues of special characters, the assets need to be sent as placeholders.
That means, sendId: true becomes mandatory for all fields receiving URLs, notably: icon, image, clickUrl, privacyLink, privacyIcon.
The network ID from Criteo.Please reach out your Criteo representative for more details.
456456
integer
nativeCallback
optional
Callback to perform render in native integrations. Please reach out your Criteo representative for more details.
function(payload) { console.log(payload); }
function
integrationMode
optional
Integration mode to use for ad render (none or ‘AMP’). Please reach out your Criteo representative for more details.
'AMP'
string
Video Object
Name
Scope
Description
Example
Type
minduration
optional
Minimum ad duration in seconds
5
integer
startdelay
optional
Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: 0 (default); Mid-roll: >0; Default mid-roll: -1; Post-roll: -2;
5
integer
playbackmethod
required
Defines how is initiated the video inventory. Page Load with Sound On: 1; Page Load with Sound Off: 2; Click with Sound On: 3; Mouse-Over with Sound On: 4; Entering Viewport with Sound On: 5; Entering Viewport with Sound Off by Default: 6;
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_danmarket
hb_bidder_danmarket
hb_adid_danmarket
hb_size_danmarket
hb_source_danmarket
hb_format_danmarket
hb_cache_host_danmar
hb_cache_id_danmarke
hb_uuid_danmarket
"Deal ID" Ad Server Key
hb_deal_danmarket
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the DAN Marketplace bidder system Ad Slot ID associated with the respective div id from the site page.
5
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the DAN Marketplace bidder margin within.
These are 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
"Deal ID" Ad Server Key
hb_deal_deepintent
Bid Params
Name
Scope
Description
Example
Type
tagId
mandatory
Ad Tag Id
'1399'
string
height
optional
height of the creative
350
number
width
optional
width of the creative
250
number
custom
optional
custom key value params
'{"position":"right-box"}''
object
user
optional
user params according to IAB standards
'{"gender":"F"}''
object
pos
optional
ad position as per IAB standards
1
number
Configuration
Deepintent recommends the UserSync configuration below. Without it, the Deepintent adapter will not able to perform user syncs, which lowers match rate and reduces monetization.
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// '*' represents all biddersfilter:'include'}}}});
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_fairtrade
hb_bidder_fairtrade
hb_adid_fairtrade
hb_size_fairtrade
hb_source_fairtrade
hb_format_fairtrade
hb_cache_host_fairtr
hb_cache_id_fairtrad
hb_uuid_fairtrade
"Deal ID" Ad Server Key
hb_deal_fairtrade
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the FairTrade bidder system Ad Slot ID associated with the respective div id from the site page.
5
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the FairTrade bidder margin within.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_fyber
hb_bidder_fyber
hb_adid_fyber
hb_size_fyber
hb_source_fyber
hb_format_fyber
hb_cache_host_fyber
hb_cache_id_fyber
hb_uuid_fyber
"Deal ID" Ad Server Key
hb_deal_fyber
Bid Params
Name
Scope
Description
Example
Type
appId
required
The app. ID provided by Inneractive
'Company_App_OS'
string
adSpotType
required
The ad spot type ('BANNER'/RECTANGLE)
'BANNER'
string
customParams
optional
Allows passing custom parameters in the bid request. See more details at: https://confluence.inner-active.com/display/DevWiki/IA+Adapter+AdUnit+Bidder+Configuration
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gamoshi
hb_bidder_gamoshi
hb_adid_gamoshi
hb_size_gamoshi
hb_source_gamoshi
hb_format_gamoshi
hb_cache_host_gamosh
hb_cache_id_gamoshi
hb_uuid_gamoshi
"Deal ID" Ad Server Key
hb_deal_gamoshi
Bid params
Name
Scope
Description
Example
Type
supplyPartnerId
required
ID of the supply partner you created in the Gamoshi dashboard.
'12345'
string
rtbEndpoint
optional
If you have a whitelabel account on Gamoshi, specify it here.
'rtb.mybidder.com'
string
This adapter only requires you to provide your supply partner ID, and optionally your RTB endpoint, in order to request
bids from your Gamoshi account.
The list of the restricted VAST protocol versions. Possible values: 1 – VAST 1.0, 2 – VAST 2.0, 3 – VAST 3.0, 4 – VAST 1.0 Wrapper, 5 – VAST 2.0 Wrapper, 6 – VAST 3.0 Wrapper.
[4,5,6]
Array<integer>
mimes
optional
Array of Mime Type strings.
['application/javascript']
Array<string>
min_dur
optional
Minimal video duration.
30
integer
max_dur
optional
Maximal video duration.
30
integer
min_btr
optional
Minimal Video bitrate.
256
integer
max_btr
optional
Maximal Video bitrate.
512
integer
vi_format
optional
Video inventory format. Possible values: 1 - In-Stream video, 2 - Out-Stream video.
1
integer
api
optional
API of the inventory. Possible values: 1 - VPAID 1.0, 2 - VPAID 2.0, 3 - MRAID-1, 4 - ORMMA, 5 - MRAID-2.
[3,4]
Array<integer>
skippable
optional
Skippability of the inventory. Possible values (case insensitive): ALLOW - skippable inventory is allowed, NOT_ALLOW - skippable inventory is not allowed, REQUIRE - only skippable inventory is allowed, UNKNOWN - skippability is unknown (default value).
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gumgum
hb_bidder_gumgum
hb_adid_gumgum
hb_size_gumgum
hb_source_gumgum
hb_format_gumgum
hb_cache_host_gumgum
hb_cache_id_gumgum
hb_uuid_gumgum
"Deal ID" Ad Server Key
hb_deal_gumgum
Note:
The GumGum Header Bidding adaptor requires setup and approval from the GumGum
team. Please reach out to your account manager or support@gumgum.com for more
information.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gxone
hb_bidder_gxone
hb_adid_gxone
hb_size_gxone
hb_source_gxone
hb_format_gxone
hb_cache_host_gxone
hb_cache_id_gxone
hb_uuid_gxone
"Deal ID" Ad Server Key
hb_deal_gxone
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the GXOne bidder system Ad Slot ID associated with the respective div id from the site page.
2
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the GXOne bidder margin within.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ias
hb_bidder_ias
hb_adid_ias
hb_size_ias
hb_source_ias
hb_format_ias
hb_cache_host_ias
hb_cache_id_ias
hb_uuid_ias
"Deal ID" Ad Server Key
hb_deal_ias
Note:
This module is an integration with prebid.js with an IAS product, pet.js. It is not a bidder per se but works in a similar way: retrieve data that publishers might be interested in setting keyword targeting, like predicted viewability and brand safety words. Please reach out to your account manager or check out our publisher solutions for more
information.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_improvedigital
hb_bidder_improvedig
hb_adid_improvedigit
hb_size_improvedigit
hb_source_improvedig
hb_format_improvedig
hb_cache_host_improv
hb_cache_id_improved
hb_uuid_improvedigit
"Deal ID" Ad Server Key
hb_deal_improvedigit
Bid params
Depending on your setup in our system, your placements will either have a globally-unique placement ID or a publisher-unique placement key as an identifier. Therefore, to identify your placement you either need a placementId only, or a combination of publisherId and placementKey.
Name
Scope
Description
Example
Type
placementId
optional
The placement ID from Improve Digital.
1234567
integer
publisherId
optional
Your publisher ID. This is only required when using a placementKey
950
integer
placementKey
optional
The placement key for your placement. Must be used with publisherId.
'myMainBannerPlacement300x200'
string
keyValues
optional
Contains one or more key-value pairings for key-value targeting
Single size filter. Where a placement supports multiple sizes, this forces the response to feature only one of the multiple sizes. This parameter is ignored when usePrebidSizes is enabled (see Sizes section below)
By default, the adapter sends one request for each ad unit to Improve Digital’s ad server. For example, if there are 4 Prebid ad units defined on the page, you’ll see 4 calls out to ad.360yield.com/hb.
The Improve Digital adapter supports Single Request mode, where all ad unit requests are made in a single call to ad.360yield.com/hb. To turn this feature on, call setConfig:
By default, the adapter doesn’t send Prebid ad unit sizes to Improve Digital’s ad server and the sizes defined for each placement in the Polaris platform will be used. If the ad server should only respond with creative sizes as defined in Prebid ad unit configuration, turn on usePrebidSizes adapter parameter like this:
This module connects publishers to Index Exchange’s (IX) network of demand
sources through Prebid.js. This module is GDPR and CCPA compliant.
It is compatible with both the older ad unit format where the sizes and
mediaType properties are placed at the top-level of the ad unit, and the newer
format where this information is encapsulated within the mediaTypes object. We
recommend that you use the newer format when possible as it will be better able
to accommodate new feature additions.
If a mix of properties from both formats are present within an ad unit, the
newer format’s properties will take precedence.
Each of the IX-specific parameters provided under the adUnits[].bids[].params
object are detailed here.
Banner
Name
Scope
Description
Example
Type
siteId
Required
An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have.
'3723'
string
size
Required for client-side serving
The single size associated with the site ID. It should be one of the sizes listed in the ad unit under adUnits[].sizes or adUnits[].mediaTypes.banner.sizes. Note that the ‘ix’ Prebid Server bid adapter ignores this parameter.
[300, 250]
Array<integer>
id
Optional
An alphanumerical value used to identify the slot_id in reporting
id: 'billboardHomepage', id: 'billboardArticle'
string
Video
Name
Scope
Description
Example
Type
siteId
Required
An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have.
'3723'
string
size
Required
The single size associated with the site ID. It should be one of the sizes listed in the ad unit under adUnits[].sizes or adUnits[].mediaTypes.video.playerSize.
[300, 600]
Array<integer>
video
Required
The video object will serve as the properties of the video ad. You can create any field under the video object that is mentioned in the OpenRTB Spec v2.5. Some fields like mimes, protocols, minduration, maxduration are required.
video: { startdelay: 0 }
object
video.mimes
Required
Array list of content MIME types supported.
['video/mp4', 'video/x-flv']
Array<string>
video.minduration
Required
Minimum video ad duration in seconds.
0
integer
video.maxduration
Required
Maximum video ad duration in seconds.
300
integer
video.protocol / video.protocols
Required
Either a single protocol provided as an integer, or protocols provided as a list of integers. 2 - VAST 2.0, 3 - VAST 3.0, 5 - VAST 2.0 Wrapper, 6 - VAST 3.0 Wrapper
[2,3,5,6]
integer / Array<integer>
id
Optional
An alphanumerical value used to identify the slot_id in reporting
id: 'inStreamCTP', id: 'inStreamAutoPlay'
string
Setup Guide
Follow these steps to configure and add the IX module to your Prebid.js
integration.
The examples in this guide assume the following starting configuration (you may remove banner or video, if either does not apply).
In regards to video, context can either be 'instream' or 'outstream'. Note that outstream requires additional configuration on the adUnit.
Please note that you can re-use the existing siteId within the same flex
position.
Video (Outstream):
Note that currently, outstream video rendering must be configured by the publisher. In the adUnit, a renderer object must be defined, which includes a url pointing to the video rendering script, and a render function for creating the video player. See http://prebid.org/dev-docs/show-outstream-video-ads.html for more information.
FPD allows you to specify key-value pairs which will be passed as part of the
query string to IX for use in Private Marketplace Deals which rely on query
string targeting for activation. For example, if a user is viewing a
news-related page, you can pass on that information by sending category=news.
Then in the IX Private Marketplace setup screens you can create Deals which
activate only on pages which contain category=news. Please reach out to your
IX representative if you have any questions or need help setting this up.
To include FPD in a bid request, it must be set before pbjs.requestBids is
called. To set it, call pbjs.setConfig and provide it with a map of FPD keys
to values as such:
The values can be updated at any time by calling pbjs.setConfig again. The
changes will be reflected in any proceeding bid requests.
Setting a Server Side Timeout
Setting a server-side timeout allows you to control the max length of time taken to connect to the server. The default value when unspecified is 50ms.
This is distinctly different from the global bidder timeout that can be set in
Prebid.js in the browser.
To add a server-side timeout, it must be set before pbjs.requestBids is
called. To set it, call pbjs.setConfig and provide it with a timeout value as
such:
pbjs.setConfig({ix:{timeout:250}});
The timeout value must be a positive whole number in milliseconds.
Additional Information
Bid Request Limit
If a single bid request to IX contains more than 20 impression requests (i.e.
more than 20 objects in bidRequest.imp), only the first 20 will be accepted,
the rest will be ignored.
To avoid this situation, ensure that when pbjs.requestBid is invoked, that the
number of bid objects (i.e. adUnits[].bids) with adUnits[].bids[].bidder set
to 'ix' across all ad units that bids are being requested for does not exceed 20.
Time-To-Live (TTL)
Banner bids from IX have a TTL of 300 seconds while video bids have a TTL of 1 hour, after which time they become invalid.
If an invalid bid wins, and its associated ad is rendered, it will not count
towards total impressions on IX’s side.
FAQs
Why do I have to input size in adUnits[].bids[].params for IX when the size is already in the ad unit?
There are two important reasons why we require it:
An IX site ID maps to a single size, whereas an ad unit can have multiple
sizes. To ensure that the right site ID is mapped to the correct size in the ad
unit we require the size to be explicitly stated.
An ad unit may have sizes that IX does not support. By explicitly stating the
size, you can choose not to have IX bid on certain sizes that are invalid.
How do I view IX’s bid request in the network?
In your browser of choice, create a new tab and open the developer tools. In
developer tools, select the network tab. Then, navigate to a page where IX is
setup to bid. Now, in the network tab, search for requests to
casalemedia.com/cygnus. These are the bid requests.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_innity
hb_bidder_innity
hb_adid_innity
hb_size_innity
hb_source_innity
hb_format_innity
hb_cache_host_innity
hb_cache_id_innity
hb_uuid_innity
"Deal ID" Ad Server Key
hb_deal_innity
Note:
The Innity bidder adapter requires setup and approval from the Innity Media team, even for existing Innity Network publishers. Please reach out to your account manager for more information and to enable using this adapter.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_inskin
hb_bidder_inskin
hb_adid_inskin
hb_size_inskin
hb_source_inskin
hb_format_inskin
hb_cache_host_inskin
hb_cache_id_inskin
hb_uuid_inskin
"Deal ID" Ad Server Key
hb_deal_inskin
Note:
The Inskin bidder adapter requires additional setup and approval from the Inskin Media Integrations team. Please reach out to your account manager for more information and to start using it.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kargo
hb_bidder_kargo
hb_adid_kargo
hb_size_kargo
hb_source_kargo
hb_format_kargo
hb_cache_host_kargo
hb_cache_id_kargo
hb_uuid_kargo
"Deal ID" Ad Server Key
hb_deal_kargo
Note:
Kargo is an invitation-only marketplace. Please reach out to your Kargo account manager to get setup. Also, you must test on a mobile device, or emulate a mobile device by manipulating the user agent string sent to the server.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lemma
hb_bidder_lemma
hb_adid_lemma
hb_size_lemma
hb_source_lemma
hb_format_lemma
hb_cache_host_lemma
hb_cache_id_lemma
hb_uuid_lemma
"Deal ID" Ad Server Key
hb_deal_lemma
Integration Note:
Lemma bidder adapter requires setup and approval from the Lemma team. Please reach out to your account manager for more information and to start using it.
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
}
}]
}];
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nafdigital
hb_bidder_nafdigital
hb_adid_nafdigital
hb_size_nafdigital
hb_source_nafdigital
hb_format_nafdigital
hb_cache_host_nafdig
hb_cache_id_nafdigit
hb_uuid_nafdigital
"Deal ID" Ad Server Key
hb_deal_nafdigital
Note:
The NAF Digital bidder adapter requires setup and approval from the NAF Digital team. Please reach out to your account manager for more information and to start using it.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nanointeractiv
hb_bidder_nanointera
hb_adid_nanointeract
hb_size_nanointeract
hb_source_nanointera
hb_format_nanointera
hb_cache_host_nanoin
hb_cache_id_nanointe
hb_uuid_nanointeract
"Deal ID" Ad Server Key
hb_deal_nanointeract
Requirements:
To be able to get identification key (pid), please contact us at https://www.nanointeractive.com/publishers
Bid Params
Name
Scope
Description
Example
Type
pid
required
Identification key, provided by Nano Interactive
'5afaa0280ae8996eb578de53'
string
category
optional
Contextual taxonomy
'automotive'
string
categoryName
optional
Contextual taxonomy (from URL query param)
'cat_name'
string
nq
optional
User search query
'automobile search query'
string
name
optional
User search query (from URL query param)
'search_param'
string
subId
optional
Channel - used to separate traffic sources
'123'
string
Configuration
The category and categoryName are mutually exclusive. If you pass both, categoryName takes precedence.
The nq and name are mutually exclusive. If you pass both, name takes precedence.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_nasmediaAdmixe
hb_bidder_nasmediaAd
hb_adid_nasmediaAdmi
hb_size_nasmediaAdmi
hb_source_nasmediaAd
hb_format_nasmediaAd
hb_cache_host_nasmed
hb_cache_id_nasmedia
hb_uuid_nasmediaAdmi
"Deal ID" Ad Server Key
hb_deal_nasmediaAdmi
Note:
The Nasmedia Admixer Bidder Adapter requires setup and approval from the Nasmedia Admixer team.
Please reach out to prebid@nasmedia.co.kr for more information.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_onedisplay
hb_bidder_onedisplay
hb_adid_onedisplay
hb_size_onedisplay
hb_source_onedisplay
hb_format_onedisplay
hb_cache_host_onedis
hb_cache_id_onedispl
hb_uuid_onedisplay
"Deal ID" Ad Server Key
hb_deal_onedisplay
Bid Params
Name
Scope
Description
Example
Type
placement
required
The placement ID from AOL.
'23324932'
string
network
required
The network ID from AOL.
'5071.1'
string
alias
optional
The placement alias from AOL.
'desktop_articlepage_something_box_300_250'
string
server
optional
The server domain name. Default is adserver-us.adtech.advertising.com. EU customers must use adserver-eu.adtech.advertising.com, and Asia customers adserver-as.adtech.advertising.com.
varadUnits=[{code:'test-div',sizes:[[728,90]],// a display sizemediaTypes:{'banner':{}},bids:[{bidder:'openx',params:{unit:'539439964',delDomain:'se-demo-d.openx.net',customParams:{key1:'v1',key2:['v2','v3']},}},{bidder:'openx',params:{unit:'539439964',platform:'a3aece0c-9e80-4316-8deb-faf804779bd1',customParams:{key1:'v1',key2:['v2','v3']},}}]},{code:'video1',mediaTypes:{video:{playerSize:[640,480],context:'instream'}},bids:[{bidder:'openx',params:{unit:'1611023124',delDomain:'PUBLISHER-d.openx.net',video:{mimes:['video/x-ms-wmv, video/mp4']}}}]}];
Configuration
Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes.
OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the
OpenX bid rate and bid price. Be sure to call pbjs.setConfig() only once.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pollux
hb_bidder_pollux
hb_adid_pollux
hb_size_pollux
hb_source_pollux
hb_format_pollux
hb_cache_host_pollux
hb_cache_id_pollux
hb_uuid_pollux
"Deal ID" Ad Server Key
hb_deal_pollux
Bid Params
Name
Scope
Description
Example
Type
zone
required
The zone ID from Pollux Network. You must identify a zone using a valid ID provided on Pollux Network platform.
'276'
string
(Sizes set in adUnit object will apply to the Pollux Network bid requests. If the indicated zone does not support any of the requested sizes, a null bid will be responded.)
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_polymorph
hb_bidder_polymorph
hb_adid_polymorph
hb_size_polymorph
hb_source_polymorph
hb_format_polymorph
hb_cache_host_polymo
hb_cache_id_polymorp
hb_uuid_polymorph
"Deal ID" Ad Server Key
hb_deal_polymorph
Note:
Polymorph adapter requires setup and approval from the Polymorph team. Please reach out to your account team or support@getpolymorph.com for more information.
Bid Params
Name
Scope
Description
Example
Type
placementId
required
The placement id/key provided by Polymorph
'ENvsYZ6m5DPDk6r7ogYV63DO2sBQoJ5EpckcXSlw'
String
defaultWidth
optional
In case multiple ad sizes are supported, it’s recommended to specify default height and width for native ad (in case native ad is chose as a winner). In case of banner or outstream ad any one of the above sizes can be chosen depending on the highest bid.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_prebidServer
hb_bidder_prebidServ
hb_adid_prebidServer
hb_size_prebidServer
hb_source_prebidServ
hb_format_prebidServ
hb_cache_host_prebid
hb_cache_id_prebidSe
hb_uuid_prebidServer
"Deal ID" Ad Server Key
hb_deal_prebidServer
Overview
The Prebid Server Adapter is a meta-adapter. It’s not an actual bidder, but
rather a way to get a batch of bids from other bidders with one request.
A request for the set of auctions is sent to Prebid Server, which performs
all the auctions server side (S2S), responding in time for Prebid.js to
send the results to the ad server. This lightens the performance load on the user’s device.
Bid Params
Bid params are sourced from the adapter configurations set for client side. These do not need to change for Prebid Server.
Errors in bidder parameters will cause Prebid Server to reject the
entire request. The Prebid Server philosophy is to avoid silent failures –
we assume you will test changes, and that it will be easier to notice a
4xx error coming from the server than a silent failure where it skips just
the bad parameter.
Configuration
To enable prebid server, set the following configuration.
List of bidder codes; must have been enabled during Prebid.js build.
defaultVendor
String
no
Automatically includes all following options in the config with vendor’s default values. Individual properties can be overridden by including them in the config along with this setting.
enabled
Boolean
no
Enables S2S; default: false (true when defaultVendor is set).
endpoint
String
no
Set the endpoint. For example: https://prebid.adnxs.com/pbs/v1/openrtb2/auction
timeout
Number
no
Bidder timeout, in milliseconds; default: 1000.
syncEndpoint
String
no
Configures the user-sync endpoint. Highly recommended.
adapter
String
no
Adapter code; default: "prebidServer".
secure
Integer
no
Override Prebid Server’s determination of whether the request needs secure assets. Set to 1 to force secure assets on the response, or 0 for non-secure assets.
adapterOptions
Object
no
Arguments will be added to resulting OpenRTB payload to Prebid Server.
extPrebid
Object
no
Arguments will be added to resulting OpenRTB payload to Prebid Server.
Examples
Video (Outstream):
Note that currently, outstream video rendering must be configured by the publisher. In the adUnit, a renderer object must be defined, which includes a url pointing to the video rendering script, and a render function for creating the video player. See https://prebid.org/dev-docs/show-outstream-video-ads.html for more information.
varadUnits=[{code:'div-gpt-ad-1460505748561-0',mediaTypes:{video:{playerSize:[640,480],context:'outstream',mimes:['video/mp4']}},bids:[{bidder:'appnexus',params:{placementId:13232392,video:{skippable:true,playback_method:['auto_play_sound_off']}},}],renderer:{url:'https://cdn.adnxs.com/renderer/video/ANOutstreamVideo.js',render:function(bid){adResponse={ad:{video:{content:bid.vastXml,player_height:bid.playerHeight,player_width:bid.playerWidth}}}// push to render queue because ANOutstreamVideo may not be loaded yet.bid.renderer.push(()=>{ANOutstreamVideo.renderAd({targetId:bid.adUnitCode,// target div id to render video.adResponse:adResponse});});}}}];
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pubmatic
hb_bidder_pubmatic
hb_adid_pubmatic
hb_size_pubmatic
hb_source_pubmatic
hb_format_pubmatic
hb_cache_host_pubmat
hb_cache_id_pubmatic
hb_uuid_pubmatic
"Deal ID" Ad Server Key
hb_deal_pubmatic
Prebid Server Note:
Before configuring the PubMatic adapter as S2S, you must reach out to the PubMatic team for approval and setup steps.
Prebid 1.0 Upgrade Note:
If you upgrading from a Prebid version prior to 1.0, please reach out to your PubMatic Customer Success Manager prior to your upgrade. Publisher accounts need new settings to function correctly with the PubMatic Prebid 1.0 adapter and your Customer Success Manager will ensure your account is setup correctly.
Bid Params
Name
Scope
Description
Example
Type
publisherId
required
Publisher ID
'32572'
string
adSlot
optional
Ad Slot Name (see below)
'38519891'
string
pmzoneid
optional
Zone ID
'zone1,zone2'
string
lat
optional
Latitude
'40.712775'
string
lon
optional
Longitude
'-74.005973'
string
yob
optional
Year of Birth
'1982'
string
gender
optional
Gender
'M'
string
kadpageurl
optional
Overrides Page URL
'http://www.yahoo.com/'
string
kadfloor
optional
Bid Floor
'1.75'
string
currency
optional
Bid currency
'AUD' (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
string
dctr
optional
Deal Custom Targeting (Value configured only in the 1st adunit will be passed on. Values if present in subsequent adunits, will be ignored.)
'key1=123|key2=345'
string
bcat
optional
Blocked IAB Categories (Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]
array of strings
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
Configuration
PubMatic recommends the UserSync configuration below. Without it, the PubMatic adapter will not able to perform user syncs, which lowers match rate and reduces monetization.
For Prebid.js v1.15.0 and later:
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// '*' represents all biddersfilter:'include'}}}});
Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.
adSlot Specification and Multi-Size Ad Units
The adSlot parameter supports two different formats:
Format
Example
Without Size
'38519891'
With Size
'38519891@300x205'
Support and behavior differs by Prebid.js version
Prebid.js v2.13.0 and later:
adSlot parameter is now optional. To omit the adSlot parameter, your publisher account must have default site and tag enabled. Consult your account manager to find out if default site and tag is enabled on your account. If used, both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. All options will send the ad request with all sizes specified in the Prebid ad unit configuration.
Prebid.js v2.9.0 to v2.12.0:
Both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. Both formats will send the ad request with all sizes specified in the Prebid ad unit configuration.
Prebid.js v1.1.18 to v2.8.0:
Both formats are supported. Without Size is the recommended option. If you are using Prebid Server, Prebid Server v0.69.0 or higher (Go version) or v1.18.0 or higher (Java version) is required to use Without Size. If you are using a managed service provider for Prebid Server, consult the provider to find out which version of Prebid Server they are using. Without Size will send the ad request with all sizes specified in the Prebid ad unit configuration. With Size will only request the specified size. Mutli-sized ad units are not supported when using Prebid Server.
Prebid.js v1.1.17 and earlier:
Only With Size is supported. To support multi-size ad units, list the PubMatic bidder entry multiple times, once for each size. Mutli-sized ad units are not supported when using Prebid Server.
video parameters
The PubMatic adapter supports video as of Prebid 1.16.0
Name
Scope
Description
Example
video.mimes
required
Video MIME types
['video/mp4','video/x-flv']
video.skippable
optional
If ‘true’, user can skip ad
true
video.minduration
optional
Minimum ad duration in seconds
5
video.maxduration
optional
Maximum ad duration in seconds
30
video.startdelay
optional
Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements
5
video.playbackmethod
optional
Defines whether inventory is user-initiated or autoplay sound on/off Values: 1: Auto-play, sound on 2: Auto-play, sound off 3: Click-to-play 4: mouse-over
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_pulsepoint
hb_bidder_pulsepoint
hb_adid_pulsepoint
hb_size_pulsepoint
hb_source_pulsepoint
hb_format_pulsepoint
hb_cache_host_pulsep
hb_cache_id_pulsepoi
hb_uuid_pulsepoint
"Deal ID" Ad Server Key
hb_deal_pulsepoint
Bid Params
Name
Scope
Description
Example
Type
cf
required
Ad size identifier
'300X250'
string
cp
required
Publisher Id
12345
integer
ct
required
Ad Tag Id
12345
integer
bcat
optional
Blocked IAB Categories
[ 'IAB1-5', 'IAB1-6' ]
array of strings
battr
optional
Blocked Creative Attributes
[ 1, 2, 5 ]
array of integers
badv
optional
Blocked Advertisers by their domains
['ford.com', 'pepsi.com']
array of strings
bidfloor
optional
Bid floor price CPM
1.23
float
video
required
Required for video requests. OpenRTB Video object.
{ w: 400, h: 300 }
object
Video parameters
Parameters on the Video object in Bid params for PulsePoint. OpenRTB 2.5 Video object specification is used. Below are some sample parameters from the OpenRTB Video specs.
Name
Scope
Description
Example
video.mimes
required
Content MIME types supported
['video/mp4','video/x-flv']
video.minduration
optional
Minimum video ad duration in seconds
8
video.maxduration
optional
Maximum video ad duration in seconds
20
video.protocols
optional
Array of supported video protocols
[2, 3]
video.w
optional
Width of the video player in device independent pixels
400
video.h
optional
Height of the video player in device independent pixels
300
video.startdelay
optional
Start delay in seconds
5
video.skip
optional
Indicates if the player will allow the video to be skipped
1
video.minbitrate
optional
Minumim bit rate in Kbps.
200
video.maxbitrate
optional
Maximum bit rate in Kbps.
500
video.api
optional
List of supported API frameworks for this impression
These are 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
"Deal ID" Ad Server Key
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.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_rubicon
hb_bidder_rubicon
hb_adid_rubicon
hb_size_rubicon
hb_source_rubicon
hb_format_rubicon
hb_cache_host_rubico
hb_cache_id_rubicon
hb_uuid_rubicon
"Deal ID" Ad Server Key
hb_deal_rubicon
Note:
The Rubicon Project adapter requires setup and approval from the Rubicon Project team, even for existing Rubicon Project publishers. Please reach out to your account team or globalsupport@rubiconproject.com for more information.
Bid Params
Name
Scope
Description
Example
Type
accountId
required
The publisher account ID
'4934'
string
siteId
required
The site ID
'13945'
string
zoneId
required
The zone ID
'23948'
string
sizes
optional
Array of Rubicon Project size IDs. If not specified, the system will try to convert from the AdUnit’s mediaTypes.banner.sizes.
[15]
Array<integer>
keywords
optional
Array of page-specific keywords. May be referenced in Rubicon Project reports.
['travel', 'tourism']
Array<string>
inventory
optional
An object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays.
Video player width in pixels. If not specified, takes width set in mediaTypes.video.playerSize
'640'
string
playerHeight
optional
Video player height in pixels. If not specified, takes height set in mediaTypes.video.playerSize
'360'
string
size_id
optional
Integer indicating the Rubicon Project video ad format ID. If not set, infers from mediaTypes.video.context
201
integer
language
recommended
Indicates the language of the content video, in ISO 639-1/alpha2. Highly recommended for successful monetization for pre-, mid-, and post-roll video ads. Not applicable for interstitial and outstream.
'en'
string
For Prebid.js 2.5 and later, the Rubicon Project adapter for video requires more parameters in the AdUnit’s mediaTypes.video definition than required for version 2.4 and earlier.
We are requiring these parameters for publishers to fully declare their video inventory to be transparent to bidders, getting the best chance at a high value and technically compatible bid.
Specifically, we’re requiring: mimes, protocols, maxduration, linearity, and api. See the example below.
Here’s a video example for Prebid.js 2.5 or later:
var videoAdUnit = {
code: 'myVideoAdUnit',
mediaTypes: {
video: {
context: 'instream',
playerSize: [640, 480],
mimes: ['video/mp4', 'video/x-ms-wmv'] // 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', // replace bidders
params: {
accountId: '7780', // and params
siteId: '87184',
zoneId: '413290',
video: {
language: 'en'
}
}
}]
};
This example adunit will also work Prebid.js 2.4 and earlier, but mimes, protocols, maxduration, linearity, and api are not required.
We recommend discussing video demand with your Rubicon Project account representative.
Lists of api, protocol, and linearity values are in the OpenRTB 2.5 documentation, copied here for convenience:
api
1 : VPAID 1.0
2 : VPAID 2.0
3 : MRAID 1.0
4 : ORMMA
5 : MRAID 2.0
6 : MRAID 3.0
linearity
1 : Linear / In-Stream
2 : Non-Linear / Overlay
protocols
1 : VAST 1.0
2 : VAST 2.0
3 : VAST 3.0
4 : VAST 1.0 Wrapper
5 : VAST 2.0 Wrapper
6 : VAST 3.0 Wrapper
7 : VAST 4.0
8 : VAST 4.0 Wrapper
9 : DAAST 1.0
10 : DAAST 1.0 Wrapper
Outstream Video
Rubicon Project supports outstream video with these restrictions:
Rubicon Project does not make concurrent banner and video requests. The Rubicon adapter will send a video request if bids[].params.video is supplied, else a banner request will be made.
Configuration
Single-Request
By default, the Rubicon Project adapter sends one request to rubiconproject.com for each AdUnit. For example, if there are 4 PBJS AdUnits defined on the page, you’ll see 4 calls out to rubiconproject.com/fastlane.json.
As of PBJS 1.12, the Rubicon Project adapter supports Single Request mode, where all AdUnit requests are made in a single call to rubiconproject.com. To turn this feature on, call setConfig:
1) 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.
2) Bids through the Rubicon Project Exchange are by default ‘net’. For certain use cases it is possible for Rubicon Project clients 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 Rubicon Project exchange. If you are a publisher who has set your Rubicon 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:
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sara
hb_bidder_sara
hb_adid_sara
hb_size_sara
hb_source_sara
hb_format_sara
hb_cache_host_sara
hb_cache_id_sara
hb_uuid_sara
"Deal ID" Ad Server Key
hb_deal_sara
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the SARA bidder system Ad Slot ID associated with the respective div id from the site page.
5
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the header bidder margin already extracted. Gross price does contain the SARA bidder margin within.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sharethrough
hb_bidder_sharethrou
hb_adid_sharethrough
hb_size_sharethrough
hb_source_sharethrou
hb_format_sharethrou
hb_cache_host_sharet
hb_cache_id_sharethr
hb_uuid_sharethrough
"Deal ID" Ad Server Key
hb_deal_sharethrough
Note:
The Sharethrough bidder adapter requires additional setup and approval from the Sharethrough Integrations team. Please reach out to your account manager for more information to start using it.
Bid Params
Name
Scope
Description
Example
Type
pkey
required
The placement key
'DfFKxpkRGPMS7A9f71CquBgZ'
string
iframe
optional
If true, the ad will render in an iframe. Defaults to false.
true
boolean
iframeSize
optional
[width, height] If provided, use this size for the iframe size. Only applicable if iframe is true. If omitted, the largest size from the ad unit sizes array will be used.
[300, 250]
[integer]
bidfloor
optional
The floor price, or minimum amount, a publisher will accept for an impression, given in CPM in USD.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smartadserver
hb_bidder_smartadser
hb_adid_smartadserve
hb_size_smartadserve
hb_source_smartadser
hb_format_smartadser
hb_cache_host_smarta
hb_cache_id_smartads
hb_uuid_smartadserve
"Deal ID" Ad Server Key
hb_deal_smartadserve
Note:
The Smart AdServer bidder adaptor requires setup and approval from the Smart AdServer Service team. Please reach out to your account manager for more information and start using it.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_smilewanted
hb_bidder_smilewante
hb_adid_smilewanted
hb_size_smilewanted
hb_source_smilewante
hb_format_smilewante
hb_cache_host_smilew
hb_cache_id_smilewan
hb_uuid_smilewanted
"Deal ID" Ad Server Key
hb_deal_smilewanted
Note
To use us as a bidder you must have an account and an active “zoneId” on our SmileWanted platform.
Test zoneId
zoneId: 1
This zoneId will always deliver an ad, a SmileWanted creation with a price of requested CPM, which offer you to test and to win every auctions.
(Please note that impressions and revenues of this test zone this will not be recorded and not be paid)
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_sonobi
hb_bidder_sonobi
hb_adid_sonobi
hb_size_sonobi
hb_source_sonobi
hb_format_sonobi
hb_cache_host_sonobi
hb_cache_id_sonobi
hb_uuid_sonobi
"Deal ID" Ad Server Key
hb_deal_sonobi
Note:
The Sonobi Bidder adapter requires setup and approval from your Sonobi Account Manager. If you require assistance
implementing our adapter please don’t hesitate to contact us at apex.prebid@sonobi.com.
Bid Params
Name
Scope
Description
Example
Type
placement_id
required*
The placement ID
'1a2b3c4d5e6f1a2b3c4d'
string
ad_unit
required*
The adunit ID
'/1234567/example/adUnit/code'
string
floor
optional
Bid floor for this placement in USD
0.50
float
sizes
optional
Adunit sizes that will override global sizes
[[300, 250], [300, 600]]
Array<Array>
hfa
optional
Publisher Unique Identifier
'123985'
string
referrer
optional
Overrides the default value for the ref param in a bid request
'prebid.org'
string
keywords
optional
Comma separated list of keywords about the site
'sports,news,food'
string
Configuration
You *must only include one ID field - either placement_id or ad_unit, not both. If you have questions on which parameter to use, please reach out to your Account Manager.
The ad_unit and placement_id are mutually exclusive but at least one is required. If you pass both, ad_unit takes precedence.
If you pass the optional sizes Array in your bid params it will override the global config sizes for the Sonobi Adapter only.
The hfa parameter requires your Sonobi Account Manager to enable this feature for you. Please contact them for further information.
The Sortable adapter has the ability to initiate user-sync requests that will improve DSP user ID match rate,
with the aim of generating higher bid prices. By default, Sortable sync requests are off. Setting the Sortable site ID globally as described above is required for user-sync requests.
Note: these configs should be combined with any other UserSync config calls, as subsequent calls to setConfig for the same attribute overwrite each other.
ID of element that video ad should be rendered into.
'adSlot1'
string
ad_mute
optional
Set to true to start the ad with the volume muted.
true
boolean
playersize_auto_adapt
optional
Set to true to make video auto-adapt to the ad’s dimensions
true
boolean
in_iframe
optional
ID of iFrame element to insert EASI script tag.
'iframe1'
string
custom_override
optional
Object of script tag attributes to override from the list here: EASI Attributes. (Note: Exclude data-spotx_ from attribute name; channel_id, vast_url, content_page_url, and ad_unit overrides are ignored.)
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_supply2
hb_bidder_supply2
hb_adid_supply2
hb_size_supply2
hb_source_supply2
hb_format_supply2
hb_cache_host_supply
hb_cache_id_supply2
hb_uuid_supply2
"Deal ID" Ad Server Key
hb_deal_supply2
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the Media Donuts bidder system Ad Slot ID associated with the respective div id from the site page.
24
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the Media Donuts header bidder margin already extracted. Gross price does contain the Media Donuts bidder margin within.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_synacormedia
hb_bidder_synacormed
hb_adid_synacormedia
hb_size_synacormedia
hb_source_synacormed
hb_format_synacormed
hb_cache_host_synaco
hb_cache_id_synacorm
hb_uuid_synacormedia
"Deal ID" Ad Server Key
hb_deal_synacormedia
Note
The Synacor Media bidder adapter requires setup and approval from Synacor. Please reach out to your account manager for more information and to start using it.
Configuration
Synacor Media requires that iframe is used for user syncing.
Example configuration:
pbjs.setConfig({userSync:{filterSettings:{iframe:{bidders:'*',// represents all biddersfilter:'include'}}}});
Google Ad Manager Video Creative
To use video, setup a VAST redirect creative within Google Ad Manager (formerly DFP) with the following VAST tag URL:
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_taphype
hb_bidder_taphype
hb_adid_taphype
hb_size_taphype
hb_source_taphype
hb_format_taphype
hb_cache_host_taphyp
hb_cache_id_taphype
hb_uuid_taphype
"Deal ID" Ad Server Key
hb_deal_taphype
Note:
The TapHype adaptor requires setup and approval from your TapHype account manager. Please reach out to your account manager to enable Prebid.js for your account.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_telaria
hb_bidder_telaria
hb_adid_telaria
hb_size_telaria
hb_source_telaria
hb_format_telaria
hb_cache_host_telari
hb_cache_id_telaria
hb_uuid_telaria
"Deal ID" Ad Server Key
hb_deal_telaria
Overview
This documentation covers some of the parameters that the Telaria(previously Tremor Video) exchange accepts. And is intended to be referenced by publishers using prebid 1.x. Documentation for prebid 0.x can be found under tremor
Bid Params
Please refer to the Tag Parameters section in the Telaria Console
// There are two ways of passing the SupplyChain Object to our adapter:// 1) set it in the configpbjs.setConfig({"schain":{"ver":"1.0","complete":1,"nodes":[{"asi":"indirectseller.com","sid":"00001","hp":1}]}});// 2) pass it in the params object of the adunit:varadUnit={"code":"video1","mediaTypes":{"video":{"playerSize":[640,480],"context":"instream"}},"bids":[{"bidder":"telaria","params":{"supplyCode":"ssp-demo-rm6rh","adCode":"ssp-!demo!-lufip","videoId":"MyCoolVideo",// Other params go here,"schain":{"ver":"1.0","complete":1,"nodes":[{"asi":"exchange1.com","sid":"1234","hp":1},{"asi":"exchange2.com","sid":"abcd","hp":1}]}}}]}
1 : In-Stream: Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll).
2 : In-Banner: Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
3 : In-Article: Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
4 : In-Feed: Found in content, social, or product feeds.
5 : Interstitial/Slider/Floating: Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the imp.instl field.
Placement
1 : Streaming
2 : Progressive
3 : Download
Supply Chain Object
The adapter has been enhanced to accept the supply chain object (schain) if provided. Please refer to SupplyChain for Non RTB Requests for more information
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_tremor
hb_bidder_tremor
hb_adid_tremor
hb_size_tremor
hb_source_tremor
hb_format_tremor
hb_cache_host_tremor
hb_cache_id_tremor
hb_uuid_tremor
"Deal ID" Ad Server Key
hb_deal_tremor
Bid Params
Name
Scope
Description
Example
Type
adCode
required
The Ad Code from Tremor.
'ssp-!demo!-lufip'
String
supplyCode
required
The Supply Code from Tremor.
'ssp-%21demo%21-rm6rh'
String
playerWidth
optional
The width of the video player. Full-screen video fills the width of the device, that is, if the video can play in full screen mode, the player width is the screen width.
600
Integer
playerHeight
optional
The height of the video player. Full-screen video fills the height of the device, that is, if the video can play in full screen mode, the player height is the screen height.
400
Integer
mediaId
optional
A unique (not random) value that identifies the content video aligned with the ad opportunity. Typically provided by the video player CMS.
12345
Integer
mediaUrl
optional
The URL to the content video source.
'http://www.mycms.com/myhostedvideo.mp4'
String
mediaTitle
optional
The title of the content video aligned with the ad opportunity.
'Description of the content video'
String
contentLength
optional
The length of the content video in seconds.
120
Integer
srcPageUrl
optional
The url of the page where the video ad will be displayed.
'http://www.mysite.com/my-content-page/'
String
floor
optional
This is a formatted string of values. The format is a comma separated list of “currency pairs”. Each pair consists of a currency code and the floor for that currency, separated by a colon.
'USD:5.00,AUD:7.25'
String
efloor
optional
Same as floor, except the entire string is encrypted using HMAC encryption and the encryption keys set on the supply’s seat from the SSP UI.
'IFHR00cxR5ul_t20sMQ0OsvMVP7fOS-mnVsxu78%3d'
String
custom
optional
Any custom value that will be later be available for reporting.
'myCustomValue'
String
categories
optional
Validated against RTB table 6.1 (Send comma delimited list if more than one category applies.
'IAB20,IAB20-1'
keywords
optional
Comma separated list of keywords describing the supply.
'funny,television'
String
srcRelationship
optional
Describes the relationship between the content owner and the requestor of the ad opportunity. 1 for “direct”, 0 for “indirect”
1
Integer
blockDomains
optional
A comma separated list of advertiser domains that should be added to the existing list of blocked advertiser domains that is set in the SSP console.
'blockthis.com, blockthat.com'
String
skip
optional
Is the video skippable? True or false. 1/T/Y is true and 0/F/N/null is false.
'1'
Character
skipmin
optional
Shortest video ad (in seconds) that can be skipped. If provided and “skip” is not, then “skip” is automatically set to true.
30
Integer
skipafter
optional
Number of seconds after which the video can be skipped. If provided and “skip” is not, then “skip” is automatically set to true.
15
Integer
delivery
optional
Comma delimited listed of Integers representing allowed delivery methods. See below as well as RTB 2.5 specification for valid values.
'1,3'
String
placement
optional
Integer value of placement type. See below as well as RTB 2.5 specification for valid values.
1
Integer
videoMinBitrate
optional
Minimum bitrate in kbps
400
Integer
videoMaxBitrate
optional
Maximum bitrate in kbps
800
Integer
minDur
optional
Minimum duration for an ad in seconds
15
Integer
maxDur
optional
Maximum duration for an ad in seconds
60
Integer
The following values are defined in the ORTB 2.5 spec.
delivery
1 : In-Stream: Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll).
2 : In-Banner: Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
3 : In-Article: Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
4 : In-Feed: Found in content, social, or product feeds.
5 : Interstitial/Slider/Floating: Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the imp.instl field.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_trustx
hb_bidder_trustx
hb_adid_trustx
hb_size_trustx
hb_source_trustx
hb_format_trustx
hb_cache_host_trustx
hb_cache_id_trustx
hb_uuid_trustx
"Deal ID" Ad Server Key
hb_deal_trustx
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page.
42
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the TrustX header bidder margin already extracted. Gross price does contain the TrustX bidder margin within.
'gross'
string
keywords
optional
A set of key-value pairs applied to all ad slots on the page. Values can be empty.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_turktelekom
hb_bidder_turkteleko
hb_adid_turktelekom
hb_size_turktelekom
hb_source_turkteleko
hb_format_turkteleko
hb_cache_host_turkte
hb_cache_id_turktele
hb_uuid_turktelekom
"Deal ID" Ad Server Key
hb_deal_turktelekom
Bid Params
Name
Scope
Description
Example
Type
uid
required
Represents the Türk Telekom bidder system Ad Slot ID associated with the respective div id from the site page.
42
integer
priceType
optional
Can take the values gross or net, default value is net. Net represents the header bid price with the Türk Telekom header bidder margin already extracted. Gross price does contain the Türk Telekom bidder margin within.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_undertone
hb_bidder_undertone
hb_adid_undertone
hb_size_undertone
hb_source_undertone
hb_format_undertone
hb_cache_host_undert
hb_cache_id_underton
hb_uuid_undertone
"Deal ID" Ad Server Key
hb_deal_undertone
Bid Params
Name
Scope
Description
Example
Type
placementId
optional
Your placement ID (provided by undertone)
"13as14d0"
string
publisherId
required
publisher ID (provided by undertone)
12345
integer
Configuration
To maximize revenue efficiency, please enable iframe-based user syncing. This functionality will improve user match rates and will help increasing the bid rate.
Example code to enable iframe user-sync for Undertone:
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.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_uol
hb_bidder_uol
hb_adid_uol
hb_size_uol
hb_source_uol
hb_format_uol
hb_cache_host_uol
hb_cache_id_uol
hb_uuid_uol
"Deal ID" Ad Server Key
hb_deal_uol
Note:
The UOL Project adapter requires setup and approval from the UOL Project team, even for existing UOL Project publishers. Please reach out to your account team or l-prebid@uolinc.com for more information.
Bid Params
Name
Scope
Description
Example
placementId
required
UOL placement ID
‘123124’, 123154
test
optional
Activate AdServer test endpoint
true, false
cpmFactor
optional
Positive Integer value that will be used by the AdServer as a cpm multiplier. If passed, also requires ‘test’ flag to be set to ‘true’
1, 2, 5
Note:
Currently, the UOL bidAdapter is under initial tests. Please follow this page for updates regarding required parameters and new features.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vertamedia
hb_bidder_vertamedia
hb_adid_vertamedia
hb_size_vertamedia
hb_source_vertamedia
hb_format_vertamedia
hb_cache_host_vertam
hb_cache_id_vertamed
hb_uuid_vertamedia
"Deal ID" Ad Server Key
hb_deal_vertamedia
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from Vertamedia.
350975
integer
Description
Get access to multiple demand partners across VertaMedia AdExchange and maximize your yield with VertaMedia header bidding adapter.
VertaMedia header bidding adapter connects with VertaMedia demand sources in order to fetch bids.
This adapter provides a solution for accessing Video demand and display demand
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_viewdeosDX
hb_bidder_viewdeosDX
hb_adid_viewdeosDX
hb_size_viewdeosDX
hb_source_viewdeosDX
hb_format_viewdeosDX
hb_cache_host_viewde
hb_cache_id_viewdeos
hb_uuid_viewdeosDX
"Deal ID" Ad Server Key
hb_deal_viewdeosDX
Bid params
Name
Scope
Description
Example
Type
aid
required
The source ID from member zone
350975
integer
outstream
optional
Oustream player settings object
{"audio_setting":"on","video_controls":"show"}
object
Oustream settings object
Name
Scope
Description
Example
Type
type
optional
allows to set the outstream type to one of inread/inbanner/interstitial/slider
'inbanner'
string
audio_setting
optional
allows to set audio settings, set to one of: on/muted/hover
'hover'
string
video_controls
optional
enables or disables the visibility of controls, set to one of: show/hide/hover
'show'
string
close_button_options
optional
allows to choose when/if it is needed to show the “close” button, set to one of: delay/not_show/based_on
'delay'
string
view_out_action
optional
allows to apply the action type to an outstream unit when it is out of the visible zone, set to one of: jump/detach/continue_playing_muted/close/continue_playing/pause
'pause'
string
default_volume
optional
allows to set the volume of outstream video ad 0-100
45
integer
percent_visible_before_show
optional
allows to setup visible percentage of an outstream unit to play 0-100
60
integer
is_countdown_show
optional
allows to enable/disable a countdown before the “close” button appears 0 - is enabled 1 - is disabled
1
integer
countdown_time
optional
allows to set up how long the countdown will last and show it to the user.
5
integer
close_button_delay
optional
allows to set a delay before showing close button
5
integer
disengagement_delay
optional
allows to set a delay before actions selected in desangagement_method parameter
5
integer
disengagement_method
optional
is applicable solely to Interstitial units allowing determine the actions that can be applied to the player, set to one of: close_button/detach_button/no/auto_detach
'close_button'
string
event_for_expand
optional
allows to select when outstream unit should be expanded, set to one of: on_start_ad/on_load_ad
'on_load_ad'
string
detach_location_on page
optional
allows to select the location where you want the detached player to be placed, set to one of: bottom_right/fullscreen/bottom_left/center_left/center_right/top_right/top_left
'top_left'
string
animation_mode
optional
allows to control your outstream unit’s animation mode on the webpage, set to one of: ease/ease_in/ease_out/step_start/linear
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_visx
hb_bidder_visx
hb_adid_visx
hb_size_visx
hb_source_visx
hb_format_visx
hb_cache_host_visx
hb_cache_id_visx
hb_uuid_visx
"Deal ID" Ad Server Key
hb_deal_visx
Note
To be able to use the full bandwidth of VIS.X high impact ad products, we strongly recommend disabling SafeFrames:
If you are using Google Ad Manager (GAM), make sure the “Serve in Safeframe” box in creative settings is unchecked,
If you are using AppNexus Seller Tag, make sure the enableSafeFrame parameter is set to False.
If you require SafeFrames to be activated, please reach out to your YOC account manager to obtain further details.
The YOC VIS.X adaptor requires setup and approval from your YOC account manager team, even for existing YOC publishers.
Please reach out to your account manager to enable Prebid.js for your account.
Bid params
Name
Scope
Description
Example
Type
uid
required
The publisher’s ad unit ID in VIS.X. The parameter can be either a string or integer for Prebid.js, however integer is preferred.
'903536'
integer or string
Configuration
The VIS.X adaptor has the ability to work in different currencies. Currently this adaptor supports EUR, USD,
GBP, PLN. Defaults to EUR. 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. GPB), use the following settings:
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_vuble
hb_bidder_vuble
hb_adid_vuble
hb_size_vuble
hb_source_vuble
hb_format_vuble
hb_cache_host_vuble
hb_cache_id_vuble
hb_uuid_vuble
"Deal ID" Ad Server Key
hb_deal_vuble
Note:
The Vuble adapter requires setup and approval from the Vuble team, even for existing Vuble publishers. Please reach out to your account team, or contact publishers-us@vuble.tv or publishers-fr@vuble.tv for more information.
Bid params
Name
Scope
Description
Example
Type
env
required
The environment. Must be ‘net’ or ‘com’. This information will be given to you by the Vuble team.
'net'
string
pubId
required
Your publisher ID. This information will be given to you by the Vuble team.
3
integer
zoneId
required
A zone ID for the SSP.
12345
integer
referrer
optional
The page’s referrer. Not mandatory but recommended.
'http://www.vuble.tv/'
string
floorPrice
optional
The desired floor price. If none is given, the floor price will depend on the zone ID.
These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_yieldone
hb_bidder_yieldone
hb_adid_yieldone
hb_size_yieldone
hb_source_yieldone
hb_format_yieldone
hb_cache_host_yieldo
hb_cache_id_yieldone
hb_uuid_yieldone
"Deal ID" Ad Server Key
hb_deal_yieldone
Note:
THE YIELDONE adapter requires setup and approval from the YIELDONE team.
Please reach out to your account team or y1s@platform-one.co.jp for more information.
