Struct openrtb2::BidRequest

pub struct BidRequest {

    pub id: String,
    pub imp: Vec<Imp>,
    pub channel: Option<DistributionChannel>,
    pub device: Option<Device>,
    pub user: Option<User>,
    pub test: bool,
    pub at: AuctionType,
    pub tmax: Option<i32>,
    pub wseat: Option<Vec<String>>,
    pub bseat: Option<Vec<String>>,
    pub allimps: bool,
    pub cur: Option<Vec<String>>,
    pub wlang: Option<Vec<String>>,
    pub bcat: Option<Vec<ContentCategory>>,
    pub badv: Option<Vec<String>>,
    pub bapp: Option<Vec<String>>,
    pub source: Option<Source>,
    pub regs: Option<Regs>,
    pub ext: Option<Map<String, Value>>,
}

3.2.1 Object: BidRequest

The top-level bid request object contains a globally unique bid request or auction ID. This id attribute is required as is at least one impression object (Section 3.2.4). Other attributes in this top-level object establish rules and restrictions that apply to all impressions being offered.

There are also several subordinate objects that provide detailed data to potential buyers. Among these are the Site and App objects, which describe the type of published media in which the impression(s) appear. These objects are highly recommended, but only one applies to a given bid request depending on whether the media is browser-based web content or a non-browser application, respectively.

Fields

id: String

string; required Unique ID of the bid request, provided by the exchange.

imp: Vec<Imp>

object array; required Array of Imp objects (Section 3.2.4) representing the impressions offered. At least 1 Imp object is required.

channel: Option<DistributionChannel>

object; recommended

device: Option<Device>

object; recommended Details via a Device object (Section 3.2.18) about the user’s device to which the impression will be delivered.

user: Option<User>

object; recommended Details via a User object (Section 3.2.20) about the human user of the device; the advertising audience.

test: bool

integer; default 0 Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.

at: AuctionType

integer; default 2 Auction type, where 1 = First Price, 2 = Second Price Plus. Exchange-specific auction types can be defined using values greater than 500.

tmax: Option<i32>

integer Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout. This value supersedes any a priori guidance from the exchange.

wseat: Option<Vec<String>>

string array White list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

bseat: Option<Vec<String>>

string array Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression. IDs of seats and knowledge of the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

allimps: bool

integer; default 0 Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking. 0 = no or unknown, 1 = yes, the impressions offered represent all that are available.

cur: Option<Vec<String>>

string array Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes. Recommended only if the exchange accepts multiple currencies.

wlang: Option<Vec<String>>

string array White list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions, but buyers would be advised to consider language attribute in the Device and/or Content objects if available.

bcat: Option<Vec<ContentCategory>>

string array Blocked advertiser categories using the IAB content categories. Refer to List 5.1.

badv: Option<Vec<String>>

string array Block list of advertisers by their domains (e.g., “ford.com”).

bapp: Option<Vec<String>>

string array Block list of applications by their platform-specific exchange- independent application identifiers. On Android, these should be bundle or package names (e.g., com.foo.mygame). On iOS, these are numeric IDs.

source: Option<Source>

object A Sorce object (Section 3.2.2) that provides data about the inventory source and which entity makes the final decision.

regs: Option<Regs>

object A Regs object (Section 3.2.3) that specifies any industry, legal, or governmental regulations in force for this request.

ext: Option<Map<String, Value>>

object Placeholder for exchange-specific extensions to OpenRTB.

Trait Implementations

impl Clone for BidRequest

fn clone(&self) -> BidRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BidRequest

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

Formats the value using the given formatter.

impl Default for BidRequest

fn default() -> BidRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BidRequest

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<BidRequest> for BidRequest

fn eq(&self, other: &BidRequest) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BidRequest

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BidRequest