BidRequest (anoa-tests 3.1.2 API)

All Superinterfaces:

Comparable<BidRequest<?>>, Serializable, Supplier<T>

All Known Implementing Classes:

BidRequest.Avro, BidRequest.NativeImpl, BidRequest.Protobuf, BidRequest.Thrift
```
public interface BidRequest<T>
extends Supplier<T>, Comparable<BidRequest<?>>, Serializable
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BidRequest.Avro`
`static class`	`BidRequest.AvroBuilder`
`static interface`	`BidRequest.Builder<T>`
`static class`	`BidRequest.Comparator`
`static class`	`BidRequest.NativeImpl`
`static class`	`BidRequest.Protobuf`
`static class`	`BidRequest.ProtobufBuilder`
`static class`	`BidRequest.Thrift`
`static class`	`BidRequest.ThriftBuilder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static BidRequest.Avro`	`avro(BidRequest<?> instance)` Returns a wrapped Avro record based on an instance of BidRequest.
`static BidRequest.Avro`	`avro(BidRequestAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(BidRequest<?> other)`
`T`	`get()` Returns underlying object.
`int`	`getAllimps()` 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.
`App<?>`	`getApp()` See App Object.
`int`	`getAt()` Auction Type.
`static Class<BidRequestAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`List<String>`	`getBadv()` Array of strings of blocked top-level domains of advertisers.
`List<String>`	`getBcat()` Blocked Advertiser Categories.
`static Comparator<BidRequest<?>>`	`getComparator()` Returns comparator instance for BidRequest objects.
`List<String>`	`getCur()` Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
`Device<?>`	`getDevice()` See Device Object.
`String`	`getId()` Unique ID of the bid request, provided by the exchange.
`List<Impression<?>>`	`getImp()` Array of impression objects.
`static Class<OpenRtbProtobuf.BidRequest>`	`getProtobufClass()` Returns Protobuf class for this struct.
`static com.google.protobuf.Descriptors.Descriptor`	`getProtobufDescriptor()` Returns Protobuf descriptor for this struct.
`static Class<AdExchangeProtobuf>`	`getProtobufProtocolClass()` Returns Protobuf protocol class for this struct.
`static com.google.protobuf.Descriptors.FileDescriptor`	`getProtobufProtocolDescriptor()` Returns Protobuf protocol descriptor for this struct.
`Regulations<?>`	`getRegs()` This object is a container for any legal, governmental or industry regulations in force for the request.
`Site<?>`	`getSite()` See Site Object.
`static Class<BidRequestThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<BidRequestThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`int`	`getTmax()` 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).
`User<?>`	`getUser()` See User Object.
`List<String>`	`getWseat()` Array of buyer seats allowed to bid on this auction.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultAllimps()`
`boolean`	`isDefaultApp()`
`boolean`	`isDefaultAt()`
`boolean`	`isDefaultBadv()`
`boolean`	`isDefaultBcat()`
`boolean`	`isDefaultCur()`
`boolean`	`isDefaultDevice()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultImp()`
`boolean`	`isDefaultRegs()`
`boolean`	`isDefaultSite()`
`boolean`	`isDefaultTmax()`
`boolean`	`isDefaultUser()`
`boolean`	`isDefaultWseat()`
`static BidRequest.NativeImpl`	`nativeImpl(BidRequest<?> instance)` Returns a POJO based on an instance of BidRequest.
`static BidRequest.Builder<BidRequestAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static BidRequest.Builder<BidRequestAvro>`	`newAvroBuilder(BidRequest<?> other)` Returns new Avro builder instance based on existing prototype BidRequest.
`static BidRequest.Builder<BidRequestAvro>`	`newAvroBuilder(BidRequestAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static BidRequest.Builder<BidRequestAvro>`	`newAvroBuilder(BidRequestAvro other)` Returns new Avro builder instance based on existing prototype.
`BidRequest.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static BidRequest.Builder<BidRequest.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static BidRequest.Builder<BidRequest.NativeImpl>`	`newNativeImplBuilder(BidRequest<?> other)` Returns a POJO builder instance based on existing prototype BidRequest.
`static BidRequest.Builder<OpenRtbProtobuf.BidRequest>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static BidRequest.Builder<OpenRtbProtobuf.BidRequest>`	`newProtobufBuilder(BidRequest<?> other)` Returns new Protobuf builder instance based on existing prototype BidRequest.
`static BidRequest.Builder<OpenRtbProtobuf.BidRequest>`	`newProtobufBuilder(OpenRtbProtobuf.BidRequest other)` Returns new Protobuf builder instance based on existing prototype.
`static BidRequest.Builder<BidRequestThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static BidRequest.Builder<BidRequestThrift>`	`newThriftBuilder(BidRequest<?> other)` Returns new Thrift builder instance based on existing prototype BidRequest.
`static BidRequest.Builder<BidRequestThrift>`	`newThriftBuilder(BidRequestThrift other)` Returns new Thrift builder instance based on existing prototype.
`static BidRequest.Protobuf`	`protobuf(BidRequest<?> instance)` Returns a wrapped Protobuf message based on an instance of BidRequest.
`static BidRequest.Protobuf`	`protobuf(OpenRtbProtobuf.BidRequest wrapped)` Wraps an existing Protobuf message.
`static BidRequest.Thrift`	`thrift(BidRequest<?> instance)` Returns a wrapped Thrift struct based on an instance of BidRequest.
`static BidRequest.Thrift`	`thrift(BidRequestThrift instance)` Creates a new wrapped Thrift struct copied from an existing instance.

- Method Detail
  - isDefault
```
default boolean isDefault()
```
    True if all fields are set to default values.
  - get
```
T get()
```
    Returns underlying object.
    
    Specified by:
    
    get in interface Supplier<T>
  - newBuilder
```
BidRequest.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    Unique ID of the bid request, provided by the exchange.
  - isDefaultId
```
boolean isDefaultId()
```
  - getImp
```
List<Impression<?>> getImp()
```
    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.
  - isDefaultImp
```
boolean isDefaultImp()
```
  - getSite
```
Site<?> getSite()
```
    See Site Object.
  - isDefaultSite
```
boolean isDefaultSite()
```
  - getApp
```
App<?> getApp()
```
    See App Object.
  - isDefaultApp
```
boolean isDefaultApp()
```
  - getDevice
```
Device<?> getDevice()
```
    See Device Object.
  - isDefaultDevice
```
boolean isDefaultDevice()
```
  - getUser
```
User<?> getUser()
```
    See User Object.
  - isDefaultUser
```
boolean isDefaultUser()
```
  - getAt
```
int getAt()
```
    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.
  - isDefaultAt
```
boolean isDefaultAt()
```
  - getTmax
```
int getTmax()
```
    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.
  - isDefaultTmax
```
boolean isDefaultTmax()
```
  - getWseat
```
List<String> getWseat()
```
    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.
  - isDefaultWseat
```
boolean isDefaultWseat()
```
  - getAllimps
```
int getAllimps()
```
    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.
  - isDefaultAllimps
```
boolean isDefaultAllimps()
```
  - getCur
```
List<String> getCur()
```
    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.
  - isDefaultCur
```
boolean isDefaultCur()
```
  - getBcat
```
List<String> getBcat()
```
    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)
  - isDefaultBcat
```
boolean isDefaultBcat()
```
  - getBadv
```
List<String> getBadv()
```
    Array of strings of blocked top-level domains of advertisers. For example, {“company1.com”, “company2.com”}.
  - isDefaultBadv
```
boolean isDefaultBadv()
```
  - getRegs
```
Regulations<?> getRegs()
```
    This object is a container for any legal, governmental or industry regulations in force for the request.
  - isDefaultRegs
```
boolean isDefaultRegs()
```
  - getComparator
```
static Comparator<BidRequest<?>> getComparator()
```
    Returns comparator instance for BidRequest objects.
  - compareTo
```
default int compareTo(BidRequest<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<BidRequest<?>>
  - newNativeImplBuilder
```
static BidRequest.Builder<BidRequest.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static BidRequest.Builder<BidRequest.NativeImpl> newNativeImplBuilder(BidRequest<?> other)
```
    Returns a POJO builder instance based on existing prototype BidRequest.
  - nativeImpl
```
static BidRequest.NativeImpl nativeImpl(BidRequest<?> instance)
```
    Returns a POJO based on an instance of BidRequest.
  - newAvroBuilder
```
static BidRequest.Builder<BidRequestAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static BidRequest.Builder<BidRequestAvro> newAvroBuilder(BidRequestAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static BidRequest.Builder<BidRequestAvro> newAvroBuilder(BidRequestAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static BidRequest.Builder<BidRequestAvro> newAvroBuilder(BidRequest<?> other)
```
    Returns new Avro builder instance based on existing prototype BidRequest.
  - avro
```
static BidRequest.Avro avro(BidRequest<?> instance)
```
    Returns a wrapped Avro record based on an instance of BidRequest.
  - avro
```
static BidRequest.Avro avro(BidRequestAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<BidRequestAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static BidRequest.Builder<OpenRtbProtobuf.BidRequest> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static BidRequest.Builder<OpenRtbProtobuf.BidRequest> newProtobufBuilder(OpenRtbProtobuf.BidRequest other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static BidRequest.Builder<OpenRtbProtobuf.BidRequest> newProtobufBuilder(BidRequest<?> other)
```
    Returns new Protobuf builder instance based on existing prototype BidRequest.
  - protobuf
```
static BidRequest.Protobuf protobuf(BidRequest<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of BidRequest.
  - protobuf
```
static BidRequest.Protobuf protobuf(OpenRtbProtobuf.BidRequest wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.BidRequest> getProtobufClass()
```
    Returns Protobuf class for this struct.
  - getProtobufProtocolClass
```
static Class<AdExchangeProtobuf> getProtobufProtocolClass()
```
    Returns Protobuf protocol class for this struct.
  - getProtobufDescriptor
```
static com.google.protobuf.Descriptors.Descriptor getProtobufDescriptor()
```
    Returns Protobuf descriptor for this struct.
  - getProtobufProtocolDescriptor
```
static com.google.protobuf.Descriptors.FileDescriptor getProtobufProtocolDescriptor()
```
    Returns Protobuf protocol descriptor for this struct.
  - newThriftBuilder
```
static BidRequest.Builder<BidRequestThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static BidRequest.Builder<BidRequestThrift> newThriftBuilder(BidRequestThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static BidRequest.Builder<BidRequestThrift> newThriftBuilder(BidRequest<?> other)
```
    Returns new Thrift builder instance based on existing prototype BidRequest.
  - thrift
```
static BidRequest.Thrift thrift(BidRequest<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of BidRequest.
  - thrift
```
static BidRequest.Thrift thrift(BidRequestThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<BidRequestThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<BidRequestThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface BidRequest<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getImp

isDefaultImp

getSite

isDefaultSite

getApp

isDefaultApp

getDevice

isDefaultDevice

getUser

isDefaultUser

getAt

isDefaultAt

getTmax

isDefaultTmax

getWseat

isDefaultWseat

getAllimps

isDefaultAllimps

getCur

isDefaultCur

getBcat

isDefaultBcat

getBadv

isDefaultBadv

getRegs

isDefaultRegs

getComparator

compareTo

newNativeImplBuilder

newNativeImplBuilder

nativeImpl

newAvroBuilder

newAvroBuilder

newAvroBuilder

newAvroBuilder

avro

avro

getAvroClass

getAvroSchema

newProtobufBuilder

newProtobufBuilder

newProtobufBuilder

protobuf

protobuf

getProtobufClass

getProtobufProtocolClass

getProtobufDescriptor

getProtobufProtocolDescriptor

newThriftBuilder

newThriftBuilder

newThriftBuilder

thrift

thrift

getThriftClass

getThriftMetadataMap