Prebid Server Bidder Params

This page contains documentation on the specific parameters required by each supported bidder. These docs only apply to Prebid Server bidders. For Prebid.js bidders see the Prebid.js Bidders page.

For each bidder listed below, you’ll find the following information:

Features A table of features supported by the adapter.
“Send All Bids” Ad Server Keys Used for sending all bids to the ad server, as described in Send All Bids vs Send Top Price
Bid Params Ad request parameters required by a given bidder, such as the tag ID, site ID, or query string parameters

You can also download the full CSV data file.

Publishers are advised to check with legal counsel before doing business with any particular bidder.

Prebid Server Bidder List

Bidder Documentation

33Across

Features

Bidder Code 33across Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 58
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
siteId required Publisher GUID from 33Across 'examplePub123' string
productId required 33Across Product ID that the Publisher has registered for (use 'siab' for Banner or Outstream Video , 'inview' for Adhesion, 'instream' for Instream Video) 'siab' string

Ad Unit Setup for Banner

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    banner: {  
      sizes: [
          [300, 250], 
          [728, 90]
      ]
    }   
  } 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required 
        productId: 'siab|inview'    // required
    }
  }]
}

Ad Unit Setup for Outstream Video

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'outstream',                 // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 2,                         // optional, defaults to 2 when context = outstream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required     
        productId: 'siab'           // required     
    }
  }],
  ...
}

Ad Unit Setup for Instream Video

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'instream',                  // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 1,                         // optional, defaults to 1 when context = instream
      startdelay: 0,                        // optional, defaults to 0 when context = instream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required    
        productId: 'instream'       // required     
    }
  }],
  ...
}

Ad Unit Setup for Multi-format: Banner, Video (Outstream)

var adUnits = [
{
  code: '33across-hb-ad-123456-1', // ad slot HTML element ID  
  mediaTypes: {
    banner: {  
      sizes: [
          [300, 250], 
          [728, 90]
      ]
    },
    video: {                                // We recommend setting the following video params
                                            // in Ad Unit rather than bidder params as per Prebid 4.0 recommendation. 
      playerSize: [300, 250],               // required
      context: 'outstream',                 // required
      mimes: ['video/mp4','video/x-flv'],   // required
      protocols: [ 2, 3 ],                  // required, set at least 1 value in array
      placement: 2,                         // optional, defaults to 2 when context = outstream
      api: [ 1, 2 ],                        // optional
      skip: 0,                              // optional
      minduration: 5,                       // optional
      maxduration: 30,                      // optional
      playbackmethod: [1,3],                // optional
      battr: [ 13, 14 ],                    // optional
      linearity: 1,                         // optional
      minbitrate: 10,                       // optional
      maxbitrate: 10                        // optional
    }   
  }, 
  bids: [{
    bidder: '33across',
    params: {
        siteId: 'examplePub123',    // required     
        productId: 'siab'           // required     
    }
  }],
  ...
}

SRA Mode

We recommend using SRA mode to optimize the bidding process as this allows our adapter to group together bid requests for Ad Units pertaining to the same product and site ID thereby minimizing the number of http requests made to our endpoint. To enable SRA set the following bidder specific config under 33Across

pbjs.setBidderConfig({
   bidders: ['33across'],
   config: {
      ttxSettings: {
        enableSRAMode: true
      }
   }
});

AAX

Features

Bidder Code aax Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-not-bid
TCF-EU Support yes IAB GVL ID 720
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aax hb_bidder_aax hb_adid_aax
hb_size_aax hb_source_aax hb_format_aax
hb_cache_host_aax hb_cache_id_aax hb_uuid_aax
hb_cache_path_aax hb_deal_aax  

Bid Params

Name Scope Description Example Type
cid required The customer id provided by Aax. 'aax_test_customer' string
crid required The placement id provided by Aax. 'aax_crid' string
video required for video Ad units Object containing video targeting parameters. See Video Object for details. video: { maxduration: 60 } object

Video Object

Name Type Description Example
mimes array of strings (Recommended) Specifies the video content MIME types supported; for example, video/x-ms-wmv and video/x-flv. [“video/x-ms-wmv”,”video/x-flv”]
minduration integer (Recommended) Specifies the minimum video ad duration, in seconds. 10
maxduration integer (Recommended) Specifies the maximum video ad duration, in seconds. 60
w integer (Recommended) Specifies the width of the video player, in pixels. Required if playerSize not present in mediaTypes.video 640
h integer (Recommended) Specifies the height of the video player, in pixels. Required if playerSize not present in mediaTypes.video 480
startdelay integer (Recommended) Specifies the start delay of the video ad 0
battr array of integers Specifies the video creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes. [ 13, 14 ]
playbackmethod array of integers Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are: 1: Autoplay, sound on; 2: Autoplay, sound off; 3: Click to play; 4: Mouse over to play [1, 3]
api array of integers Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are: 1: VPAID 1.0; 2: VPAID 2.0; 3: MRAID-1; 4: ORMMA; 5: MRAID-2 [1, 2]
protocols array of integers Array of supported video protocols. Currently supported values are: 1: VAST 1.0; 2: VAST 2.0; 3: VAST 3.0; 4: VAST 1.0 Wrapper; 5: VAST 2.0 Wrapper; 6: VAST 3.0 Wrapper; 7: VAST 4.0 [1, 2]
placement integer Placement type for the impression. Possible options: 1: In-Stream; 2: In-banner; 3: Outstream/In-article; 4: In-feed; 5: Interstitial/Slider/Floating; 6: Long-Form; 1

Besides the above-mentioned parameters, we support all other OpenRTB 2.x video objects as optional parameters.

In addition to bids[].params.video, Aax adapter consumes parameters specified in the mediaTypes.video.

Example of Instream Video Ad-unit

var videoAdUnit = {
  code: 'video1',
  mediaTypes: {
    video: {
      context: "instream",
      playerSize: [640, 480],
      mimes: ['video/mp4'],
      placement: 1
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid',  
    }
  }]
};

Example of Native Ad-unit

var adUnits = [{
  code: 'div-gpt-ad-6874091242345-0',
  mediaTypes: {
    native: {
      image: {
        required: true,
        sizes: [300, 250],
        wmin: 50,
      },
      title: {
        required: true,
        len: 80
      }
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid'
    }
  }]
}];

Example of Banner Ad-unit

var adUnits = [{
  code: 'div-gpt-ad-6874091242345-0',
  mediaTypes: {
    banner: {
      sizes: [
        [728, 90],
        [300, 600],
        [300, 250]
      ],
    }
  },
  bids: [{
    bidder: 'aax',
    params: {
      cid: 'aax_test_customer',
      crid: 'aax_crid'
    }
  }]
}];

Aceex

Features

Bidder Code aceex Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aceex hb_bidder_aceex hb_adid_aceex
hb_size_aceex hb_source_aceex hb_format_aceex
hb_cache_host_aceex hb_cache_id_aceex hb_uuid_aceex
hb_cache_path_aceex hb_deal_aceex  

Note

The Example Bidding adapter requires setup before beginning. Please contact us at tech@aceex.com

Bid Params

Name Scope Description Example Type
accountid required Endpoint id 'hash' string

AcuityAds

Features

Bidder Code acuityads Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 231
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_acuityads hb_bidder_acuityads hb_adid_acuityads
hb_size_acuityads hb_source_acuityads hb_format_acuityads
hb_cache_host_acuity hb_cache_id_acuityad hb_uuid_acuityads
hb_cache_path_acuity hb_deal_acuityads  

Note

The Example Bidding adapter requires setup before beginning. Please contact us at rafi.babler@acuityads.com

Prebid.JS Bid Params

Name Scope Description Example Type
placementId required Placement ID '123' string

Prebid Server Bid Params

Name Scope Description Example Type
host required Region id 'ep1' string
accountid required Endpoint id / Placement id 'hash' string

AdElement

Features

Bidder Code adelement Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 196
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adelement hb_bidder_adelement hb_adid_adelement
hb_size_adelement hb_source_adelement hb_format_adelement
hb_cache_host_adelem hb_cache_id_adelemen hb_uuid_adelement
hb_cache_path_adelem hb_deal_adelement  

Note

Bidding adapter requires setup before beginning. Please contact us at prebid@adelement.com

Bid Params

Name Scope Description Example Type
supply_id required Supply Id '1' string

AdformOpenRTB

Features

Bidder Code adf Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 50
GPP Support check with bidder DSA Support yes
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adf hb_bidder_adf hb_adid_adf
hb_size_adf hb_source_adf hb_format_adf
hb_cache_host_adf hb_cache_id_adf hb_uuid_adf
hb_cache_path_adf hb_deal_adf  

This bidder previously had a bidder code of adformOpenRTB, but prefers new configurations to use adf.

Bid params

Name Scope Description Example Type
mid required, if inv and nmane not set Placement ID 12345 integer
inv required, if mid not set Inventory source ID 1234 integer
mname required, if mid not set Placement name "Leaderboard" string
adxDomain optional, Prebid.js only The Adform domain "adx.adform.net" string
priceType optional Price type "gross" string

Note: Bid placement should be defined using the mid parameter or inv and mname parameters (dynamic master tag) but not both.

OpenRTB request config

OpenRTB bid request app, site, device properties configured using prebid config.

pbjs.setConfig({
  ortb2: {
    app: {
      name: 'My APP'
    }
  }
});

Ad Generation

Features

Bidder Code adgeneration Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs novatiq, criteo, id5Id ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

Adhese

Features

Bidder Code adhese Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 553
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs id5Id ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Registration

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

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

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
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 14
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

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

AdKernelAdn

Features

Bidder Code adkernelAdn Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 14
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

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

ADman Media

Features

Bidder Code adman Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 149
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs uid2, lotamePanoramaId, idx ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Note

The Adman Bidding adapter requires setup before beginning. Please contact us at prebid@admanmedia.com Due to different integration API prebid.js and prebid-server api params are different

Prebid.JS Bid Params

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

Prebid server Bid Params

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

AdMatic

Features

Bidder Code admatic Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 1281
GPP Support tcfeu, tcfca, usnat, usstate_all, usp DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs criteo, id5Id, sharedId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_admatic hb_bidder_admatic hb_adid_admatic
hb_size_admatic hb_source_admatic hb_format_admatic
hb_cache_host_admati hb_cache_id_admatic hb_uuid_admatic
hb_cache_path_admati hb_deal_admatic  

Description

AdMatic header bidding adapter connects with AdMatic demand sources to fetch bids for banner network ID. Please reach out to your account manager or prebid@admatic.com.tr for more information.

Bid params

Name Scope Description Example Type
networkId required The network ID from AdMatic 12345 number
host required RTB Host layer.serve.admatic.com.tr string

Test Parameters

300x250 banner test

var adUnits = [{
  code: 'your-slot_1-div',
  mediaTypes: {
    banner: { sizes: [[300, 250]] },
  },
  bids: [{
      bidder: 'admatic',
      params: { 
          networkId: 12345,
          host: 'layer.serve.admatic.com.tr'
      }
  }]
},{
  code: 'your-slot_2-div',
  mediaTypes: {
    native: { ... },
  },
  bids: [{
      bidder: 'admatic',
      params: { 
          networkId: 12345,
          host: 'layer.serve.admatic.com.tr'
      }
  }]
},{
  code: 'your-slot_3-div',
  mediaTypes: {
    video: { ... },
  },
  bids: [{
      bidder: 'admatic',
      params: { 
          networkId: 12345,
          host: 'layer.serve.admatic.com.tr'
      }
  }]
}];

UserSync example

pbjs.setConfig({
  userSync: {
    iframeEnabled: true,
    syncEnabled: true,
    syncDelay: 1
  }
});

AdMixer

Features

Bidder Code admixer Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 511
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs AdmixerID ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
zone required The unique identifier of the ad placement. Could be obtained from the Admixer UI or from your account manager. “e5ff8e48-4bd0-4a2c-9236-55530ab8981d” string
kvTargeting optional Key/Value - a pair of the unique values that will be used for the custom targeting option. {key1: value2, key2: value2} object

Adnuntius

Features

Bidder Code adnuntius Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 855
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK no Supports Deals check with bidder
Floors Module Support no First Party Data Support yes
User IDs none ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adnuntius hb_bidder_adnuntius hb_adid_adnuntius
hb_size_adnuntius hb_source_adnuntius hb_format_adnuntius
hb_cache_host_adnunt hb_cache_id_adnuntiu hb_uuid_adnuntius
hb_cache_path_adnunt hb_deal_adnuntius  

Bid Params

Name Scope Description Example Type
auId required The ad unit ID '0000000000072345' leading zeros can be omitted. '0000000000072345' string
network optional Used if you want to make requests to multiple networks in adnuntius. 'adnuntius' string
userId optional Allows you to set a specific user id in the request. 'userId' string
targeting optional Targeting to be sent through to adnuntius with the request. { c: ['prebids'] } string
maxDeals optional The maximum number of deal bids to include. Default 0. 1 Integer
bidType optional Whether to use grossBid or netBid from the server response as the cpm bid. Default is grossBid. grossBid string

The bidType can also be set under config in the bidderSettings.

Targeting

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

Example

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

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

Sending segments to the ad server

There’s an option to send segment id in the bidder config that will be picked up and sent to the ad server. Below is an example on how to do this:

pbjs.setBidderConfig({
    bidders: ['adnuntius', 'bidderB'],
    config: {
        ortb2: {
            user: {
                data: [{
                    name: "adnuntius",
                    segment: [
                        { id: "1" },
                        { id: "2" }
                    ]
                }]
            }
        }
    }
});

Disable cookies for adnuntius

You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuintius will not set it for internal ads.

pbjs.setBidderConfig({
    bidders: ['adnuntius'],
    config: {
        useCookie: false
    }
});

Use cookie will always be set to true by default. Changing it to false will disable cookies.

Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Adnuntius adapter. the auId below will not return a creative. Please substitute it with your own.

{
    "imp": [{
        "id": "impression-id",
        "banner": {
            "format": [{
                "w": 980,
                "h": 240
            }, {
                "w": 980,
                "h": 360
            }]
        },
        "ext": {
            "adnuntius": {
                "auId": "abc123",
                "maxDeals": 2 // Optional
            }
        }
    }]
}

As a publisher you have the option to set no cookie in the device request to let Adnuntius adserver know not to set cookies in the client’s browser. In order to do that you just need to pass this in the request:

{
    "device": {  
        "ext": {
            "noCookies": true
        }
    }
}

First Party Data

publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:

  • ortb2.site
  • ortb2.user

These fields are optional and only needed for user identification and contextual targeting. How to use it can be read here: Prebid ortb2. Currently we only support this for our prebid server bidder, but will add it to the client bidder in the future.

Video requests

Currently we only support client requests and instream context. An example request would look like this:

{
    "code": "video1",
    "mediaTypes": {
        "video": {
            "playerSize": [640, 480],
            "context": "instream"
        }
    },
    "bids": [{
        "bidder": "adnuntius",
        "params": {
            "auId": "00000000001cd429", //put your placement id here

            "video": {
                "skippable": true,
                "playback_method": ["auto_play_sound_off"]
            }
        }
    }]
};

AdOcean

Features

Bidder Code adocean Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 328
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Note

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

Prebid.JS Bid Params

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

Prebid Server Bid Params

Name Scope Description Example Type
slaveId required slave ID 'adoceanmyaozpniqismex' string
masterId required master ID 'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7' string
emitterPrefix required AdOcean emitter prefix 'myao' string

Adoppler

Features

Bidder Code adoppler Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adoppler hb_bidder_adoppler hb_adid_adoppler
hb_size_adoppler hb_source_adoppler hb_format_adoppler
hb_cache_host_adoppl hb_cache_id_adoppler hb_uuid_adoppler
hb_cache_path_adoppl hb_deal_adoppler  

Bid Params

Name Scope Description Example Type
adunit required AdUnit to bid against ‘test’ string
client optional Client name ‘ads’ string

Adot

Features

Bidder Code adot Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 272
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs pubProvidedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adot hb_bidder_adot hb_adid_adot
hb_size_adot hb_source_adot hb_format_adot
hb_cache_host_adot hb_cache_id_adot hb_uuid_adot
hb_cache_path_adot hb_deal_adot  

Prebid JS

Bid Params

Name Scope Description Example Type
placementId optional The placement ID from Adot. 'adot_placement_224521' string
video optional Object containing video targeting parameters. See Video Object for details.   object

Video Object

Name Scope Description Type
container optional Selector used for finding the element in which the video player will be displayed, e.g., #div-1. The ad unit code will be used if no container is provided. string

Bid Config

PublisherId

You can set a publisherId using pbjs.setBidderConfig for the bidder adot

Example

pbjs.setBidderConfig({
    bidders: ['adot'],
    config: {
        adot: {
            publisherId: '__MY_PUBLISHER_ID__'
        }
    }
});

Specific publisher path

You can set a specific publisher path using pbjs.setBidderConfig for the bidder adot The bidrequest will add this path to the bidder endpoint

Example

pbjs.setBidderConfig({
    bidders: ['adot'],
    config: {
        adot: {
            publisherPath: '__MY_PUBLISHER_PATH__'
        }
    }
});

Prebid server

Bid Params

Name Scope Description Example Type
placementId optional An ID which identifies this placement of the impression. 'adot_placement_224521' string
parallax optional (only for prebid-server) Specify if the wanted advertising’s creative is a parallax. true/false boolean
publisherPath optional Specific to each integration. Do not use until asked by someone from adot. /hubvisor string

Testing Bid Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side adot adapter. This is a mobile Bid-request example.

  {
  "id": "b967c495-adeb-4cf3-8f0a-0d86fa17aeb2",
  "app": {
    "id": "0",
    "name": "test-adot-integration",
    "publisher": {
      "id": "1",
      "name": "Test",
      "domain": "test.com"
    },
    "bundle": "com.example.app",
    "paid": 0,
    "domain": "test.com",
    "page": "https:\/\/www.test.com\/",
    "cat": [
      "IAB1",
      "IAB6",
      "IAB8",
      "IAB9",
      "IAB10",
      "IAB16",
      "IAB18",
      "IAB19",
      "IAB22"
    ]
  },
  "device": {
    "ua": "Mozilla\/5.0 (Linux; Android 7.0; SM-G925F Build\/NRD90M; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/80.0.3987.132 Mobile Safari\/537.36",
    "make": "phone-make",
    "model": "phone-model",
    "os": "os",
    "osv": "osv",
    "ip": "0.0.0.0",
    "ifa": "IDFA",
    "carrier": "WIFI",
    "language": "English",
    "geo": {
      "zip": "75001",
      "country": "FRA",
      "type": 2,
      "lon": 48.2,
      "lat": 2.32,
      "accuracy": 100
    },
    "ext": {
      "is_app": 1
    },
    "connectiontype": 2,
    "devicetype": 4
  },
  "user": {
    "id": "IDFA",
    "buyeruid": ""
  },
  "imp": [
    {
      "id": "dec4147e-a63f-4d25-9fff-da9bfd05bd02",
      "banner": {
        "w": 320,
        "h": 50,
        "format": [
          {
            "w": 320,
            "h": 50
          }
        ],
        "api": [
          1,
          2,
          5,
          6,
          7
        ]
      },
      "bidfloorcur": "USD",
      "bidfloor": 0.1,
      "instl": 0,
      "ext": {
        "adot": {
        }
      }
    }
  ],
  "cur": [
    "USD"
  ],
  "regs": {
    "ext": {
      "gdpr": 1
    }
  },
  "at": 1
}

Please contact admin@we-are-adot.com if you would like to build and deploy Prebid server and use it with Adot.

Adpone

Features

Bidder Code adpone Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID 799
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals no
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

Adprime

Features

Bidder Code adprime Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Prebid.js Bid Params

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

Prebid Server Bid Params

Name Scope Description Example Type
TagID required Adprime ad tag id '1234asdf' string
keywords optional page context keywords [‘car’,’sport’] array
audiences optional publisher audiences [‘aud1’,’aud2’] array

Adquery

Features

Bidder Code adquery Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 902
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs adQuery QiD ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adquery hb_bidder_adquery hb_adid_adquery
hb_size_adquery hb_source_adquery hb_format_adquery
hb_cache_host_adquer hb_cache_id_adquery hb_uuid_adquery
hb_cache_path_adquer hb_deal_adquery  

Bid Params

Name Scope Description Example Type
placementId required Placement ID 6d93f2a0e5f0fe2cc3a6e9e3ade964b43b07f897 string
type required Ad Type banner string
sizes required Allowed sizes 320x100,300x250,336x280,300x50,300x100,320x50,320x480,300x150,320x180 string

Adrino

Features

Bidder Code adrino Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 1072
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adrino hb_bidder_adrino hb_adid_adrino
hb_size_adrino hb_source_adrino hb_format_adrino
hb_cache_host_adrino hb_cache_id_adrino hb_uuid_adrino
hb_cache_path_adrino hb_deal_adrino  

Note

The Adrino bidder adapter requires setup and approval from the Adrino team. Please reach out to wydawcy@adrino.pl for more information.

Bid Params

Name Scope Description Example Type
hash required Identifier for specific ad placement 'abcdef123456' string

Native example

var adUnits = [
    code: '/12345678/prebid_native_example_1',
    mediaTypes: {
        native: {
            image: {
                required: true,
                sizes: [[300, 210],[300,150],[140,100]]
            },
            title: {
                required: true
            },
            sponsoredBy: {
                required: false
            },
            body: {
                required: false
            },
            icon: {
                required: false
            }
        }
    },
    bids: [{
        bidder: 'adrino',
        params: {
            hash: 'abcdef123456'
        }
    }]
];

AdsInteractive

Features

Bidder Code adsinteractive Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support will-not-bid
TCF-EU Support yes IAB GVL ID 1212
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support no Demand Chain Support no
Safeframes OK no Supports Deals no
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsinteractive hb_bidder_adsinterac hb_adid_adsinteracti
hb_size_adsinteracti hb_source_adsinterac hb_format_adsinterac
hb_cache_host_adsint hb_cache_id_adsinter hb_uuid_adsinteracti
hb_cache_path_adsint hb_deal_adsinteracti  

Registration

The AdsInteractive adapter requires setup and approval. Please reach out to it@adsinteractive.com to setup your account.

Bid Params

Name Scope Description Example Type
adUnit required adUnit tag name 'example_adunit_1' string

AdsYield

Features

Bidder Code adsyield Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adsyield hb_bidder_adsyield hb_adid_adsyield
hb_size_adsyield hb_source_adsyield hb_format_adsyield
hb_cache_host_adsyie hb_cache_id_adsyield hb_uuid_adsyield
hb_cache_path_adsyie hb_deal_adsyield  

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'open-adsyield.com' string
adUnitId required Ad Unit Id will be generated on AdsYield Platform. 42 integer
adUnitType required Type of Ad Unit ('video', 'banner') 'banner' string
publisherId required Publisher ID 12345 integer
custom1 optional Custom targeting field 1 'custom1' string
custom2 optional Custom targeting field 2 'custom2' string
custom3 optional Custom targeting field 3 'custom3' string
custom4 optional Custom targeting field 4 'custom4' string
custom5 optional Custom targeting field 5 'custom5' string

Adsyield server-side Prebid Server adapter requires only publisherId and host parameters. But Adsyield client-side Prebid.js adapter requires only host, adUnitId, adUnitType.

Adsyield server-side Prebid Server adapter supports only banner, video, audio, native media types. But Adsyield client-side Prebid.js adapter supports only banner and video media types, doesn’t support audio and native.

Adtarget

Features

Bidder Code adtarget Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 779
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Registration

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

Bid params

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

Description

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

Test Parameters

var adUnits = [

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

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

Additional Configuration

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

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

Adtelligent

Features

Bidder Code adtelligent Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 410
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs all (with commercial activation) ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Prebid Server Note

This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams function. See prebid.js #6361 for more details.

Bid params

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

Description

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

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

Adtelligent now supports adpod.

Test Parameters

    var adUnits = [

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

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

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

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

Additional Configuration

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

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

Adtarget.me

Features

Bidder Code adtrgtme Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support no Demand Chain Support no
Safeframes OK yes Supports Deals no
Floors Module Support no First Party Data Support yes
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adtrgtme hb_bidder_adtrgtme hb_adid_adtrgtme
hb_size_adtrgtme hb_source_adtrgtme hb_format_adtrgtme
hb_cache_host_adtrgt hb_cache_id_adtrgtme hb_uuid_adtrgtme
hb_cache_path_adtrgt hb_deal_adtrgtme  

Note

The Adtrgtme bidding adapter requires setup before beginning. Please contact us at info@adtarget.me

Bid Params

Name Scope Description Example Type
site_id required Site ID 1234567890 uint64

Advangelists

Features

Bidder Code advangelists Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

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

AdView

Features

Bidder Code AdView Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 1022
GPP Support tcfeu, usca DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_AdView hb_bidder_AdView hb_adid_AdView
hb_size_AdView hb_source_AdView hb_format_AdView
hb_cache_host_AdView hb_cache_id_AdView hb_uuid_AdView
hb_cache_path_AdView hb_deal_AdView  

Note

The Example Bidding adapter requires setup before beginning. Please contact us at partner@adview.com

Bid Params

Name Scope Description Example Type
placementId required Placement ID 'posid00001' string
accountId required Account ID 'accountid01' string

adxcg

Features

Bidder Code adxcg Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs id5Id, identityLink, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adxcg hb_bidder_adxcg hb_adid_adxcg
hb_size_adxcg hb_source_adxcg hb_format_adxcg
hb_cache_host_adxcg hb_cache_id_adxcg hb_uuid_adxcg
hb_cache_path_adxcg hb_deal_adxcg  

Note

This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams function. See prebid.js #6361 for more details.

Prebid-server activation requires setup and approval before beginning. Please reach out to your account manager or info@adxcg.com for more details.

Bid Params

Name Scope Description Example Type
adzoneid required adxcg zone id '1' string

Adyoulike

Features

Bidder Code adyoulike Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 259
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs criteo, sharedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_adyoulike hb_bidder_adyoulike hb_adid_adyoulike
hb_size_adyoulike hb_source_adyoulike hb_format_adyoulike
hb_cache_host_adyoul hb_cache_id_adyoulik hb_uuid_adyoulike
hb_cache_path_adyoul hb_deal_adyoulike  

Note

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

Bid Params

Name Scope Description Example Type
placement required The placement ID from Adyoulike. '194f787b85c829fb8822cdaf1ae64435' string

Same ‘placement’ parameter can be used from either prebid JS or prebid server.

AIDEM

Features

Bidder Code aidem Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 1218
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support no Demand Chain Support no
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support yes
User IDs none ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aidem hb_bidder_aidem hb_adid_aidem
hb_size_aidem hb_source_aidem hb_format_aidem
hb_cache_host_aidem hb_cache_id_aidem hb_uuid_aidem
hb_cache_path_aidem hb_deal_aidem  

Description

This module connects publishers to AIDEM demand.

This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.

Global Bid Params

Name Scope Description Example Type
siteId required Unique site ID 'ABCDEF' String
publisherId required Unique publisher ID 'FEDCBA' String
placementId optional Unique publisher tag ID 'ABCDEF' String
rateLimit optional Limit the volume sent to AIDEM. Must be between 0 and 1 0.6 Number
Name Scope Description Example Type
sizes required List of the sizes wanted [[300, 250], [300,600]] Array

Video Bid Params

Name Scope Description Example Type
context required One of instream, outstream, adpod 'instream' String
playerSize required Width and height of the player '[640, 480]' Array
maxduration required Maximum video ad duration, in seconds 30 Integer
minduration required Minimum video ad duration, in seconds 5 Integer
mimes required List of the content MIME types supported by the player ["video/mp4"] Array
protocols required An array of supported video protocols. At least one supported protocol must be specified, where: 2 = VAST 2.0 3 = VAST 3.0 5 = VAST 2.0 wrapper 6 = VAST 3.0 wrapper 2 Array

Additional Config

Name Scope Description Example Type
coppa optional Child Online Privacy Protection Act true Boolean
consentManagement optional Consent Management Object {} Object
Name Scope Description Example Type
gdpr optional GDPR Object see Prebid.js doc {} Object
usp optional USP Object see Prebid.js doc {} Object

Example Banner ad unit

var adUnits = [{
    code: 'banner-prebid-test-site',
    mediaTypes: {
        banner: {
            sizes: [
                [300, 600],
                [300, 250]
            ]
        }
    },
    bids: [{
          bidder: 'aidem',
          params: {
              siteId: 'prebid-test-siteId',
              publisherId: 'prebid-test-publisherId',
          },
    }]
}];

Example Video ad unit

var adUnits = [{
    code: 'video-prebid-test-site',
    mediaTypes: {
      video: {
        context: 'instream',
        playerSize: [640, 480],
        maxduration: 30,
        minduration: 5,
        mimes: ["video/mp4"],
        protocols: 2
      }
    },
    bids: [{
          bidder: 'aidem',
          params: {
              siteId: 'prebid-test-siteId',
              publisherId: 'prebid-test-publisherId',
          },
    }]
}];
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

pbjs.que.push(function (){
  pbjs.setConfig({
    consentManagement: {
      gdpr:{
        cmpApi: 'iab'
      }
    }
  });
})
var pbjs = pbjs || {};
pbjs.que = pbjs.que || [];

pbjs.que.push(function (){
  pbjs.setConfig({
    consentManagement: {
      usp:{
        cmpApi: 'static',
        consentData:{
          getUSPData:{
            uspString: '1YYY'
          }
        }
      }
    }
  });
})

Setting First Party Data (FPD)

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

pbjs.que.push(function (){
  pbjs.setConfig({
    ortb2: {
      site: {
        cat: ['IAB2'],
        sectioncat: ['IAB2-2'],
        keywords: 'power tools, drills'
      },
    }
  });
})

Supported Media Types

Type Support
Banner Support all AIDEM Sizes
Video Support all AIDEM Sizes

Setup / Dev Guide

nvm use

npm install

gulp build --modules=aidemBidAdapter

gulp serve --modules=aidemBidAdapter

# Open a chrome browser with no ad blockers enabled, and paste in this URL. The `pbjs_debug=true` is needed if you want to enable `loggerInfo` output on the `console` tab of Chrome Developer Tools.
http://localhost:9999/integrationExamples/gpt/hello_world.html?pbjs_debug=true

If you need to run the tests suite but do not want to have to build the full adapter and serve it, simply run:

gulp test --file "test/spec/modules/aidemBidAdapter_spec.js"

For video: gulp serve –modules=aidemBidAdapter,dfpAdServerVideo

FAQs

How do I view AIDEM bid request?

Navigate to a page where AIDEM is setup to bid. In the network tab, search for requests to zero.aidemsrv.com/bid/request.

AJA

Features

Bidder Code aja Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support None DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals no
Floors Module Support no First Party Data Support no
User IDs criteo, unifiedId, imuid ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

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

Configuration

AJA recommends setting UserSync by iframe for monetization.

For Prebid.js v1.15.0 and later:

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

For Prebid.js v1.14.0 and before:

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

AlgoriX

Features

Bidder Code algorix Prebid.org Member yes
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_algorix hb_bidder_algorix hb_adid_algorix
hb_size_algorix hb_source_algorix hb_format_algorix
hb_cache_host_algori hb_cache_id_algorix hb_uuid_algorix
hb_cache_path_algori hb_deal_algorix  

Note

AlgoriX adapter requires setup and approval from the AlgoriX team, even for existing in-app developers and publishers. Please reach out to your account team or email to prebid@algorix.co for more information.

Bid Params

Name Scope Description Example Type
sid required Sid '30014' string
token required Token '028bca2d3b5c4f0ba155fa34864b0c4d' string
placementId optional Placement Id '123456' string
appId optional App Id 'asdasdasd' string
region optional Server Region 'APAC', 'USE', 'EUC' string

Note:

  • Prebid Server adapter only checks for and uses first imp bid params. All other imp bid params are ignored.
  • placementId and appId will be generated on AlgoriX Platform.
  • region is optional param, which determine the AlgoriX server. APAC for SG endpoint, USE for US endpoint, EUC for EU endpoint, Other for Global endpoint.

Alkimi

Features

Bidder Code alkimi Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 1169
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_alkimi hb_bidder_alkimi hb_adid_alkimi
hb_size_alkimi hb_source_alkimi hb_format_alkimi
hb_cache_host_alkimi hb_cache_id_alkimi hb_uuid_alkimi
hb_cache_path_alkimi hb_deal_alkimi  

Bid Params

Name Scope Description Example Type
token required The ID issued by Alkimi to the publisher '8a80d8e9-0cf9-4329-8486-6f5bbcd8a61a' string
bidFloor optional Minimum bid for this impression expressed in CPM. 0 float
instl optional Set to 1 if using interstitial (default: 0) 1 integer
exp optional Advisory as to the number of seconds that may elapse between the auction and the actual impression. 10 integer

AMX RTB

Features

Bidder Code amx Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support true
TCF-EU Support yes IAB GVL ID 737
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_amx hb_bidder_amx hb_adid_amx
hb_size_amx hb_source_amx hb_format_amx
hb_cache_host_amx hb_cache_id_amx hb_uuid_amx
hb_cache_path_amx hb_deal_amx  

Bid Params

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

Test Parameters

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

{
  testMode: true,
  tagId: "cHJlYmlkLm9yZw"
}

This will produce a bid at $10 with a test creative.

Note that the tagId is case-sensitive. Do not use cHJlYmlkLm9yZw in production environments: this ID is for testing only.

First Party Data

From Prebid.js >= 4.30, publishers can use the ortb2 configuration parameter to provide First Party Data. We accept all standard OpenRTB fields for both:

  • ortb2.site
  • ortb2.user

Note that all fields are optional. For contextual data (e.g. categories), standard IAB taxonomies are supported. We do not support passing first party data via bid parameters.

Example - Setting ortb2.site and ortb2.user fields

pbjs.setBidderConfig({
  bidders: ["amx"],
  config: {
    ortb2: {
      site: {
        keywords: "kw1,kw2",
        cat: ["IAB2"],
        sectioncat: ["IAB2-1"],
        pagecat: ["IAB2-22"],
        content: {
          context: 5,
        },
      },
      user: {
        yob: 1981,
        keywords: "kw3",
      },
    },
  },
});

AndBeyond.Media

Features

Bidder Code beyondmedia Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_beyondmedia hb_bidder_beyondmedi hb_adid_beyondmedia
hb_size_beyondmedia hb_source_beyondmedi hb_format_beyondmedi
hb_cache_host_beyond hb_cache_id_beyondme hb_uuid_beyondmedia
hb_cache_path_beyond hb_deal_beyondmedia  

Prebid Bid Params

Name Scope Description Example Type
placementId required Placement Id '0' 'string'

Apacdex

Features

Bidder Code apacdex Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_apacdex hb_bidder_apacdex hb_adid_apacdex
hb_size_apacdex hb_source_apacdex hb_format_apacdex
hb_cache_host_apacde hb_cache_id_apacdex hb_uuid_apacdex
hb_cache_path_apacde hb_deal_apacdex  

Table of Contents

Bid Params

Name Scope Description Example Type
placementId* required Placement ID provided by Apacdex 'plc100000' string
siteId* required Publisher site ID from Apacdex 'apacdex1234' string
floorPrice optional CPM bidfloor in USD 0.03 float
geo optional GEO data of device. See Geo Object for details. {"lat":17.98928,"lon":99.7741712,"accuracy":20} object

(*) Please do not use placementId and siteId at the same time.

Geo Object

If the publisher has GEO data of the user’s device. Make it available through the geo audience so we can improve ad targeting, which means improving bids. The list of fields can be referenced in Section 3.2.19 from the OpenRTB 2.5 document.

Name Scope Description Example Type
lat required Latitude from -90.0 to +90.0, where negative is south. 17.98928 float
lon required Longitude from -180.0 to +180.0, where negative is west. 99.7741712 float
accuracy required Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation. 20 integer
lastfix optional Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken. 30 integer
utcoffset optional Local time as the number +/- of minutes from UTC. -420 integer

Video Ad Unit

Publishers declare video inventory by passing the following parameters via mediaTypes.video

Name Scope Description Example Type
context required instream or outstream "outstream" string
playerSize required width, height of the player in pixels [640,360] - will be translated to w and h in bid request array<integers>
mimes recommended List of content MIME types supported by the player (see openRTB v2.5 for options) ["video/mp4"] array<string>
protocols recommended Supported video bid response protocol values
1: VAST 1.0
2: VAST 2.0
3: VAST 3.0
4: VAST 1.0 Wrapper
5: VAST 2.0 Wrapper
6: VAST 3.0 Wrapper
7: VAST 4.0
8: VAST 4.0 Wrapper
[2,3,5,6] array<integers>
api recommended Supported API framework values:
1: VPAID 1.0
2: VPAID 2.0
3: MRAID-1
4: ORMMA
5: MRAID-2
[2] array<integers>
maxduration recommended Maximum video ad duration in seconds. 30 integer
minduration recommended Minimum video ad duration in seconds 6 integer
playbackmethod recommended Playback methods that may be in use. Only one method is typically used in practice. (see openRTB v2.5 section 5.10 for options) [2] array<integers>
skip optional Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. 1 integer
skipafter optional Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable. 6 integer
minbitrate optional Minimum bit rate in Kbps. 300 integer
maxbitrate optional Maximum bit rate in Kbps. 9600 integer
startdelay* recommended Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.
>0: Mid-Roll (value indicates start delay in second)
0: Pre-Roll
-1: Generic Mid-Roll
-2: Generic Post-Roll
0 integer
placement* recommended Placement type for the impression. (see openRTB v2.5 section 5.9 for options) 1 integer

Lists of values are in the OpenRTB 2.5 documentation as referenced above.

Sample Banner Ad Unit

var adUnits = [
  {
    code: 'test-div',
    mediaTypes: {
      banner: {
        sizes: [[300, 250], [300,600]]
      }
    },
    bids: [
      {
          bidder: 'apacdex',
          params: {
              siteId: 'apacdex1234', // siteId provided by Apacdex
              floorPrice: 0.01, // default is 0.01 if not declared
          }
      }
    ]
  }
];

Sample Video Ad Unit: Instream

var instreamAdUnit = {
  code: 'test-div',
  sizes: [[640, 480]],
  mediaTypes: {
    video: {
      playerSize: [[640, 480]],
      context: "instream"
      api: [2],
      placement: 1,
      skip: 1,
      linearity: 1,
      minduration: 1,
      maxduration: 120,
      mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
      playbackmethod: [6],
      startdelay: 0,
      protocols: [1, 2, 3, 4, 5, 6]
    },
  },
  bids: [
    {
      bidder: 'apacdex',
      params: {
        siteId: 'apacdex1234', // siteId provided by Apacdex
        floorPrice: 0.01, // default is 0.01 if not declared
      }
    }
  ]
};

mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document You must review all video parameters to ensure validity for your player and DSPs

Sample Video Ad Unit: Outstream

var outstreamAdUnit = {
  code: 'test-div',
  sizes: [[410, 231]],
  mediaTypes: {
    video: {
      playerSize: [[410, 231]],
      context: "outstream"
      api: [2],
      placement: 5,
      linearity: 1,
      minduration: 1,
      maxduration: 120,
      mimes: ["video/mp4", "video/x-flv", "video/x-ms-wmv", "application/vnd.apple.mpegurl", "application/x-mpegurl", "video/3gpp", "video/mpeg", "video/ogg", "video/quicktime", "video/webm", "video/x-m4v", "video/ms-asf", video/x-msvideo"],
      playbackmethod: [6],
      startdelay: 0,
      protocols: [1, 2, 3, 4, 5, 6]
    },
  },
  bids: [
    {
      bidder: 'apacdex',
      params: {
        siteId: 'apacdex1234', // siteId provided by Apacdex
        floorPrice: 0.01, // default is 0.01 if not declared
      }
    }
  ]
};

mediaTypes.video object reference to section 3.2.7 Object: Video in the OpenRTB 2.5 document You must review all video parameters to ensure validity for your player and DSPs

Applogy

Features

Bidder Code applogy Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

AppNexus

Features

Bidder Code appnexus Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 32
GPP Support some (check with bidder) DSA Support yes
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support no
User IDs all (with commercial activation) ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Table of Contents

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

Bid Params

Starting with Prebid.js version 7.36.0, an update was made to the appnexusBidAdapter.js file to support bid params in a lower-case underscore format (eg invCode to inv_code) similar to how the params are formatted for the Prebid Server AppNexus bidder. This change was implemented to streamline publisher setups for both projects instead of maintaining separate versions of the same params depending on what setup is used. To avoid breaking changes, the old ‘camelCase’ format is still currently supported for all AppNexus bid params in the appnexusBidAdapter.js file. If you are using an older version of Prebid.js, you will need to continue to use the older ‘camelCase’ format as appropriate. The table below will reflect both formats, though it’s recommended to use the lower-case underscore format where possible going forward (assuming you’re using a compatible version of Prebid.js).

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

Video Object

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

User Object

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

App Object

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

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

Custom Targeting keys

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

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

Auction Level Keywords

It’s possible to pass a set of keywords for the whole request, rather than a particular adUnit. Though they would apply to all adUnits (which include the appnexus bidder) in an auction, these keywords can work together with the bidder level keywords (if for example you want to have specific targeting for a particular adUnit).

Below is an example of how to define these auction level keywords for the appnexus bidder:

pbjs.setConfig({
  appnexusAuctionKeywords: {
    genre: ['classical', 'jazz'],
    instrument: 'piano'
  }
});

Like in the bidder.params.keywords, the values here can be empty. Please see the section immediately below for more details.

Passing Keys Without Values

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

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

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

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

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

First Party Data

Publishers should use the ortb2 method of setting First Party Data.

At this time however, the appnexus bidder fully reads the First Party Data when using the Prebid Server and Prebid Server Premium endpoints. The client-side version of the appnexus bidder has partial support to read all the various keywords parameters from the First Party Data fields. There is also some special support with the segment fields but only from known sources which are specifically configured. All other First Party Data fields are not read at this time.

PBS/PSP supports all first party data fields: site, user, segments, and imp-level first party data.

User Sync in AMP

If you are syncing user id’s with Prebid Server and are using AppNexus’ managed service, see AMP Implementation Guide cookie-sync instructions for details.

Mobile App Display Manager Version

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

Debug Auction

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

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

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

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

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

Prebid Server Test Request

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

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

Appstock

Features

Bidder Code appstock Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appstock hb_bidder_appstock hb_adid_appstock
hb_size_appstock hb_source_appstock hb_format_appstock
hb_cache_host_appsto hb_cache_id_appstock hb_uuid_appstock
hb_cache_path_appsto hb_deal_appstock  

Note

The Appstock Bidding adapter requires setup before beginning. Please contact us at moshiko@app-stock.com

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'pre.vr-tb.com' string
publisherId required Publisher ID 12345 integer

Appush

Features

Bidder Code appush Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-not-bid
TCF-EU Support no IAB GVL ID 879
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support no
User IDs none ORTB Blocking Support partial
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_appush hb_bidder_appush hb_adid_appush
hb_size_appush hb_source_appush hb_format_appush
hb_cache_host_appush hb_cache_id_appush hb_uuid_appush
hb_cache_path_appush hb_deal_appush  

Prebid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'
endpointId optional Endpoint Id '0' 'string'

Adserver.Online

Features

Bidder Code aso Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_aso hb_bidder_aso hb_adid_aso
hb_size_aso hb_source_aso hb_format_aso
hb_cache_host_aso hb_cache_id_aso hb_uuid_aso
hb_cache_path_aso hb_deal_aso  

Note

For more information about Adserver.Online, please contact support@adsrv.org.

Bid Params

Name Scope Description Example Type
zone required Zone ID 73815 Integer
server optional Custom bidder endpoint https://endpoint.url String

Test Parameters

 var adUnit = {
    code: 'unit1',
    mediaTypes: {
        banner: {
            sizes: [[300, 250]]
        }
    },
    bids: [
        {
            bidder: 'aso',
            params: {
                zone: 73815,
            }
        }
    ]
}

Video Caching

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

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

Audience Network

Features

Bidder Code audienceNetwork Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_audienceNetwor hb_bidder_audienceNe hb_adid_audienceNetw
hb_size_audienceNetw hb_source_audienceNe hb_format_audienceNe
hb_cache_host_audien hb_cache_id_audience hb_uuid_audienceNetw
hb_cache_path_audien hb_deal_audienceNetw  

Registration

Audience Network will not bid on requests made from device simulators. When testing for Mobile bids, you must make bid requests using a real device.

Note: Audience Network is disabled by default. Please enable it in the app config if you wish to use it. Make sure you provide the partnerID for the auctions to run correctly.

Bid Params

Name Scope Description Example Type
placementId required The Placement ID from Audience Network '555555555555555\_555555555555555' string
format optional Format, one of “native”, “fullwidth” or “video” 'native' string

Automatad OpenRTB Bid Adapter

Features

Bidder Code automatad Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support no
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_automatad hb_bidder_automatad hb_adid_automatad
hb_size_automatad hb_source_automatad hb_format_automatad
hb_cache_host_automa hb_cache_id_automata hb_uuid_automatad
hb_cache_path_automa hb_deal_automatad  

Prebid.js Bid Params

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

Prebid-Server Bid Params

Name Scope Description Example Type
position optional Position field from automatad 22390678 string
placementId optional The placement ID from automatad. "a34gh6d" string

Avocet

Features

Bidder Code avct Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Registration

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

Bid Params

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

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

Axis

Features

Bidder Code axis Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-not-bid
TCF-EU Support yes IAB GVL ID 1197
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support no
User IDs none ORTB Blocking Support partial
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_axis hb_bidder_axis hb_adid_axis
hb_size_axis hb_source_axis hb_format_axis
hb_cache_host_axis hb_cache_id_axis hb_uuid_axis
hb_cache_path_axis hb_deal_axis  

Overview

For more information, visit the axis-marketplace website

Bid Params

Name Scope Description Example Type
integration required Integration '000000' 'string'
token required Token '000000' 'string'
iabCat optional (Prebid.js only) Array of IAB content categories that describe the content producer ['IAB1-1', 'IAB3-1', 'IAB4-3'] Array(string)

Axonix

Features

Bidder Code axonix Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID 678
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_axonix hb_bidder_axonix hb_adid_axonix
hb_size_axonix hb_source_axonix hb_format_axonix
hb_cache_host_axonix hb_cache_id_axonix hb_uuid_axonix
hb_cache_path_axonix hb_deal_axonix  

Prebid Server Note

The Axonix Bidding adapter requires setup before beginning. Please contact us at support.axonix@emodoinc.com.

Bid Params

Name Scope Description Example Type
supplyId required Supply UUID '2c426f78-bb18-4a16-abf4-62c6cd0ee8de' string
region optional Cloud region 'us-east-1' string
endpoint optional Supply custom endpoint 'https://open-rtb.axonix.com/custom' string
instl optional Set to 1 if using interstitial (default: 0) 1 integer

BCM International

Features

Bidder Code bcmint Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bcmint hb_bidder_bcmint hb_adid_bcmint
hb_size_bcmint hb_source_bcmint hb_format_bcmint
hb_cache_host_bcmint hb_cache_id_bcmint hb_uuid_bcmint
hb_cache_path_bcmint hb_deal_bcmint  

Note

The BCM International adapter requires approval and setup. Please reach out to contact@bcm.ltd or visit us at bcm.ltd for more details.

Bid Params

Name Scope Description Example Type
server required Server endpoint https://srv.datacygnal.io String
zone required Zone ID 73815 Integer

Video Caching

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

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

Beachfront

Features

Bidder Code beachfront Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 335
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs unifiedId, identityLink, uid2, hadronId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Registration

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

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

Bid Params

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

video params

Name Scope Description Example Type
appId optional Beachfront Exchange ID for video bids. '11bc5dd5-7421-4dd8-c926-40fa653bec76' string
bidfloor optional Bid floor for video bids. 0.01 float
tagid optional Tag ID 'placement-name' string
responseType optional Video response type.
both: VAST URL and VAST XML
nurl: VAST URL only
adm: VAST XML only
'both' string
mimes optional Array of strings listing supported MIME types. ["video/mp4", "application/javascript"] Array<string>
playbackmethod optional Playback method supported by the publisher.
1: Auto-play sound on
2: Auto-play sound off
3: Click-to-play
4: Mouse-over
1 integer
maxduration optional Maximum video ad duration in seconds. 30 integer
placement optional Placement type for the impression.
1: In-Stream
2: In-Banner
3: In-Article
4: In-Feed
5: Interstitial/Slider/Floating
1 integer
skip optional Indicates if the player will allow the video to be skipped. 1 integer
skipmin optional Videos of total duration greater than this number of seconds can be skippable. 15 integer
skipafter optional Number of seconds a video must play before skipping is enabled. 5 integer

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

player params

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

First Party Data

Publishers should use the ortb2 method of setting First Party Data. The following fields are supported:

  • ortb2.site.*
  • ortb2.app.*
  • ortb2.user.*

Example first party data that’s available to all bidders and all adunits:

pbjs.setConfig({
    ortb2: {
        site: {
            keywords: "kw1,kw2",
            content: {
                title: "title1",
                series: "series1"
            }
        },
        user: {
            keywords: "a,b",
            gender: "M",
            yob: 1984
        }
    }
});

Prebid Server

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

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

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

Beintoo

Features

Bidder Code beintoo Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID 618
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

Bematterfull

Features

Bidder Code bematterfull Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bematterfull hb_bidder_bematterfu hb_adid_bematterfull
hb_size_bematterfull hb_source_bematterfu hb_format_bematterfu
hb_cache_host_bematt hb_cache_id_bematter hb_uuid_bematterfull
hb_cache_path_bematt hb_deal_bematterfull  

Prebid Server Bid Params

Name Scope Description Example Type
env required Environment name mtflll-stage string
pid required unique placement ID cs230510321b516f0eb9a10e5913d3b1 string

Between

Features

Bidder Code between Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 724
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK no Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_between hb_bidder_between hb_adid_between
hb_size_between hb_source_between hb_format_between
hb_cache_host_betwee hb_cache_id_between hb_uuid_between
hb_cache_path_betwee hb_deal_between  

Prebid.js Bid Params

Name Scope Description Example Type
s required Section ID from Between SSP control panel 999999 integer
cur optional 3-letter ISO 4217 code defining the currency of the bid (currently support USD and EUR), default is USD 'USD' string

Prebid-Server Bid Params

Name Scope Description Example Type
host required Between SSP host url prefix. Defines data center where requests will be sent. Choose the closest one to the prebid-server you are using. Allowed values: lbs-eu1.ads, lbs-ru1.ads, lbs-asia1.ads, lbs-us-east1.ads 'lbs-eu1.ads' string
publisher_id required Publisher ID from Between SSP control panel '123' string

Bidgency Group

Features

Bidder Code bidgency Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidgency hb_bidder_bidgency hb_adid_bidgency
hb_size_bidgency hb_source_bidgency hb_format_bidgency
hb_cache_host_bidgen hb_cache_id_bidgency hb_uuid_bidgency
hb_cache_path_bidgen hb_deal_bidgency  

Note

The Bidgency Group adapter requires approval and setup. Please reach out to aso@bidgency.com or visit us at bidgency.com for more details.

Bid Params

Name Scope Description Example Type
server required Server endpoint https://srv.bidgx.com String
zone required Zone ID 73815 Integer

Video Caching

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

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

Bidmachine

Features

Bidder Code bidmachine Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 736
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals no
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidmachine hb_bidder_bidmachine hb_adid_bidmachine
hb_size_bidmachine hb_source_bidmachine hb_format_bidmachine
hb_cache_host_bidmac hb_cache_id_bidmachi hb_uuid_bidmachine
hb_cache_path_bidmac hb_deal_bidmachine  

Prebid Server Note

The Bidmachine Bidding adapter requires setup before beginning. Please contact us at hi@bidmachine.io .

Bid Params

Name Scope Description Example Type
host required DC region "api-eu" string
path required URL path, will be provided by manager "auction/rtb/v2" string
seller_id required Your ID in Bidmachine system "1" string

BidMyAdz

Features

Bidder Code bidmyadz Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidmyadz hb_bidder_bidmyadz hb_adid_bidmyadz
hb_size_bidmyadz hb_source_bidmyadz hb_format_bidmyadz
hb_cache_host_bidmya hb_cache_id_bidmyadz hb_uuid_bidmyadz
hb_cache_path_bidmya hb_deal_bidmyadz  

Prebid Server Bid Params

Currently adapter doesn’t support multiimpression, so only the first impression will be delivered

Name Scope Description Example Type
placementId required Placement Id will be generated on BidMyAdz Platform. '1234' string

BidsCube

Features

Bidder Code bidscube Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidscube hb_bidder_bidscube hb_adid_bidscube
hb_size_bidscube hb_source_bidscube hb_format_bidscube
hb_cache_host_bidscu hb_cache_id_bidscube hb_uuid_bidscube
hb_cache_path_bidscu hb_deal_bidscube  

Note

The BidsCube Bidding adapter requires setup before beginning. Please contact us at support@bidscube.com

Bid Params

Name Scope Description Example Type
placementId required Placement ID '12345' string

Bidstack

Features

Bidder Code bidstack Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 462
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support yes Demand Chain Support no
Safeframes OK no Supports Deals no
Floors Module Support yes First Party Data Support no
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bidstack hb_bidder_bidstack hb_adid_bidstack
hb_size_bidstack hb_source_bidstack hb_format_bidstack
hb_cache_host_bidsta hb_cache_id_bidstack hb_uuid_bidstack
hb_cache_path_bidsta hb_deal_bidstack  

Registration

The Bidstack Bidding adapter requires setup before beginning. Please contact us at tech@bidstack.com

Bid Params

Name Scope Description Example Type
publisherId required Publisher ID 'be224bf2-fd3f-4afb-b6fc-4a97718be2f5' string
placementId optional Placement ID 'some_placement_id' string
consent optional User EULA consent true boolean

BizzClick

Features

Bidder Code bizzclick Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID none
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bizzclick hb_bidder_bizzclick hb_adid_bizzclick
hb_size_bizzclick hb_source_bizzclick hb_format_bizzclick
hb_cache_host_bizzcl hb_cache_id_bizzclic hb_uuid_bizzclick
hb_cache_path_bizzcl hb_deal_bizzclick  

Note

The Example Bidding adapter requires setup before beginning. Please contact us at support@bizzclick.com .BizzClick will only respond to the first impression and that multiple ad formats of that single impression are not supported.

Bid Params for Prebid Server and Prebid Mobile

Name Scope Description Example Type
sourceId required Unique hash provided by bizzclick '6dllcEHSxYdSb6yLmCqE' string
accountId required Unique name provided by bizzclick 'bizzclick-test' string
host optional Bizzclick server region. US East by default 'us-e-node1' string
placementId required Deprecated parameter. Please use sourceId instead '6dllcEHSxYdSb6yLmCqE' string

Bid Params for Prebid.js

Name Scope Description Example Type
sourceId required Unique hash provided by bizzclick '6dllcEHSxYdSb6yLmCqE' string
accountId required Unique name provided by bizzclick 'bizzclick-test' string
host optional Bizzclick server region. US East by default 'us-e-node1' string

BLIINK

Features

Bidder Code bliink Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 658
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bliink hb_bidder_bliink hb_adid_bliink
hb_size_bliink hb_source_bliink hb_format_bliink
hb_cache_host_bliink hb_cache_id_bliink hb_uuid_bliink
hb_cache_path_bliink hb_deal_bliink  

Note

The BLIINK Header Bidding adaptor requires setup and approval from the BLIINK team. Please reach out to your account manager for more informations.

Bid Params

Name Scope Description Example Type
tagId required The TagID from BLIINK. '32' string
imageUrl optional The image url on which the ad is displayed in case of in-image ad. 'https://image.png' string
videoUrl optional The Video url on which the ad is displayed in case of video ad. 'https://video.mp4' string

Blockthrough

Features

Bidder Code blockthrough Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support will-not-bid
TCF-EU Support no IAB GVL ID 815
GPP Support usp DSA Support check with bidder
USP/CCPA Support yes COPPA Support no
Supply Chain Support yes Demand Chain Support no
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs none ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_blockthrough hb_bidder_blockthrou hb_adid_blockthrough
hb_size_blockthrough hb_source_blockthrou hb_format_blockthrou
hb_cache_host_blockt hb_cache_id_blockthr hb_uuid_blockthrough
hb_cache_path_blockt hb_deal_blockthrough  

Note

The BT Bid Adapter makes requests to the BT Server which supports OpenRTB.

Publishers should use the ortb2 method of setting First Party Data. The BT adapter requires setup and approval from the Blockthrough team. Please reach out to marketing@blockthrough.com for more information.

Prebid JS

Bid Params

Name Scope Description Example Type
bidderCode required Bidder configuration. Could configure several bidders this way. bidderA: {publisherId: 55555} object

Bid Config

Make sure to set required orgID, websiteID values received after approval using pbjs.setBidderConfig.

Name Scope Description Example Type
orgID required A unique ID for your organization provided by the Blockthrough team. 4829301576428910 string
websiteID required A unique ID for your site provided by the Blockthrough team. 5654012389765432 string

Example

pbjs.setBidderConfig({
  bidders: ['blockthrough'],
  config: {
    ortb2: {
      site: {
        ext: {
          blockthrough: {
            orgID: '4829301576428910',
            websiteID: '5654012389765432',
          },
        },
      },
    },
  },
});

AdUnits configuration example

var adUnits = [
  {
    code: 'banner-div-1',
    mediaTypes: {
      banner: {
        sizes: [[728, 90]],
      },
    },
    bids: [
      {
        bidder: 'blockthrough',
        params: {
          bidderA: {
            publisherId: 55555,
          },
          bidderB: {
            zoneId: 12,
          },
        },
      },
    ],
  },
];

Blue

Features

Bidder Code blue Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 620
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs id5Id, identityLink, pubProvidedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_blue hb_bidder_blue hb_adid_blue
hb_size_blue hb_source_blue hb_format_blue
hb_cache_host_blue hb_cache_id_blue hb_uuid_blue
hb_cache_path_blue hb_deal_blue  

Note

The bidder requires setup before usage. Please get in touch with our publisher team at celsooliveira@getblue.io to get started.

Bid Params

Name Scope Description Example Type
publisherId required Unique publisher ID 'ABCDEF' string

Bluesea

Features

Bidder Code bluesea Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK no Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs none ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bluesea hb_bidder_bluesea hb_adid_bluesea
hb_size_bluesea hb_source_bluesea hb_format_bluesea
hb_cache_host_bluese hb_cache_id_bluesea hb_uuid_bluesea
hb_cache_path_bluese hb_deal_bluesea  

Registration

If you have any question regarding the set up, please reach out to your account manager or prebid@blueseasx.com for more information.

Bid Params

Name Scope Description Example Type
pubid required Unique partner account id '254673' string
token required Token for certification '3l2l2mbl2knw2ggc' string

First Party Data

Publishers can use the ortb2 configuration to provide First Party Data. The following fields are supported:

  • ortb2.site.*
  • ortb2.user.*

Bright Mountain Media

Features

Bidder Code bmtm Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs id5Id, sharedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bmtm hb_bidder_bmtm hb_adid_bmtm
hb_size_bmtm hb_source_bmtm hb_format_bmtm
hb_cache_host_bmtm hb_cache_id_bmtm hb_uuid_bmtm
hb_cache_path_bmtm hb_deal_bmtm  

Bid Params

Name Scope Description Example Type
placement_id required Placement ID will be generated on Bright Mountain Media Platform 1 integer

Boldwin

Features

Bidder Code boldwin Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 1151
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_boldwin hb_bidder_boldwin hb_adid_boldwin
hb_size_boldwin hb_source_boldwin hb_format_boldwin
hb_cache_host_boldwi hb_cache_id_boldwin hb_uuid_boldwin
hb_cache_path_boldwi hb_deal_boldwin  

Note

The Boldwin Bidding adapter requires setup before beginning. Please contact us at support@bold-win.com

Bid Params

Name Scope Description Example Type
endpointId required Endpoint Id '0' string

For both the Prebid Server and Prebid.js integrations it is required to use only one parameter: endpointId. endpointId - should be sent in the Prebid bid request to Boldwin in case you integrate with Boldwin bidder.

Brave

Features

Bidder Code brave Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 869
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support no
User IDs none ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_brave hb_bidder_brave hb_adid_brave
hb_size_brave hb_source_brave hb_format_brave
hb_cache_host_brave hb_cache_id_brave hb_uuid_brave
hb_cache_path_brave hb_deal_brave  

Note

The Brave Header Bidding adapter requires setup and approval from the Brave team. Please reach out to your account manager or support@thebrave.io for more information

Bid Params

Name Scope Description Example Type
placementId required Brave’s platform placement id 'to0QI2aPgkbBZq6vgf0oHitouZduz0qw' string

BoldwinX

Features

Bidder Code bwx Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_bwx hb_bidder_bwx hb_adid_bwx
hb_size_bwx hb_source_bwx hb_format_bwx
hb_cache_host_bwx hb_cache_id_bwx hb_uuid_bwx
hb_cache_path_bwx hb_deal_bwx  

Prebid Server Bid Params

Name Scope Description Example Type
pid required unique placement ID aa8210e2013wc095fe9dba67981040b0 string
env optional Environment name bwx-stage string

Cadent Aperture MX

Features

Bidder Code cadent_aperture_mx Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 183
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs identityLink, uid2 ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cadent_apertur hb_bidder_cadent_ape hb_adid_cadent_apert
hb_size_cadent_apert hb_source_cadent_ape hb_format_cadent_ape
hb_cache_host_cadent hb_cache_id_cadent_a hb_uuid_cadent_apert
hb_cache_path_cadent hb_deal_cadent_apert  

Registration

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

Bid Params

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

Clickonometrics

Features

Bidder Code ccx Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 773
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ccx hb_bidder_ccx hb_adid_ccx
hb_size_ccx hb_source_ccx hb_format_ccx
hb_cache_host_ccx hb_cache_id_ccx hb_uuid_ccx
hb_cache_path_ccx hb_deal_ccx  

Bid Params

Common params (banner, video)

Name Scope Description Example Type
placementId required Clickonometrics placement ID 12345 integer

Video params

Name Scope Description Example Type
video.playbackmethod optional See OpenRTB docs for info [1, 2, 3, 4] Array<integer>
video.protocols optional See OpenRTB docs for info [2, 3, 5, 6] Array<integer>
video.mimes optional See OpenRTB docs for info ['video/mp4', 'video/x-flv'] Array<string>
video.skip optional See OpenRTB docs for info 1 integer
video.skipafter optional See OpenRTB docs for info 5 integer

CodeFuel

Features

Bidder Code CodeFuel Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_CodeFuel hb_bidder_CodeFuel hb_adid_CodeFuel
hb_size_CodeFuel hb_source_CodeFuel hb_format_CodeFuel
hb_cache_host_CodeFu hb_cache_id_CodeFuel hb_uuid_CodeFuel
hb_cache_path_CodeFu hb_deal_CodeFuel  

Description

Module that connects to Codefuel bidder to fetch bids. Display format is supported but not native format. Using OpenRTB standard.

Bid Params

Name Scope Description Example Type
placementId required Placement-Id defined by the caller '0111f8ac-2d40-4613-8557-b47dbf622fff' string

Configuration

    pbjs.setConfig({
    codefuel: {
        bidderUrl: 'https://prebidtest.zemanta.com/api/bidder/prebidtest/bid/'
    }
});

Coinzilla

Features

Bidder Code coinzilla Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_coinzilla hb_bidder_coinzilla hb_adid_coinzilla
hb_size_coinzilla hb_source_coinzilla hb_format_coinzilla
hb_cache_host_coinzi hb_cache_id_coinzill hb_uuid_coinzilla
hb_cache_path_coinzi hb_deal_coinzilla  

Bid Params

Name Scope Description Example Type
placementId required The placement ID(Zone Id)   string

Colossus

Features

Bidder Code colossus Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs britepoolid, identityLink, unifiedId, id5Id, uid2 ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_colossus hb_bidder_colossus hb_adid_colossus
hb_size_colossus hb_source_colossus hb_format_colossus
hb_cache_host_coloss hb_cache_id_colossus hb_uuid_colossus
hb_cache_path_coloss hb_deal_colossus  

Disclosure

This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.

Prebid.Server Bid Params

Name Scope Description Example Type
TagID optional Placement Id will be generated on Colossus SSP Platform. '0' string
groupId optional Group Id will be generated on Colossus SSP Platform. '0' string

You only need to use one parameter: either TagID or groupId

For prebidJS parametres, look into colossusssp.md

Compass

Features

Bidder Code compass Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 883
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_compass hb_bidder_compass hb_adid_compass
hb_size_compass hb_source_compass hb_format_compass
hb_cache_host_compas hb_cache_id_compass hb_uuid_compass
hb_cache_path_compas hb_deal_compass  

Bid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'
endpointId optional Endpoint Id '0' 'string'

Note

For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId

ConnectAd

Features

Bidder Code connectad Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 138
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Prebid Server Note

This bidder requires the client side Prebid.js adapter to work on Prebid Server due to the dependency on the transformBidParams function. See prebid.js #6361 for more details.

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

Bid Params

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

Consumable

Features

Bidder Code consumable Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 591
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Disclosure

The Consumable bid adapter may cycle the ad initially shown with a new one at various intervals. This means the advertiser meta-data accompanying the bid response may be incomplete at the time of response.

Bid Params

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

Table of contents

Introduction

Publishers can use Prebid Server in any of the following ways with Consumable. Consumable’s adapter supports all of the following methods:

  • If you want to call Consumable from a web environment, you can use Prebid.js to call Prebid Server, and then Prebid Server uses our server-side adapter to call Consumable. This reduces workload on the browser. For set up instructions, see Call Consumable from a web browser section on this page.
  • In mobile apps, you can use the Prebid Mobile SDK to call Prebid Server and then Prebid Server uses our server-side adapter to call Consumable. For set up instructions, see Call Consumable from Prebid Mobile SDK section on this page.
  • In CTV apps and other long-form video environments, you (or the SSAI vendor) can make a call to Prebid Server using OpenRTB, and then Prebid Server uses our server-side adapter to call Consumable. For set up instructions, see Call Consumable from CTV/long-form video environment section on this page.

Supported media types

The following table lists the media types that Consumable supports. For information about the the Time-To-Live (TTL) for each media type, see How Consumable counts impressions in our Knowledge Base.

Type Prebid Server support
banner Supported
video Supported, including ad pods for OTT
audio Supported

Setup instructions to call Consumable through Prebid Server

Note: If you are hosting your own Prebid Server instance, you must contact your Consumable Exchange Representative to get an endpoint and setup instructions.

If you are using an existing Prebid Server instance that is already configured to call Consumable, depending on whether you want to call Consumable from the browser, mobile app, CTV, or long-form video, follow any of the below sections to complete the Consumable-specific configuration.

Call Consumable from a web browser

To call Consumable from a web browser using Prebid Server, you must first configure Prebid.js to call Consumable directly from the browser using our client-side adapter. Follow the quick start instructions provided in Prebid’s Getting Started for Developers documentation. Complete the following steps to complete the Consumable-specific configuration:

  1. Build the binary in one of the following ways: Download Prebid.js from the Prebid site to use the standard compiled binary that Prebid includes in the download process and select Consumable Exchange as an adapter.
  2. Define the Consumable-specific parameters at the bidder level which include adding consumable as the bidder and the siteId. For Consumable’s bidder-specific parameters, see the Bid request parameters section below.

    {
        bidder: 'consumable',
        params: {
            "networkId": 11,
            "siteId": 32,
            "unitId": 42,
            "unitName": "cnsmbl-audio-728x90-slider"
        }
    }
    
  3. Define your ad units in the adUnit object. This includes the details about the ad slots such as the media types, ad size, and ad code. For more information about this object, see Prebid’s Ad Unit Reference documentation.
  4. Enable user syncing by adding the following code in the pbjs.setConfig() function. Consumable strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Consumable bid rate and bid price. Make sure to call pbjs.setConfig() only once. This configuration is optional in Prebid, but required by Consumable.

     pbjs.setConfig({
         userSync: {
             iframeEnabled: true,
             filterSettings: {
                 iframe: {
                     bidders: ['consumable'],
                     filter: 'include'
                 }
             }
         }
     });
    
  5. (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the Set up First Party Data (FPD) section in our Prebid.js documentation on the Prebid site.
  6. (Optional) If you want to monetize instream video, you need to enable a cache endpoint in the pbjs.setConfig() function as follows:

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

Call Consumable from Prebid Mobile SDK

Before you begin: Contact your Consumable Exchange representative to get your placementId. You must provide this placementID to your Prebid Server host company.

Note: To implement Prebid Mobile SDK, follow Prebid’s Getting Started with Prebid Mobile documentation.

To add Consumable as a bidder to your mobile app:

  1. Inform your Prebid Server hosting company to add consumable as a bidder in the configuration and include the placementId that Consumable provides to you at the time of integration.
  2. Define the Consumable-specific parameters at the bidder level. For information about these parameters, see the Bid request parameters section below.
  3. Include any ad unit level required or optional parameters provided in Prebid’s Prebid Mobile API - iOS and Prebid Mobile API - Android documentation.

Call Consumable from CTV/long-form video environment

Before you begin: Contact your Consumable Exchange Representative to get the placementId. You must provide this placement ID to your Prebid Server host company.

Note: To implement CTV and long-form video using Prebid Server, follow Prebid’s Long Form Video documentation.

To add Consumable as a bidder:

  1. Inform your Prebid Server hosting company to add consumableas a bidder in the configuration and include the placementId that Consumable provides to you at the time of integration.
  2. Define the Consumable-specific parameters at the bidder level. For information about these parameters, see the Bid request parameters section below.
  3. Include any ad unit level required or optional parameters provided in Prebid’s /openrtb2/video documentation.

Bid request parameters

For a list of the OpenRTB fields that Consumable supports in bid requests, see List of supported OpenRTB bid request fields for sellers. The following are the required fields for the various supported media types.

Site (Banner, Video, Audio)

You must include these parameters at the bidder level.

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

App or CTV (Banner, Video, Audio)

You must include these parameters at the bidder level.

Key Scope Type Description
placementId Required String An Consumable-specific identifier that is associated with this ad unit. It will be associated with the single size, if the size is provided. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '0421008445828ceb46f496700a5fa65e'

Examples

Banner

{
  "id": "cons-banner-id",
  "imp": [
    {
      "id": "imp-id",
      "banner": {
        "w": 300,
        "h": 250,
        "id": "1",
        "pos": 0,
        "format": [
          {
            "w": 300,
            "h": 250
          },
          {
            "w": 300,
            "h": 600
          }
        ]
      },
      "instl": 0,
      "tagid": "5602709",
      "bidfloor": 0.02,
      "bidfloorcur": "USD",
      "secure": 1,
      "ext": {
        "consumable": {
          "placementId": "0421008445828ceb46f496700a5fa65e"
        }
      }
    }
  ],
  "app": {
    "bundle": "555555555",
    "storeurl": "https://apps.apple.com/us/app/test-app/id555555555",
    "publisher": {
      "id": "123456"
    },
    "content": {
      "title": "Entertainment",
      "genre": "IAB9-30,IAB6,IAB9-7,IAB1"
    }
  },
  "device": {
    "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
    "ip": "10.20.30.40",
    "ifa": "2E2E2E2E-3B3B-4141-8A8A-181818181818"
  },
  "at": 1,
  "tmax": 200
}

Video

{
  "id": "cons-video-example",
  "imp": [
    {
      "id": "imp-id",
      "video": {
        "mimes": [
          "video/mp4",
          "video/3gpp",
          "video/webm"
        ],
        "minduration": 15,
        "maxduration": 60,
        "startdelay": -1,
        "protocols": [
          2,
          3,
          5,
          6
        ],
        "w": 320,
        "h": 480,
        "placement": 1,
        "linearity": 1,
        "minbitrate": 1000,
        "api": [
          1,
          2,
          3,
          5
        ]
      },
      "secure": 1,
      "ext": {
        "consumable": {
          "placementId": "0421008445828ceb46f496700a5fa65e"
        }
      }
    }
  ],
  "app": {
    "bundle": "555555555",
    "storeurl": "https://apps.apple.com/us/app/test-app/id555555555",
    "publisher": {
      "id": "123456"
    },
    "content": {
      "title": "Entertainment",
      "genre": "IAB9-30,IAB6,IAB9-7,IAB1"
    }
  },
  "device": {
    "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E18",
    "ip": "10.20.30.40",
    "ifa": "2E2E2E2E-3B3B-4141-8A8A-181818181818"
  },
  "at": 1,
  "tmax": 1000
}

Audio

{
  "id": "cons-audio-example",
  "imp": [
    {
      "id": "imp-id",
      "video": {
        "mimes": [
          "video/mp3"
        ],
        "minduration": 15,
        "maxduration": 60,
        "startdelay": -1,
        "protocols": [
          2,
          3,
          5,
          6
        ],
        "placement": 1,
        "linearity": 1,
        "minbitrate": 1000,
        "api": [
          1,
          2,
          3,
          5
        ]
      },
      "secure": 1,
      "ext": {
        "consumable": {
          "placementId": "0421008445828ceb46f496700a5fa65e"
        }
      }
    }
  ],
  "app": {
    "bundle": "555555555",
    "storeurl": "https://apps.apple.com/us/app/test-app/id555555555",
    "publisher": {
      "id": "123456"
    },
    "content": {
      "title": "Entertainment",
      "genre": "IAB9-30,IAB6,IAB9-7,IAB1"
    }
  },
  "device": {
    "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E18",
    "ip": "10.20.30.40",
    "ifa": "2E2E2E2E-3B3B-4141-8A8A-181818181818"
  },
  "at": 1,
  "tmax": 1000
}

SSP Copper6

Features

Bidder Code copper6 Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 410 (adtelligent)
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals no
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_copper6 hb_bidder_copper6 hb_adid_copper6
hb_size_copper6 hb_source_copper6 hb_format_copper6
hb_cache_host_copper hb_cache_id_copper6 hb_uuid_copper6
hb_cache_path_copper hb_deal_copper6  

Bid params

Name Scope Description Example Type
aid required The source ID from Copper6 Media. 12412 integer

Description

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

Test Parameters

    var adUnits = [

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

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

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

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

CPMStar

Features

Bidder Code cpmstar Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

Criteo

Features

Bidder Code criteo Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 91
GPP Support some (check with bidder) DSA Support yes
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, pubProvidedId, sharedId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_criteo hb_bidder_criteo hb_adid_criteo
hb_size_criteo hb_source_criteo hb_format_criteo
hb_cache_host_criteo hb_cache_id_criteo hb_uuid_criteo
hb_cache_path_criteo hb_deal_criteo  

Notes

This bidder adapter automatically includes the Criteo User ID module and performs iFrame syncs.

Prebid-Server support is on alpha test and is currently a non-finished product. Activation requires setup and approval before beginning. Please reach out to your account manager or publishers@criteo.com for more details.

Bid Params

Name Scope Description Example Type
zoneId required (deprecated) The zone ID from Criteo. Should be replaced by networkId when using zone matching. 234234 integer
networkId required The network ID from Criteo. Please reach out your Criteo representative for more details. 456456 integer
pubid required publisher id 'ABC123' string
nativeCallback optional (Prebid.js only) Callback to perform render in native integrations. Please reach out your Criteo representative for more details. function(payload) { console.log(payload); } function
integrationMode optional (Prebid.js only) Integration mode to use for ad render (none or ‘AMP’). Please reach out your Criteo representative for more details. 'AMP' string
publisherSubId optional Custom identifier for reporting. Please reach out your Criteo representative for more details. 'adunit-1' string

First Party Data

Criteo supports both ortb2 and ortb2Imp methods to set First Party Data.

The standard Open RTB properties supported from ortb2 / ortb2Imp are described in the following table.

Name Scope Description Example Type
ortb2.user optional Details via a Open RTB User object about the human user of the device; the advertising audience. N/A object
ortb2.site optional Details via a Open RTB Site object about the publisher’s website. N/A object
ortb2Imp.rwdd optional Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes. 1 integer

Besides these standard properties, ext field can be used to send any publisher specific data which may have been discussed with a Criteo representative.

Video Object

Name Scope Description Example Type
minduration optional Minimum ad duration in seconds 5 integer
startdelay optional Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: 0 (default); Mid-roll: >0; Default mid-roll: -1; Post-roll: -2; 5 integer
playbackmethod required Defines how the video inventory is initiated. Page Load with Sound On: 1; Page Load with Sound Off: 2; Click with Sound On: 3; Mouse-Over with Sound On: 4; Entering Viewport with Sound On: 5; Entering Viewport with Sound Off by Default: 6; [4, 5] Array<integer>
placement required Video placement type. In-Stream: 1; In-Banner: 2; In-Article: 3: In-Feed: 4; Interstitial: 5; 1 integer
skip required Ability from the video player for the user to skip the video. Not skippable: 0; Skippable: 1; 1 integer

In addition, Criteo adapter relies on parameters specified in the mediaTypes.video definition of the video ad-units, namely:

Name Scope Description Example Type
context required outstream, instream or long-form instream string
mimes required List of the content MIME types supported by the player ["video/mp4"] Array<string>
playerSize required Width and height of the player [640, 480] Array<integer>
protocols required Supported video bid response protocols. VAST 1.0: 1; VAST 2.0: 2; VAST 3.0: 3; VAST 1.0 Wrapper: 4; VAST 2.0 Wrapper: 5; VAST 3.0 Wrapper: 6; [5, 6] Array<integer>
maxduration required Maximum ad duration in seconds 20 integer
api required API frameworks supported. VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5; MRAID 3.0: 6; OMID 1.0: 7; [1, 2] Array<integer>
plcmt optional 1=in-stream, 2=accompanying content, 3=interstitial, 4=no content/standalone. Highly recommended to comply with new IAB video specifications. 1 integer

Example of Video Ad-unit

var adUnits = [
{
    code: 'video1',
    mediaTypes: {
        video: {
            playerSize: [640, 480],
            context: 'instream',
            mimes: ["video/mp4"],
            maxduration: 30,
            api: [1, 2],
            playerSize: [640,480],
            protocols: [2, 3],
            skip: 0,
            playbackmethod: [1],
            placement: 1
        }
    },
    bids: [{
        bidder: 'criteo',
        params: {
            zoneId: 1455580
        }
    }]
}];

Additional Config (Optional)

If you don’t want to use the FastBid adapter feature, you can disable it via this configuration:

pbjs.setConfig({
  'criteo': {
    fastBidVersion: 'none',
  }
});

Criteo teams are planning to completely remove this feature with Prebid 9.0

Criteo Bid Adapter supports the collection of the user’s hashed email, if available.

Please consider passing it to the adapter, following these guidelines.

C-WIRE

Features

Bidder Code cwire Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 1081
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support check with bidder
Supply Chain Support no Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_cwire hb_bidder_cwire hb_adid_cwire
hb_size_cwire hb_source_cwire hb_format_cwire
hb_cache_host_cwire hb_cache_id_cwire hb_uuid_cwire
hb_cache_path_cwire hb_deal_cwire  

Bid Params

Name Scope Description Example Type
pageId required C-WIRE page id 2453 integer
placementId required C-WIRE placement id 113244 integer

URL parameters

Additionally, the following parameters can be passed by URL parameters for testing.

Name Scope Description Example Type
cwcreative optional C-WIRE creative id to force &cwcreative=1234 string
cwgroups optional C-WIRE group name to force &cwgroups=test-group string
cwfeatures optional Comma separated list of features &cwfeatures=feature1,feature2 string
cwdebug optional Debug flag &cwdebug=true string

DataBlocks

Features

Bidder Code datablocks Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs criteo,unifiedId,netId,pubcid ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
source_id required Website Source Id 111 integer
host optional Network Host to request from ‘prebid.dblks.net’ string
tagid optional Placement ID ‘leaderboard_1’ string
vis_optout optional Opt out of visibility metric true boolean

Deepintent

Features

Bidder Code deepintent Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 541
GPP Support usp, usnat, usstate_all DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_deepintent hb_bidder_deepintent hb_adid_deepintent
hb_size_deepintent hb_source_deepintent hb_format_deepintent
hb_cache_host_deepin hb_cache_id_deepinte hb_uuid_deepintent
hb_cache_path_deepin hb_deal_deepintent  

Bid Params

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

Configuration

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

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

AdUnit Format for Banner

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

video parameters

Deepintent supports video as of Prebid v1.16.0

Name Scope Description Example
video.mimes required Video MIME types ['video/mp4','video/x-flv']
video.skippable optional If ‘true’, user can skip ad true
video.minduration optional Minimum ad duration in seconds 5
video.maxduration optional Maximum ad duration in seconds 30
video.startdelay optional Start delay in seconds for pre-roll, mid-roll, or post-roll ad placements 5
video.playbackmethod optional Defines whether inventory is user-initiated or autoplay sound on/off
Values:
1: Auto-play, sound on
2: Auto-play, sound off
3: Click-to-play
4: mouse-over
1
video.api optional API frameworks supported
Values:
1: VPAID 1.0
2: VPAID 2.0
3: MRAID-1
4: ORMMA
5: MRAID-2
[1, 2]
video.protocols optional Supported video bid response protocols
Values
1: VAST 1.0
2: VAST 2.0
3: VAST 3.0
4: VAST 1.0 Wrapper
5: VAST 2.0 Wrapper
6: VAST 3.0 Wrapper
[5, 6]
video.battr optional Blocked creative attributes, See OpenRTB 2.5 specification, List 5.3 for values [3, 9]
video.linearity optional Indicates if the impression is linear or nonlinear
Values:
1: Linear/In-Stream
2: Non-Linear/Overlay.
1
video.placement optional Video placement type. See OpenRTB 2.5 specification, List 5.9 for Values 1
video.minbitrate optional Minumim bit rate in Kbps. 50
video.maxbitrate optional Maximum bit rate in Kbps. 70

AdUnit Format for Video

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

DEFINE MEDIA

Features

Bidder Code definemedia Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 440
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_definemedia hb_bidder_definemedi hb_adid_definemedia
hb_size_definemedia hb_source_definemedi hb_format_definemedi
hb_cache_host_define hb_cache_id_defineme hb_uuid_definemedia
hb_cache_path_define hb_deal_definemedia  

Registration

Please reach out to our account management team to get started. Contact information is available under a link.

Bid Params

Name Scope Description Example Type
mandantId required Mandant ID 5 integer
adslotId optional Adslot ID 199 integer

Dianomi

Features

Bidder Code dianomi Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 885
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support no
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dianomi hb_bidder_dianomi hb_adid_dianomi
hb_size_dianomi hb_source_dianomi hb_format_dianomi
hb_cache_host_dianom hb_cache_id_dianomi hb_uuid_dianomi
hb_cache_path_dianom hb_deal_dianomi  

Note

  • Supports display and banner formats.
  • Uses OpenRTB standard.

Registration

The Dianomi Adapter requires setup before beginning. Please contact us at eng@dianomi.com.

Bid params

Name Scope Description Example Type
smartadId required Placement ID 12345 integer
endpoint optional for testing only www-prebid.dianomi.com string

Note: smartadId is a pre agreed ID between the publisher and Dianomi.

Native example

var adUnits = [
    code: 'your-native-container-id',
    mediaTypes: {
        native: {
            image: {
                required: false,
                sizes: [100, 50]
            },
            title: {
                required: false,
                len: 140
            },
            sponsoredBy: {
                required: false
            },
            clickUrl: {
                required: false
            },
            body: {
                required: false
            },
            icon: {
                required: false,
                sizes: [50, 50]
            }
        }
    },
    bids: [{
        bidder: 'dianomi',
        params: {
            smartadId: 9607
        }
    }]
];
var adUnits = [
    code: 'your-banner-container-id',
    mediaTypes: {
      banner: {
        sizes: [[300, 250]]
      } 
    },
    bids: [{
        bidder: 'dianomi',
        params: {
            smartadId: 9607
        }
    }]
];

Video example

var adUnits = [
    code: 'your-video-container-id',
    mediaTypes: {
      video: {
        playerSize: [[640, 480]]
      } 
    },
    bids: [{
        bidder: 'dianomi',
        params: {
            smartadId: 9607
        }
    }]
];

DistrictM DMX

Features

Bidder Code dmx Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 144
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dmx hb_bidder_dmx hb_adid_dmx
hb_size_dmx hb_source_dmx hb_format_dmx
hb_cache_host_dmx hb_cache_id_dmx hb_uuid_dmx
hb_cache_path_dmx hb_deal_dmx  

Bid Params

Name Scope Description Example Type
seller_id required The DMX Partner ID provided upon onboarding, this is for specific setup BURL, NURL or ADM support ‘seller_id’ string
publisher_id required Boost MemberId from DistrictM UI ‘member1’ string
tagid required Represent the placement ID from DistrictM or your own ‘123abc’ string
bidfloor optional The minimum price acceptable for a bid ‘1.0’ string
memberid optional MemberId from DistrictM UI (legacy: replaced by publisher_id) ‘member1’ string
dmxid optional Placement ID from DistrictM (legacy: replaced by tagid) ‘123abc’ string

(See districtmDMX for Prebid.js)

Duration Media

Features

Bidder Code duration Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 816
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_duration hb_bidder_duration hb_adid_duration
hb_size_duration hb_source_duration hb_format_duration
hb_cache_host_durati hb_cache_id_duration hb_uuid_duration
hb_cache_path_durati hb_deal_duration  

Bid Params

Name Scope Description Example Type
siteId required siteId is provided by your Duration Media account manager(s)   integer
placementId optional placementId is provided by your Duration Media account manager(s). This parameter allows to report on a specific ad unit   integer
video optional Object containing video targeting parameters. Note that this parameter is not used in Prebid Server. See Video Object for details. video: { playback_method: ['auto_play_sound_off'] } object

Note

If you are using Google Ad Manager (GAM), it is highly recommended to make sure the “Serve in Safeframe” box in creative settings is unchecked. If you absolutely want to run Duration Media in a Saferame creative, please contact your Duration Media repsentative to coordinate this setup.

Test Parameters

var adUnits = [
    {
        code: 'test-div1',
        mediaTypes: {
            banner: {
                sizes: [[300, 250]],  // a display size
            }
        },
        bids: [
            {
                bidder: "duration",
                params: {
                    siteId: 2,
                    placementId: 3
                }
            }
        ]
    },{
        code: 'test-div2',
        mediaTypes: {
            banner: {
                sizes: [[320, 50]],   // a mobile size
            }
        },
        bids: [
            {
                bidder: "duration",
                params: {
                    siteId: 2
                }
            }
        ]
    }
];

Video Object

Name Description Type
skippable Boolean which, if true, means the user can click a button to skip the video ad. Defaults to false. boolean
playback_method Array of strings listing playback methods supported by the publisher. Allowed values: "auto_play_sound_on"; "auto_play_sound_off"; "click_to_play"; "mouseover"; "auto_play_sound_unknown"; "viewport_sound_on", "viewport_sound_off". Array<string>
position Array of strings listing video player position supported by the publisher. Allowed values: "na", "atf", "btf", "head", "foot", "sidebar", "full". Array<string>
mimes Array of strings listing the content MIME types supported, e.g., ["video/x-flv", "video/x-ms-wmv"]. Array<string>
minduration Integer that defines the minimum video ad duration in seconds. integer
maxduration Integer that defines the maximum video ad duration in seconds. integer
frameworks Array of integers listing API frameworks supported by the publisher. Allowed values: None: 0; VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5. Array<integer>

DXKulture

Features

Bidder Code dxkulture Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_dxkulture hb_bidder_dxkulture hb_adid_dxkulture
hb_size_dxkulture hb_source_dxkulture hb_format_dxkulture
hb_cache_host_dxkult hb_cache_id_dxkultur hb_uuid_dxkulture
hb_cache_path_dxkult hb_deal_dxkulture  

Integration Note

The DXKulture Header Bidding adapter requires approval from the DXKulture team. Please reach out to devops@dxkulture.com for more information.

Bid Params

Name Scope Description Example Type
placementId required Placement Id '1234abcd' string
publisherId required Publisher Id '12345' string
bidfloor optional Bid Floor 2.3 float
bidfloorcur optional Bid Floor Currency 'USD' string

E-volution tech

Features

Bidder Code e_volution Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 957
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs id5Id ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_e_volution hb_bidder_e_volution hb_adid_e_volution
hb_size_e_volution hb_source_e_volution hb_format_e_volution
hb_cache_host_e_volu hb_cache_id_e_voluti hb_uuid_e_volution
hb_cache_path_e_volu hb_deal_e_volution  

Note

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

Prebid.JS Bid Params

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

Prebid Server Bid Params

Name Scope Description Example Type
key required E-volution integration key 'cf64c93f277afdd928d8260653d7413d' 'string'

Edge226

Features

Bidder Code edge226 Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID 1202
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_edge226 hb_bidder_edge226 hb_adid_edge226
hb_size_edge226 hb_source_edge226 hb_format_edge226
hb_cache_host_edge22 hb_cache_id_edge226 hb_uuid_edge226
hb_cache_path_edge22 hb_deal_edge226  

Bid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'
endpointId optional Endpoint Id '0' 'string'

Note

For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId

Embi Media

Features

Bidder Code embimedia Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_embimedia hb_bidder_embimedia hb_adid_embimedia
hb_size_embimedia hb_source_embimedia hb_format_embimedia
hb_cache_host_embime hb_cache_id_embimedi hb_uuid_embimedia
hb_cache_path_embime hb_deal_embimedia  

Note

The Embi Media Bidding adapter requires setup before beginning.

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'bidder-embi.media' string
publisherId required Publisher ID 12345 integer

emetriq

Features

Bidder Code emetriq Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 213
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emetriq hb_bidder_emetriq hb_adid_emetriq
hb_size_emetriq hb_source_emetriq hb_format_emetriq
hb_cache_host_emetri hb_cache_id_emetriq hb_uuid_emetriq
hb_cache_path_emetri hb_deal_emetriq  

Bid Params

Name Scope Description Example Type
placement_id (PBS+PBJS) or placementId (PBJS) required Placement id '32068254' string

emetriq is an aliased bidder for AppNexus.

Note

For setup with emetriq, please reach out to admins@emetriq.com

EMTV

Features

Bidder Code emtv Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-not-bid
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_emtv hb_bidder_emtv hb_adid_emtv
hb_size_emtv hb_source_emtv hb_format_emtv
hb_cache_host_emtv hb_cache_id_emtv hb_uuid_emtv
hb_cache_path_emtv hb_deal_emtv  

Bid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'
endpointId optional Endpoint Id '0' 'string'

Note

For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId

Engage BDR

Features

Bidder Code engagebdr Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

E-Planning

Features

Bidder Code eplanning Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 90
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Bid Params

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

Epom

Features

Bidder Code epom Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID 849
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support yes
Supply Chain Support no Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_epom hb_bidder_epom hb_adid_epom
hb_size_epom hb_source_epom hb_format_epom
hb_cache_host_epom hb_cache_id_epom hb_uuid_epom
hb_cache_path_epom hb_deal_epom  

Note

The Epom Bidding adapter requires setup before beginning. Please contact us at support@epom.com

Bid Params

Currently, Epom Bidding server do not support any bid parameters. We get all we need from the referring URL

Epsilon

Features

Bidder Code conversant Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 24
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId, publinkId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

Name Scope Description Example Type
site_id required The site ID from Epsilon. '87293' string
secure required (for secure pages) If impression requires secure HTTPS URL creative assets and markup. 0 for non-secure, 1 for secure. Default is non-secure 1 integer
bidfloor optional Bid floor 0.50 float
tag_id optional Identifies specific ad placement. 'cnvr-test-tag' string
white_label_url optional Override the destination URL the request is sent to. 'https://mydomain.com/hbendpoint' string
pubcid_name optional Name of the pub common id. Epsilon adapter can read the id directly if the UserID module is absent. Default is _pubcid. '_pubcid' string

Video Params

Name Scope Description Example Type
position optional Ad position on screen. See details below. Only supported in bids.params. 1 integer
mimes optional Array of content MIME types supported. Required for video ['video/mp4'] Array<string>
maxduration optional Maximum duration in seconds for this video as an integer. 30 integer
api optional Array of supported API frameworks. See details below. [2] Array<integer>
protocols optional Array of supported video protocols. See details below. [2] Array<integer>

Video parameters can be included in either mediaTypes.video or bids.params except where noted.

The following values are defined in the ORTB 2.5 spec.

position

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

api

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

protocols

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

First Party Data

Publishers should use the ortb2 method of setting for setting First Party Data. Example first party data configuration that is available to all adUnits

pbjs.setConfig({
    debug: true,
    cache: {
    url: 'https://prebid.adnxs.com/pbc/v1/cache'
    },
    ortb2: { 
        site: { 
            content: { 
                series: 'MySeries', 
                season: 'My Season', 
                episode: 3, 
                title: 'My Title' 
            } 
        } 
    }
});

Example AdUnit specific data using the ortb2Imp object

        var videoAdUnit = {
            code: 'video1',
            mediaTypes: {
                video: {
                    playerSize: [[640, 480]]
                }
            },
            ortb2Imp: {
                instl: 1,
                ext: {
                    data: {
                        adUnitSpecificAttribute: "123"
                    }
                }
            },
            bids: [{
                bidder: 'conversant',
                params: {
                    site_id: '108060',
                    mimes: ['video/mp4', 'video/webm']
                }
            }]
        }

        pbjs.que.push(function(){
            pbjs.addAdUnits(videoAdUnits);
        }

eRGADX

Features

Bidder Code ergadx Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 14 (adkernel)
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_ergadx hb_bidder_ergadx hb_adid_ergadx
hb_size_ergadx hb_source_ergadx hb_format_ergadx
hb_cache_host_ergadx hb_cache_id_ergadx hb_uuid_ergadx
hb_cache_path_ergadx hb_deal_ergadx  

Note

The eRGADX bidding adapter requires setup and approval before implementation. Please reach out to prashant.musale@erelego.com for more details.

Bid Params

Name Scope Description Example Type
host required RTB host 'cpm.ergadx.com' string
zoneId required Zone Id 30164 integer

Evolution Technologies

Features

Bidder Code evtech Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_evtech hb_bidder_evtech hb_adid_evtech
hb_size_evtech hb_source_evtech hb_format_evtech
hb_cache_host_evtech hb_cache_id_evtech hb_uuid_evtech
hb_cache_path_evtech hb_deal_evtech  

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'e-volution.ai' string
publisherId required Publisher ID 12345 integer

flipp

Features

Bidder Code flipp Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support will-not-bid
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support no Demand Chain Support check with bidder
Safeframes OK yes Supports Deals no
Floors Module Support no First Party Data Support no
User IDs none ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support no

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_flipp hb_bidder_flipp hb_adid_flipp
hb_size_flipp hb_source_flipp hb_format_flipp
hb_cache_host_flipp hb_cache_id_flipp hb_uuid_flipp
hb_cache_path_flipp hb_deal_flipp  

Bid Params

Name Scope Description Example Type
publisherNameIdentifier required Publisher name identifier test-publisher-name string
creativeType required Type of the creative NativeX NativeX\|DTX
siteId required ID associated with the site 123456 integer
zoneIds optional Zones to request from bidder [789, 123] array[integer]
userKey optional User Key to power experience optimization and frequency capping. Publishers: please confirm with legal counsel before using this feature. 4188d8a3-22d1-49cb-8624-8838a22562bd uuidv4
options optional Additional integration specific context options: { "startCompact": true } map[string]interface{}

Current available integration options are as follows:

Name Scope Description Example Type
startCompact optional Height of the experience will be reduced true boolean
dwellExpand optional Auto expand the experience after a certain time passes true boolean
contentCode optional Force show a certain experience. Generally used for testing and debugging purposes. publisher-test string

FreeWheelssp

Features

Bidder Code freewheelssp Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 285
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support partial
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_freewheelssp hb_bidder_freewheels hb_adid_freewheelssp
hb_size_freewheelssp hb_source_freewheels hb_format_freewheels
hb_cache_host_freewh hb_cache_id_freewhee hb_uuid_freewheelssp
hb_cache_path_freewh hb_deal_freewheelssp  

Bid Params

Name Scope Description Example Type
zoneId required The zone ID for the ad. “2003” string
format optional The format to use for displaying the ad. Can be one of the following:
screen-roll
intext-roll
sliderad
floorad
expand-banner
instream
* inbanner
Note: The screen-roll, intext-roll, sliderad and floorad formats are all FreeWheel outstream formats.
Default value: “instream”
“screen-roll” string
bidfloor optional Bid floor price. 13.2118 float
bidfloorcur optional Bid floor currency. “USD” string
vastUrlParams optional Add query parameters to the vast request. Should be a single item level JSON.
Works with formats: instream, inbanner
{ protocolVersion:’3.0’ } object

When the following params are used with instream or inbanner formats, they should be included in the vastUrlParams object. For other formats, they should be included directly in the params object:

Name Scope Description Example Type
soundButton optional If enabled, the sound will be off by default and the user will be able to turn it on/off by clicking on a button. (disabled on iOS devices)
Default value: false
true boolean
defaultMute optional If “soundButton=true” is set, controls if the video will start with the sound muted.
Default value: true
false boolean
timeline optional Display a progress bar to the bottom of the ad unit.
Default value: false
true boolean
protocolVersion optional Specify the VAST version that will be used for the vastVersion parameter value on AdsSetup request.
Default Value: 4.2
3 .0 float
onOver optional Allows to enable the sound only when the mouse is over the ad container.
Works with formats: screen-roll, intext-roll, sliderad, floorad, expand-banner
Default value: false
true boolean
closeTimeout optional The duration in milliseconds before displaying the close button.
Works with formats: screen-roll, intext-roll, sliderad, floorad
Default value: 5000
2000 integer
animated optional Enable an animation on opening and on closing of the video.
Works with formats: intext-roll, sliderad
Default value: true
false boolean
animationSpeed optional If the animated parameter is set to true, allows to choose the animation speed in milliseconds.
Works with formats: intext-roll, sliderad
Default value: 700
500 integer
contentId optional Displays the ad inside the content-id dom element (dom id). Requires an ‘auto’, ‘p’ or ‘article’ param.
Works with format: intext-roll
“element-id” string
auto optional If value is set to “v2”, position the intext-roll automatically. If contentId is set, the auto positioning will find a position inside the ‘contentId’ dom element.
If contentId is not set, the auto positionaing will search the best position to display the ad based on the page semantic. It will select several possible position and show the intext-roll at the time one of them is made visible.
Works with format: intext-roll
Default value: null
“v2” string
article optional Set the location of the ad just after the given article tag in the page (0 is for the first article tag). If content-id is set, the article index is relative to articles inside the ‘content-id’ dom element “element-id”
Works with format: intext-roll
string
p optional Set the location of the ad just after the given paragraph tag in the page (0 is for the first p tag). If content-id is set, the p index is relative to paragraphs inside the ‘content-id’ dom element.
Works with format: intext-roll
“element-id” string
iframeMode optional Indicate to intext-roll that it is served in a friendly hidden iframe. Can be one of the following:
normal - place ad in friendly iframe
dfp - place ad in iframe on dfp platform
Works with format: intext-roll
“normal” string
inRead optional When true, will keep the ad slot window on the page when the ad is done.
Works with format: intext-roll
Default value: false
true boolean
lang optional Text language. Can be one of: [fr,en,es,it,de,nl,pt]
Works with format: intext-roll
Default value: “fr”
“en” string
openingTime optional The time in milliseconds to display the opening animation.
Works with format: intext-roll
Default value: 0
100 integer
pauseRatio optional Specify the viewabilityratio where the ad is paused. This can be a float between 0 and 1, or “never” which means never paused. The default value will pause when the ad has less than 50% viewability.
Works with formats: intext-roll, expand-banner
Default value: 0.5
0.9 float | string
closeAction optional Define what to do for the banner after all ads complete. Can be one of:
collapse - will set the target css display property to “none”.
hide - will leave the target element in place, empty.
Works with formats: intext-roll, expand-banner
Default value: “collapse”
“hide” string
domId optional id of the dom element containing the text. If this targeted div is empty, be sure it has the needed width or a width of 0px will be used. Note that the script tag should be added in the page AFTER the targeted dom element so the target will be ready when the script runs.
Works with formats: intext-roll, expand-banner
“element-id” string
errorAction optional Define what to do for the banner after an ad error. Can be one of:
collapse - will set the target css display property to “none”.
hide - will leave the target element in place, empty.
Works with formats: intext-roll, expand-banner
Default value: “collapse”
“hide” string
stickToTop optional Controls if the ad will stick to the top of the browser window. Can be one of the following:
true - The ad will stick to the top of the browser window upon scroll.
“bottom” - The ad will stick to the top and will be hidden again when reaching the bottom of the page.
* number - The ad will stick to the top for the given distance in pixels.
Works with formats: intext-roll, expand-banner
300 boolean \| string \| number
blurDisplay optional Allow to choose between too blur effects for the sides of the banner. Can be one of:
big - will show the blured video only once in the background.
duplicate - will show the blured video twice: once for each side.
Works with format: expand-banner
Default value: “big”
“duplicate” string
expandDirection optional Allows to force the expansion direction. Can be one of the following:
before - Expand to the left if the banner is vertical and to the top if the banner is horizontal.
after - Expand to the right if the banner is vertical and to the bottom if the banner is horizontal.
center - Expand to left and right if the banner is vertical. Expand to the top and bottom if the banner is horizontal.
auto - Expand based on the space available on the page. Expand to the left and/or right if the banner is vertical. and expand to the top and bottom if the banner is horizontal, depending on the space available.
* none - Banner will not expand
Works with format: expand-banner
Default value: “auto”
“before” string
zIndex optional Force the z-index value on the ad container. The default value is around 4100 (see IAB guidelines). Use this parameter if it doesn’t fit your needs.
Works with format: expand-banner
Default value: ~4100
1000 integer
hAlign optional Horizontal side where to display the video. Can be one of:
left - horizontal align to the left of the page.
middle - horizontal align to the middle of the page.
* right - horizontal align to the right of the page.
Works with format: sliderad
Default value: “right”
“left” string
hSpacing optional Set a horizontal spacing between the hAlign side and the video.
Works with format: sliderad
Default value: 10
20 integer
vAlign optional Vertical side where to display the video. Can be one of:
top - vertical align to the top of the page.
middle - vertical align to the middle of the page.
* bottom - vertical align to the bottom of the page.
Works with format: sliderad
Default value: “bottom”
“top” string
vSpacing optional Set a vertical spacing between the vAlign side and the video.
Works with format: sliderad
Default value: 10
20 integer
mod optional Ad trigger mode. Can be one of:
asap - play the ad asap
click - play the ad when the user clicks a link
* scroll - play the ad when the user scrolls
Works with format: screen-roll
Default value: “asap”
“click” string
opacity optional Define the opacity of the background. This is a number between 0 (completely transparent) and 1 (totally black).
Works with format: screen-roll
Default value: 0.4
.5 float
smartPlay optional Enable to use autoPlay on mobile devices.
Works with format: screen-roll
Default value: false
true boolean
bannerHeight optional The height in pixel of the bottom banner. The video ad takes this height when its not expanded.
Works with format: floorad
Default value: 250
500 integer

FRVR Ad Network

Features

Bidder Code frvradn Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID 1107
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_frvradn hb_bidder_frvradn hb_adid_frvradn
hb_size_frvradn hb_source_frvradn hb_format_frvradn
hb_cache_host_frvrad hb_cache_id_frvradn hb_uuid_frvradn
hb_cache_path_frvrad hb_deal_frvradn  

Registration

FRVR Ad Network Bidding adapter requires setup before beginning. Please contact us at info@frvr.com

Bid Params

Name Scope Description Example Type
publisher_id required Publisher ID '11111' string
ad_unit_id required Ad Unit ID '22222' string

FutureAds

Features

Bidder Code futureads Prebid.org Member yes
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 511
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs AdmixerID ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_futureads hb_bidder_futureads hb_adid_futureads
hb_size_futureads hb_source_futureads hb_format_futureads
hb_cache_host_future hb_cache_id_futuread hb_uuid_futureads
hb_cache_path_future hb_deal_futureads  

Bid Params

Name Scope Description Example Type
zone required The unique identifier of the ad placement. Could be obtained from the FutureAds UI or from your account manager. “e5ff8e48-4bd0-4a2c-9236-55530ab8981d” string
kvTargeting optional Key/Value - a pair of the unique values that will be used for the custom targeting option. {key1: value2, key2: value2} object

Gamma

Features

Bidder Code gamma Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid Params

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

Gamoshi

Features

Bidder Code gamoshi Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 644
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs id5Id, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Bid params

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

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

Globalsun

Features

Bidder Code globalsun Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-not-bid
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support no
User IDs none ORTB Blocking Support partial
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_globalsun hb_bidder_globalsun hb_adid_globalsun
hb_size_globalsun hb_source_globalsun hb_format_globalsun
hb_cache_host_global hb_cache_id_globalsu hb_uuid_globalsun
hb_cache_path_global hb_deal_globalsun  

Prebid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'

gothamads

Features

Bidder Code gothamads Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support yes IAB GVL ID none
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_gothamads hb_bidder_gothamads hb_adid_gothamads
hb_size_gothamads hb_source_gothamads hb_format_gothamads
hb_cache_host_gotham hb_cache_id_gothamad hb_uuid_gothamads
hb_cache_path_gotham hb_deal_gothamads  

Note

Gothamads will bid only on first impresion in bid request. The Example Bidding adapter requires setup before beginning. Please contact us at support@gothamads.com

Bid Params

Name Scope Description Example Type
accountId required account id 'hash' string

GreedyGame

Features

Bidder Code greedygame Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_greedygame hb_bidder_greedygame hb_adid_greedygame
hb_size_greedygame hb_source_greedygame hb_format_greedygame
hb_cache_host_greedy hb_cache_id_greedyga hb_uuid_greedygame
hb_cache_path_greedy hb_deal_greedygame  

Note

The GreedyGame Bidding adapter requires setup before beginning. Please contact us at arpit@greedygame.com

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'rtb-greedygame.com' string
publisherId required Publisher ID 12345 integer

TheMediaGrid

Features

Bidder Code grid Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 686
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support yes
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

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

Table of Contents

Bid Params

Name Scope Description Example Type
uid required Represents the MediaGrid bidder system Ad Slot ID associated with the respective div id from the site page. 1 integer
bidFloor optional Floor of the impression opportunity. If present in the request overrides XML info. 0.8 float

Bidder Config

You can allow writing in localStorage pbjs.setBidderConfig for the bidder grid

pbjs.setBidderConfig({
    bidders: ["grid"],
    config: {
        localStorageWriteAllowed: true
    }
})

If it will be “true” this allow TheMediaGrid Bid Adapter to write userId in first party localStorage

First Party Data

Publishers should use the ortb2 method of setting First Party Data.

Global site or user data using setConfig(), or Bidder-specific using setBidderConfig() supports following fields:

  • ortb2.user.data[]: Standard IAB segment taxonomy user data
  • ortb2.user.ext.device: Non standard arbitrary user device
  • ortb2.user.keywords: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2
  • ortb2.site.keywords: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2
  • ortb2.site.cat[]: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array
  • ortb2.site.pagecat[]: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array
  • ortb2.site.content.genre: Standard IAB OpenRTB 2.5 site.content.genre field

AdUnit-specific data using AdUnit.ortb2Imp supports following fields:

  • ortb2.imp[].ext.data.*
  • ortb2.imp[].instl

Native setup example (s2s only)

Setup native in adUnit mediaTypes, for example:

...
mediaTypes: {
  native: {
    ortb: {
      ver: '1.2',
      "assets": [
        {
          "id": 1,
          "img": {
            "hmin": 180,
            "wmin": 216,
            "type": 3
          },
          "required": 1
        },
        {
          "title": {
            "len": 140
          },
          "id": 2,
          "required": 1
        },
        {
          "id": 3,
          "data": {
            "len": 25,
            "type": 1
          },
          "required": 1
        }
      ],
    }
  }
},
...

GumGum

Features

Bidder Code gumgum Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 61
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs unifiedId, identityLink ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Note

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

Client side and server side parameters differ slightly. For Server side (Prebid S2S) implementation, we currently accept the zone parameter. For Client side (Prebid.js) implementation, we accept zone and a long list of other parameters which are listed below.

Server Side Bid Params

Name Scope Description Example Type
zone required for all bid requests tracking a single domain or site Tracking ID 'ggumtest' string
pubId required for all bid requests tracking multiple domains or sites Publisher ID 123 integer
irisid optional Iris.tv ID 'iris_6f9285823a4' string
slot optional Placement ID 40 number
product required for new supported products like ‘skins’ Product Type skins string

Client Side Bid Params

Name Scope Description Example Type
zone required for all bid requests tracking a single domain or site Tracking ID 'ggumtest' string
pubId required for all bid requests tracking multiple domains or sites Publisher ID 123 integer
slot required for slot placement only Slot ID 9 integer
product required for new supported products like ‘skins’ Product Type skins string
iriscat optional Iris.tv segments 'segment1,segment2' string
irisid optional Iris.tv ID '123' string
bidfloor optional CPM bidfloor in USD 0.03 float

Legacy Client Side Bid Params

Name Scope Description Example Type
inScreen required for in-screen placement only Tracking ID 'ggumtest' string
inScreenPubID required for in-screen placement only Publisher ID 123 integer
inSlot required for slot placement only Slot ID 9 integer
video required for video placement only Tracking ID 'ggumtest' string
videoPubID required for video placement only Publisher ID 123 integer
inVideo required for in-video placement only Tracking ID 'ggumtest' string
ICV required for ICV placement only ICV ID 19 integer
bidfloor optional CPM bidfloor in USD 0.03 float

Please note that both video and in-video products require a mediaType of video while all other products require a mediaType of banner.

Client Side Examples

Client side integration currently supports slot, in-screen, video, and in-video products. The following examples are based on the ‘Client Side Bid Params’ table. All bid requests require a zone or pubId parameter:

{
    bidder: 'gumgum',
    params: {
        zone: 'zone_id' // provided by GumGum
    }
}

To enable ad requests at a publisher level, instead of zone use pubId:

{           
    bidder: 'gumgum',       
    params: {       
        pubId: pub_id // provided by GumGum     
    }       
}      

In-Screen

To enable ad requests for in-screen, either zone or pubId must be present in the params object:

{
    bidder: 'gumgum',
    params: {
        zone: 'zone_id' // provided by GumGum
    }
}

Skins

Skins ad requests require the product parameter with the value of skins in the params object:

{
    bidder: 'gumgum',
    params: {
        zone: 'zone_id', // provided by GumGum
        product: 'skins'
    }
}

Slot

Slot ad requests require the slot parameter in the params object:

{
    bidder: 'gumgum',
    params: {
        zone: 'zone_id', // provided by GumGum
        slot: 'slot_id' // provided by GumGum
    }
}

Video and In-Video

For video and in-video products, please follow the configuration shown under the in-screen example. Additionally, you will need to define a ‘video’ field in the ‘mediaTypes’ object. For example:

{
    mediaTypes: {
        video: {
            context: 'instream',
            playerSize: [640, 480],
            minduration: 1,
            maxduration: 2,
            linearity: 1,  // ** Change this to 2 for in-video
            startdelay: 1,
            placement: 1,
            protocols: [1, 2]
        }
    }
}

Please note:

All fields under video (context, playerSize, minDuration etc) are the minimum requirements to make a video ad request. You should replace playerSize, minduration, maxduration, startdelay, placement, and protocols values to your specifications (see OpenRTB spec 2.5 for more information). linearity should be set to 1 for video product, and 2 for in-video.

Server Side Examples

At the moment, the only products supported via Prebid S2S are slot, in-screen, and video. The configuration is similar to client side configuration. Add the following object in your bids array:

{
    bidder: 'gumgum',
    params: {
        zone: 'zone_id', // provided by GumGum
    }
}

Slot

The mediaTypes field should have ‘banner’ with sizes using standard IAB display sizes (as seen in the example below). The zone id is provided by GumGum.

{
    mediaTypes: {
        banner: {
            sizes: [[300, 250], [300, 600]]
        }
    },
    bids: [
        {
            bidder: 'gumgum',
            params: {
                zone: 'zone_id' // zone id is provided by GumGum
            }
        },
    ]
}

In-Screen

The adUnits settings for both in-screen and slot have a similar structure. The only difference between slot and in-screen ad unit configuration is the sizes. In-screen products require a non-standard IAB display size (e.g. [1, 1] as seen in the example below or any other size you choose).

{
    mediaTypes: {
        banner: {
            sizes: [[1, 1]]
        }
    },
    bids: [
        {
            bidder: 'gumgum',
            params: {
                zone: 'zone_id' // zone id is provided by GumGum
            }
        },
    ]
}

Skins

The skins product requires a similar setup to its client side header bidding counterpart:

{
    bids: [
        {
            bidder: 'gumgum',
            params: {
                zone: 'zone_id', // provided by GumGum
                product: 'skins'
            }
        },
    ]
}

Video

The video product requires nearly the same setup as with Prebid client side header bidding:

{
    mediaTypes: {
        video: {
            context: 'instream',
            mimes: ['video/mp4'],
            playerSize: [640, 480],
            w: 640,
            h: 480,
            minduration: 1,
            maxduration: 2,
            linearity: 1,
            startdelay: 1,
            placement: 1,
            protocols: [1, 2]
        }
    },
    bids: [
        {
            bidder: 'gumgum',
            params: {
                zone: 'zone_id' // zone id is provided by GumGum
            }
        },
    ]
}

All fields under video (context, playerSize, minDuration etc) are the minimum requirements to make a video ad request. Please replace playerSize, w, h, mimes, minduration, maxduration, startdelay, and protocols values to your specifications (see OpenRTB spec 2.5 for more information).

HuaweiAds

Features

Bidder Code huaweiads Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 856
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support yes
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK no Supports Deals yes
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_huaweiads hb_bidder_huaweiads hb_adid_huaweiads
hb_size_huaweiads hb_source_huaweiads hb_format_huaweiads
hb_cache_host_huawei hb_cache_id_huaweiad hb_uuid_huaweiads
hb_cache_path_huawei hb_deal_huaweiads  

Note

The Huawei Bidding adapter requires setup and approval before implementation. Please contact us at developereu@huawei.com, also you can submit a ticket online.

Bid Params

Name Scope Description Example Type
publisherid required Publisher Id '2001000399' string
signkey required Sign Key '5d********82c38594f8b2bdfd9f********a398dca734932898e3********8d' string
keyid required Key Id '2' string
slotid required Slot Id 'u42ohmaufh' string
adtype required Ad Type 'banner','native','interstitial','rewarded' string

Notes:

  1. The following parameters need to be registered on the HuaweiAds platform, and at the same time, the permission to access the server interface needs to be opened on the HuaweiAds platform.
  2. You can find publisherid, signkey, and keyid on the platform after registration.
  3. You need to create your advertising creative on the platform and get the corresponding slotid and adtype.
  4. We require OAID (Open Advertising ID) or GAID (Google Advertising ID) in the request. OAID and GAID are non-permanent device identifiers that allow personalized ads to be served to users while protecting user data privacy. In most cases, OAID is used for HMS phones and GAID is used for GMS phones. GAID is collected by default. For OAID on HMS phones, app developers should call the AdvertisingIdClient.getAdvertisingIdInfo(mContext) method to obtain the OAID, then add the OAID to the request using the Prebid SDK as shown below.
  5. The auction will use the Prebid Server time zone, but this can be by developers if they send the clientTime targeting parameter to the HuaweiAds Adx server using the Prebid SDK. For example: TargetingParams.addUserData("clientTime", "2018-11-02 16:34:07.981+0800").

Obtain the OAID

// Add the OAID to user data in prebid initialization
if ( isHmsAvailable() ) {
    TargetingParams.addUserData("oaid", AdvertisingIdClient.Info info = AdvertisingIdClient.getAdvertisingIdInfo(getApplicationContext()).getId());
}

//Determine the HMS availability
public static boolean isHmsAvailable(Context context) {
    boolean isAvailable = false;
    if (null != context) {
        int result = HuaweiApiAvailability.getInstance().isHuaweiMobileServicesAvailable(context);
        isAvailable = (com.huawei.hms.api.ConnectionResult.SUCCESS == result);
    }
    Log.i(TAG, "isHmsAvailable: " + isAvailable);
    return isAvailable;
}

iion

Features

Bidder Code iionads Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-one
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support no First Party Data Support no
User IDs all ORTB Blocking Support yes
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iionads hb_bidder_iionads hb_adid_iionads
hb_size_iionads hb_source_iionads hb_format_iionads
hb_cache_host_iionad hb_cache_id_iionads hb_uuid_iionads
hb_cache_path_iionad hb_deal_iionads  

Bid Params

Name Scope Description Example Type
host required Ad network’s RTB host 'iionads.com' string
adUnitId required Ad Unit Id will be generated on iionads Platform. 42 integer
adUnitType required Type of Ad Unit ('video', 'banner') 'banner' string
publisherId required Publisher ID '12345' string
custom1 optional Custom targeting field 1 'custom1' string
custom2 optional Custom targeting field 2 'custom2' string
custom3 optional Custom targeting field 3 'custom3' string
custom4 optional Custom targeting field 4 'custom4' string
custom5 optional Custom targeting field 5 'custom5' string

iionads server-side Prebid Server adapter requires only publisherId and host parameters. But iionads client-side Prebid.js adapter requires only host, adUnitId, adUnitType.

iionads server-side Prebid Server adapter supports only banner, video, audio, native media types. But iionads client-side Prebid.js adapter supports only banner and video media types, doesn’t support audio and native.

iMedia Digital Services (iMDS)

Features

Bidder Code imds Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support will-bid-on-any
TCF-EU Support no IAB GVL ID none
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support no
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals no
Floors Module Support yes First Party Data Support no
User IDs all ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_imds hb_bidder_imds hb_adid_imds
hb_size_imds hb_source_imds hb_format_imds
hb_cache_host_imds hb_cache_id_imds hb_uuid_imds
hb_cache_path_imds hb_deal_imds  

Note

The iMedia Digital Services bidder adapter requires setup and approval from iMedia Digital Services. Please reach out to your account manager for more information and to start using it.

Configuration

iMedia Digital Services requires that iframe is used for user syncing.

Example configuration:

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

DFP Video Creative

To use video, setup a VAST redirect creative within Google Ad Manager with the following VAST tag URL:

If using the new imds adapter with x8.x or later:

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

If using the legacy synacormedia adapter with v7.x or earlier:

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

Bid params

Name Scope Description Example Type
seatId required The seat ID from iMedia Digital Services. This will be the same for all ad units. 'prebid' string
tagId required The placement ID or tag ID from iMedia Digital Services. 'demo1' string
placementId optional Legacy parameter replaced by tagId 'demo1' string
bidfloor optional Legacy parameter for floor price for the request. Replaced by Price Floors Module 0.1 float

Example Ad Unit

var adUnits = [{
    "code": "test-div",
    "mediaTypes": {
        "video": {
            "pos": 1,
            "playerSize": [300, 250],
            "context": "instream",
            "mimes": ["video/mp4"],
            "protocols": [2, 3, 5, 6, 7, 8],
            "playbackmethod": [2],
            "skip": 0,
            "minduration": 15,
            "maxduration": 30,
            "startdelay": 0,
            "linearity": 1
        }
    },
    "bids": [{
        "bidder": "imds",
        "params": {
            "seatId": "prebid",
            "tagId": "demo1",
            "bidfloor": 0.20
        }
    }]
}]

Impactify

Features

Bidder Code impactify Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 606
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs criteo, id5Id, pubCommonId, unifiedId, uid2, netId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_impactify hb_bidder_impactify hb_adid_impactify
hb_size_impactify hb_source_impactify hb_format_impactify
hb_cache_host_impact hb_cache_id_impactif hb_uuid_impactify
hb_cache_path_impact hb_deal_impactify  

Note

The Impactify adaptator requires setup and validation from the Impactify team. Simply email us your contact details at support@impactify.io and we’ll make sure we’ll connect you within 48h.

Bid Params

Name Scope Description Example Type
appId required Impactify publisher id (Contact us) 'example.com' string
format required Impactify ad format (screen or display) 'screen' string
style required Impactify ad style (inline, impact or static) 'impact' string

Configuration

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

Note : Impactify adapter needs storage access to work properly (Do not forget to set storageAllowed to true).

For Prebid.js v1.15.0 and later:

pbjs.bidderSettings = {
    impactify: {
        storageAllowed: true // Mandatory
    }
};

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

For Prebid.js v1.14.0 and before:


pbjs.bidderSettings = {
    impactify: {
        storageAllowed: true // Mandatory
    }
};

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

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

Improve Digital

Features

Bidder Code improvedigital Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 253
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs all ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Bid params

Name Scope Description Example Type
placementId required The placement ID from Improve Digital. 1234567 integer
publisherId required The publisher ID from Improve Digital. 4567 integer
keyValues optional Contains one or more key-value pairings for key-value targeting { testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] } object
bidFloor optional Bid floor price 0.01 float
bidFloorCur optional Bid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK 'USD' string
extend optional See the Extend mode section true boolean
rendererConfig optional Configuration object for JS renderer of the RAZR creatives. Provided by Improve Digital. { key1: value1 } object

Configuration

Sizes

By default, the adapter 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 }
});

Renderer Config

Global configuration for the special creative format renderer. Please use rendererConfig bid param for ad slot specific configuration.

pbjs.setConfig({
    improvedigital: {
        rendererConfig: {
            // Global config object provided by Improve Digital
        }
    }
});

Extend Mode

Improve Digital Extend mode provides publishers with access to additional demand from other SSPs. Before enabling please contact our team for more information. The Extend mode can be enabled:

  • per ad unit via the extend bid param
  • for all ad units via setConfig():
pbjs.setConfig({
    improvedigital: {
        extend: true
    }
});

Examples

Examples of different ad unit formats can be found in Prebid.js ad unit reference. Improve Digital bidder must be added in the ad unit’s bids array. Example:

pbjs.addAdUnits({
    code: 'banner1',
    sizes: [[728, 90], [970, 250]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId: 1111111,
                publisherId: 1234
            }
        }
    ]
});

Example for Key-Values

pbjs.addAdUnits({
    code: 'banner1',
    sizes: [[600, 290]],
    bids: [
        {
            bidder: 'improvedigital',
            params: {
                placementId: 1111111,
                publisherId: 1234,
                keyValues: {
                    testKey1: ["testValueA"],
                    testKey2: ["testValueB", "testValueC"]
                }
            }
        }
    ]
});

Indicue

Features

Bidder Code indicue Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support some (check with bidder) DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals no
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, unifiedId ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_indicue hb_bidder_indicue hb_adid_indicue
hb_size_indicue hb_source_indicue hb_format_indicue
hb_cache_host_indicu hb_cache_id_indicue hb_uuid_indicue
hb_cache_path_indicu hb_deal_indicue  

Bid params

Name Scope Description Example Type
aid required The source ID from Indicue Media. 12412 integer

Description

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

Test Parameters

    var adUnits = [

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

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

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

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

InfyTV

Features

Bidder Code infytv Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_infytv hb_bidder_infytv hb_adid_infytv
hb_size_infytv hb_source_infytv hb_format_infytv
hb_cache_host_infytv hb_cache_id_infytv hb_uuid_infytv
hb_cache_path_infytv hb_deal_infytv  

Note

The Example Bidding adapter requires setup before beginning. Please contact us at adops@infy.tv

Bid Params

Name Scope Description Example Type
publisherId required Publisher ID '11111' string
placementId optional Placement ID '11111' string

InMobi

Features

Bidder Code inmobi Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support yes IAB GVL ID 333
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support no COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_inmobi hb_bidder_inmobi hb_adid_inmobi
hb_size_inmobi hb_source_inmobi hb_format_inmobi
hb_cache_host_inmobi hb_cache_id_inmobi hb_uuid_inmobi
hb_cache_path_inmobi hb_deal_inmobi  

Note

The InMobi Prebid adapter requires a setup to create placement IDs. Please contact your InMobi partner manager for setup assistance. For queries, write to us at prebid-support@inmobi.com

User Sync Disclosure

InMobi has partnered with a third party, ID5, to use their ID as our primary user identifier for mobile web supply. We will also rely on ID5 IDs to handle compliance flows related to Data Subject Right requests in our systems. Hence, we require the publisher to use ID5’s sync URL for user syncing and passing the corresponding ID5 ID to InMobi in the bid request. For this purpose, we provide ID5’s sync URL in our Prebid adapter for User ID sync. Note that, InMobi has a direct contract with ID5 for consuming ID5 ID and the user sync via Prebid does not require the publisher to get into a contractual relationship with ID5.

To opt out of InMobi ads on mobile web inventory or for any other requests, the user needs to visit the Opt-out page on InMobi website (https://www.inmobi.com/page/opt-out/). For opting out of ID5 ID entirely, the user needs to visit ID5’s opt out page: https://id5.io/platform-privacy-policy/.

Bid Params

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

InteractiveOffers

Features

Bidder Code interactiveOffers Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_interactiveOff hb_bidder_interactiv hb_adid_interactiveO
hb_size_interactiveO hb_source_interactiv hb_format_interactiv
hb_cache_host_intera hb_cache_id_interact hb_uuid_interactiveO
hb_cache_path_intera hb_deal_interactiveO  

Note

Module that connects to interactiveOffers demand sources. Param partnerId is required.

Bid Params

Name Scope Description Example Type
partnerId required Partner id ‘abc123’ string

Example:

{
    bidder: "interactiveOffers",
    params: {
        partnerId: "abc123"
    }
}

intertech

Features

Bidder Code intertech Prebid.org Member no
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support check with bidder COPPA Support check with bidder
Supply Chain Support check with bidder Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_intertech hb_bidder_intertech hb_adid_intertech
hb_size_intertech hb_source_intertech hb_format_intertech
hb_cache_host_intert hb_cache_id_intertec hb_uuid_intertech
hb_cache_path_intert hb_deal_intertech  

Registration

The Intertech Bidding adapter requires setup before beginning. Please contact us at prebid@intertechsrvcs.com.

Bid params

Name Scope Description Example Type
pageId required Page ID 123456 Integer
impId required Block ID 12 Integer

Invibes

Features

Bidder Code invibes Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, native Multi Format Support will-bid-on-any
TCF-EU Support yes IAB GVL ID 436
GPP Support tcfeu DSA Support check with bidder
USP/CCPA Support no COPPA Support no
Supply Chain Support no Demand Chain Support no
Safeframes OK no Supports Deals no
Floors Module Support no First Party Data Support no
User IDs none ORTB Blocking Support no
Privacy Sandbox check with bidder Prebid Server App Support no

"Send All Bids" Ad Server Keys

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

Disclosure

The bidder will use the Local Storage if allowed by the publisher and user gives consent on page with the following purposes: - set an internal Invibes ID - get the internal Invibes ID if it was set priorly for the user

The bidder will NOT set any cookies. The bidder will also try to read from Cookies if publisher gibes the internal ID if this wasn’t found in LocalStorage.

Bid Params

Name Scope Description Example Type
placementId required The Invibes placement ID '1234567' string
domainId optional Id of domain 1001 integer
customEndpoint optional Custom test domain https://bid.videostep.com/Bid/VideoAdContent integer
debug optional Debug paramentes (only prebid server) { "testBvid": "1234", "testLog": true } object

IQX

Features

Bidder Code iqx Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support will-bid-on-any
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK yes Supports Deals check with bidder
Floors Module Support yes First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support check with bidder

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iqx hb_bidder_iqx hb_adid_iqx
hb_size_iqx hb_source_iqx hb_format_iqx
hb_cache_host_iqx hb_cache_id_iqx hb_uuid_iqx
hb_cache_path_iqx hb_deal_iqx  

Prebid.js Bid params

Name Scope Description Example Type
pid required Placement ID test-banner string
env required Environment name iqx string
ext optional Specific integration config {} object

Prebid Server Bid Params

Name Scope Description Example Type
env required Environment name iqx-stage string
pid required unique placement ID aa8217e20131c095fe9dba67981040b0 string

IQzone

Features

Bidder Code iqzone Prebid.org Member no
Prebid.js Adapter yes Prebid Server Adapter yes
Media Types display, video, native Multi Format Support check with bidder
TCF-EU Support no IAB GVL ID check with bidder
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support check with bidder
Supply Chain Support yes Demand Chain Support check with bidder
Safeframes OK check with bidder Supports Deals check with bidder
Floors Module Support check with bidder First Party Data Support check with bidder
User IDs none ORTB Blocking Support check with bidder
Privacy Sandbox check with bidder Prebid Server App Support yes

"Send All Bids" Ad Server Keys

These are the bidder-specific keys that would be targeted within GAM in a Send-All-Bids scenario. GAM truncates keys to 20 characters.
hb_pb_iqzone hb_bidder_iqzone hb_adid_iqzone
hb_size_iqzone hb_source_iqzone hb_format_iqzone
hb_cache_host_iqzone hb_cache_id_iqzone hb_uuid_iqzone
hb_cache_path_iqzone hb_deal_iqzone  

Prebid.js Bid Params

Name Scope Description Example Type
placementId optional Placement Id '0' 'string'
endpointId optional Endpoint Id '0' 'string'

Note

For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId

Index Exchange (Prebid Server)

Features

Bidder Code ix Prebid.org Member yes
Prebid.js Adapter no Prebid Server Adapter yes
Media Types display, video, native Multi Format Support true
TCF-EU Support yes IAB GVL ID 10
GPP Support check with bidder DSA Support check with bidder
USP/CCPA Support yes COPPA Support yes
Supply Chain Support yes Demand Chain Support no
Safeframes OK yes Supports Deals yes
Floors Module Support yes First Party Data Support yes
User IDs idl, netId, fabrickId, zeotapIdPlus, uid2, TDID, id5Id, lotamePanoramaId, publinkId, hadronId, pubcid, utiq, criteoID, euid, imuid, 33acrossId, nonID, pairid ORTB Blocking Support check with bidder
Privacy Sandbox paapi Prebid Server App Support yes

"Send All Bids" Ad Server Keys

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

Table of contents

Introduction

Publishers can use Prebid Server in any of the following ways with Index Exchange (Index). Index’s adapter supports all of the following methods:

  • If you want to call Index from a web environment, you can use Prebid.js to call Prebid Server, and then Prebid Server uses our server-side adapter to call Index. This reduces workload on the browser. For set up instructions, see Call Index from a web browser section on this page.
  • In mobile apps, you can use the Prebid Mobile SDK to call Prebid Server and then Prebid Server uses our server-side adapter to call Index. For set up instructions, see Call Index from Prebid Mobile SDK section on this page.
  • In CTV apps and other long-form video environments, you (or the SSAI vendor) can make a call to Prebid Server using OpenRTB, and then Prebid Server uses our server-side adapter to call Index. For set up instructions, see Call Index from CTV/long-form video environment section on this page.
  • In any other server-to-server OpenRTB environment, you can send OpenRTB bid requests to the Prebid Server host of your choice. For set up instructions, see Call Index from any other server