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 to the Ad Server
Bid Params Ad request parameters required by a given bidder, such as the tag ID, site ID, or query string parameters

You can also download the full CSV data file.

Prebid Server Bidder List

Bidder Documentation

33Across

Features

Bidder Code 33across Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
siteId required Publisher GUID from 33Across 'examplePub123' string
productId required 33Across Product ID that the Publisher has registered for (use 'siab' for standard supply and 'inview' for renderer) 'siab' string

Adform

Features

Bidder Code adform Prebid.org Member yes
Media Types display GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, sharedId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

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

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

Ad Generation

Features

Bidder Code adgeneration Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Adhese

Features

Bidder Code adhese Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Registration

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

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

Bid Params

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

Configuration

Adhese supports ‘iframe’ UserSync configuration only.

For Prebid.js v1.15.0 and later:

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

For Prebid.js v1.14.0 and before:

pbjs.setConfig({
   userSync: {
    iframeEnabled: true,
    enabledBidders: ['adhese']
 }});

Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.

AdKernel

Features

Bidder Code adkernel Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The Adkernel Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

Bid Params

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

AdKernelAdn

Features

Bidder Code adkernelAdn Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The AdkernelAdn Header Bidding adaptor requires setup and approval before beginning. Please reach out to prebid@adkernel.com for more details

Bid Params

Name Scope Description Example Type
host optional Ad network host 'tag.adkernel.com' string
pubId required Publisher Id 102 integer

ADman Media

Features

Bidder Code adman Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

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

Bid Params

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

AdMixer

Features

Bidder Code admixer Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
zone required     string

AdOcean

Features

Bidder Code adocean Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

Name Scope Description Example Type
slaveId required slave ID 'adoceanmyaozpniqismex' string
masterId required master ID 'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7' string
emiter required traffic source id 'myao.adocean.pl' string

Adoppler

Features

Bidder Code adoppler Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

Adpone

Features

Bidder Code adpone Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Adprime

Features

Bidder Code adprime Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adprime hb_bidder_adprime hb_adid_adprime
hb_size_adprime hb_source_adprime hb_format_adprime
hb_cache_host_adprim hb_cache_id_adprime hb_uuid_adprime
hb_cache_path_adprim hb_deal_adprime  

Note:

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

Bid Params

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

Adtarget

Features

Bidder Code adtarget Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtarget hb_bidder_adtarget hb_adid_adtarget
hb_size_adtarget hb_source_adtarget hb_format_adtarget
hb_cache_host_adtarg hb_cache_id_adtarget hb_uuid_adtarget
hb_cache_path_adtarg hb_deal_adtarget  

Registration

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

Bid params

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

Description

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

Test Parameters

    var adUnits = [

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

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

Additional Configuration

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

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

Adtelligent

Features

Bidder Code adtelligent Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid params

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

Description

Get access to multiple demand partners across Adtelligent AdExchange and maximize your yield with Adtelligent header bidding adapter.

Adtelligent header bidding adapter connects with Adtelligent demand sources in order to fetch bids. This adapter provides a solution for accessing Video demand and display demand.

Adtelligent now supports adpod.

Test Parameters

    var adUnits = [

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

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

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

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

Additional Configuration

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

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

Advangelists

Features

Bidder Code advangelists Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

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

Bid Params

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

AJA

Features

Bidder Code aja Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The AJA Bidding adaptor requires setup and approval before beginning. Please reach out to ssp_support@aja-kk.co.jp for more details

Bid Params

Name Scope Description Example Type
asi required ad spot hash code '123abc' string

Configuration

AJA recommends setting UserSync by iframe for monetization.

For Prebid.js v1.15.0 and later:

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

For Prebid.js v1.14.0 and before:

pbjs.setConfig({
  userSync: {
    iframeEnabled: true,
    enabledBidders: ['aja']
  }
});

Applogy

Features

Bidder Code applogy Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_applogy hb_bidder_applogy hb_adid_applogy
hb_size_applogy hb_source_applogy hb_format_applogy
hb_cache_host_applog hb_cache_id_applogy hb_uuid_applogy
hb_cache_path_applog hb_deal_applogy  

Bid Params

Name Scope Description Example Type
token required Applogy tokeb ‘aaaa’ string

AppNexus

Features

Bidder Code appnexus Prebid.org Member yes
Media Types display, video, native GDPR TCF1 Support yes
User IDs criteo, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Table of Contents

All AppNexus placements included in a single call to requestBids must belong to the same parent Publisher. If placements from two different publishers are included in the call, the AppNexus bidder will not return any demand for those placements.
Note: This requirement does not apply to adapters that are aliasing the AppNexus adapter.

Bid Params

Name Scope Description Example Type
placementId required The placement ID from AppNexus. You may identify a placement using the invCode and member instead of a placement ID. The placementID parameter can be either a string or integer for Prebid.js, however integer is preferred. Legacy code can retain the string value. Prebid Server requires an integer value. 234234 integer
member optional The member ID from AppNexus. Must be used with invCode. '12345' string
invCode optional The inventory code from AppNexus. Must be used with member. 'abc123' string
publisherId optional The publisher ID from AppNexus. It is used by the AppNexus end point to identify the publisher when placementId is not provided and invCode goes wrong. The publisherId parameter can be either a string or integer for Prebid.js, however integer is preferred. 12345 integer
user optional Object that specifies information about an external user. See User Object for details. user: { age: 25, gender: 0, dnt: true} object
allowSmallerSizes optional If true, ads smaller than the values in your ad unit’s sizes array will be allowed to serve. Defaults to false. true boolean
usePaymentRule optional If true, Appnexus will return net price to Prebid.js after publisher payment rules have been applied. true boolean
keywords optional A set of key-value pairs applied to all ad slots on the page. Mapped to buy-side segment targeting (login required). Values can be empty. See Passing Keys Without Values below for examples. Note that to use keyword with the Prebid Server adapter, that feature must be enabled for your account by an AppNexus account manager. keywords: { genre: ['rock', 'pop'] } object
video optional Object containing video targeting parameters. See Video Object for details. video: { playback_method: ['auto_play_sound_off'] } object
app optional Object containing mobile app parameters. See the App Object for details. app : { id: 'app-id'} object
reserve optional Sets a floor price for the bid that is returned. If floors have been configured in the AppNexus Console, those settings will override what is configured here. 0.90 float
position optional Identify the placement as above or below the fold. Allowed values: Unknown: unknown; Above the fold: above; Below the fold: below 'above' string
trafficSourceCode optional Specifies the third-party source of this impression. 'my_traffic_source' string
supplyType optional Indicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app 'web' string
supplyType optional Indicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app 'web' string
pubClick optional Specifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using AppNexus click tracking properly. 'http://click.adserver.com/' string
extInvCode optional Specifies predefined value passed on the query string that can be used in reporting. The value must be entered into the system before it is logged. '10039' string
externalImpId optional Specifies the unique identifier of an externally generated auction. 'bacbab02626452b097f6030b3c89ac05' string

Video Object

Name Description Type
minduration Integer that defines the minimum video ad duration in seconds. integer
maxduration Integer that defines the maximum video ad duration in seconds. integer
context A string that indicates the type of video ad requested. Allowed values: "pre_roll"; "mid_roll"; "post_roll"; "outstream". string
skippable Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false. boolean
skipoffset Integer that defines the number of seconds until an ad can be skipped. Assumes skippable setting was set to true. integer
playback_method A string that sets the playback method supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown". string
frameworks Array of integers listing API frameworks supported by the publisher. Allowed values: None: 0; VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; MRAID 2.0: 4; ORMMA: 5. Array<integer>

User Object

Name Description Example Type
age The age of the user. 35 integer
externalUid Specifies a string that corresponds to an external user ID for this user. '1234567890abcdefg' string
segments Specifies the segments to which the user belongs. [1, 2] Array<integer>
gender Specifies the gender of the user. Allowed values: Unknown: 0; Male: 1; Female: 2 1 integer
dnt Do not track flag. Indicates if tracking cookies should be disabled for this auction true boolean
language Two-letter ANSI code for this user’s language. EN string

App Object

AppNexus supports using prebid within a mobile app’s webview. If you are interested in using an SDK, please see Prebid Mobile instead.

Name Description Example Type
id The App ID. 'B1O2W3M4AN.com.prebid.webview' string
device_id Object that contains the advertising identifiers of the user (idfa, aaid, md5udid, sha1udid, or windowsadid). { aaid: "38400000-8cf0-11bd-b23e-10b96e40000d" } object
geo Object that contains the latitude (lat) and longitude (lng) of the user. { lat: 40.0964439, lng: -75.3009142 } object

Custom Targeting keys

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

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

Passing Keys Without Values

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

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

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

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

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

User Sync in AMP

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

Mobile App Display Manager Version

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

Debug Auction

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

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

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

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

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

Prebid Server Test Request

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

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

Audience Network

Features

Bidder Code audienceNetwork Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

Avocet

Features

Bidder Code avct Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_avct hb_bidder_avct hb_adid_avct
hb_size_avct hb_source_avct hb_format_avct
hb_cache_host_avct hb_cache_id_avct hb_uuid_avct
hb_cache_path_avct hb_deal_avct  

Registration

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

Bid Params

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

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

Beachfront

Features

Bidder Code beachfront Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Registration

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

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

Bid Params

Name Scope Description Example Type
appId required Beachfront Exchange ID '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor required Bid floor 0.01 float
video optional Object with video parameters. See the video section below for details.   object
banner optional Object with banner parameters. See the banner section below for details.   object
player optional Object with outstream player parameters. See the player section below for details.   object

video params

Name Scope Description Example Type
appId optional Beachfront Exchange ID for video bids. '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor optional Bid floor for video bids. 0.01 float
tagid optional Tag ID '7cd7a7b4-ef3f-4aeb-9565-3627f255fa10' string
mimes optional Array of strings listing supported MIME types. ["video/mp4", "application/javascript"] Array<string>
playbackmethod optional Playback method supported by the publisher.
1: Auto-play sound on
2: Auto-play sound off
3: Click-to-play
4: Mouse-over
1 integer
maxduration optional Maximum video ad duration in seconds. 30 integer
placement optional Placement type for the impression.
1: In-Stream
2: In-Banner
3: In-Article
4: In-Feed
5: Interstitial/Slider/Floating
1 integer

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

player params

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

Prebid Server

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

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

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

Beintoo

Features

Bidder Code beintoo Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_beintoo hb_bidder_beintoo hb_adid_beintoo
hb_size_beintoo hb_source_beintoo hb_format_beintoo
hb_cache_host_beinto hb_cache_id_beintoo hb_uuid_beintoo
hb_cache_path_beinto hb_deal_beintoo  

Bid Params

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

Brightroll

Features

Bidder Code Brightroll Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_Brightroll hb_bidder_Brightroll hb_adid_Brightroll
hb_size_Brightroll hb_source_Brightroll hb_format_Brightroll
hb_cache_host_Bright hb_cache_id_Brightro hb_uuid_Brightroll
hb_cache_path_Bright hb_deal_Brightroll  

Registration

Brightroll requires registration for each Prebid Server host company and each publisher. Contact dsp-supply-prebid@verizonmedia.com

Bid Params

Name Scope Description Example Type
publisher required Publisher Name to use ‘pub1’ string

ConnectAd

Features

Bidder Code connectad Prebid.org Member yes
Media Types display GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Prebid Server Note:

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

Bid Params

Name Scope Description Example Type
siteId required The site ID from ConnectAd. 12345 integer
networkId required The network ID from ConnectAd. 10047 integer
bidfloor optional Requested Floorprice 0.15 number

Consumable

Features

Bidder Code consumable Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The Consumable adaptor requires setup and approval from your Consumable account manager, even for existing Consumable publishers. Please reach out to your account manager to enable Prebid.js for your account.

Bid Params

Name Scope Description Example Type
siteId required The site ID from Consumable. 12345 integer
networkId required The network ID from Consumable. 9969 integer
unitId required The unit ID from Consumable. 987654 integer
unitName required The unit name from Consumable. cnsmbl-unit string

Conversant

Features

Bidder Code conversant Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
site_id required The site ID from Conversant. '87293' string
secure required (for secure pages) If impression requires secure HTTPS URL creative assets and markup. 0 for non-secure, 1 for secure. Default is non-secure 1 integer
bidfloor optional Bid floor 0.50 float
tag_id optional Identifies specific ad placement. 'cnvr-test-tag' string
position optional Ad position on screen. See details below. 1 integer
mimes optional Array of content MIME types supported. Required for video ['video/mp4'] Array<string>
maxduration optional Maximum duration in seconds for this video as an integer. 30 integer
api optional Array of supported API frameworks. See details below. [2] Array<integer>
protocols optional Array of supported video protocols. See details below. [2] Array<integer>
white_label_url optional Override the destination URL the request is sent to. 'https://mydomain.com/hbendpoint' string
pubcid_name optional Name of the pub common id. Conversant adapter can read the id directly if the UserID module is absent. Default is _pubcid. _pubcid string

The following values are defined in the ORTB 2.5 spec.

position

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

api

  • 1 : VPAID 1.0
  • 2 : VPAID 2.0
  • 3 : MRAID 1.0
  • 4 : ORMMA
  • 5 : MRAID 2.0
  • 6 : MRAID 3.0

protocols

  • 1 : VAST 1.0
  • 2 : VAST 2.0
  • 3 : VAST 3.0
  • 4 : VAST 1.0 Wrapper
  • 5 : VAST 2.0 Wrapper
  • 6 : VAST 3.0 Wrapper
  • 7 : VAST 4.0
  • 8 : VAST 4.0 Wrapper
  • 9 : DAAST 1.0
  • 10 : DAAST 1.0 Wrapper

CPMStar

Features

Bidder Code cpmstar Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

DataBlocks

Features

Bidder Code datablocks Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_datablocks hb_bidder_datablocks hb_adid_datablocks
hb_size_datablocks hb_source_datablocks hb_format_datablocks
hb_cache_host_databl hb_cache_id_databloc hb_uuid_datablocks
hb_cache_path_databl hb_deal_datablocks  

Bid Params

Name Scope Description Example Type
sourceId required Website Source Id 111 integer
host requird Network Host to request from ‘host1’ string

DistrictM DMX

Features

Bidder Code dmx Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
memberid required Represent boost MemberId from DistrictM UI ‘member1’ string
tagid optional Represent the placement ID ‘123abc’ string
bidfloor optional The minimum price acceptable for a bid ‘1.0’ string

(See districtmDMX for Prebid.js)

EMX Digital

Features

Bidder Code emx_digital Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Registration

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

Bid Params

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

Engage BDR

Features

Bidder Code engagebdr Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_engagebdr hb_bidder_engagebdr hb_adid_engagebdr
hb_size_engagebdr hb_source_engagebdr hb_format_engagebdr
hb_cache_host_engage hb_cache_id_engagebd hb_uuid_engagebdr
hb_cache_path_engage hb_deal_engagebdr  

Bid Params

Name Scope Description Example Type
sspid required SSPID parameter ‘11111’ string

E-Planning

Features

Bidder Code eplanning Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The E-Planning Header Bidding adaptor requires setup and approval from the E-Planning team. Please go to E-Planning website for more details.

Bid Params

Name Scope Description Example Type
ci required Your partner ID (provided by E-Planning) '18f66' string
sv optional Indicates a bidder URL different than default 'ads.us.e-planning.net' string
isv optional Indicates a CDN URL different than default 'us.img.e-planning.net' string
t optional Indicates bidding for testing purposes 1 integer
ml optional  Uses placement names as ad unit names instead of sizes 1 integer

Gamma

Features

Bidder Code gamma Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
siteId required Site ID 1465446377 integer
zoneId required Zone ID 1515999290 integer

Gamoshi

Features

Bidder Code gamoshi Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid params

Name Scope Description Example Type
supplyPartnerId required ID of the supply partner you created in the Gamoshi dashboard. '12345' string
rtbEndpoint optional If you have a whitelabel account on Gamoshi, specify it here. 'rtb.mybidder.com' string

This adapter only requires you to provide your supply partner ID, and optionally your RTB endpoint, in order to request bids from your Gamoshi account.

TheMediaGrid

Features

Bidder Code grid Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs id5Id, unifiedId, liveIntentId, digitrust GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
uid required Represents the MediaGrid bidder system Ad Slot ID associated with the respective div id from the site page. 1 integer
keywords optional A set of key-value pairs applied to all ad slots on the page. Values can be empty. keywords: { topic: ['stress', 'fear'] } object
useNewFormat optional Indicates to use the new ad request format true boolean

GumGum

Features

Bidder Code gumgum Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Note:

The GumGum Header Bidding adaptor requires setup and approval from the GumGum team. Please reach out to your account manager or support@gumgum.com for more information.

Server and Client Side Bid Params

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

Client Side only Bid Params

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

Improve Digital

Features

Bidder Code improvedigital Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid params

Depending on your setup in our system, your placements will either have a globally-unique placement ID or a publisher-unique placement key as an identifier. Therefore, to identify your placement you either need a placementId only, or a combination of publisherId and placementKey.

Name Scope Description Example Type
placementId optional The placement ID from Improve Digital. 1234567 integer
publisherId optional Your publisher ID. This is only required when using a placementKey 950 integer
placementKey optional The placement key for your placement. Must be used with publisherId. 'myMainBannerPlacement300x200' string
keyValues optional Contains one or more key-value pairings for key-value targeting { testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] } object
size optional Single size filter. Where a placement supports multiple sizes, this forces the response to feature only one of the multiple sizes. This parameter is ignored when usePrebidSizes is enabled (see Sizes section below) { w:300, h:250 } object
bidFloor optional Bid floor price 0.01 float
bidFloorCur optional Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK 'USD' string

Configuration

Single-Request

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

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

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

Sizes

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

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

Examples

Configuration With placementId

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId:1053688
            }
        }
    ]
}];

Configuration With publisherId/placementKey

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementKey:'',
                publisherId:
            }
        }
    ]
}];

Configuration With PlacementId and Key-Values

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
               placementId:1053689,
                keyValues: {
                    testKey1: ["testValueA"],
                    testKey2: ["testValueB", "testValueC"]
                }
            }
        }
    ]
}];

Configuration With PlacementId and Size Filter

var adUnits = [{
    code: 'div-gpt-ad-1499748733608-0',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId:1053687,
                size: {
                    w:300,
                    h:300
                }
            }
        }
    ]
}];

Index Exchange

Features

Bidder Code ix Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Overview

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

Description

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

IX Prebid.js Adapter

Our Prebid.js adapter is compatible with both the older ad unit format where the sizes and mediaType properties are placed at the top-level of the ad unit, and the newer format where this information is encapsulated within the mediaTypes object. We recommend that you use the newer format when possible as it will be better able to accommodate new feature additions.

If a mix of properties from both formats is present within an ad unit, the newer format’s properties will take precedence.

Here are examples of both formats.

Older Format
var adUnits = [{
    // ...

    sizes: [
        [300, 250],
        [300, 600]
    ]

    // ...
}];
Newer Format
var adUnits = [{
    // ...
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        },
        video: {
            context: 'instream',
            playerSize: [
                [1280, 720]
            ]
        }
    },
    // ...
}];

Supported Media Types (Prebid.js)

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

Supported Media Types (Prebid Server)

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

Bid Parameters

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

Name Scope Description Example Type
siteId Required An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. '3723' string
size Required for client-side serving The single size associated with the site ID. It should be one of the sizes listed in the ad unit under adUnits[].sizes or adUnits[].mediaTypes.banner.sizes. Note that the ‘ix’ Prebid Server bid adapter ignores this parameter. [300, 250] Array<integer>
id Optional An alphanumerical value used to identify the slot_id in reporting id: 'billboardHomepage', id: 'billboardArticle' string

Video

Name Scope Description Example Type
siteId Required An IX-specific identifier that is associated with a specific size on this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. '3723' string
size Required The single size associated with the site ID. It should be one of the sizes listed in the ad unit under adUnits[].sizes or adUnits[].mediaTypes.video.playerSize. [300, 600] Array<integer>
video Required The video object will serve as the properties of the video ad. You can create any field under the video object that is mentioned in the OpenRTB Spec v2.5. Some fields like mimes, protocols, minduration, maxduration are required. video: { startdelay: 0 } object
video.mimes Required Array list of content MIME types supported. ['video/mp4', 'video/x-flv'] Array<string>
video.minduration Required Minimum video ad duration in seconds. 0 integer
video.maxduration Required Maximum video ad duration in seconds. 300 integer
video.protocol / video.protocols Required Either a single protocol provided as an integer, or protocols provided as a list of integers. 2 - VAST 2.0, 3 - VAST 3.0, 5 - VAST 2.0 Wrapper, 6 - VAST 3.0 Wrapper [2,3,5,6] integer / Array<integer>
id Optional An alphanumerical value used to identify the slot_id in reporting id: 'inStreamCTP', id: 'inStreamAutoPlay' string

Setup Guide

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

The examples in this guide assume the following starting configuration (you may remove banner or video, if either does not apply).

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

var adUnits = [{
    code: 'banner-div-a',
    mediaTypes: {
        banner: {
            sizes: [
                [300, 250],
                [300, 600]
            ]
        }
    },
    bids: []
},
{
    code: 'video-div-a',
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [
                [1280, 720]
            ]
        }
    },
    bids: []
}];

1. Add IX to the appropriate ad units

For each size in an ad unit that IX will be bidding on, add one of the following bid objects under adUnits[].bids:

{
    bidder: 'ix',
    params: {
        siteId: '123456',
        size: [300, 250]
    }
}

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

Examples

Banner:

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

Video (Instream):

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

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

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

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

Video Caching

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

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

User Sync

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

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

2. Include ixBidAdapter in your build process

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

gulp build --modules=ixBidAdapter,dfpAdServerVideo,fooBidAdapter,bazBidAdapter

If a JSON file is being used to specify the bidder modules, add "ixBidAdapter" to the top-level array in that file.

[
    "ixBidAdapter",
    "dfpAdServerVideo",
    "fooBidAdapter",
    "bazBidAdapter"
]

And then build.

gulp build --modules=bidderModules.json

Setting First Party Data (FPD)

FPD allows you to specify key-value pairs that are passed as part of the query string to IX for use in Private Marketplace Deals which rely on query string targeting for activation. For example, if a user is viewing a news-related page, you can pass on that information by sending category=news. Then in the IX Private Marketplace setup screens, you can create Deals which activate only on pages that contain category=news. Please reach out to your IX representative if you have any questions or need help setting this up.

To include FPD in a bid request, it must be set before pbjs.requestBids is called. To set it, call pbjs.setConfig and provide it with a map of FPD keys to values as such:

pbjs.setConfig({
    ix: {
        firstPartyData: {
            '<key name>': '<key value>',
            '<key name>': '<key value>',
            // ...
        }
    }
});

The values can be updated at any time by calling pbjs.setConfig again. The changes will be reflected in any proceeding bid requests.

Setting a Server Side Timeout

Setting a server-side timeout allows you to control the max length of time taken to connect to the server. The default value when unspecified is 50ms.

This is distinctly different from the global bidder timeout that can be set in Prebid.js in the browser.

To add a server-side timeout, it must be set before pbjs.requestBids is called. To set it, call pbjs.setConfig and provide it with a timeout value as such:

pbjs.setConfig({
    ix: {
        timeout: 50
    }
});

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

IX Prebid Server Adapter

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

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

Important Prebid Server Note

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

Additional Information

Bid Request Limit

If a single bid request to IX contains more than 20 impression requests (i.e. more than 20 objects in bidRequest.imp), only the first 20 will be accepted, the rest will be ignored.

To avoid this situation, ensure that when pbjs.requestBid is invoked, that the number of bid objects (i.e. adUnits[].bids) with adUnits[].bids[].bidder set to 'ix' across all ad units that bids are being requested for does not exceed 20.

Time-To-Live (TTL)

Banner bids from IX have a TTL of 300 seconds while video bids have a TTL of 1 hour, after which time they become invalid.

If an invalid bid wins, and its associated ad is rendered, it will not count towards total impressions on IX’s side.

FAQs

Why do I have to input size in adUnits[].bids[].params for IX when the size is already in the ad unit?

There are two important reasons why we require it:

  1. An IX site ID maps to a single size, whereas an ad unit can have multiple sizes. To ensure that the right site ID is mapped to the correct size in the ad unit we require the size to be explicitly stated.

  2. An ad unit may have sizes that IX does not support. By explicitly stating the size, you can choose not to have IX bid on certain sizes that are invalid.

How can I view the bid request sent to IX by Prebid.js?

In your browser of choice, create a new tab and open the developer tools. In developer tools, select the network tab. Then, navigate to a page where IX is set up to bid. Now, in the network tab, search for requests to casalemedia.com/cygnus. These are the bid requests.

InMobi

Features

Bidder Code inmobi Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

Bid Params

Name Scope Description Example Type
plc required Placement ID '1234' string

Invibes

Features

Bidder Code invibes Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Jixie

Features

Bidder Code jixie Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_jixie hb_bidder_jixie hb_adid_jixie
hb_size_jixie hb_source_jixie hb_format_jixie
hb_cache_host_jixie hb_cache_id_jixie hb_uuid_jixie
hb_cache_path_jixie hb_deal_jixie  

Registration

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

Bid Params

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

Kidoz

Features

Bidder Code kidoz Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

Kubient

Features

Bidder Code kubient Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_kubient hb_bidder_kubient hb_adid_kubient
hb_size_kubient hb_source_kubient hb_format_kubient
hb_cache_host_kubien hb_cache_id_kubient hb_uuid_kubient
hb_cache_path_kubien hb_deal_kubient  

Note:

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

Bid Params

Name Scope Description Example Type
zoneid required The ad zone or tag specific ID '27248' string
floor optional The floor CPM price for the request 0.1234 float
server optional Bidder domain (default 'x.fidelity-media.com') 'kssp.kbntx.ch' string

Lifestreet

Features

Bidder Code lifestreet Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
slot required Ad Slot 'slot166704' string
adkey required Ad Key '78c' string
ad_size required Ad Size '160x600' string

LockerDome

Features

Bidder Code lockerdome Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Logicad for Publishers

Features

Bidder Code logicad Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Luna Media

Features

Bidder Code lunamedia Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_lunamedia hb_bidder_lunamedia hb_adid_lunamedia
hb_size_lunamedia hb_source_lunamedia hb_format_lunamedia
hb_cache_host_luname hb_cache_id_lunamedi hb_uuid_lunamedia
hb_cache_path_luname hb_deal_lunamedia  

Note:

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

Bid Params

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

Marsmedia

Features

Bidder Code marsmedia Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

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

Mgid

Features

Bidder Code mgid Prebid.org Member no
Media Types display, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
    }
  }]
}];

MobileFuse

Features

Bidder Code mobilefuse Prebid.org Member yes
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_mobilefuse hb_bidder_mobilefuse hb_adid_mobilefuse
hb_size_mobilefuse hb_source_mobilefuse hb_format_mobilefuse
hb_cache_host_mobile hb_cache_id_mobilefu hb_uuid_mobilefuse
hb_cache_path_mobile hb_deal_mobilefuse  

Bid Params

Name Scope Description Example Type
placement_id required An ID which identifies this specific inventory placement 1111 integer
pub_id required An ID which identifies the publisher selling the inventory 2222 integer
tagid_src optional ext if passing publisher’s ids, empty if passing MobileFuse IDs in placement_id field. Defaults to empty ’’ string

Nano Interactive

Features

Bidder Code nanointeractive Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
hb_cache_path_nanoin hb_deal_nanointeract  

Requirements:

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

Bid Params

Name Scope Description Example Type
pid required Identification key, provided by Nano Interactive '5afaa0280ae8996eb578de53' string
category optional Contextual taxonomy 'automotive' string
categoryName optional Contextual taxonomy (from URL query param) 'cat_name' string
nq optional User search query 'automobile search query' string
name optional User search query (from URL query param) 'search_param' string
subId optional Channel - used to separate traffic sources '123' string

Configuration

The category and categoryName are mutually exclusive. If you pass both, categoryName takes precedence.
The nq and name are mutually exclusive. If you pass both, name takes precedence.

Example with only required field pid

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53'
        }
    }]
}];

Example with category

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            category: 'automotive',
            subId: '123'
        }
    }]
}];

Example with categoryName

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // Category "automotive" is in the URL like:
            // https://www....?cat_name=automotive&...
            categoryName: 'cat_name',
            subId: '123'
        }
    }]
}];

Example with nq

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // User searched "automobile search query" (extracted from search text field)
            nq: 'automobile search query',
            subId: '123'
        }
    }]
}];

Example with name

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            // User searched "automobile search query" and it is in the URL like:
            // https://www....?search_param=automobile%20search%20query&...
            name: 'search_param',
            subId: '123'
        }
    }]
}];

Example with category and nq

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            category: 'automotive',
            nq: 'automobile search query',
            subId: '123'
        }
    }]
}];

Example with categoryName and name

var adUnits = [{
    code: 'nano-div',
    sizes: [[300, 250], [300,600]],
    bids: [{
        bidder: 'nanointeractive',
        params: {
            pid: '5afaa0280ae8996eb578de53',
            categoryName: 'cat_name',
            name: 'search_param',
            subId: '123'
        }
    }]
}];

NinthDecimal

Features

Bidder Code ninthdecimal Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

One Fifty Two Media

Features

Bidder Code oftmedia Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
placementId required     string
randomKey optional     string
invCode optional     string
member optional     string

One Fifty Two Media is an aliased bidder for AppNexus

OpenX

Features

Bidder Code openx Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.

Bid Parameters

Name Scope Description Example Type
delDomain or platform required OpenX delivery domain or platform id provided by your OpenX representative. “PUBLISHER-d.openx.net” or “555not5a-real-plat-form-id0123456789” String
unit required OpenX ad unit ID provided by your OpenX representative. “1611023122” String
customParams optional User-defined targeting key-value pairs. customParams applies to a specific unit. {key1: "v1", key2: ["v2","v3"]} Object
customFloor optional Minimum price in USD. customFloor applies to a specific unit. For example, use the following value to set a $1.50 floor: 1.50

WARNING:
Misuse of this parameter can impact revenue
1.50 Number
doNotTrack optional Prevents advertiser from using data for this user.

WARNING:
Impacts all bids in the request. May impact revenue.
true Boolean
coppa optional Enables Child’s Online Privacy Protection Act (COPPA) regulations. WARNING:
Impacts all bids in the request. May impact revenue.
true Boolean

Video

Name Scope Description Example Type
unit required OpenX ad unit ID provided by your OpenX representative. “1611023122” String
delDomain required OpenX delivery domain provided by your OpenX representative. “PUBLISHER-d.openx.net” String
openrtb optional An OpenRtb Impression with Video subtype properties { imp: [{ video: {mimes: ['video/x-ms-wmv, video/mp4']} }] } Object

Example

var adUnits = [
  {
    code: 'test-div',
    sizes: [[728, 90]],  // a display size
    mediaTypes: {'banner': {}},
    bids: [
      {
        bidder: 'openx',
        params: {
          unit: '539439964',
          delDomain: 'se-demo-d.openx.net',
          customParams: {
            key1: 'v1',
            key2: ['v2', 'v3']
          },
        }
      }, {
        bidder: 'openx',
        params: {
          unit: '539439964',
          platform: 'a3aece0c-9e80-4316-8deb-faf804779bd1',
          customParams: {
            key1: 'v1',
            key2: ['v2', 'v3']
          },
        }
      }
    ]
  },
  {
    code: 'video1',
    mediaTypes: {
      video: {
        playerSize: [640, 480],
        context: 'instream'
      }
    },
    bids: [{
      bidder: 'openx',
      params: {
        unit: '1611023124',
        delDomain: 'PUBLISHER-d.openx.net',
        video: { 
          mimes: ['video/x-ms-wmv, video/mp4']
        }
      }
    }]
  }
];

Configuration

Add the following code to enable user syncing. By default, Prebid.js version 0.34.0+ turns off user syncing through iframes. OpenX strongly recommends enabling user syncing through iframes. This functionality improves DSP user match rates and increases the OpenX bid rate and bid price. Be sure to call pbjs.setConfig() only once.

pbjs.setConfig({
   userSync: {
      iframeEnabled: true
   }
});

Additional Details

Banner Ads

Video Ads

Orbidder

Features

Bidder Code orbidder Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

PubMatic

Features

Bidder Code pubmatic Prebid.org Member yes
Media Types display, video, native GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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:

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

For Prebid.js v1.15.0 and later:

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

For Prebid.js v1.14.0 and before:

pbjs.setConfig({
   userSync: {
    iframeEnabled: true,
    enabledBidders: ['pubmatic']
 }});

Note: Combine the above the configuration with any other UserSync configuration. Multiple setConfig() calls overwrite each other and only last call for a given attribute will take effect.

adSlot Specification and Multi-Size Ad Units

The adSlot parameter supports two different formats:

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

Support and behavior differs by Prebid.js version

Prebid.js v2.13.0 and later:

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

Prebid.js v2.9.0 to v2.12.0:

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

Prebid.js v1.18.0 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.17.0 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 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

AdUnit Format for Video

var videoAdUnits = [
{
    code: 'test-div-video',
    mediaTypes: {
        video: {
            playerSize: [640, 480],           // required
            context: 'instream'
        }
    },
    bids: [{
      bidder: 'pubmatic',
      params: {
        publisherId: '32572',                     // required
        adSlot: '38519891@300x250',              // required
        video: {
          mimes: ['video/mp4','video/x-flv'],   // required
          skippable: true,                      // optional
          minduration: 5,                       // optional
          maxduration: 30,                      // optional
          startdelay: 5,                        // optional
          playbackmethod: [1,3],                // optional
          api: [ 1, 2 ],                        // optional
          protocols: [ 2, 3 ],                  // optional
          battr: [ 13, 14 ],                    // optional
          linearity: 1,                         // optional
          placement: 2,                         // optional
          minbitrate: 10,                       // optional
          maxbitrate: 10                        // optional
        }
      }
    }]
}]

AdUnit Format for Native

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

Configuration for video

For Video ads, prebid cache needs to be enabled for PubMatic adapter.

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

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

PubNative

Features

Bidder Code pubnative Prebid.org Member yes
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 (e.g. Mopub) 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
}

PulsePoint

Features

Bidder Code pulsepoint Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

Bid Params

Name Scope Description Example Type
cf required Ad size identifier '300X250' string
cp required Publisher Id 12345 integer
ct required Ad Tag Id 12345 integer
bcat optional Blocked IAB Categories [ 'IAB1-5', 'IAB1-6' ] array of strings
battr optional Blocked Creative Attributes [ 1, 2, 5 ] array of integers
badv optional Blocked Advertisers by their domains ['ford.com', 'pepsi.com'] array of strings
bidfloor optional Bid floor price CPM 1.23 float
video required Required for video requests. OpenRTB Video object. { w: 400, h: 300 } object

Video parameters

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

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

RhythmOne

Features

Bidder Code rhythmone Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

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

RTBHouse

Features

Bidder Code rtbhouse Prebid.org Member no
Media Types display, native GDPR TCF1 Support yes
User IDs id5Id, identityLink GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK yes USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

Rubicon Project

Features

Bidder Code rubicon Prebid.org Member yes
Media Types display, video GDPR TCF1 Support yes
User IDs identityLink, liveIntentId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK yes USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 team or globalsupport@magnite.com for more information.

Bid Params

Name Scope Description Example Type
accountId required The publisher account ID '4934' string
siteId required The site ID '13945' string
zoneId required The zone ID '23948' string
sizes optional Array of Rubicon Project size IDs. If not specified, the system will try to convert from the AdUnit’s mediaTypes.banner.sizes. [15] Array<integer>
keywords optional Array of page-specific keywords. May be referenced in Rubicon Project reports. ['travel', 'tourism'] Array<string>
inventory optional An object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays. {"rating":["5-star"], "prodtype":["tech","mobile"]} object
visitor optional An object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays. {"ucat":["new"], "search":["iphone"]} object
position optional Set the page position. Valid values are “atf” and “btf”. 'atf' string
userId optional Site-specific user ID may be reflected back in creatives for analysis. Note that userId needs to be the same for all slots. '12345abc' string
floor optional Sets the global floor – no bids will be made under this value. 0.50 float
latLong optional Sets the latitude and longitude for the visitor (avail since PBJS 1.10) [40.7608, 111.8910] Array<float>
video required for video Video targeting parameters. See the video section below. {"language": "en"} object

Video

The following video parameters are supported:

Name Scope Description Example Type
playerWidth optional Video player width in pixels. If not specified, takes width set in mediaTypes.video.playerSize '640' string
playerHeight optional Video player height in pixels. If not specified, takes height set in mediaTypes.video.playerSize '360' string
size_id optional for Prebid.js, required for Prebid Server Integer indicating the Rubicon Project video ad format ID. If not set, Prebid.js can infer 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:

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

Configuration

Single-Request

By default, the Rubicon Project adapter sends one request to rubiconproject.com for each AdUnit. For example, if there are 4 PBJS AdUnits defined on the page, you’ll see 4 calls out to rubiconproject.com/fastlane.json.

As of PBJS 1.12, the Rubicon Project adapter supports Single Request mode, where all AdUnit requests are made in a single call to rubiconproject.com. To turn this feature on, call setConfig:

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

Notes

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:

pbjs.setConfig({ rubicon: {netRevenue: false} });

Sharethrough

Features

Bidder Code sharethrough Prebid.org Member no
Media Types display, native GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

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
bidfloor optional The floor price, or minimum amount, a publisher will accept for an impression, given in CPM in USD. 1.00 float
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]
pkey required The placement key 'DfFKxpkRGPMS7A9f71CquBgZ' string

Smaato

Features

Bidder Code smaato Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support no COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.

Bid Params

Name Scope Description Example Type
publisherId required Your Smaato publisher id '1100012345' string
adspaceId required Your Smaato adspace id '11002234' string
app optional Object containing mobile app parameters. See the App Object for details. app : { ifa: '56700000-9cf0-22bd-b23e-46b96e40003a'} object

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 Banner Ad Unit

var adUnit = {
    "code": "header-bid-tag-1",
    "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"
        }
    }]
};

First Party Data

The Smaato adapter supports passing through first party data configured in your prebid integration.

pbjs.setConfig({
    fpd: {
        context: {
            keywords: "power tools"
        },
        user: {
            keywords: "a,b",
            gender: "M",
            yob: 1984
        }
});

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":"100042525",
               "adspaceId":"130563103"
            }
         }
      }
   ]

Smart AdServer

Features

Bidder Code smartadserver Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, digitrust, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 adaptor requires setup and approval from the Smart AdServer Service team. Please reach out to your account manager for more information and start using it.

Bid params

Name Scope Description Example Type
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 The placement page ID 1234 integer
formatId required The placement format ID 1234 integer
domain optional The network domain (default see example) 'http://prg.smartadserver.com', 'https://prg.smartadserver.com' string
target optional The keyword targeting 'sport=tennis' string
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 or all empty.

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

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

SmartRTB

Features

Bidder Code smartrtb Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Registration

Please contact us to create a new Smart RTB Marketplace account, and for any assistance in configuration. You may email info@smrtb.com for inquiries.

Prebid.js Bid Params

Name Scope Description Example Type
zoneId required   z_261b6c7e7d4d4985393b293cc903d1 string
forceBid optional Returns test bid true boolean

Prebid Server Bid Params

Name Scope Description Example Type
pub_id required Publisher ID assigned to you. 'siteA' string
zone_id optional Enables mapping for further settings and reporting in the Marketplace UI. 'z_261b6c7e7d4d4985393b293cc903d1' string
force_bid optional If zone ID is mapped, this may be set to always return fake sample bids (banner, video) true boolean

Test Prebid Server Request

This sample request is our global test placement and should always return a branded banner bid.

        {
        "id": "abc",
        "site": {
            "page": "prebid.org"
        },
        "imp": [{
                "id": "test",
                "banner": {
                        "format": [{
                                "w": 300,
                                "h": 250
                        }]
                },
                "ext": {
                        "smartrtb": {
			    "pub_id": "test",
			    "zone_id": "N4zTDq3PPEHBIODv7cXK",
			    "force_bid": true
                        }
                }
        }]
    }

Somo Audience

Features

Bidder Code somoaudience Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
placementId required Placement ID provided by Somo Audience '22a58cfb0c9b656bff713d1236e930e8' string

Sonobi

Features

Bidder Code sonobi Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

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.

Sovrn

Features

Bidder Code sovrn Prebid.org Member yes
Media Types display GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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' string

Synacor Media

Features

Bidder Code synacormedia Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 requires setup and approval from Synacor. Please reach out to your account manager for more information and to start using it.

Configuration

Synacor Media requires that iframe is used for user syncing.

Example configuration:

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

DFP Video Creative

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

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

Bid params

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

Example Ad Unit

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

Video Parameters (see openrtb 2.5 spec)

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

Tappx

Features

Bidder Code tappx Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.

Note: The Tappx prebid bidder only supports in app traffic at the moment

Bid Params

Name Scope Description Example Type
host required Tappx host ‘host1’ string
tappxkey required An ID which identifies the adunit ‘key1’ string
endpoint required Endpoint provided to publisher ‘endpoint1’ string
bidfloor optional Minimum bid for this impression expressed in CPM (USD) 1.2 number

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)

TripleLift

Features

Bidder Code triplelift Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs criteo, identityLink, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support yes
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

Bid Params

Name Scope Description Example Type
inventoryCode required TripleLift inventory code for this ad unit (provided to you by your partner manager) 'pubname_main_feed' string
floor optional Bid floor 1.00 float
video required for instream video oRTB video object { mimes: ['video/mp4'], w: 640, h: 480 } object
video.w required for instream video oRTB video object width dimension 640 int
video.h required for instream video oRTB video object height dimension 480 int

TripleLift Native

Features

Bidder Code triplelift_native Prebid.org Member no
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

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

ucfunnel

Features

Bidder Code ucfunnel Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs unifiedId GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

Bid params

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

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

Examples

Unruly

Features

Bidder Code unruly Prebid.org Member no
Media Types display, video, native GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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. This will be provided to you by your Unruly account manager 123456 integer
targetingUUID required The targeting UUID from Unruly. This will be provided to you by your Unruly account manager '766220b5-3d02-46c5-aa8b-2bc60c6f7418' string

Valueimpression

Features

Bidder Code valueimpression Prebid.org Member no
Media Types display, video GDPR TCF1 Support yes
User IDs none GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

Bid Params

Name Scope Description Example Type
siteId required Publisher site ID from Valueimpression 'vi-site-id' string

VerizonMedia

Features

Bidder Code verizonmedia Prebid.org Member yes
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_verizonmedia hb_bidder_verizonmed hb_adid_verizonmedia
hb_size_verizonmedia hb_source_verizonmed hb_format_verizonmed
hb_cache_host_verizo hb_cache_id_verizonm hb_uuid_verizonmedia
hb_cache_path_verizo hb_deal_verizonmedia  

Bid Params

Name Scope Description Example Type
dcn required Site ID provided by One Mobile ‘site1’ string
pos required Placement ID ‘placement1’ string

YOC VIS.X

Features

Bidder Code visx Prebid.org Member no
Media Types display GDPR TCF1 Support yes
User IDs id5Id, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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.

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.

Bid params

Name Scope Description Example Type
uid required The publisher’s ad unit ID in VIS.X '903536' string

Configuration

The YOC VIS.X adapter has the ability to work in different currencies. Currently this adapter 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.

  1. Download and configure the Prebid.js Currency module.

http://prebid.org/dev-docs/modules/currency.html

  1. 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 currency module is set up and configured in order to trade with YOC in a currency that is not supported by YOC VIS.X bidder.
  • You should set EUR in bidderCurrencyDefault parameter if you use unsupported currency for VIS.X.
  • Feel free to reach out to your contact at YOC if you need additional support setting up Prebid.js and currency config.

VRTCAL Markets, Inc.

Features

Bidder Code vrtcal Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

YeahMobi

Features

Bidder Code yeahmobi Prebid.org Member yes
Media Types display, native GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
Media Types display, video GDPR TCF1 Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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
adSize required Override the default prebid size '970x250' string
targeting optional Key-Value Targeting { 'key1': 'value1', 'key2': 'value2' } object
extId optional External Id 'abc' string
customParams optional Custom parameters to append to the query string of the bidding endpoint. { 'param': 'value1', 'param2': 'value2' } object

Yieldmo

Features

Bidder Code yieldmo Prebid.org Member yes
Media Types display GDPR TCF1 Support yes
User IDs pubCommonId, unifiedId, criteo GDPR TCF2 Support yes
SChain Support yes COPPA Support no
Safeframes OK check with bidder USP/CCPA Support yes
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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  

Bid Params

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

YIELDONE

Features

Bidder Code yieldone Prebid.org Member no
Media Types display, video GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter yes
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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

ZeroClickFraud

Features

Bidder Code zeroclickfraud Prebid.org Member no
Media Types display GDPR TCF1 Support no
User IDs none GDPR TCF2 Support no
SChain Support no COPPA Support no
Safeframes OK check with bidder USP/CCPA Support no
Supports Deals yes Prebid.js Adapter no
    Prebid Server Adapter yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_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 requird Network Host to request from ‘host1’ string