open_rtb

Class Bid.Avro

java.lang.Object

open_rtb.Bid.Avro

All Implemented Interfaces:

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

Enclosing interface:

Bid<T>

public static class Bid.Avro
extends Object
implements Bid<BidAvro>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Bid

Bid.Avro, Bid.AvroBuilder, Bid.Builder<T>, Bid.Comparator, Bid.NativeImpl, Bid.Protobuf, Bid.ProtobufBuilder, Bid.Thrift, Bid.ThriftBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
Avro(byte[] binaryEncoding) Constructs a new Avro instance based on a message's binary encoding.

Method Summary

Modifier and Type	Method and Description
Bid.Avro	encoded()
boolean	equals(Object other)
static Bid<BidAvro>	from(byte[] binaryEncoding) Decodes a Avro record.
BidAvro	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.
String	getCid() Campaign ID or similar that appears within the ad markup.
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.
int	getW() Width of the ad in pixels.
int	hashCode()
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()
Bid.Builder<BidAvro>	newBuilder() Creates a new builder based on this object.
byte[]	toByteArray() Returns an Avro binary encoding of this record.
ByteBuffer	toByteBuffer() Returns the Avro binary encoding of this record wrapped in a read-only buffer.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface open_rtb.Bid

avro, avro, compareTo, getAvroClass, getAvroSchema, getComparator, getProtobufClass, getProtobufDescriptor, getProtobufProtocolClass, getProtobufProtocolDescriptor, getThriftClass, getThriftMetadataMap, isDefault, nativeImpl, newAvroBuilder, newAvroBuilder, newAvroBuilder, newAvroBuilder, newNativeImplBuilder, newNativeImplBuilder, newProtobufBuilder, newProtobufBuilder, newProtobufBuilder, newThriftBuilder, newThriftBuilder, newThriftBuilder, protobuf, protobuf, thrift, thrift

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Avro

public Avro(byte[] binaryEncoding)

Constructs a new Avro instance based on a message's binary encoding. Only use this if you know what you're doing.

Method Detail

get

public BidAvro get()

Description copied from interface: Bid

Returns underlying object.

Specified by:

get in interface Supplier<BidAvro>

Specified by:

get in interface Bid<BidAvro>

newBuilder

public Bid.Builder<BidAvro> newBuilder()

Description copied from interface: Bid

Creates a new builder based on this object.

Specified by:

newBuilder in interface Bid<BidAvro>

toByteArray

public byte[] toByteArray()

Returns an Avro binary encoding of this record.

toByteBuffer

public ByteBuffer toByteBuffer()

Returns the Avro binary encoding of this record wrapped in a read-only buffer.

getId

public String getId()

Description copied from interface: Bid

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.

Specified by:

getId in interface Bid<BidAvro>

isDefaultId

public boolean isDefaultId()

Specified by:

isDefaultId in interface Bid<BidAvro>

getImpid

public String getImpid()

Description copied from interface: Bid

ID of the impression object to which this bid applies.

Specified by:

getImpid in interface Bid<BidAvro>

isDefaultImpid

public boolean isDefaultImpid()

Specified by:

isDefaultImpid in interface Bid<BidAvro>

getPrice

public double getPrice()

Description copied from interface: Bid

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.

Specified by:

getPrice in interface Bid<BidAvro>

isDefaultPrice

public boolean isDefaultPrice()

Specified by:

isDefaultPrice in interface Bid<BidAvro>

getAdid

public String getAdid()

Description copied from interface: Bid

ID that references the ad to be served if the bid wins.

Specified by:

getAdid in interface Bid<BidAvro>

isDefaultAdid

public boolean isDefaultAdid()

Specified by:

isDefaultAdid in interface Bid<BidAvro>

getNurl

public String getNurl()

Description copied from interface: Bid

Win notice URL. Note that ad markup is also typically, but not necessarily, returned via this URL.

Specified by:

getNurl in interface Bid<BidAvro>

isDefaultNurl

public boolean isDefaultNurl()

Specified by:

isDefaultNurl in interface Bid<BidAvro>

getAdm

public String getAdm()

Description copied from interface: Bid

Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.

Specified by:

getAdm in interface Bid<BidAvro>

isDefaultAdm

public boolean isDefaultAdm()

Specified by:

isDefaultAdm in interface Bid<BidAvro>

getAdomain

public List<String> getAdomain()

Description copied from interface: Bid

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.

Specified by:

getAdomain in interface Bid<BidAvro>

isDefaultAdomain

public boolean isDefaultAdomain()

Specified by:

isDefaultAdomain in interface Bid<BidAvro>

getLurl

public String getLurl()

Description copied from interface: Bid

Sample image URL (without cache busting) for content checking.

Specified by:

getLurl in interface Bid<BidAvro>

isDefaultLurl

public boolean isDefaultLurl()

Specified by:

isDefaultLurl in interface Bid<BidAvro>

getCid

public String getCid()

Description copied from interface: Bid

Campaign ID or similar that appears within the ad markup.

Specified by:

getCid in interface Bid<BidAvro>

isDefaultCid

public boolean isDefaultCid()

Specified by:

isDefaultCid in interface Bid<BidAvro>

getCrid

public String getCrid()

Description copied from interface: Bid

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.

Specified by:

getCrid in interface Bid<BidAvro>

isDefaultCrid

public boolean isDefaultCrid()

Specified by:

isDefaultCrid in interface Bid<BidAvro>

getAttr

public List<Integer> getAttr()

Description copied from interface: Bid

Array of creative attributes. See Table 6.3 Creative Attributes.

Specified by:

getAttr in interface Bid<BidAvro>

isDefaultAttr

public boolean isDefaultAttr()

Specified by:

isDefaultAttr in interface Bid<BidAvro>

getDealid

public String getDealid()

Description copied from interface: Bid

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.

Specified by:

getDealid in interface Bid<BidAvro>

isDefaultDealid

public boolean isDefaultDealid()

Specified by:

isDefaultDealid in interface Bid<BidAvro>

getW

public int getW()

Description copied from interface: Bid

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.

Specified by:

getW in interface Bid<BidAvro>

isDefaultW

public boolean isDefaultW()

Specified by:

isDefaultW in interface Bid<BidAvro>

getH

public int getH()

Description copied from interface: Bid

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.

Specified by:

getH in interface Bid<BidAvro>

isDefaultH

public boolean isDefaultH()

Specified by:

isDefaultH in interface Bid<BidAvro>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

encoded

public Bid.Avro encoded()

from

public static Bid<BidAvro> from(byte[] binaryEncoding)
                         throws IOException

Decodes a Avro record.

Throws:

IOException