github.com/prebid/prebid-server/v2@v2.18.0/exchange/entities/entities.go (about)

     1  package entities
     2  
     3  import (
     4  	"github.com/prebid/openrtb/v20/openrtb2"
     5  	"github.com/prebid/prebid-server/v2/openrtb_ext"
     6  )
     7  
     8  // PbsOrtbSeatBid is a SeatBid returned by an AdaptedBidder.
     9  //
    10  // This is distinct from the openrtb2.SeatBid so that the prebid-server ext can be passed back with typesafety.
    11  type PbsOrtbSeatBid struct {
    12  	// Bids is the list of Bids which this AdaptedBidder wishes to make.
    13  	Bids []*PbsOrtbBid
    14  	// Currency is the Currency in which the Bids are made.
    15  	// Should be a valid Currency ISO code.
    16  	Currency string
    17  	// fledgeAuctionConfigs is quasi-opaque data passed back for in-browser interest group auction.
    18  	// if exists, it should be passed through even if bids[] is empty.
    19  	FledgeAuctionConfigs []*openrtb_ext.FledgeAuctionConfig
    20  	// HttpCalls is the list of debugging info. It should only be populated if the request.test == 1.
    21  	// This will become response.ext.debug.httpcalls.{bidder} on the final Response.
    22  	HttpCalls []*openrtb_ext.ExtHttpCall
    23  	// Seat defines whom these extra Bids belong to.
    24  	Seat string
    25  }
    26  
    27  // PbsOrtbBid is a Bid returned by an AdaptedBidder.
    28  //
    29  // PbsOrtbBid.Bid.Ext will become "response.seatbid[i].Bid.ext.bidder" in the final OpenRTB response.
    30  // PbsOrtbBid.BidMeta will become "response.seatbid[i].Bid.ext.prebid.meta" in the final OpenRTB response.
    31  // PbsOrtbBid.BidType will become "response.seatbid[i].Bid.ext.prebid.type" in the final OpenRTB response.
    32  // PbsOrtbBid.BidTargets does not need to be filled out by the Bidder. It will be set later by the exchange.
    33  // PbsOrtbBid.BidVideo is optional but should be filled out by the Bidder if BidType is video.
    34  // PbsOrtbBid.BidEvents is set by exchange when event tracking is enabled
    35  // PbsOrtbBid.BidFloors is set by exchange when floors is enabled
    36  // PbsOrtbBid.DealPriority is optionally provided by adapters and used internally by the exchange to support deal targeted campaigns.
    37  // PbsOrtbBid.DealTierSatisfied is set to true by exchange.updateHbPbCatDur if deal tier satisfied otherwise it will be set to false
    38  // PbsOrtbBid.GeneratedBidID is unique Bid id generated by prebid server if generate Bid id option is enabled in config
    39  type PbsOrtbBid struct {
    40  	Bid               *openrtb2.Bid
    41  	BidMeta           *openrtb_ext.ExtBidPrebidMeta
    42  	BidType           openrtb_ext.BidType
    43  	BidTargets        map[string]string
    44  	BidVideo          *openrtb_ext.ExtBidPrebidVideo
    45  	BidEvents         *openrtb_ext.ExtBidPrebidEvents
    46  	BidFloors         *openrtb_ext.ExtBidPrebidFloors
    47  	DealPriority      int
    48  	DealTierSatisfied bool
    49  	GeneratedBidID    string
    50  	OriginalBidCPM    float64
    51  	OriginalBidCur    string
    52  	TargetBidderCode  string
    53  	AdapterCode       openrtb_ext.BidderName
    54  }