open_rtb

Class BidRequest.Protobuf

java.lang.Object

open_rtb.BidRequest.Protobuf

All Implemented Interfaces:

Serializable, Comparable<BidRequest<?>>, Supplier<OpenRtbProtobuf.BidRequest>, BidRequest<OpenRtbProtobuf.BidRequest>

Enclosing interface:

BidRequest<T>

public static class BidRequest.Protobuf
extends Object
implements BidRequest<OpenRtbProtobuf.BidRequest>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.BidRequest

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

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
static BidRequest<OpenRtbProtobuf.BidRequest>	from(byte[] binaryEncoding) Decodes a Protobuf message.
OpenRtbProtobuf.BidRequest	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.
List<String>	getBadv() Array of strings of blocked top-level domains of advertisers.
List<String>	getBcat() Blocked Advertiser Categories.
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.
Regulations<?>	getRegs() This object is a container for any legal, governmental or industry regulations in force for the request.
Site<?>	getSite() See Site Object.
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.
int	hashCode()
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()
BidRequest.Builder<OpenRtbProtobuf.BidRequest>	newBuilder() Creates a new builder based on this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface open_rtb.BidRequest

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

Protobuf

public Protobuf(byte[] binaryEncoding)

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

Method Detail

get

public OpenRtbProtobuf.BidRequest get()

Description copied from interface: BidRequest

Returns underlying object.

Specified by:

get in interface Supplier<OpenRtbProtobuf.BidRequest>

Specified by:

get in interface BidRequest<OpenRtbProtobuf.BidRequest>

newBuilder

public BidRequest.Builder<OpenRtbProtobuf.BidRequest> newBuilder()

Description copied from interface: BidRequest

Creates a new builder based on this object.

Specified by:

newBuilder in interface BidRequest<OpenRtbProtobuf.BidRequest>

getId

public String getId()

Description copied from interface: BidRequest

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

Specified by:

getId in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultId

public boolean isDefaultId()

Specified by:

isDefaultId in interface BidRequest<OpenRtbProtobuf.BidRequest>

getImp

public List<Impression<?>> getImp()

Description copied from interface: BidRequest

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.

Specified by:

getImp in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultImp

public boolean isDefaultImp()

Specified by:

isDefaultImp in interface BidRequest<OpenRtbProtobuf.BidRequest>

getSite

public Site<?> getSite()

Description copied from interface: BidRequest

See Site Object.

Specified by:

getSite in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultSite

public boolean isDefaultSite()

Specified by:

isDefaultSite in interface BidRequest<OpenRtbProtobuf.BidRequest>

getApp

public App<?> getApp()

Description copied from interface: BidRequest

See App Object.

Specified by:

getApp in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultApp

public boolean isDefaultApp()

Specified by:

isDefaultApp in interface BidRequest<OpenRtbProtobuf.BidRequest>

getDevice

public Device<?> getDevice()

Description copied from interface: BidRequest

See Device Object.

Specified by:

getDevice in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultDevice

public boolean isDefaultDevice()

Specified by:

isDefaultDevice in interface BidRequest<OpenRtbProtobuf.BidRequest>

getUser

public User<?> getUser()

Description copied from interface: BidRequest

See User Object.

Specified by:

getUser in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultUser

public boolean isDefaultUser()

Specified by:

isDefaultUser in interface BidRequest<OpenRtbProtobuf.BidRequest>

getAt

public int getAt()

Description copied from interface: BidRequest

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.

Specified by:

getAt in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultAt

public boolean isDefaultAt()

Specified by:

isDefaultAt in interface BidRequest<OpenRtbProtobuf.BidRequest>

getTmax

public int getTmax()

Description copied from interface: BidRequest

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.

Specified by:

getTmax in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultTmax

public boolean isDefaultTmax()

Specified by:

isDefaultTmax in interface BidRequest<OpenRtbProtobuf.BidRequest>

getWseat

public List<String> getWseat()

Description copied from interface: BidRequest

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.

Specified by:

getWseat in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultWseat

public boolean isDefaultWseat()

Specified by:

isDefaultWseat in interface BidRequest<OpenRtbProtobuf.BidRequest>

getAllimps

public int getAllimps()

Description copied from interface: BidRequest

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.

Specified by:

getAllimps in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultAllimps

public boolean isDefaultAllimps()

Specified by:

isDefaultAllimps in interface BidRequest<OpenRtbProtobuf.BidRequest>

getCur

public List<String> getCur()

Description copied from interface: BidRequest

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.

Specified by:

getCur in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultCur

public boolean isDefaultCur()

Specified by:

isDefaultCur in interface BidRequest<OpenRtbProtobuf.BidRequest>

getBcat

public List<String> getBcat()

Description copied from interface: BidRequest

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)

Specified by:

getBcat in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultBcat

public boolean isDefaultBcat()

Specified by:

isDefaultBcat in interface BidRequest<OpenRtbProtobuf.BidRequest>

getBadv

public List<String> getBadv()

Description copied from interface: BidRequest

Array of strings of blocked top-level domains of advertisers. For example, {“company1.com”, “company2.com”}.

Specified by:

getBadv in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultBadv

public boolean isDefaultBadv()

Specified by:

isDefaultBadv in interface BidRequest<OpenRtbProtobuf.BidRequest>

getRegs

public Regulations<?> getRegs()

Description copied from interface: BidRequest

This object is a container for any legal, governmental or industry regulations in force for the request.

Specified by:

getRegs in interface BidRequest<OpenRtbProtobuf.BidRequest>

isDefaultRegs

public boolean isDefaultRegs()

Specified by:

isDefaultRegs in interface BidRequest<OpenRtbProtobuf.BidRequest>

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

from

public static BidRequest<OpenRtbProtobuf.BidRequest> from(byte[] binaryEncoding)
                                                   throws IOException

Decodes a Protobuf message.

Throws:

IOException