Type Members

1.  sealed abstract class LossReason extends GeneratedEnum

   The following table lists the options for an exchange to inform a bidder as to the reason why they did not win an item.

2.  sealed abstract class NoBidReason extends GeneratedEnum

   The following table lists the options for a bidder to signal the exchange as to why it did not offer a bid for the item.

3.  final case class Openrtb(ver: String = "", domainspec: String = "", domainver: String = "", payload: Payload = com.explorestack.protobuf.openrtb.Openrtb.Payload.Empty) extends GeneratedMessage with Updatable[Openrtb] with Product with Serializable

   This top-level object is the root for both request and response payloads.

   This top-level object is the root for both request and response payloads. It includes versioning information and references to the Layer-4 domain model on which transactions are based. By default, the domain model used by OpenRTB is the Advertising Common Object Model (AdCOM).

   ver

   Version of the Layer-3 OpenRTB specification (e.g., "3.0").

   domainspec

   Identifier of the Layer-4 domain model. @default "adcom"

   domainver

   Specification version of the Layer-4 domain model referenced in the “domainspec” attribute. @required

   Annotations

   @SerialVersionUID()

4.  final case class Request(id: String = "", test: Boolean = false, tmax: Int = 0, at: Int = 0, cur: Seq[String] = _root_.scala.Seq.empty, seat: Seq[String] = _root_.scala.Seq.empty, wseat: Boolean = false, cdata: String = "", source: Option[Source] = _root_.scala.None, item: Seq[Item] = _root_.scala.Seq.empty, package: Int = 0, context: Option[Any] = _root_.scala.None, ext: Option[Struct] = _root_.scala.None, extProto: Seq[Any] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[Request] with Product with Serializable

   The Request object contains a globally unique bid request ID.

   The Request object contains a globally unique bid request ID. This id attribute is required as is an Item array with at least one object (i.e., at least one item for sale). Other attributes establish rules and restrictions that apply to all items being offered.

   id

   Unique ID of the bid request; provided by the exchange.

   test

   Indicator of test mode in which auctions are not billable, where false = live mode, true = test mode. @default false

   tmax

   Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout.

   at

   Auction type, where 1 = First Price, 2 = Second Price Plus. Values greater than 500 can be used for exchange-specific auction types. @default 2

   cur

   Array of accepted currencies for bids on this bid request using ISO-4217 alpha codes. @default ["USD"]

   seat

   Restriction list of buyer seats for bidding on this item.

   wseat

   Flag that determines the restriction interpretation of the “seat” array, where false = block list, true = whitelist. @default true

   cdata

   Allows bidder to retrieve data set on its behalf in the exchange’s cookie. The string must be in base85 cookie-safe characters.

   source

   A “Source” object that provides data about the inventory source and which entity makes the final decision.

   item

   Array of “Item” objects (at least one) that constitute the set of goods being offered for sale. @required

   package

   Flag to indicate if the Exchange can verify that the items offered represent all of the items available in context.

   context

   Layer-4 domain object structure that provides context for the items being offered conforming to the specification and version referenced in “openrtb.domainspec” and “openrtb.domainver”. For AdCOM v1.x, the objects allowed here all of which are optional are one of the “DistributionChannel” subtypes (i.e., “Site”, “App”, or “Dooh”), “User”, “Device”, “Regs”, and any objects subordinate to these as specified by AdCOM. @recommended

   ext

   Optional vendor-specific extensions.

   extProto

   Legacy proto extensions.

   Annotations

   @SerialVersionUID()

5.  final case class Response(id: String = "", bidid: String = "", nbr: NoBidReason = com.explorestack.protobuf.openrtb.NoBidReason.NO_BID_REASON_INVALID, cur: String = "", cdata: String = "", seatbid: Seq[Seatbid] = _root_.scala.Seq.empty, ext: Option[Struct] = _root_.scala.None, extProto: Seq[Any] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[Response] with Product with Serializable

   This object is the bid response object under the Openrtb root.

   This object is the bid response object under the Openrtb root. Its id attribute is a reflection of the bid request ID. The bidid attribute is an optional response tracking ID for bidders. If specified, it will be available for use in substitution macros placed in markup and notification URLs. At least one Seatbid object is required, which contains at least one Bid for an item.

   id

   ID of the bid request to which this is a response; must match the "request.id" attribute. @required

   bidid

   Bidder generated response ID to assist with logging/tracking.

   nbr

   Reason for not bidding if applicable.

   cur

   Bid currency using ISO-4217 alpha codes. @default "USD"

   cdata

   Allows bidder to set data in the exchange’s cookie, which can be retrieved on bid requests

   seatbid

   Array of “Seatbid” objects; 1+ required if a bid is to be made.

   ext

   Optional vendor-specific extensions.

   extProto

   Legacy proto extensions.

   Annotations

   @SerialVersionUID()