open_rtb

Interface OpenRtbProtobuf.VideoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OpenRtbProtobuf.Video, OpenRtbProtobuf.Video.Builder

Enclosing class:

OpenRtbProtobuf

public static interface OpenRtbProtobuf.VideoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getApi(int index) List of supported API frameworks for this impression.
int	getApiCount() List of supported API frameworks for this impression.
List<Integer>	getApiList() List of supported API frameworks for this impression.
int	getBattr(int index) Blocked creative attributes.
int	getBattrCount() Blocked creative attributes.
List<Integer>	getBattrList() 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.
OpenRtbProtobuf.Banner	getCompanionad(int index) If companion ads are available, they can be listed as an array of banner objects.
int	getCompanionadCount() If companion ads are available, they can be listed as an array of banner objects.
List<OpenRtbProtobuf.Banner>	getCompanionadList() If companion ads are available, they can be listed as an array of banner objects.
OpenRtbProtobuf.BannerOrBuilder	getCompanionadOrBuilder(int index) If companion ads are available, they can be listed as an array of banner objects.
List<? extends OpenRtbProtobuf.BannerOrBuilder>	getCompanionadOrBuilderList() If companion ads are available, they can be listed as an array of banner objects.
int	getDeliverymethod(int index) List of supported delivery methods (streaming, progressive).
int	getDeliverymethodCount() List of supported delivery methods (streaming, progressive).
List<Integer>	getDeliverymethodList() 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.
String	getMimes(int index) Content MIME types supported.
com.google.protobuf.ByteString	getMimesBytes(int index) Content MIME types supported.
int	getMimesCount() Content MIME types supported.
List<String>	getMimesList() Content MIME types supported.
int	getMinbitrate() Minimum bit rate in Kbps.
int	getMinduration() Minimum video ad duration in seconds.
int	getPlaybackmethod(int index) List of allowed playback methods.
int	getPlaybackmethodCount() List of allowed playback methods.
List<Integer>	getPlaybackmethodList() List of allowed playback methods.
int	getPos() Ad Position (see table 6.5).
int	getProtocol() Video bid response protocols.
int	getProtocols(int index) Video bid response protocols.
int	getProtocolsCount() Video bid response protocols.
List<Integer>	getProtocolsList() 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.
int	getVastCompanionType(int index) Recommended if companion objects are included.
int	getVastCompanionTypeCount() Recommended if companion objects are included.
List<Integer>	getVastCompanionTypeList() Recommended if companion objects are included.
int	getW() Width of the player in pixels.
boolean	hasBoxingallowed() If exchange publisher has rules preventing letter boxing of 4x3 content to play in a 16x9 window, then this should be set to false.
boolean	hasH() Height of the player in pixels.
boolean	hasLinearity() Indicates whether the ad impression must be linear, non- linear or can be of any type (field not set).
boolean	hasMaxbitrate() Maximum bit rate in Kbps.
boolean	hasMaxduration() Maximum video ad duration in seconds.
boolean	hasMaxextended() Maximum extended video ad duration, if extension is allowed.
boolean	hasMinbitrate() Minimum bit rate in Kbps.
boolean	hasMinduration() Minimum video ad duration in seconds.
boolean	hasPos() Ad Position (see table 6.5).
boolean	hasProtocol() Video bid response protocols.
boolean	hasSequence() If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
boolean	hasStartdelay() Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.
boolean	hasW() Width of the player in pixels.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getMimesList

List<String> getMimesList()

 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. 
 

repeated string mimes = 1;

getMimesCount

int getMimesCount()

 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. 
 

repeated string mimes = 1;

getMimes

String getMimes(int index)

 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. 
 

repeated string mimes = 1;

getMimesBytes

com.google.protobuf.ByteString getMimesBytes(int index)

 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. 
 

repeated string mimes = 1;

hasMinduration

boolean hasMinduration()

 Minimum video ad duration in seconds. 
 

optional sint32 minduration = 2 [default = -1];

getMinduration

int getMinduration()

 Minimum video ad duration in seconds. 
 

optional sint32 minduration = 2 [default = -1];

hasMaxduration

boolean hasMaxduration()

 Maximum video ad duration in seconds. 
 

optional sint32 maxduration = 3 [default = -1];

getMaxduration

int getMaxduration()

 Maximum video ad duration in seconds. 
 

optional sint32 maxduration = 3 [default = -1];

hasProtocol

boolean hasProtocol()

 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. 
 

optional uint32 protocol = 4;

getProtocol

int getProtocol()

 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. 
 

optional uint32 protocol = 4;

getProtocolsList

List<Integer> getProtocolsList()

 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. 
 

repeated uint32 protocols = 5 [packed = true];

getProtocolsCount

int getProtocolsCount()

 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. 
 

repeated uint32 protocols = 5 [packed = true];

getProtocols

int getProtocols(int index)

 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. 
 

repeated uint32 protocols = 5 [packed = true];

hasW

boolean hasW()

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

optional uint32 w = 6;

getW

int getW()

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

optional uint32 w = 6;

hasH

boolean hasH()

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

optional uint32 h = 7;

getH

int getH()

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

optional uint32 h = 7;

hasStartdelay

boolean hasStartdelay()

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

optional sint32 startdelay = 8;

getStartdelay

int getStartdelay()

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

optional sint32 startdelay = 8;

hasLinearity

boolean hasLinearity()

 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. 
 

optional uint32 linearity = 9;

getLinearity

int getLinearity()

 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. 
 

optional uint32 linearity = 9;

hasSequence

boolean hasSequence()

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

optional uint32 sequence = 10 [default = 1];

getSequence

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. 
 

optional uint32 sequence = 10 [default = 1];

getBattrList

List<Integer> getBattrList()

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

repeated uint32 battr = 11 [packed = true];

getBattrCount

int getBattrCount()

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

repeated uint32 battr = 11 [packed = true];

getBattr

int getBattr(int index)

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

repeated uint32 battr = 11 [packed = true];

hasMaxextended

boolean hasMaxextended()

 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. 
 

optional sint32 maxextended = 12;

getMaxextended

int getMaxextended()

 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. 
 

optional sint32 maxextended = 12;

hasMinbitrate

boolean hasMinbitrate()

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

optional uint32 minbitrate = 13;

getMinbitrate

int getMinbitrate()

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

optional uint32 minbitrate = 13;

hasMaxbitrate

boolean hasMaxbitrate()

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

optional uint32 maxbitrate = 14;

getMaxbitrate

int getMaxbitrate()

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

optional uint32 maxbitrate = 14;

hasBoxingallowed

boolean hasBoxingallowed()

 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. 
 

optional uint32 boxingallowed = 15 [default = 1];

getBoxingallowed

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. 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. 
 

optional uint32 boxingallowed = 15 [default = 1];

getPlaybackmethodList

List<Integer> getPlaybackmethodList()

 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. 
 

repeated uint32 playbackmethod = 16 [packed = true];

getPlaybackmethodCount

int getPlaybackmethodCount()

 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. 
 

repeated uint32 playbackmethod = 16 [packed = true];

getPlaybackmethod

int getPlaybackmethod(int index)

 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. 
 

repeated uint32 playbackmethod = 16 [packed = true];

getDeliverymethodList

List<Integer> getDeliverymethodList()

 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. 
 

repeated uint32 deliverymethod = 17 [packed = true];

getDeliverymethodCount

int getDeliverymethodCount()

 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. 
 

repeated uint32 deliverymethod = 17 [packed = true];

getDeliverymethod

int getDeliverymethod(int index)

 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. 
 

repeated uint32 deliverymethod = 17 [packed = true];

hasPos

boolean hasPos()

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

optional uint32 pos = 18;

getPos

int getPos()

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

optional uint32 pos = 18;

getCompanionadList

List<OpenRtbProtobuf.Banner> getCompanionadList()

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

repeated .open_rtb.Banner companionad = 19;

getCompanionad

OpenRtbProtobuf.Banner getCompanionad(int index)

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

repeated .open_rtb.Banner companionad = 19;

getCompanionadCount

int getCompanionadCount()

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

repeated .open_rtb.Banner companionad = 19;

getCompanionadOrBuilderList

List<? extends OpenRtbProtobuf.BannerOrBuilder> getCompanionadOrBuilderList()

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

repeated .open_rtb.Banner companionad = 19;

getCompanionadOrBuilder

OpenRtbProtobuf.BannerOrBuilder getCompanionadOrBuilder(int index)

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

repeated .open_rtb.Banner companionad = 19;

getApiList

List<Integer> getApiList()

 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. 
 

repeated uint32 api = 20 [packed = true];

getApiCount

int getApiCount()

 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. 
 

repeated uint32 api = 20 [packed = true];

getApi

int getApi(int index)

 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. 
 

repeated uint32 api = 20 [packed = true];

getVastCompanionTypeList

List<Integer> getVastCompanionTypeList()

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

repeated uint32 vast_companion_type = 21 [packed = true];

getVastCompanionTypeCount

int getVastCompanionTypeCount()

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

repeated uint32 vast_companion_type = 21 [packed = true];

getVastCompanionType

int getVastCompanionType(int index)

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

repeated uint32 vast_companion_type = 21 [packed = true];