Demand Partners

The following page contains all of Relay's demand partners and their configuration fields organized alphabetically. To find your specific partner quickly, use command + F to search the document.

Commonly Used Partners

Index Exchange

Banner

You must include these parameters at the bidder level.

KeyScopeTypeDescription
siteIDRequredStringAn Index-specific identifier that is associated with this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '9999990', '9999991', '9999992'`

Video

You must include these parameters at the bidder level

KeyScopeTypeDescription
siteIDRequredStringAn Index-specific identifier that is associated with this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '9999990', '9999991', '9999992'`

If you are using Index’s outstream ad unit and have placed the video object at the bidder level, you must include the Index required parameters at the bidder level. You can include the optional parameters to specify the outstream ad unit configurations.

KeyScopeTypeDescription
video.wRequredIntegerThe width of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the video.w and video.h parameters. We strongly recommend video sizes to be 256 x 256 or greater, 300 x 250, or 320 x 180.
video.hRequiredIntegerThe height of the video player in pixels that will be passed to demand partners. You must define the size of the video player using the video.w and video.h parameters. We strongly recommend video sizes to be 256 x 256 or greater, 300 x 250, or 320 x 180.
video.playerSizeRequiredIntegerThe video player size that will be passed to demand partners.
video.playerConfigOptionalHashThe Index-specific outstream ad unit configurations.
video.playerConfig.floatOnScrollOptionalBooleanA boolean specifying whether you want to use the player’s floating capabilities, where:
- true: Use the Index player’s float capabilities.
Note: If you set floatOnScroll to true, Index updates the placement value to 5.
Note: We do not recommend using the player’s default float capabilities if you have more than one outstream ad unit per page.
-false: Do not use the Index player’s float capabilities (default).
video.playerConfig.floatSizeOptionalIntegerThe height and width of the floating player in pixels. If you do not specify a float size, the player adjusts to the aspect ratio of the player size that is defined when it is not floating. Index recommends that you review and test the float size to your user experience preference.
video.plcmtRequiredIntegerThe video’s placement type, where:

- 1 = Instream
- 2 = Accompanying Content
- 3 = Interstitial
- 4 = No Content/Standalone

Magnite / Rubicon Project

NameScopeDescriptionExampleType
accountIdrequiredThe publisher account ID4934integer
siteIdrequiredA unique ID for your site13945integer
zoneIdrequiredA unique ID for your site's ad placements23948integer
positionoptionalSet the page position. Valid values are "atf" and "btf".'atf'string
userIdoptionalSite-specific user ID may be reflected back in creatives for analysis. Note that userId needs to be the same for all slots.'12345abc'string
flooroptionalSets the global floor -- no bids will be made under this value.0.50float
latLongoptionalSets the latitude and longitude for the visitor (avail since PBJS 1.10)[40.7608, 111.8910]Array<float>
inventoryoptionalSee below for details on First Party Data. In release 4.29 and earlier, this parameter allows the definition of an object defining arbitrary key-value pairs concerning the page for use in targeting. The values must be arrays of strings.{"rating":["5-star"], "prodtype":["tech","mobile"]}object
visitoroptionalSee below for details on First Party Data. In release 4.29 and earlier, this parameter allows the definition of an object defining arbitrary key-value pairs concerning the visitor for use in targeting. The values must be arrays of strings.{"ucat":["new"], "search":["iphone"]}object
keywordsoptionalSee below for details on First Party Data. In release 4.29 and earlier, this can be used to influence reports for client-side display. To get video or server-side reporting, please use First Party data or the inventory/visitor parameters.["travel", "tourism"]Array<string>
videorequired for videoVideo targeting parameters. See the video section below.{"language": "en"}object
pchainoptionaldeprecated option that was an early alternative to schain"GAM:11111-reseller1:22222"string
bidonmultiformatoptionalBeta parameter - please check with your account manager before setting this valuebooleantrue

PubMatic

NameScopeDescriptionExampleType
publisherIdrequiredPublisher ID'32572'string
adSlotoptionalAd Slot Name (see below)'38519891'string
pmzoneidoptionalZone ID'zone1,zone2'string
latoptionalLatitude'40.712775'string
lonoptionalLongitude'-74.005973'string
yoboptionalYear of Birth'1982'string
genderoptionalGender'M'string
kadpageurloptionalOverrides Page URL'http://www.yahoo.com/'string
kadflooroptionalBid Floor'1.75'string
currencyoptionalBid currency'AUD' (Value configured only in the 1st adunit will be passed on.
Values if present in subsequent adunits, will be ignored.)
string
dctroptionalDeal Custom Targeting
(Value configured only in the 1st adunit will be passed on.
Values if present in subsequent adunits, will be ignored.)
`'key1=123key2=345'`string
acatoptionalAllowed categories
(List of allowed categories for a given auction to be sent in either using ortb2 config (request.ext.prebid.bidderparams.pubmatic.acat) or using slot level params. If categories sent using both then priority will be given to ortb2 over slot level params.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]array of strings
bcatoptionalBlocked IAB Categories
(Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.)
[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]array of strings
dealsoptionalPMP deals
(Values from each slot will be passed per slot. An array of strings only. Each deal-id should be a string of a length of more than 3 characters.)
[ 'deal-id-5', 'deal-id-6', 'deal-id-7' ]array of strings
outstreamAUoptionalOustream AdUnit described in Blue BillyWig UI. This field is mandatory if mimeType is described as video and context is outstream (i.e., for outstream videos)'renderer_test_pubmatic'string

AppNexus

NameScopeDescriptionExampleType
placement_id (PBS+PBJS) or placementId (PBJS)requiredThe 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.234234integer
memberoptionalThe member ID from AppNexus. Must be used with invCode.'12345'string
invCode or inv_codeoptionalThe inventory code from AppNexus. Must be used with member.'abc123'string
publisherId or publisher_idoptionalThe 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.12345integer
frameworksoptionalArray of integers listing API frameworks for Banner supported by the publisher.integer
useroptionalObject that specifies information about an external user. See User Object for details.user: { age: 25, gender: 0, dnt: true}object
allowSmallerSizes or allow_smaller_sizesoptionalIf true, ads smaller than the values in your ad unit's sizes array will be allowed to serve. Defaults to false.trueboolean
usePaymentRule (PBJS) or use_pmt_rule (PBS+PBJS)optionalIf true, Appnexus will return net price to Prebid.js after publisher payment rules have been applied.trueboolean
keywordsoptionalA 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
videooptionalObject containing video targeting parameters. See Video Object for details.video: { playback_method: ['auto_play_sound_off'] }object
appoptionalObject containing mobile app parameters. See the App Object for details.app : { id: 'app-id'}object
reserveoptionalSets 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 docs0.90float
positionoptionalIdentify 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_codeoptionalSpecifies the third-party source of this impression.'my_traffic_source'string
supplyType or supply_typeoptionalIndicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app'web'string
pubClick or pub_clickoptionalSpecifies 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_codeoptionalSpecifies 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_idoptionalSpecifies the unique identifier of an externally generated auction.'bacbab02626452b097f6030b3c89ac05'string
generate_ad_pod_idoptionalSignal 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.trueboolean

Full List of Partners

33Across

NameScopeDescriptionExampleType
siteIdrequiredPublisher GUID from 33Across'examplePub123'string
productIdrequired33Across Product ID that the Publisher has registered for (use 'siab' for Banner or Outstream Video , 'inview' for Adhesion, 'instream' for Instream Video)'siab'string

AAX

NameScopeDescriptionExampleType
cidrequiredThe customer id provided by Aax.'aax_test_customer'string
cridrequiredThe placement id provided by Aax.'aax_crid'string
videorequired for video Ad unitsObject containing video targeting parameters. See Video Object for details.video: { maxduration: 60 }object

Aceex

NameScopeDescriptionExampleType
accountidrequiredEndpoint id'hash'string

AcuityAds

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

AdformOpenRTB

NameScopeDescriptionExampleType
midrequired, if inv and nmane not setPlacement ID12345integer
invrequired, if mid not setInventory source ID1234integer
mnamerequired, if mid not setPlacement name"Leaderboard"string
adxDomainoptional, Prebid.js onlyThe Adform domain"adx.adform.net"string
priceTypeoptionalPrice type"gross"string

Ad Generation

NameScopeDescriptionExampleType
idrequiredadId'1234'string

Adhese

NameScopeDescriptionExampleType
accountrequiredAdhese account name'demo'string
locationrequiredAdhese location name'_adhese_prebid_demo_'string
formatrequiredAdhese format name'leaderboard'string
dataoptionalCustom target data{ 'ci': [9000, 9050] }object

AdKernel

NameScopeDescriptionExampleType
hostrequiredAd network's RTB host'cpm.metaadserving.com'string
zoneIdrequiredRTB zone id30164integer

AdKernelAdn

NameScopeDescriptionExampleType
hostoptionalAd network host'tag.adkernel.com'string
pubIdrequiredPublisher Id102integer

ADman Media

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

AdMixer

NameScopeDescriptionExampleType
zonerequiredThe unique identifier of the ad placement. Could be obtained from the Admixer UI or from your account manager."e5ff8e48-4bd0-4a2c-9236-55530ab8981d"string
kvTargetingoptionalKey/Value - a pair of the unique values that will be used for the custom targeting option.{key1: value2, key2: value2}object

Adnuntius

NameScopeDescriptionExampleType
auIdrequiredThe ad unit ID '0000000000072345' leading zeros can be omitted.'0000000000072345'string
networkoptionalUsed if you want to make requests to multiple networks in adnuntius.'adnuntius'string
targetingoptionalTargeting to be sent through to adnuntius with the request.{ c: ['prebids'] }string
maxDealsoptionalThe maximum number of deal bids to include. Default 0.1Integer

AdOcean

NameScopeDescriptionExampleType
slaveIdrequiredslave ID'adoceanmyaozpniqismex'string
masterIdrequiredmaster ID'tmYF.DMl7ZBq.Nqt2Bq4FutQTJfTpxCOmtNPZoQUDcL.G7'string
emiterrequiredtraffic source id'myao.adocean.pl'string

Adoppler

NameScopeDescriptionExampleType
adunitrequiredAdUnit to bid against'test'string
clientoptionalClient name'ads'string

Adot

NameScopeDescriptionExampleType
placementIdoptionalThe placement ID from Adot.'adot_placement_224521'string
videooptionalObject containing video targeting parameters. See Video Object for details.object

Adpone

NameScopeDescriptionExampleType
placementIdrequiredThe placement ID from Adpone.234234integer

Adprime

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Adrino

NameScopeDescriptionExampleType
hashrequiredIdentifier for specific ad placement'abcdef123456'string

AdsInteractive

NameScopeDescriptionExampleType
adUnitrequiredadUnit tag name'example_adunit_1'string

AdsYield

NameScopeDescriptionExampleType
zonerequiredThe unique identifier of the ad placement. Could be obtained from the AdsYield UI or from your account manager.'e5ff8e48-4bd0-4a2c-9236-55530ab8981d'string
hostrequiredAd network's RTB host'open-adsyield.com'string
publisherIdrequiredPublisher ID12345integer

Adtarget

NameScopeDescriptionExampleType
aidrequiredThe source ID from Adtarget platform.529814integer

Adtelligent

NameScopeDescriptionExampleType
aidrequiredThe source ID from Adtelligent.350975integer

Adtarget.me

NameScopeDescriptionExampleType
site_idrequiredSite ID1234567890uint64

Advangelists

NameScopeDescriptionExampleType
placementrequired'263'string
pubidrequired'0cf8d6d643e13d86a5b6374148a4afac'string
mimesoptionalvideo only['video/mp4', 'application/javascript']array of strings
playbackmethodoptionalvideo only[2,6]array of numbers
maxdurationoptionalvideo only30number
skipoptionalvideo only0 or 1number

AdView

NameScopeDescriptionExampleType
placementIdrequiredPlacement ID'posid00001'string
accountIdrequiredAccount ID'accountid01'string

adxcg

NameScopeDescriptionExampleType
adzoneidrequiredadxcg zone id'1'string

Adyoulike

NameScopeDescriptionExampleType
placementrequiredThe placement ID from Adyoulike.'194f787b85c829fb8822cdaf1ae64435'string

AJA

NameScopeDescriptionExampleType
asirequiredad spot hash code'123abc'string

AlgoriX

NameScopeDescriptionExampleType
sidrequiredSid'30014'string
tokenrequiredToken'028bca2d3b5c4f0ba155fa34864b0c4d'string
placementIdoptionalPlacement Id'123456'string
appIdoptionalApp Id'asdasdasd'string
regionoptionalServer Region'APAC', 'USE', 'EUC'string

Alkimi

NameScopeDescriptionExampleType
tokenrequiredThe ID issued by Alkimi to the publisher'8a80d8e9-0cf9-4329-8486-6f5bbcd8a61a'string
bidFloorrequiredMinimum bid for this impression expressed in CPM.0float
posoptionalSpecify the position of the ad as a relative measure of visibility or prominence. Allowed values: Above the fold: 1; Below the fold: 3; Middle of the fold: 7;0integer

AMX RTB

NameScopeDescriptionExampleType
tagIdrequiredTag ID'cHJlYmlkLm9yZw'string
testModeoptionalActivate 100% fill adstrueboolean
adUnitIdoptionalAd Unit ID used in reporting. Will default to bid.adUnitCode'sticky_banner'string

AndBeyond.Media

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Apacdex

NameScopeDescriptionExampleType
placementId*requiredPlacement ID provided by Apacdex'plc100000'string
siteId*requiredPublisher site ID from Apacdex'apacdex1234'string
floorPriceoptionalCPM bidfloor in USD0.03float
geooptionalGEO data of device. See Geo Object for details.{"lat":17.98928,"lon":99.7741712,"accuracy":20}object

Applogy

NameScopeDescriptionExampleType
tokenrequiredApplogy tokeb'aaaa'string

Appush

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Audience Network

NameScopeDescriptionExampleType
placementIdrequiredThe Placement ID from Audience Network'555555555555555\_555555555555555'string
formatoptionalFormat, one of "native", "fullwidth" or "video"'native'string

Automatad OpenRTB Bid Adapter

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Avocet

NameScopeDescriptionExampleType
placementrequiredA Placement ID from Avocet."5ebd27607781b9af3ccc3332"string

Axonix

NameScopeDescriptionExampleType
supplyIdrequiredSupply UUID'2c426f78-bb18-4a16-abf4-62c6cd0ee8de'string
regionoptionalCloud region'us-east-1'string
endpointoptionalSupply custom endpoint'https://open-rtb.axonix.com/custom'string
instloptionalSet to 1 if using interstitial (default: 0)1integer

Beachfront

NameScopeDescriptionExampleType
appIdrequiredBeachfront Exchange ID'11bc5dd5-7421-4dd8-c926-40fa653bec76'string
bidfloorrequiredBid floor. The floor price module will take priority over this value.0.01float
videooptionalObject with video parameters. See the video section below for details.object
banneroptionalObject with banner parameters. See the banner section below for details.object
playeroptionalObject with outstream player parameters. See the player section below for details.object

Beintoo

NameScopeDescriptionExampleType
placementIdrequiredstring

Between

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Bidmachine

NameScopeDescriptionExampleType
hostrequiredDC region"api-eu"string
pathrequiredURL path, will be provided by manager"auction/rtb/v2"string
seller_idrequiredYour ID in Bidmachine system"1"string

BidMyAdz

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

BidsCube

NameScopeDescriptionExampleType
placementIdrequiredPlacement ID'12345'string

Bidstack

NameScopeDescriptionExampleType
publisherIdrequiredPublisher ID'be224bf2-fd3f-4afb-b6fc-4a97718be2f5'string
placementIdoptionalPlacement ID'some_placement_id'string
consentoptionalUser EULA consenttrueboolean

BizzClick

NameScopeDescriptionExampleType
placementIdrequiredplacement id'hash'string
accountIdrequiredaccount id'bizzclickTest'string

BLIINK

NameScopeDescriptionExampleType
tagIdrequiredThe TagID from BLIINK.'32'string
imageUrloptionalThe image url on which the ad is displayed in case of in-image ad.'https://image.png'string

Blue

NameScopeDescriptionExampleType
publisherIdrequiredUnique publisher ID'ABCDEF'string

Bright Mountain Media

NameScopeDescriptionExampleType
placement_idrequiredPlacement ID will be generated on Bright Mountain Media Platform1integer

Boldwin

NameScopeDescriptionExampleType
placementIdoptionalPlacement Id'0'string
endpointIdoptionalEndpoint Id'0'string

Brave

NameScopeDescriptionExampleType
placementIdrequiredBrave's platform placement id'to0QI2aPgkbBZq6vgf0oHitouZduz0qw'string

Brightroll

NameScopeDescriptionExampleType
publisherrequiredPublisher Name to use'pub1'string

Cadent Aperture MX

NameScopeDescriptionExampleType
tagidrequiredThe Tag ID from Cadent Aperture MX.test1string
bidflooroptionalThe CPM bid floor0.25string

Clickonometrics

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

CodeFuel

NameScopeDescriptionExampleType
placementIdrequiredPlacement-Id defined by the caller'0111f8ac-2d40-4613-8557-b47dbf622fff'string

Coinzilla

NameScopeDescriptionExampleType
placementIdrequiredThe placement ID(Zone Id)string

Colossus

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Compass

NameScopeDescriptionExampleType
placementIdoptionalPlacement Id'0''string'
endpointIdoptionalEndpoint Id'0''string'

ConnectAd

NameScopeDescriptionExampleType
siteIdrequiredThe site ID from ConnectAd.12345integer
networkIdrequiredThe network ID from ConnectAd.10047integer
bidflooroptionalRequested Floorprice0.15number

Consumable

NameScopeDescriptionExampleType
siteIdrequiredThe site ID from Consumable.12345integer
networkIdrequiredThe network ID from Consumable.9969integer
unitIdrequiredThe unit ID from Consumable.987654integer
unitNamerequiredThe unit name from Consumable.cnsmbl-unitstring

SSP Copper6

NameScopeDescriptionExampleType
aidrequiredThe source ID from Copper6 Media.12412integer

CPMStar

NameScopeDescriptionExampleType
placementIdrequiredThe placement ID from CPMStar.81006integer

Criteo

NameScopeDescriptionExampleType
zoneIdrequired(deprecated) The zone ID from Criteo. Should be replaced by networkId when using zone matching.234234integer
networkIdrequiredThe network ID from Criteo. Please reach out your Criteo representative for more details.456456integer
nativeCallbackoptional(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
integrationModeoptional(Prebid.js only) Integration mode to use for ad render (none or 'AMP'). Please reach out your Criteo representative for more details.'AMP'string
publisherSubIdoptionalCustom identifier for reporting. Please reach out your Criteo representative for more details.'adunit-1'string

C-WIRE

NameScopeDescriptionExampleType
pageIdrequiredC-WIRE page id2453integer
placementIdrequiredC-WIRE placement id113244integer

DataBlocks

NameScopeDescriptionExampleType
sourceIdrequiredWebsite Source Id111integer
hostoptionalNetwork Host to request from'prebid.datablocks.bet'string
tagidoptionalPlacement ID'leaderboard_1'string
vis_optoutoptionalOpt out of visibility metrictrueboolean

Deepintent

NameScopeDescriptionExampleType
tagIdmandatoryAd Tag Id'1399'string
heightoptionalheight of the creative350number
widthoptionalwidth of the creative250number
customoptionalcustom key value params'{"position":"right-box"}''object
useroptionaluser params according to IAB standards'{"gender":"F"}''object
posoptionalad position as per IAB standards1number

DEFINE MEDIA

NameScopeDescriptionExampleType
mandantIdrequiredMandant ID5integer
adslotIdoptionalAdslot ID199integer

Dianomi

NameScopeDescriptionExampleType
smartadIdrequiredPlacement ID12345integer
endpointoptionalfor testing onlywww-prebid.dianomi.comstring

DistrictM DMX

NameScopeDescriptionExampleType
seller_idrequiredThe DMX Partner ID provided upon onboarding, this is for specific setup BURL, NURL or ADM support'seller_id'string
publisher_idrequiredBoost MemberId from DistrictM UI'member1'string
tagidrequiredRepresent the placement ID from DistrictM or your own'123abc'string
bidflooroptionalThe minimum price acceptable for a bid'1.0'string
memberidoptionalMemberId from DistrictM UI (legacy: replaced by publisher_id)'member1'string
dmxidoptionalPlacement ID from DistrictM (legacy: replaced by tagid)'123abc'string

Duration Media

NameScopeDescriptionExampleType
siteIdrequiredsiteId is provided by your Duration Media account manager(s)integer
placementIdoptionalplacementId is provided by your Duration Media account manager(s). This parameter allows to report on a specific ad unitinteger
videooptionalObject 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

E-volution tech

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

EMTV

NameScopeDescriptionExampleType
placementIdoptionalPlacement Id'0''string'
endpointIdoptionalEndpoint Id'0''string'

Engage BDR

NameScopeDescriptionExampleType
sspidrequiredSSPID parameter'11111'string

E-Planning

NameScopeDescriptionExampleType
cirequiredYour partner ID (provided by E-Planning)'18f66'string
svoptionalIndicates a bidder URL different than default'ads.us.e-planning.net'string
isvoptionalIndicates a CDN URL different than default'us.img.e-planning.net'string
toptionalIndicates bidding for testing purposes1integer
mloptionalUses placement names as ad unit names instead of sizes1integer
snoptionalUses space name instead of sizesadunitNamestring

Epom

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Epsilon

NameScopeDescriptionExampleType
site_idrequiredThe site ID from Epsilon.'87293'string
securerequired (for secure pages)If impression requires secure HTTPS URL creative assets and markup. 0 for non-secure, 1 for secure. Default is non-secure1integer
bidflooroptionalBid floor0.50float
tag_idoptionalIdentifies specific ad placement.'cnvr-test-tag'string
white_label_urloptionalOverride the destination URL the request is sent to.'https://mydomain.com/hbendpoint'string
pubcid_nameoptionalName of the pub common id. Epsilon adapter can read the id directly if the UserID module is absent. Default is _pubcid.'_pubcid'string

eRGADX

NameScopeDescriptionExampleType
hostrequiredRTB host'cpm.ergadx.com'string
zoneIdrequiredZone Id30164integer

Evolution Technologies

NameScopeDescriptionExampleType
hostrequiredAd network's RTB host'e-volution.ai'string
publisherIdrequiredPublisher ID12345integer

flipp

NameScopeDescriptionExampleType
publisherNameIdentifierrequiredPublisher name identifiertest-publisher-namestring
creativeTyperequiredType of the creativeNativeXNativeX|DTX
siteIdrequiredID associated with the site123456integer
zoneIdsoptionalZones to request from bidder[789, 123]array[integer]
userKeyoptionalUser Key to power experience optimization and frequency capping. Publishers: please confirm with legal counsel before using this feature.4188d8a3-22d1-49cb-8624-8838a22562bduuidv4
optionsoptionalAdditional integration specific contextoptions: { "startCompact": true }map[string]interface{}
NameScopeDescriptionExampleType
------------------------------------------------------------
startCompactoptionalHeight of the experience will be reducedtrueboolean
dwellExpandoptionalAuto expand the experience after a certain time passestrueboolean
contentCodeoptionalForce show a certain experience. Generally used for testing and debugging purposes.publisher-teststring

FreeWheelssp

NameScopeDescriptionExampleType
zoneIdrequiredThe zone ID for the ad."2003"string
formatoptionalThe 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
bidflooroptionalBid floor price.13.2118float
bidfloorcuroptionalBid floor currency."USD"string
vastUrlParamsoptionalAdd query parameters to the vast request. Should be a single item level JSON.
Works with formats: instream, inbanner
{ protocolVersion:'3.0' }object
NameScopeDescriptionExampleType
---------------------------------------------------------------
soundButtonoptionalIf 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
trueboolean
defaultMuteoptionalIf "soundButton=true" is set, controls if the video will start with the sound muted.
Default value: true
falseboolean
timelineoptionalDisplay a progress bar to the bottom of the ad unit.
Default value: false
trueboolean
protocolVersionoptionalSpecify the VAST version that will be used for the vastVersion parameter value on AdsSetup request.
Default Value: 4.2
3 .0float
onOveroptionalAllows 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
trueboolean
closeTimeoutoptionalThe duration in milliseconds before displaying the close button.
Works with formats: screen-roll, intext-roll, sliderad, floorad
Default value: 5000
2000integer
animatedoptionalEnable an animation on opening and on closing of the video.
Works with formats: intext-roll, sliderad
Default value: true
falseboolean
animationSpeedoptionalIf the animated parameter is set to true, allows to choose the animation speed in milliseconds.
Works with formats: intext-roll, sliderad
Default value: 700
500integer
contentIdoptionalDisplays 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
autooptionalIf 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
articleoptionalSet 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
poptionalSet 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
iframeModeoptionalIndicate 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
inReadoptionalWhen true, will keep the ad slot window on the page when the ad is done.
Works with format: intext-roll
Default value: false
trueboolean
langoptionalText language. Can be one of: [fr,en,es,it,de,nl,pt]
Works with format: intext-roll
Default value: "fr"
"en"string
openingTimeoptionalThe time in milliseconds to display the opening animation.
Works with format: intext-roll
Default value: 0
100integer
pauseRatiooptionalSpecify 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.9float | string
closeActionoptionalDefine 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
domIdoptionalid 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
errorActionoptionalDefine 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
stickToTopoptionalControls 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
300boolean | string | number
blurDisplayoptionalAllow 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
expandDirectionoptionalAllows 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
zIndexoptionalForce 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
1000integer
hAlignoptionalHorizontal 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
hSpacingoptionalSet a horizontal spacing between the hAlign side and the video.
Works with format: sliderad
Default value: 10
20integer
vAlignoptionalVertical 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
vSpacingoptionalSet a vertical spacing between the vAlign side and the video.
Works with format: sliderad
Default value: 10
20integer
modoptionalAd 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
opacityoptionalDefine 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
.5float
smartPlayoptionalEnable to use autoPlay on mobile devices.
Works with format: screen-roll
Default value: false
trueboolean
bannerHeightoptionalThe height in pixel of the bottom banner. The video ad takes this height when its not expanded.
Works with format: floorad
Default value: 250
500integer

FRVR Ad Network

NameScopeDescriptionExampleType
publisher_idrequiredPublisher ID'11111'string
ad_unit_idrequiredAd Unit ID'22222'string

FutureAds

NameScopeDescriptionExampleType
zonerequiredThe unique identifier of the ad placement. Could be obtained from the FutureAds UI or from your account manager."e5ff8e48-4bd0-4a2c-9236-55530ab8981d"string
kvTargetingoptionalKey/Value - a pair of the unique values that will be used for the custom targeting option.{key1: value2, key2: value2}object

Gamma

NameScopeDescriptionExampleType
siteIdrequiredSite ID1465446377integer
zoneIdrequiredZone ID1515999290integer

Gamoshi

NameScopeDescriptionExampleType
supplyPartnerIdrequiredID of the supply partner you created in the Gamoshi dashboard.'12345'string
rtbEndpointoptionalIf you have a whitelabel account on Gamoshi, specify it here.'rtb.mybidder.com'string

Title Missing

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Globalsun

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Goldbach

NameScopeDescriptionExampleType
placementIdrequiredThe placement ID from Goldbach. You may identify a placement using the invCode and member instead of a placement ID. The placementID parameter can be either a string or integer for Prebid.js, however integer is preferred. Legacy code can retain the string value. Prebid Server requires an integer value.234234integer
memberoptionalThe member ID from Goldbach. Must be used with invCode.'12345'string
invCodeoptionalThe inventory code from Goldbach. Must be used with member.'abc123'string
publisherIdoptionalThe publisher ID from Goldbach. It is used by the Goldbach end point to identify the publisher when placementId is not provided and invCode goes wrong. The publisherId parameter can be either a string or integer for Prebid.js, however integer is preferred.12345integer
frameworksoptionalArray of integers listing API frameworks for Banner supported by the publisher.integer
useroptionalObject that specifies information about an external user. See User Object for details.user: { age: 25, gender: 0, dnt: true}object
allowSmallerSizesoptionalIf true, ads smaller than the values in your ad unit's sizes array will be allowed to serve. Defaults to false.trueboolean
usePaymentRule (PBJS) or use_pmt_rule (PBS)optionalIf true, Xandr will return net price to Prebid.js after publisher payment rules have been applied.trueboolean
keywordsoptionalA set of key-value pairs applied to all ad slots on the page. Mapped to buy-side segment targeting (login required). Values can be empty. See Passing Keys Without Values below for examples. Note that to use keyword with the Prebid Server adapter, that feature must be enabled for your account by an Goldbach account manager.keywords: { genre: ['rock', 'pop'] }object
videooptionalObject containing video targeting parameters. See Video Object for details.video: { playback_method: ['auto_play_sound_off'] }object
appoptionalObject containing mobile app parameters. See the App Object for details.app : { id: 'app-id'}object
reserveoptionalSets a floor price for the bid that is returned. If floors have been configured in the Goldbach Console, those settings will override what is configured here unless 'Reserve Price Override' is checked. See Xandr docs0.90float
positionoptionalIdentify the placement as above or below the fold. Allowed values: Unknown: unknown; Above the fold: above; Below the fold: below'above'string
trafficSourceCodeoptionalSpecifies the third-party source of this impression.'my_traffic_source'string
supplyTypeoptionalIndicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app'web'string
supplyTypeoptionalIndicates the type of supply for this placement. Possible values are web, mobile_web, mobile_app'web'string
pubClickoptionalSpecifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using Goldbach click tracking properly.'http://click.adserver.com/'string
extInvCodeoptionalSpecifies 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
externalImpIdoptionalSpecifies the unique identifier of an externally generated auction.'bacbab02626452b097f6030b3c89ac05'string
generate_ad_pod_idoptionalSignal to Goldbach to split impressions by ad pod and add unique ad pod id to each request. Specific to long form video endpoint only. Supported by Prebid Server, not Prebid JS.trueboolean

TheMediaGrid

NameScopeDescriptionExampleType
uidrequiredRepresents the MediaGrid bidder system Ad Slot ID associated with the respective div id from the site page.1integer
bidFlooroptionalFloor of the impression opportunity. If present in the request overrides XML info.0.8float

GumGum

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

HuaweiAds

NameScopeDescriptionExampleType
publisheridrequiredPublisher Id'2001000399'string
signkeyrequiredSign Key'5d********82c38594f8b2bdfd9f********a398dca734932898e3********8d'string
keyidrequiredKey Id'2'string
slotidrequiredSlot Id'u42ohmaufh'string
adtyperequiredAd Type'native'string

iion

NameScopeDescriptionExampleType
hostrequiredAd network's RTB host'iionads.com'string
adUnitIdrequiredAd Unit Id will be generated on iionads Platform.42integer
adUnitTyperequiredType of Ad Unit ('video', 'banner')'banner'string
publisherIdrequiredPublisher ID'12345'string
custom1optionalCustom targeting field 1'custom1'string
custom2optionalCustom targeting field 2'custom2'string
custom3optionalCustom targeting field 3'custom3'string
custom4optionalCustom targeting field 4'custom4'string
custom5optionalCustom targeting field 5'custom5'string

iMedia Digital Services (iMDS)

NameScopeDescriptionExampleType
seatIdrequiredThe seat ID from iMedia Digital Services. This will be the same for all ad units.'prebid'string
tagIdrequiredThe placement ID or tag ID from iMedia Digital Services.'demo1'string
placementIdoptionalLegacy parameter replaced by tagId'demo1'string
bidflooroptionalLegacy parameter for floor price for the request. Replaced by Price Floors Module.0.1float

Impactify

NameScopeDescriptionExampleType
appIdrequiredImpactify publisher id (Contact us)'example.com'string
formatrequiredImpactify ad format (screen or display)'screen'string
stylerequiredImpactify ad style (inline, impact or static)'impact'string

Improve Digital

NameScopeDescriptionExampleType
placementIdrequiredThe placement ID from Improve Digital.1234567integer
publisherIdrequiredThe publisher ID from Improve Digital.4567integer
keyValuesoptionalContains one or more key-value pairings for key-value targeting{ testKey1: ['testValueA'], testKey2: ['testValueB', 'testValueC'] }object
bidFlooroptionalBid floor price0.01float
bidFloorCuroptionalBid floor price currency. Supported values: USD (default), EUR, GBP, AUD, DKK, SEK, CZK, CHF, NOK'USD'string
extendoptionalSee the Extend mode sectiontrueboolean
rendererConfigoptionalConfiguration object for JS renderer of the RAZR creatives. Provided by Improve Digital.{ key1: value1 }object

InfyTV

NameScopeDescriptionExampleType
publisherIdrequiredPublisher ID'11111'string
placementIdoptionalPlacement ID'11111'string

InMobi

NameScopeDescriptionExampleType
plcrequiredPlacement ID'1234'string

InteractiveOffers

NameScopeDescriptionExampleType
partnerIdrequiredPartner id'abc123'string

intertech

NameScopeDescriptionExampleType
pageIdrequiredPage ID123456Integer
impIdrequiredBlock ID12Integer

Invibes

NameScopeDescriptionExampleType
placementIdrequiredThe Invibes placement ID'1234567'string
domainIdoptionalId of domain1001integer
customEndpointoptionalCustom test domainhttps://bid.videostep.com/Bid/VideoAdContentinteger
debugoptionalDebug paramentes (only prebid server){ "testBvid": "1234", "testLog": true }object

IQzone

For these parameters, please reach out to your Solutions Architect or refer to https://docs.prebid.org/dev-docs/pbs-bidders.html.

Index Exchange

Banner

You must include these parameters at the bidder level.

KeyScopeTypeDescription
siteIDRequredStringAn Index-specific identifier that is associated with this ad unit. This is similar to a placement ID or an ad unit ID that some other modules have. For example, '999999