# Functions
No description provided by the author
BuildBidderMap builds a map of string to BidderName, to remain compatbile with the prebioud BidderMap variable.
No description provided by the author
BuildBidderStringSlice builds a slioce of strings for each BidderName.
No description provided by the author
No description provided by the author
CoreBidderNames returns a slice of all core bidders.
IsBidderNameReserved returns true if the specified name is a case insensitive match for a reserved bidder name.
IsKnownIOSAppTrackingStatus returns true if the value is a known iOS app tracking authorization status.
NewBidderParamsValidator makes a BidderParamValidator, assuming all the necessary files exist in the filesystem.
No description provided by the author
No description provided by the author
ParseDeviceExtATTS parses the ATTS value from the request.device.ext OpenRTB field.
PriceGranularityFromString converts a legacy string into the new PriceGranularity.
ReadDealTiersFromImp returns a map of bidder deal tiers read from the impression of an original request (not split / cleaned).
# Constants
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
BidderOWPrebidCTV for prebid adpod response.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Reserved for the /info/bidders/all endpoint.
Reserved for first party data.
Reserved for first party data.
Reserved for non-bidder specific messages when using a map keyed on the bidder name.
Reserved for Global Placement ID (GPID).
Reserved for Prebid Server configuration.
Reserved for Apple's SKAdNetwork OpenRTB extension.
Reserved for Per-Impression Transactions IDs for Multi-Impression Bid Requests.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
Names of core bidders.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FirstPartyDataContextExtKey defines a field name within request.ext and request.imp.ext reserved for first party data.
FirstPartyDataExtKey defines a field name within request.ext and request.imp.ext reserved for first party data.
GPIDKey defines the field name within request.ext reserved for the Global Placement ID (GPID),.
HbBidderConstantKey is the name of the Bidder.
HbCacheKey and HbVastCacheKey store UUIDs which can be used to fetch things from prebid cache.
No description provided by the author
HbCacheHost and HbCachePath exist to supply cache host and path as targeting parameters.
No description provided by the author
No description provided by the author
HbEnvKey exists to support the Prebid Universal Creative.
This is not a key, but values used by the HbEnvKey.
HbFormatKey is the format of the bid.
No description provided by the author
No description provided by the author
No description provided by the author
Values of the IOSAppTrackingStatus enumeration.
Values of the IOSAppTrackingStatus enumeration.
Values of the IOSAppTrackingStatus enumeration.
Values of the IOSAppTrackingStatus enumeration.
No description provided by the author
NativeExchangeSpecificLowerBound defines the lower threshold of exchange specific types for native ads.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PrebidExtBidderKey represents the field name within request.imp.ext.prebid reserved for bidder params.
PrebidExtKey represents the prebid extension key used in requests.
SKAdNExtKey defines the field name within request.ext reserved for Apple's SKAdNetwork.
No description provided by the author
TIDKey reserved for Per-Impression Transactions IDs for Multi-Impression Bid Requests.
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
AdsCert defines if Call Sign feature is enabled for request.
No description provided by the author
BidAdPodExt defines the prebid adpod response in bidresponse.ext.adpod parameter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DealTier defines the configuration of a deal tier.
No description provided by the author
Experiment defines if experimental features are available for the request.
No description provided by the author
No description provided by the author
No description provided by the author
ExtApp defines the contract for bidrequest.app.ext.
ExtAppPrebid further defines the contract for bidrequest.app.ext.prebid.
ExtBid defines the contract for bidresponse.seatbid.bid[i].ext.
ExtBidderMessage defines an error object to be returned, consiting of a machine readable error code, and a human readable error message string.
ExtBidPrebid defines the contract for bidresponse.seatbid.bid[i].ext.prebid DealPriority represents priority of deal bid.
ExtBidPrebidCache defines the contract for bidresponse.seatbid.bid[i].ext.prebid.cache.
No description provided by the author
ExtBidPrebidEvents defines the contract for bidresponse.seatbid.bid[i].ext.prebid.events.
ExtBidPrebidMeta defines the contract for bidresponse.seatbid.bid[i].ext.prebid.meta.
ExtBidPrebidVideo defines the contract for bidresponse.seatbid.bid[i].ext.prebid.video.
ExtBidResponse defines the contract for bidresponse.ext.
No description provided by the author
ExtDevice defines the contract for bidrequest.device.ext.
ExtDeviceInt defines the contract for bidrequest.device.ext.prebid.interstitial.
ExtDevicePrebid defines the contract for bidrequest.device.ext.prebid.
ExtHttpCall defines the contract for a bidresponse.ext.debug.httpcalls.{bidder}[i].
ExtImp33across defines the contract for bidrequest.imp[i].ext.33across.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpAdkernel defines the contract for bidrequest.imp[i].ext.adkernel.
ExtImpAdkernelAdn defines the contract for bidrequest.imp[i].ext.adkernelAdn.
ExtImpAdman defines adman specifiec param.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpAdprime defines adprime specifiec param.
No description provided by the author
ExtImpAdtarget defines the contract for bidrequest.imp[i].ext.adtarget.
ExtImpAdtelligent defines the contract for bidrequest.imp[i].ext.adtelligent.
ExtImpAdtrgtme defines the contract for bidrequest.imp[i].ext.adtrgtme.
No description provided by the author
No description provided by the author
ExtImpAdyoulike defines the contract for bidrequest.imp[i].ext.adyoulike.
No description provided by the author
ExtImpAlgoriX defines the contract for bidrequest.imp[i].ext.algorix.
ExtImpAMX is the imp.ext format for the AMX bidder.
No description provided by the author
No description provided by the author
ExtImpAppnexus defines the contract for bidrequest.imp[i].ext.appnexus.
ExtImpAppnexusKeyVal defines the contract for bidrequest.imp[i].ext.appnexus.keywords[i].
ExtImpAvocet defines the contract for bidrequest.imp[i].ext.avocet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpBrightroll defines the contract for bidrequest.imp[i].ext.brightroll.
ExtImpColossus defines colossus specifiec param.
No description provided by the author
ExtImpConsumable defines the contract for bidrequest.imp[i].ext.consumable.
No description provided by the author
No description provided by the author
ExtImpCriteo defines the contract for bidrequest.imp[i].ext.criteo.
ExtImpDatablocks defines the contract for bidrequest.imp[i].ext.datablocks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpEngageBDR defines the contract for bidrequest.imp[i].ext.engagebdr.
ExtImpEPlanning defines the contract for bidrequest.imp[i].ext.eplanning.
No description provided by the author
ExtImpGamma defines the contract for bidrequest.imp[i].ext.gamma.
ExtImpGamoshi defines the contract for bidrequest.imp[i].ext.gamoshi.
ExtImpGrid defines the contract for bidrequest.imp[i].ext.grid.
ExtImpGumGum defines the contract for bidrequest.imp[i].ext.gumgum Either Zone or PubId must be present, others are optional parameters.
ExtImpGumGumBanner defines the contract for bidresponse.seatbid.bid[i].ext.gumgum.banner.
ExtImpGumGumVideo defines the contract for bidresponse.seatbid.bid[i].ext.gumgum.video.
No description provided by the author
ExtImpImpactify defines the contract for bidrequest.imp[i].ext.impactify.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpIx defines the contract for bidrequest.imp[i].ext.ix.
No description provided by the author
No description provided by the author
ExtImpKubient defines the contract for bidrequest.imp[i].ext.kubient.
ExtImpLockerDome defines the contract for bidrequest.imp[i].ext.lockerdome.
No description provided by the author
No description provided by the author
ExtImpMadvertise defines the contract for bidrequest.imp[i].ext.madvertise.
ExtImpMarsmedia defines the contract for bidrequest.imp[i].ext.marsmedia.
No description provided by the author
ExtImpMgid defines the contract for bidrequest.imp[i].ext.mgid.
ExtImpMobileFuse defines the contract for bidrequest.imp[i].ext.mobilefuse.
ExtImpNanoInteractive defines the contract for bidrequest.imp[i].ext.nanointeractive.
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpOpenWeb defines the contract for bidrequest.imp[i].ext.openweb.
ExtImpOpenx defines the contract for bidrequest.imp[i].ext.openx.
ExtImpOrbidder defines the contract for bidrequest.imp[i].ext.openx.
ExtImpOutbrain defines the contract for bidrequest.imp[i].ext.outbrain.
No description provided by the author
ExtImpPrebid defines the contract for bidrequest.imp[i].ext.prebid.
No description provided by the author
ExtImpPubmaticKeyVal defines the contract for bidrequest.imp[i].ext.pubmatic.keywords[i].
No description provided by the author
No description provided by the author
ExtImpRhythmone defines the contract for bidrequest.imp[i].ext.rhythmone.
No description provided by the author
ExtImpRubicon defines the contract for bidrequest.imp[i].ext.rubicon.
No description provided by the author
No description provided by the author
ExtImpSmaato defines the contract for bidrequest.imp[i].ext.smaato PublisherId and AdSpaceId are mandatory parameters for non adpod (long-form video) requests, others are optional parameters PublisherId and AdBreakId are mandatory parameters for adpod (long-form video) requests, others are optional parameters AdSpaceId is identifier for specific ad placement or ad tag AdBreakId is identifier for specific ad placement or ad tag.
ExtImpSmartadserver defines the contract for bidrequest.imp[i].ext.smartadserver.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpSynacormedia defines the contract for bidrequest.imp[i].ext.synacormedia.
No description provided by the author
No description provided by the author
No description provided by the author
ExtImpTriplelift defines the contract for bidrequest.imp[i].ext.triplelift.
ExtImpUcfunnel defines the contract for bidrequest.imp[i].ext.ucfunnel.
ExtImpUnicorn defines the contract for bidrequest.imp[i].ext.unicorn.
No description provided by the author
ExtImpVASTBidder defines the contract for bidrequest.imp[i].ext.vastbidder.
ExtImpVASTBidderTag defines the contract for bidrequest.imp[i].ext.pubmatic.tags[i].
ExtImpVerizonMedia defines the contract for bidrequest.imp[i].ext.verizonmedia.
ExtImpVideoByte defines the contract for bidrequest.imp[i].ext.videobyte.
ExtImpVrtcal defines the contract for bidrequest.imp[i].ext.vrtcal.
ExtImpYahooSSP defines the contract for bidrequest.imp[i].ext.yahoossp.
ExtImpYeahmobi defines the contract for bidrequest.imp[i].ext.yeahmobi.
ExtImpYieldlab defines the contract for bidrequest.imp[i].ext.yieldlab.
ExtImpYieldmo defines the contract for bidrequest.imp[i].ext.yieldmo.
ExtImpYieldone defines the contract for bidrequest.imp[i].ext.yieldone.
ExtImpZeroClickFraud defines the contract for bidrequest.imp[i].ext.datablocks.
No description provided by the author
ExtKayzen defines the contract for bidrequest.imp[i].ext.kayzen.
ExtKrushmedia defines imp[0].ext object structure.
ExtCTVBid defines the contract for bidresponse.seatbid.bid[i].ext.
ExtOWRequest defines the contract for bidrequest.ext.
ExtPublisher defines the contract for ...publisher.ext (found in both bidrequest.site and bidrequest.app).
ExtPublisherPrebid defines the contract for publisher.ext.prebid.
ExtRegs defines the contract for bidrequest.regs.ext.
ExtRequest defines the contract for bidrequest.ext.
ExtRequestAdPod holds AdPod specific extension parameters at request level.
No description provided by the author
ExtRequestPrebid defines the contract for bidrequest.ext.prebid.
ExtRequestPrebidCache defines the contract for bidrequest.ext.prebid.cache.
ExtRequestPrebidCacheBids defines the contract for bidrequest.ext.prebid.cache.bids.
ExtRequestPrebidCacheVAST defines the contract for bidrequest.ext.prebid.cache.vastxml.
ExtRequestPrebidChannel defines the contract for bidrequest.ext.prebid.channel.
ExtRequestPrebidData defines Prebid's First Party Data (FPD) and related bid request options.
ExtRequestPrebidDataEidPermission defines a filter rule for filter user.ext.eids.
ExtRequestPrebid defines the contract for bidrequest.ext.prebid.schains.
ExtRequestTargeting defines the contract for bidrequest.ext.prebid.targeting.
ExtResponseDebug defines the contract for bidresponse.ext.debug.
ExtResponsePrebid defines the contract for bidresponse.ext.prebid.
ExtResponseSyncData defines the contract for bidresponse.ext.usersync.{bidder}.
ExtSilverMob defines the contract for bidrequest.imp[i].ext.silvermob.
ExtSite defines the contract for bidrequest.site.ext.
No description provided by the author
ExtSmartyAds defines the contract for bidrequest.imp[i].ext.smartyads.
ExtSource defines the contract for bidrequest.source.ext.
ExtStoredAuctionResponse defines the contract for bidrequest.imp[i].ext.prebid.storedauctionresponse.
ExtStoredBidResponse defines the contract for bidrequest.imp[i].ext.prebid.storedbidresponse.
ExtStoredRequest defines the contract for bidrequest.imp[i].ext.prebid.storedrequest.
ExtUser defines the contract for bidrequest.user.ext.
No description provided by the author
No description provided by the author
ExtUserPrebid defines the contract for bidrequest.user.ext.prebid.
ExtUserSync defines the contract for bidresponse.ext.usersync.{bidder}.syncs[i].
ExtVideoAdPod structure to accept video specific more parameters like adpod.
GranularityRange struct defines a range of prices used by PriceGranularity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PriceFloorRules defines the contract for bidrequest.ext.prebid.floors.
No description provided by the author
PriceGranularity defines the allowed values for bidrequest.ext.prebid.targeting.pricegranularity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VideoAdPod holds Video AdPod specific extension parameters at impression level.
No description provided by the author
# Interfaces
The BidderParamValidator is used to enforce bidrequest.imp[i].ext.{anyBidder} values.
# Type aliases
BidderName refers to a core bidder id or an alias id.
BidType describes the allowed values for bidresponse.seatbid.bid[i].ext.prebid.type.
CookieStatus describes the allowed values for bidresponse.ext.usersync.{bidder}.status.
DealTierBidderMap defines a correlation between bidders and deal tiers.
IOSAppTrackingStatus describes the values for iOS app tracking authorization status.
No description provided by the author
No description provided by the author
TargetingKeys are used throughout Prebid as keys which can be used in an ad server like DFP.
UserSyncType describes the allowed values for bidresponse.ext.usersync.{bidder}.syncs[i].type.