open_rtb

Class Banner.Protobuf

java.lang.Object

open_rtb.Banner.Protobuf

All Implemented Interfaces:

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

Enclosing interface:

Banner<T>

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Banner

Banner.Avro, Banner.AvroBuilder, Banner.Builder<T>, Banner.Comparator, Banner.NativeImpl, Banner.Protobuf, Banner.ProtobufBuilder, Banner.Thrift, Banner.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 Banner<OpenRtbProtobuf.Banner>	from(byte[] binaryEncoding) Decodes a Protobuf message.
OpenRtbProtobuf.Banner	get() Returns underlying object.
List<Integer>	getApi() List of supported API frameworks for this banner.
List<Integer>	getBattr() Blocked creative attributes.
List<Integer>	getBtype() Blocked creative types.
List<Integer>	getExpdir() Specify properties for an expandable ad.
int	getH() Height of the impression in pixels.
int	getHmax() Maximum height of the impression in pixels.
int	getHmin() Minimum height of the impression in pixels.
String	getId() Unique identifier for this banner object.
List<String>	getMimes() Whitelist of content MIME types supported.
int	getPos() Ad Position.
int	getTopframe() Specify if the banner is delivered in the top frame or in an iframe.
int	getW() Width of the impression in pixels.
int	getWmax() Maximum width of the impression in pixels.
int	getWmin() Minimum width of the impression in pixels.
int	hashCode()
boolean	isDefaultApi()
boolean	isDefaultBattr()
boolean	isDefaultBtype()
boolean	isDefaultExpdir()
boolean	isDefaultH()
boolean	isDefaultHmax()
boolean	isDefaultHmin()
boolean	isDefaultId()
boolean	isDefaultMimes()
boolean	isDefaultPos()
boolean	isDefaultTopframe()
boolean	isDefaultW()
boolean	isDefaultWmax()
boolean	isDefaultWmin()
Banner.Builder<OpenRtbProtobuf.Banner>	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.Banner

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.Banner get()

Description copied from interface: Banner

Returns underlying object.

Specified by:

get in interface Supplier<OpenRtbProtobuf.Banner>

Specified by:

get in interface Banner<OpenRtbProtobuf.Banner>

newBuilder

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

Description copied from interface: Banner

Creates a new builder based on this object.

Specified by:

newBuilder in interface Banner<OpenRtbProtobuf.Banner>

getW

public int getW()

Description copied from interface: Banner

Width of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.

Specified by:

getW in interface Banner<OpenRtbProtobuf.Banner>

isDefaultW

public boolean isDefaultW()

Specified by:

isDefaultW in interface Banner<OpenRtbProtobuf.Banner>

getH

public int getH()

Description copied from interface: Banner

Height of the impression in pixels. Since some ad types are not restricted by size this field is not required, but it’s highly recommended that this information be included when possible.

Specified by:

getH in interface Banner<OpenRtbProtobuf.Banner>

isDefaultH

public boolean isDefaultH()

Specified by:

isDefaultH in interface Banner<OpenRtbProtobuf.Banner>

getWmax

public int getWmax()

Description copied from interface: Banner

Maximum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum width and "w" is taken as recommended. If not included, then "w" should be considered an exact requirement.

Specified by:

getWmax in interface Banner<OpenRtbProtobuf.Banner>

isDefaultWmax

public boolean isDefaultWmax()

Specified by:

isDefaultWmax in interface Banner<OpenRtbProtobuf.Banner>

getHmax

public int getHmax()

Description copied from interface: Banner

Maximum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this maximum height and "h" is taken as recommended. If not included, then "h" should be considered an exact requirement.

Specified by:

getHmax in interface Banner<OpenRtbProtobuf.Banner>

isDefaultHmax

public boolean isDefaultHmax()

Specified by:

isDefaultHmax in interface Banner<OpenRtbProtobuf.Banner>

getWmin

public int getWmin()

Description copied from interface: Banner

Minimum width of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum width and "w" is taken as recommended. If not included, then "w" should be considered an exact requirement.

Specified by:

getWmin in interface Banner<OpenRtbProtobuf.Banner>

isDefaultWmin

public boolean isDefaultWmin()

Specified by:

isDefaultWmin in interface Banner<OpenRtbProtobuf.Banner>

getHmin

public int getHmin()

Description copied from interface: Banner

Minimum height of the impression in pixels. If included, it indicates that a range of sizes is allowed with this minimum height and "h" is taken as recommended. If not included, then "h" should be considered an exact requirement.

Specified by:

getHmin in interface Banner<OpenRtbProtobuf.Banner>

isDefaultHmin

public boolean isDefaultHmin()

Specified by:

isDefaultHmin in interface Banner<OpenRtbProtobuf.Banner>

getId

public String getId()

Description copied from interface: Banner

Unique identifier for this banner object. Useful for tracking multiple banner objects (e.g., in companion banner array). Usually starts with 1, increasing with each object. Combination of impression id banner object should be unique.

Specified by:

getId in interface Banner<OpenRtbProtobuf.Banner>

isDefaultId

public boolean isDefaultId()

Specified by:

isDefaultId in interface Banner<OpenRtbProtobuf.Banner>

getPos

public int getPos()

Description copied from interface: Banner

Ad Position. Use Table 6.5

Specified by:

getPos in interface Banner<OpenRtbProtobuf.Banner>

isDefaultPos

public boolean isDefaultPos()

Specified by:

isDefaultPos in interface Banner<OpenRtbProtobuf.Banner>

getBtype

public List<Integer> getBtype()

Description copied from interface: Banner

Blocked creative types. See Table 6.2 Banner Ad Types. If blank, assume all types are allowed.

Specified by:

getBtype in interface Banner<OpenRtbProtobuf.Banner>

isDefaultBtype

public boolean isDefaultBtype()

Specified by:

isDefaultBtype in interface Banner<OpenRtbProtobuf.Banner>

getBattr

public List<Integer> getBattr()

Description copied from interface: Banner

Blocked creative attributes. See Table 6.3 Creative Attributes. If blank assume all types are allowed.

Specified by:

getBattr in interface Banner<OpenRtbProtobuf.Banner>

isDefaultBattr

public boolean isDefaultBattr()

Specified by:

isDefaultBattr in interface Banner<OpenRtbProtobuf.Banner>

getMimes

public List<String> getMimes()

Description copied from interface: Banner

Whitelist of content MIME types supported. Popular MIME types include, but are not limited to “image/jpg”, “image/gif” and “application/x-shockwave-flash”.

Specified by:

getMimes in interface Banner<OpenRtbProtobuf.Banner>

isDefaultMimes

public boolean isDefaultMimes()

Specified by:

isDefaultMimes in interface Banner<OpenRtbProtobuf.Banner>

getTopframe

public int getTopframe()

Description copied from interface: Banner

Specify if the banner is delivered in the top frame or in an iframe. “0” means it is not in the top frame, and “1” means that it is.

Specified by:

getTopframe in interface Banner<OpenRtbProtobuf.Banner>

isDefaultTopframe

public boolean isDefaultTopframe()

Specified by:

isDefaultTopframe in interface Banner<OpenRtbProtobuf.Banner>

getExpdir

public List<Integer> getExpdir()

Description copied from interface: Banner

Specify properties for an expandable ad. See Table 6.11 Expandable Direction for possible values.

Specified by:

getExpdir in interface Banner<OpenRtbProtobuf.Banner>

isDefaultExpdir

public boolean isDefaultExpdir()

Specified by:

isDefaultExpdir in interface Banner<OpenRtbProtobuf.Banner>

getApi

public List<Integer> getApi()

Description copied from interface: Banner

List of supported API frameworks for this banner. (See Table 6.4 API Frameworks). If an API is not explicitly listed it is assumed not to be supported.

Specified by:

getApi in interface Banner<OpenRtbProtobuf.Banner>

isDefaultApi

public boolean isDefaultApi()

Specified by:

isDefaultApi in interface Banner<OpenRtbProtobuf.Banner>

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 Banner<OpenRtbProtobuf.Banner> from(byte[] binaryEncoding)
                                           throws IOException

Decodes a Protobuf message.

Throws:

IOException