Bid (anoa-tests 3.1.2 API)

All Superinterfaces:

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

All Known Implementing Classes:

Bid.Avro, Bid.NativeImpl, Bid.Protobuf, Bid.Thrift
```
public interface Bid<T>
extends Supplier<T>, Comparable<Bid<?>>, Serializable
```
4.3.3 Bid Object For each bid, the “nurl” attribute contains the win notice URL. If the bidder wins the impression, the exchange calls this notice URL a) to inform the bidder of the win and b) to convey certain information using substitution macros (see Section 4.6 Substitution Macros). The “adomain” attribute can be used to check advertiser block list compliance. The “iurl” attribute can provide a link to an image that is representative of the campaign’s content (irrespective of whether the campaign may have multiple creatives). This enables human review for spotting inappropriate content. The “cid” attribute can be used to block ads that were previously identified as inappropriate; essentially a safety net beyond the block lists. The “crid” attribute can be helpful in reporting creative issues back to bidders. Finally, the “attr” array indicates the creative attributes that describe the ad to be served. BEST PRACTICE: Substitution macros may allow a bidder to use a static notice URL for all of its bids. Thus, exchanges should offer the option of a default notice URL that can be pre- configured per bidder to reduce redundant data transfer.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Bid.Avro`	`avro(Bid<?> instance)` Returns a wrapped Avro record based on an instance of Bid.
`static Bid.Avro`	`avro(BidAvro wrapped)` Wraps an existing Avro record.
`default int`	`compareTo(Bid<?> other)`
`T`	`get()` Returns underlying object.
`String`	`getAdid()` ID that references the ad to be served if the bid wins.
`String`	`getAdm()` Actual ad markup.
`List<String>`	`getAdomain()` Advertiser’s primary or top-level domain for advertiser checking.
`List<Integer>`	`getAttr()` Array of creative attributes.
`static Class<BidAvro>`	`getAvroClass()` Returns Avro record class.
`static Schema`	`getAvroSchema()` Returns Avro record schema.
`String`	`getCid()` Campaign ID or similar that appears within the ad markup.
`static Comparator<Bid<?>>`	`getComparator()` Returns comparator instance for Bid objects.
`String`	`getCrid()` Creative ID for reporting content issues or defects.
`String`	`getDealid()` A unique identifier for the direct deal associated with the bid.
`int`	`getH()` Height of the ad in pixels.
`String`	`getId()` ID for the bid object chosen by the bidder for tracking and debugging purposes.
`String`	`getImpid()` ID of the impression object to which this bid applies.
`String`	`getLurl()` Sample image URL (without cache busting) for content checking.
`String`	`getNurl()` Win notice URL.
`double`	`getPrice()` Bid price in CPM.
`static Class<OpenRtbProtobuf.Bid>`	`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.
`static Class<BidThrift>`	`getThriftClass()` Returns Thrift class for this struct.
`static Map<BidThrift._Fields,FieldMetaData>`	`getThriftMetadataMap()` Returns Thrift metadata map for this struct.
`int`	`getW()` Width of the ad in pixels.
`default boolean`	`isDefault()` True if all fields are set to default values.
`boolean`	`isDefaultAdid()`
`boolean`	`isDefaultAdm()`
`boolean`	`isDefaultAdomain()`
`boolean`	`isDefaultAttr()`
`boolean`	`isDefaultCid()`
`boolean`	`isDefaultCrid()`
`boolean`	`isDefaultDealid()`
`boolean`	`isDefaultH()`
`boolean`	`isDefaultId()`
`boolean`	`isDefaultImpid()`
`boolean`	`isDefaultLurl()`
`boolean`	`isDefaultNurl()`
`boolean`	`isDefaultPrice()`
`boolean`	`isDefaultW()`
`static Bid.NativeImpl`	`nativeImpl(Bid<?> instance)` Returns a POJO based on an instance of Bid.
`static Bid.Builder<BidAvro>`	`newAvroBuilder()` Returns new Avro builder instance with default values.
`static Bid.Builder<BidAvro>`	`newAvroBuilder(Bid<?> other)` Returns new Avro builder instance based on existing prototype Bid.
`static Bid.Builder<BidAvro>`	`newAvroBuilder(BidAvro.Builder other)` Returns new Avro builder instance based on existing prototype builder.
`static Bid.Builder<BidAvro>`	`newAvroBuilder(BidAvro other)` Returns new Avro builder instance based on existing prototype.
`Bid.Builder<T>`	`newBuilder()` Creates a new builder based on this object.
`static Bid.Builder<Bid.NativeImpl>`	`newNativeImplBuilder()` Returns a POJO builder instance with default values.
`static Bid.Builder<Bid.NativeImpl>`	`newNativeImplBuilder(Bid<?> other)` Returns a POJO builder instance based on existing prototype Bid.
`static Bid.Builder<OpenRtbProtobuf.Bid>`	`newProtobufBuilder()` Returns new Protobuf builder instance with default values.
`static Bid.Builder<OpenRtbProtobuf.Bid>`	`newProtobufBuilder(Bid<?> other)` Returns new Protobuf builder instance based on existing prototype Bid.
`static Bid.Builder<OpenRtbProtobuf.Bid>`	`newProtobufBuilder(OpenRtbProtobuf.Bid other)` Returns new Protobuf builder instance based on existing prototype.
`static Bid.Builder<BidThrift>`	`newThriftBuilder()` Returns new Thrift builder instance with default values.
`static Bid.Builder<BidThrift>`	`newThriftBuilder(Bid<?> other)` Returns new Thrift builder instance based on existing prototype Bid.
`static Bid.Builder<BidThrift>`	`newThriftBuilder(BidThrift other)` Returns new Thrift builder instance based on existing prototype.
`static Bid.Protobuf`	`protobuf(Bid<?> instance)` Returns a wrapped Protobuf message based on an instance of Bid.
`static Bid.Protobuf`	`protobuf(OpenRtbProtobuf.Bid wrapped)` Wraps an existing Protobuf message.
`static Bid.Thrift`	`thrift(Bid<?> instance)` Returns a wrapped Thrift struct based on an instance of Bid.
`static Bid.Thrift`	`thrift(BidThrift 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
```
Bid.Builder<T> newBuilder()
```
    Creates a new builder based on this object.
  - getId
```
String getId()
```
    ID for the bid object chosen by the bidder for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
  - isDefaultId
```
boolean isDefaultId()
```
  - getImpid
```
String getImpid()
```
    ID of the impression object to which this bid applies.
  - isDefaultImpid
```
boolean isDefaultImpid()
```
  - getPrice
```
double getPrice()
```
    Bid price in CPM. WARNING/Best Practice Note: Although this value is a float, OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
  - isDefaultPrice
```
boolean isDefaultPrice()
```
  - getAdid
```
String getAdid()
```
    ID that references the ad to be served if the bid wins.
  - isDefaultAdid
```
boolean isDefaultAdid()
```
  - getNurl
```
String getNurl()
```
    Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.
  - isDefaultNurl
```
boolean isDefaultNurl()
```
  - getAdm
```
String getAdm()
```
    Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
  - isDefaultAdm
```
boolean isDefaultAdm()
```
  - getAdomain
```
List<String> getAdomain()
```
    Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
  - isDefaultAdomain
```
boolean isDefaultAdomain()
```
  - getLurl
```
String getLurl()
```
    Sample image URL (without cache busting) for content checking.
  - isDefaultLurl
```
boolean isDefaultLurl()
```
  - getCid
```
String getCid()
```
    Campaign ID or similar that appears within the ad markup.
  - isDefaultCid
```
boolean isDefaultCid()
```
  - getCrid
```
String getCrid()
```
    Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
  - isDefaultCrid
```
boolean isDefaultCrid()
```
  - getAttr
```
List<Integer> getAttr()
```
    Array of creative attributes. See Table 6.3 Creative Attributes.
  - isDefaultAttr
```
boolean isDefaultAttr()
```
  - getDealid
```
String getDealid()
```
    A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object.
  - isDefaultDealid
```
boolean isDefaultDealid()
```
  - getW
```
int getW()
```
    Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - isDefaultW
```
boolean isDefaultW()
```
  - getH
```
int getH()
```
    Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin optional fields it is recommended that the response bid contains this field to signal the size of ad chosen.
  - isDefaultH
```
boolean isDefaultH()
```
  - getComparator
```
static Comparator<Bid<?>> getComparator()
```
    Returns comparator instance for Bid objects.
  - compareTo
```
default int compareTo(Bid<?> other)
```
    Specified by:
    
    compareTo in interface Comparable<Bid<?>>
  - newNativeImplBuilder
```
static Bid.Builder<Bid.NativeImpl> newNativeImplBuilder()
```
    Returns a POJO builder instance with default values.
  - newNativeImplBuilder
```
static Bid.Builder<Bid.NativeImpl> newNativeImplBuilder(Bid<?> other)
```
    Returns a POJO builder instance based on existing prototype Bid.
  - nativeImpl
```
static Bid.NativeImpl nativeImpl(Bid<?> instance)
```
    Returns a POJO based on an instance of Bid.
  - newAvroBuilder
```
static Bid.Builder<BidAvro> newAvroBuilder()
```
    Returns new Avro builder instance with default values.
  - newAvroBuilder
```
static Bid.Builder<BidAvro> newAvroBuilder(BidAvro other)
```
    Returns new Avro builder instance based on existing prototype.
  - newAvroBuilder
```
static Bid.Builder<BidAvro> newAvroBuilder(BidAvro.Builder other)
```
    Returns new Avro builder instance based on existing prototype builder.
  - newAvroBuilder
```
static Bid.Builder<BidAvro> newAvroBuilder(Bid<?> other)
```
    Returns new Avro builder instance based on existing prototype Bid.
  - avro
```
static Bid.Avro avro(Bid<?> instance)
```
    Returns a wrapped Avro record based on an instance of Bid.
  - avro
```
static Bid.Avro avro(BidAvro wrapped)
```
    Wraps an existing Avro record.
  - getAvroClass
```
static Class<BidAvro> getAvroClass()
```
    Returns Avro record class.
  - getAvroSchema
```
static Schema getAvroSchema()
```
    Returns Avro record schema.
  - newProtobufBuilder
```
static Bid.Builder<OpenRtbProtobuf.Bid> newProtobufBuilder()
```
    Returns new Protobuf builder instance with default values.
  - newProtobufBuilder
```
static Bid.Builder<OpenRtbProtobuf.Bid> newProtobufBuilder(OpenRtbProtobuf.Bid other)
```
    Returns new Protobuf builder instance based on existing prototype.
  - newProtobufBuilder
```
static Bid.Builder<OpenRtbProtobuf.Bid> newProtobufBuilder(Bid<?> other)
```
    Returns new Protobuf builder instance based on existing prototype Bid.
  - protobuf
```
static Bid.Protobuf protobuf(Bid<?> instance)
```
    Returns a wrapped Protobuf message based on an instance of Bid.
  - protobuf
```
static Bid.Protobuf protobuf(OpenRtbProtobuf.Bid wrapped)
```
    Wraps an existing Protobuf message.
  - getProtobufClass
```
static Class<OpenRtbProtobuf.Bid> 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 Bid.Builder<BidThrift> newThriftBuilder()
```
    Returns new Thrift builder instance with default values.
  - newThriftBuilder
```
static Bid.Builder<BidThrift> newThriftBuilder(BidThrift other)
```
    Returns new Thrift builder instance based on existing prototype.
  - newThriftBuilder
```
static Bid.Builder<BidThrift> newThriftBuilder(Bid<?> other)
```
    Returns new Thrift builder instance based on existing prototype Bid.
  - thrift
```
static Bid.Thrift thrift(Bid<?> instance)
```
    Returns a wrapped Thrift struct based on an instance of Bid.
  - thrift
```
static Bid.Thrift thrift(BidThrift instance)
```
    Creates a new wrapped Thrift struct copied from an existing instance.
  - getThriftClass
```
static Class<BidThrift> getThriftClass()
```
    Returns Thrift class for this struct.
  - getThriftMetadataMap
```
static Map<BidThrift._Fields,FieldMetaData> getThriftMetadataMap()
```
    Returns Thrift metadata map for this struct.

Interface Bid<T>

Nested Class Summary

Method Summary

Method Detail

isDefault

get

newBuilder

getId

isDefaultId

getImpid

isDefaultImpid

getPrice

isDefaultPrice

getAdid

isDefaultAdid

getNurl

isDefaultNurl

getAdm

isDefaultAdm

getAdomain

isDefaultAdomain

getLurl

isDefaultLurl

getCid

isDefaultCid

getCrid

isDefaultCrid

getAttr

isDefaultAttr

getDealid

isDefaultDealid

getW

isDefaultW

getH

isDefaultH

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