Struct openrtb2::Bid

pub struct Bid<'a> {
    pub id: Cow<'a, str>,
    pub impid: Cow<'a, str>,
    pub price: f64,
    pub nurl: Option<Cow<'a, str>>,
    pub burl: Option<Cow<'a, str>>,
    pub lurl: Option<Cow<'a, str>>,
    pub adm: Option<Cow<'a, str>>,
    pub adid: Option<Cow<'a, str>>,
    pub adomain: Option<Vec<Cow<'a, str>>>,
    pub bundle: Option<Cow<'a, str>>,
    pub iurl: Option<Cow<'a, str>>,
    pub cid: Option<Cow<'a, str>>,
    pub crid: Option<Cow<'a, str>>,
    pub tactic: Option<Cow<'a, str>>,
    pub cat: Option<Vec<ContentCategory>>,
    pub attr: Option<Vec<CreativeAttribute>>,
    pub api: Option<ApiFramework>,
    pub protocol: Option<Protocol>,
    pub qagmediarating: Option<IqgMediaRating>,
    pub language: Option<Cow<'a, str>>,
    pub dealid: Option<Cow<'a, str>>,
    pub w: Option<i32>,
    pub h: Option<i32>,
    pub wratio: Option<i32>,
    pub hratio: Option<i32>,
    pub exp: Option<i32>,
    pub ext: Option<Object<'a>>,
}

4.2.3 Object: Bid

A SeatBid object contains one or more Bid objects, each of which relates to a specific impression in the bid request via the impid attribute and constitutes an offer to buy that impression for a given price.

Fields

id: Cow<'a, str>

string; required Bidder generated bid ID to assist with logging/tracking.

impid: Cow<'a, str>

string; required ID of the Imp object in the related bid request.

price: f64

float; required Bid price expressed as CPM although the actual transaction is for a unit impression only. Note that while the type indicates float, integer math is highly recommended when handling currencies (e.g., BigDecimal in Java).

nurl: Option<Cow<'a, str>>

string Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup. Substitution macros (Section 4.4) may be included in both the URL and optionally returned markup.

burl: Option<Cow<'a, str>>

string Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.). Substitution macros (Section 4.4) may be included.

lurl: Option<Cow<'a, str>>

string Loss notice URL called by the exchange when a bid is known to have been lost. Substitution macros (Section 4.4) may be included. Exchange-specific policy may preclude support for loss notices or the disclosure of winning clearing prices resulting in ${AUCTION_PRICE} macros being removed (i.e., replaced with a zero-length string).

adm: Option<Cow<'a, str>>

string Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both. Substitution macros (Section 4.4) may be included.

adid: Option<Cow<'a, str>>

string ID of a preloaded ad to be served if the bid wins.

adomain: Option<Vec<Cow<'a, str>>>

string array Advertiser domain for block list checking (e.g., “ford.com”). This can be an array of for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.

bundle: Option<Cow<'a, str>>

string A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it is a numeric ID.

iurl: Option<Cow<'a, str>>

string URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.

cid: Option<Cow<'a, str>>

string Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.

crid: Option<Cow<'a, str>>

string Creative ID to assist with ad quality checking.

tactic: Option<Cow<'a, str>>

string Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted. The specific usage and meaning of the tactic ID should be communicated between buyer and exchanges a priori.

cat: Option<Vec<ContentCategory>>

string array IAB content categories of the creative. Refer to List 5.1.

attr: Option<Vec<CreativeAttribute>>

integer array Set of attributes describing the creative. Refer to List 5.3.

api: Option<ApiFramework>

integer API required by the markup if applicable. Refer to List 5.6.

protocol: Option<Protocol>

integer Video response protocol of the markup if applicable. Refer to List 5.8.

qagmediarating: Option<IqgMediaRating>

integer Creative media rating per IQG guidelines. Refer to List 5.19.

language: Option<Cow<'a, str>>

string Language of the creative using ISO-639-1-alpha-2. The non- standard code “xx” may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).

dealid: Option<Cow<'a, str>>

string Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.

w: Option<i32>

integer Width of the creative in device independent pixels (DIPS).

h: Option<i32>

integer Height of the creative in device independent pixels (DIPS).

wratio: Option<i32>

integer Relative width of the creative when expressing size as a ratio. Required for Flex Ads.

hratio: Option<i32>

integer Relative height of the creative when expressing size as a ratio. Required for Flex Ads.

exp: Option<i32>

integer Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.

ext: Option<Object<'a>>

object Placeholder for bidder-specific extensions to OpenRTB.

Trait Implementations

impl<'a> Clone for Bid<'a>

fn clone(&self) -> Bid<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Bid<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Bid<'a>

fn default() -> Bid<'a>

Returns the "default value" for a type.

impl<'de: 'a, 'a> Deserialize<'de> for Bid<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<Bid<'a>> for Bid<'a>

fn eq(&self, other: &Bid<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bid<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Bid<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Bid<'a>