oa-test.2.1.0.source-code.com_adgear_avro_openrtb_BidRequest.thrift Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of anoa-test Show documentation

Test module for other Anoa modules, which exposes complex records (OpenRTB bid requests) through utility classes for use in unit tests within other Anoa modules (anoa-core, for instance).

The newest version!

namespace * thrift.com.adgear.avro.openrtb

include "com_adgear_avro_openrtb_Impression.thrift"
include "com_adgear_avro_openrtb_Site.thrift"
include "com_adgear_avro_openrtb_App.thrift"
include "com_adgear_avro_openrtb_Device.thrift"
include "com_adgear_avro_openrtb_User.thrift"
include "com_adgear_avro_openrtb_Regulations.thrift"

/** 3.3.1 Bid Request Object
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 “imp” (i.e., impression) object. Other attributes are optional since an exchange may establish default values. */
struct BidRequest {
  /** [01] Unique ID of the bid request, provided by the exchange. */
  01: required string id,
  /** [02] Array of impression objects. Multiple impression auctions may be specified in a single bid request. At least one impression is required for a valid bid request. */
  02: required list imp,
  /** [03] See Site Object. */
  03: optional com_adgear_avro_openrtb_Site.Site site,
  /** [04] See App Object. */
  04: optional com_adgear_avro_openrtb_App.App app,
  /** [05] See Device Object. */
  05: optional com_adgear_avro_openrtb_Device.Device device,
  /** [06] See User Object. */
  06: optional com_adgear_avro_openrtb_User.User user,
  /** [07] Auction Type. If “1”, then first price auction. If “2”, then second price auction. Additional auction types can be defined as per the exchange’s business rules. Exchange specific rules should be numbered over 500. */
  07: optional i32 at = 2,
  /** [08] Maximum amount of time in milliseconds to submit a bid (e.g., 120 means the bidder has 120ms to submit a bid before the auction is complete). If this value never changes across an exchange, then the exchange can supply this information offline. */
  08: optional i32 tmax,
  /** [09] Array of buyer seats allowed to bid on this auction. Seats are an optional feature of exchange. For example, [“4”,”34”,”82”,”A45”] indicates that only advertisers using these exchange seats are allowed to bid on the impressions in this auction. */
  09: optional list wseat,
  /** [10] Flag to indicate whether Exchange can verify that all impressions offered represent all of the impressions available in context (e.g., all impressions available on the web page; all impressions available for a video [pre, mid and postroll spots], etc.) to support road-blocking. A true value should only be passed if the exchange is aware of all impressions in context for the publisher. “0” means the exchange cannot verify, and “1” means that all impressions represent all impressions available. */
  10: optional i32 allimps = 0,
  /** [11] Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes. If only one currency is used by the exchange, this parameter is not required. */
  11: optional list cur,
  /** [12] Blocked Advertiser Categories. Note that there is no existing categorization / taxonomy of advertiser industries. However, as a substitute exchanges may decide to use IAB categories as an approximation (See Table 6.1 Content Categories) */
  12: optional list bcat,
  /** [13] Array of strings of blocked top-level domains of advertisers. For example, {“company1.com”, “company2.com”}. */
  13: optional list badv,
  /** [14] This object is a container for any legal, governmental or industry regulations in force for the request. */
  14: optional com_adgear_avro_openrtb_Regulations.Regulations regs
}