Packages

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. 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()
Linear Supertypes
Updatable[Request], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new 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)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllCur(__vs: Iterable[String]): Request
  5. def addAllExtProto(__vs: Iterable[Any]): Request
  6. def addAllItem(__vs: Iterable[Item]): Request
  7. def addAllSeat(__vs: Iterable[String]): Request
  8. def addCur(__vs: String*): Request
  9. def addExtProto(__vs: Any*): Request
  10. def addItem(__vs: Item*): Request
  11. def addSeat(__vs: String*): Request
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. val at: Int
  14. val cdata: String
  15. def clearContext: Request
  16. def clearCur: Request
  17. def clearExt: Request
  18. def clearExtProto: Request
  19. def clearItem: Request
  20. def clearSeat: Request
  21. def clearSource: Request
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  23. def companion: Request.type
    Definition Classes
    Request → GeneratedMessage
  24. val context: Option[Any]
  25. val cur: Seq[String]
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. val ext: Option[Struct]
  28. val extProto: Seq[Any]
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  30. def getContext: Any
  31. def getExt: Struct
  32. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Request → GeneratedMessage
  33. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Request → GeneratedMessage
  34. def getSource: Source
  35. val id: String
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. val item: Seq[Item]
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  41. val package: Int
  42. def productElementNames: Iterator[String]
    Definition Classes
    Product
  43. val seat: Seq[String]
  44. def serializedSize: Int
    Definition Classes
    Request → GeneratedMessage
  45. val source: Option[Source]
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. val test: Boolean
  48. val tmax: Int
  49. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  50. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  51. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  52. def toProtoString: String
    Definition Classes
    Request → GeneratedMessage
  53. def update(ms: (Lens[Request, Request]) => Mutation[Request]*): Request
    Definition Classes
    Updatable
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. def withAt(__v: Int): Request
  58. def withCdata(__v: String): Request
  59. def withContext(__v: Any): Request
  60. def withCur(__v: Seq[String]): Request
  61. def withExt(__v: Struct): Request
  62. def withExtProto(__v: Seq[Any]): Request
  63. def withId(__v: String): Request
  64. def withItem(__v: Seq[Item]): Request
  65. def withPackage(__v: Int): Request
  66. def withSeat(__v: Seq[String]): Request
  67. def withSource(__v: Source): Request
  68. def withTest(__v: Boolean): Request
  69. def withTmax(__v: Int): Request
  70. def withWseat(__v: Boolean): Request
  71. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  72. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Request → GeneratedMessage
  73. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  74. val wseat: Boolean

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Updatable[Request]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped