open_rtb

Class Video.Avro

java.lang.Object

open_rtb.Video.Avro

All Implemented Interfaces:

Serializable, Comparable<Video<?>>, Supplier<VideoAvro>, Video<VideoAvro>

Enclosing interface:

Video<T>

public static class Video.Avro
extends Object
implements Video<VideoAvro>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface open_rtb.Video

Video.Avro, Video.AvroBuilder, Video.Builder<T>, Video.Comparator, Video.NativeImpl, Video.Protobuf, Video.ProtobufBuilder, Video.Thrift, Video.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
Video.Avro	encoded()
boolean	equals(Object other)
static Video<VideoAvro>	from(byte[] binaryEncoding) Decodes a Avro record.
VideoAvro	get() Returns underlying object.
List<Integer>	getApi() List of supported API frameworks for this impression.
List<Integer>	getBattr() Blocked creative attributes.
int	getBoxingallowed() If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window, then this should be set to false.
List<Banner<?>>	getCompanionad() If companion ads are available, they can be listed as an array of banner objects.
List<Integer>	getDeliverymethod() List of supported delivery methods (streaming, progressive).
int	getH() Height of the player in pixels.
int	getLinearity() Indicates whether the ad impression must be linear, non- linear or can be of any type (field not set).
int	getMaxbitrate() Maximum bit rate in Kbps.
int	getMaxduration() Maximum video ad duration in seconds.
int	getMaxextended() Maximum extended video ad duration, if extension is allowed.
List<String>	getMimes() Content MIME types supported.
int	getMinbitrate() Minimum bit rate in Kbps.
int	getMinduration() Minimum video ad duration in seconds.
List<Integer>	getPlaybackmethod() List of allowed playback methods.
int	getPos() Ad Position (see table 6.5).
int	getProtocol() Video bid response protocols.
List<Integer>	getProtocols() Video bid response protocols.
int	getSequence() If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
int	getStartdelay() Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.
List<Integer>	getVastCompanionType() Recommended if companion objects are included.
int	getW() Width of the player in pixels.
int	hashCode()
boolean	isDefaultApi()
boolean	isDefaultBattr()
boolean	isDefaultBoxingallowed()
boolean	isDefaultCompanionad()
boolean	isDefaultDeliverymethod()
boolean	isDefaultH()
boolean	isDefaultLinearity()
boolean	isDefaultMaxbitrate()
boolean	isDefaultMaxduration()
boolean	isDefaultMaxextended()
boolean	isDefaultMimes()
boolean	isDefaultMinbitrate()
boolean	isDefaultMinduration()
boolean	isDefaultPlaybackmethod()
boolean	isDefaultPos()
boolean	isDefaultProtocol()
boolean	isDefaultProtocols()
boolean	isDefaultSequence()
boolean	isDefaultStartdelay()
boolean	isDefaultVastCompanionType()
boolean	isDefaultW()
Video.Builder<VideoAvro>	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.Video

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 VideoAvro get()

Description copied from interface: Video

Returns underlying object.

Specified by:

get in interface Supplier<VideoAvro>

Specified by:

get in interface Video<VideoAvro>

newBuilder

public Video.Builder<VideoAvro> newBuilder()

Description copied from interface: Video

Creates a new builder based on this object.

Specified by:

newBuilder in interface Video<VideoAvro>

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.

getMimes

public List<String> getMimes()

Description copied from interface: Video

Content MIME types supported. Popular MIME types include, but are not limited to “video/x-ms- wmv” for Windows Media, and “video/x-flv” for Flash Video.

Specified by:

getMimes in interface Video<VideoAvro>

isDefaultMimes

public boolean isDefaultMimes()

Specified by:

isDefaultMimes in interface Video<VideoAvro>

getMinduration

public int getMinduration()

Description copied from interface: Video

Minimum video ad duration in seconds.

Specified by:

getMinduration in interface Video<VideoAvro>

isDefaultMinduration

public boolean isDefaultMinduration()

Specified by:

isDefaultMinduration in interface Video<VideoAvro>

getMaxduration

public int getMaxduration()

Description copied from interface: Video

Maximum video ad duration in seconds.

Specified by:

getMaxduration in interface Video<VideoAvro>

isDefaultMaxduration

public boolean isDefaultMaxduration()

Specified by:

isDefaultMaxduration in interface Video<VideoAvro>

getProtocol

public int getProtocol()

Description copied from interface: Video

Video bid response protocols. See Table 6.7 Video Bid Response Protocols for a list of possible values. NOTE: Use “protocols” when multiple protocols are supported. Its use is also highly recommended even for one since this “protocol” attribute is likely to be deprecated in a future version. At least one supported protocol must be specified in either the “protocol” or “protocols” attribute.

Specified by:

getProtocol in interface Video<VideoAvro>

isDefaultProtocol

public boolean isDefaultProtocol()

Specified by:

isDefaultProtocol in interface Video<VideoAvro>

getProtocols

public List<Integer> getProtocols()

Description copied from interface: Video

Video bid response protocols. See Table 6.7 Video Bid Response Protocols for a list of possible values. At least one supported protocol must be specified in either the “protocol” or “protocols” attribute.

Specified by:

getProtocols in interface Video<VideoAvro>

isDefaultProtocols

public boolean isDefaultProtocols()

Specified by:

isDefaultProtocols in interface Video<VideoAvro>

getW

public int getW()

Description copied from interface: Video

Width of the player in pixels. This field is not required, but it’s highly recommended that this information be included.

Specified by:

getW in interface Video<VideoAvro>

isDefaultW

public boolean isDefaultW()

Specified by:

isDefaultW in interface Video<VideoAvro>

getH

public int getH()

Description copied from interface: Video

Height of the player in pixels. This field is not required, but it’s highly recommended that this information be included.

Specified by:

getH in interface Video<VideoAvro>

isDefaultH

public boolean isDefaultH()

Specified by:

isDefaultH in interface Video<VideoAvro>

getStartdelay

public int getStartdelay()

Description copied from interface: Video

Indicates the start delay in seconds for preroll, midroll, or postroll ad placement. See Table 6.9 Video Start Delay for generic placement values.

Specified by:

getStartdelay in interface Video<VideoAvro>

isDefaultStartdelay

public boolean isDefaultStartdelay()

Specified by:

isDefaultStartdelay in interface Video<VideoAvro>

getLinearity

public int getLinearity()

Description copied from interface: Video

Indicates whether the ad impression must be linear, non- linear or can be of any type (field not set). See Table 6.6 Video Linearity for a list of the possible values and recommended bidder interpretation.

Specified by:

getLinearity in interface Video<VideoAvro>

isDefaultLinearity

public boolean isDefaultLinearity()

Specified by:

isDefaultLinearity in interface Video<VideoAvro>

getSequence

public int getSequence()

Description copied from interface: Video

If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.

Specified by:

getSequence in interface Video<VideoAvro>

isDefaultSequence

public boolean isDefaultSequence()

Specified by:

isDefaultSequence in interface Video<VideoAvro>

getBattr

public List<Integer> getBattr()

Description copied from interface: Video

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

Specified by:

getBattr in interface Video<VideoAvro>

isDefaultBattr

public boolean isDefaultBattr()

Specified by:

isDefaultBattr in interface Video<VideoAvro>

getMaxextended

public int getMaxextended()

Description copied from interface: Video

Maximum extended video ad duration, if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.

Specified by:

getMaxextended in interface Video<VideoAvro>

isDefaultMaxextended

public boolean isDefaultMaxextended()

Specified by:

isDefaultMaxextended in interface Video<VideoAvro>

getMinbitrate

public int getMinbitrate()

Description copied from interface: Video

Minimum bit rate in Kbps. Exchange may set this dynamically, or universally across their set of publishers.

Specified by:

getMinbitrate in interface Video<VideoAvro>

isDefaultMinbitrate

public boolean isDefaultMinbitrate()

Specified by:

isDefaultMinbitrate in interface Video<VideoAvro>

getMaxbitrate

public int getMaxbitrate()

Description copied from interface: Video

Maximum bit rate in Kbps. Exchange may set this dynamically, or universally across their set of publishers.

Specified by:

getMaxbitrate in interface Video<VideoAvro>

isDefaultMaxbitrate

public boolean isDefaultMaxbitrate()

Specified by:

isDefaultMaxbitrate in interface Video<VideoAvro>

getBoxingallowed

public int getBoxingallowed()

Description copied from interface: Video

If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window, then this should be set to false. Default setting is true, which assumes that boxing of content to fit into a window is allowed. “1” indicates boxing is allowed. “0” indicates it is not allowed.

Specified by:

getBoxingallowed in interface Video<VideoAvro>

isDefaultBoxingallowed

public boolean isDefaultBoxingallowed()

Specified by:

isDefaultBoxingallowed in interface Video<VideoAvro>

getPlaybackmethod

public List<Integer> getPlaybackmethod()

Description copied from interface: Video

List of allowed playback methods. If blank, assume that all are allowed. See Table 6.8 Video Playback Methods for a list of possible values.

Specified by:

getPlaybackmethod in interface Video<VideoAvro>

isDefaultPlaybackmethod

public boolean isDefaultPlaybackmethod()

Specified by:

isDefaultPlaybackmethod in interface Video<VideoAvro>

getDeliverymethod

public List<Integer> getDeliverymethod()

Description copied from interface: Video

List of supported delivery methods (streaming, progressive). If blank, assume all are supported. See Table 6.12 Content Delivery Methods for a list of possible values.

Specified by:

getDeliverymethod in interface Video<VideoAvro>

isDefaultDeliverymethod

public boolean isDefaultDeliverymethod()

Specified by:

isDefaultDeliverymethod in interface Video<VideoAvro>

getPos

public int getPos()

Description copied from interface: Video

Ad Position (see table 6.5). Default: unknown.

Specified by:

getPos in interface Video<VideoAvro>

isDefaultPos

public boolean isDefaultPos()

Specified by:

isDefaultPos in interface Video<VideoAvro>

getCompanionad

public List<Banner<?>> getCompanionad()

Description copied from interface: Video

If companion ads are available, they can be listed as an array of banner objects. See Banner Object.

Specified by:

getCompanionad in interface Video<VideoAvro>

isDefaultCompanionad

public boolean isDefaultCompanionad()

Specified by:

isDefaultCompanionad in interface Video<VideoAvro>

getApi

public List<Integer> getApi()

Description copied from interface: Video

List of supported API frameworks for this impression. (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 Video<VideoAvro>

isDefaultApi

public boolean isDefaultApi()

Specified by:

isDefaultApi in interface Video<VideoAvro>

getVastCompanionType

public List<Integer> getVastCompanionType()

Description copied from interface: Video

Recommended if companion objects are included. See Table 6.17 VAST Companion Types for a list of possible values.

Specified by:

getVastCompanionType in interface Video<VideoAvro>

isDefaultVastCompanionType

public boolean isDefaultVastCompanionType()

Specified by:

isDefaultVastCompanionType in interface Video<VideoAvro>

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 Video.Avro encoded()

from

public static Video<VideoAvro> from(byte[] binaryEncoding)
                             throws IOException

Decodes a Avro record.

Throws:

IOException