Openrtb.BidRequest.Impression.VideoOrBuilder (Beeswax API 2017-02-13 API)

All Superinterfaces:

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

All Known Implementing Classes:

Openrtb.BidRequest.Impression.Video, Openrtb.BidRequest.Impression.Video.Builder

Enclosing class:

Openrtb.BidRequest.Impression
```
public static interface Openrtb.BidRequest.Impression.VideoOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework`	`getApi(int index)` List of supported API frameworks for this banner.
`int`	`getApiCount()` List of supported API frameworks for this banner.
`List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>`	`getApiList()` List of supported API frameworks for this banner.
`OpenrtbCommon.CreativeAttribute`	`getBattr(int index)` Blocked creative attributes.
`int`	`getBattrCount()` Blocked creative attributes.
`List<OpenrtbCommon.CreativeAttribute>`	`getBattrList()` Blocked creative attributes.
`OpenrtbCommon.Flag`	`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.
`Openrtb.BidRequest.Impression.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<Openrtb.BidRequest.Impression.Banner>`	`getCompanionadList()` If companion ads are available, they can be listed as an array of banner objects.
`Openrtb.BidRequest.Impression.BannerOrBuilder`	`getCompanionadOrBuilder(int index)` If companion ads are available, they can be listed as an array of banner objects.
`List<? extends Openrtb.BidRequest.Impression.BannerOrBuilder>`	`getCompanionadOrBuilderList()` If companion ads are available, they can be listed as an array of banner objects.
`OpenrtbCommon.Enums.BidRequest.Impression.Video.CompanionType`	`getCompaniontype(int index)` Recommended if companion objects are included.
`int`	`getCompaniontypeCount()` Recommended if companion objects are included.
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.CompanionType>`	`getCompaniontypeList()` Recommended if companion objects are included.
`OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery`	`getDelivery(int index)` List of supported delivery methods.
`int`	`getDeliveryCount()` List of supported delivery methods.
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery>`	`getDeliveryList()` List of supported delivery methods.
`Extension.VideoExtensions`	`getExt()` `optional .openrtb.VideoExtensions ext = 1000;`
`Extension.VideoExtensionsOrBuilder`	`getExtOrBuilder()` `optional .openrtb.VideoExtensions ext = 1000;`
`int`	`getH()` Height of the player in pixels.
`OpenrtbCommon.Enums.BidRequest.Impression.Video.Linearity`	`getLinearity()` Indicates whether the ad impression is linear or non-linear.
`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)` Whitelist of content MIME types supported.
`com.google.protobuf.ByteString`	`getMimesBytes(int index)` Whitelist of content MIME types supported.
`int`	`getMimesCount()` Whitelist of content MIME types supported.
`List<String>`	`getMimesList()` Whitelist of content MIME types supported.
`int`	`getMinbitrate()` Minimum bit rate in Kbps.
`int`	`getMinduration()` Minimum video ad duration in seconds.
`OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod`	`getPlaybackmethod(int index)` List of allowed playback methods.
`int`	`getPlaybackmethodCount()` List of allowed playback methods.
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod>`	`getPlaybackmethodList()` List of allowed playback methods.
`OpenrtbCommon.Enums.BidRequest.Impression.AdPosition`	`getPos()` The position of the ad as a relative measure of visibility or prominence.
`OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol`	`getProtocols(int index)` Video bid response protocols.
`int`	`getProtocolsCount()` Video bid response protocols.
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol>`	`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`	`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`	`hasExt()` `optional .openrtb.VideoExtensions ext = 1000;`
`boolean`	`hasH()` Height of the player in pixels.
`boolean`	`hasLinearity()` Indicates whether the ad impression is linear or non-linear.
`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()` The position of the ad as a relative measure of visibility or prominence.
`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()

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

repeated string mimes = 1;

getMimesCount

int getMimesCount()

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

repeated string mimes = 1;

getMimes

String getMimes(int index)

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

repeated string mimes = 1;

getMimesBytes

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

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

repeated string mimes = 1;

hasLinearity
```
boolean hasLinearity()
```
```
 Indicates whether the ad impression is linear or non-linear.
 
```
optional .openrtb.Enums.BidRequest.Impression.Video.Linearity linearity = 2 [default = LINEAR];

getLinearity

OpenrtbCommon.Enums.BidRequest.Impression.Video.Linearity getLinearity()

 Indicates whether the ad impression is linear or non-linear.

optional .openrtb.Enums.BidRequest.Impression.Video.Linearity linearity = 2 [default = LINEAR];

hasMinduration

boolean hasMinduration()

 Minimum video ad duration in seconds.

optional int32 minduration = 3;

getMinduration

int getMinduration()

 Minimum video ad duration in seconds.

optional int32 minduration = 3;

hasMaxduration

boolean hasMaxduration()

 Maximum video ad duration in seconds.

optional int32 maxduration = 4;

getMaxduration

int getMaxduration()

 Maximum video ad duration in seconds.

optional int32 maxduration = 4;

getProtocolsList

List<OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol> getProtocolsList()

 Video bid response protocols.

repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;

getProtocolsCount
```
int getProtocolsCount()
```
```
 Video bid response protocols.
 
```
repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;

getProtocols

OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol getProtocols(int index)

 Video bid response protocols.

repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;

hasW

boolean hasW()

 Width of the player in pixels. This field is not required, but it’s highly recommended.

optional int32 w = 6;

getW

int getW()

 Width of the player in pixels. This field is not required, but it’s highly recommended.

optional int32 w = 6;

hasH

boolean hasH()

 Height of the player in pixels. This field is not required, but it’s highly recommended.

optional int32 h = 7;

getH

int getH()

 Height of the player in pixels. This field is not required, but it’s highly recommended.

optional int32 h = 7;

hasStartdelay

boolean hasStartdelay()

 Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.
 Check the enum VideoStartDelay for special values.

optional int32 startdelay = 8 [default = -3];

getStartdelay

int getStartdelay()

 Indicates the start delay in seconds for preroll, midroll, or postroll ad placement.
 Check the enum VideoStartDelay for special values.

optional int32 startdelay = 8 [default = -3];

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 int32 sequence = 9 [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 int32 sequence = 9 [default = 1];

getBattrList

List<OpenrtbCommon.CreativeAttribute> getBattrList()

 Blocked creative attributes. If blank assume all types are allowed.

repeated .openrtb.CreativeAttribute battr = 10;

getBattrCount

int getBattrCount()

 Blocked creative attributes. If blank assume all types are allowed.

repeated .openrtb.CreativeAttribute battr = 10;

getBattr

OpenrtbCommon.CreativeAttribute getBattr(int index)

 Blocked creative attributes. If blank assume all types are allowed.

repeated .openrtb.CreativeAttribute battr = 10;

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 int32 maxextended = 11 [default = 0];

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 int32 maxextended = 11 [default = 0];

hasMinbitrate

boolean hasMinbitrate()

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

optional int32 minbitrate = 12;

getMinbitrate

int getMinbitrate()

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

optional int32 minbitrate = 12;

hasMaxbitrate

boolean hasMaxbitrate()

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

optional int32 maxbitrate = 13;

getMaxbitrate

int getMaxbitrate()

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

optional int32 maxbitrate = 13;

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.

optional .openrtb.Flag boxingallowed = 14 [default = YES];

getBoxingallowed

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

optional .openrtb.Flag boxingallowed = 14 [default = YES];

getPlaybackmethodList

List<OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod> getPlaybackmethodList()

 List of allowed playback methods. If blank, assume that all are allowed.

repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;

getPlaybackmethodCount
```
int getPlaybackmethodCount()
```
```
 List of allowed playback methods. If blank, assume that all are allowed.
 
```
repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;

getPlaybackmethod

OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod getPlaybackmethod(int index)

 List of allowed playback methods. If blank, assume that all are allowed.

repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;

getDeliveryList

List<OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery> getDeliveryList()

 List of supported delivery methods. If blank, assume all are supported.

repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;

getDeliveryCount

int getDeliveryCount()

 List of supported delivery methods. If blank, assume all are supported.

repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;

getDelivery

OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery getDelivery(int index)

 List of supported delivery methods. If blank, assume all are supported.

repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;

hasPos
```
boolean hasPos()
```
```
 The position of the ad as a relative measure of visibility or prominence.
 
```
optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 17 [default = POSITION_UNKNOWN];

getPos

OpenrtbCommon.Enums.BidRequest.Impression.AdPosition getPos()

 The position of the ad as a relative measure of visibility or prominence.

optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 17 [default = POSITION_UNKNOWN];