Openrtb.BidRequest.Impression.VideoOrBuilder (Beeswax API 2017-03-16 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)` `repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 19;`
`int`	`getApiCount()` `repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 19;`
`List<OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework>`	`getApiList()` `repeated .openrtb.Enums.BidRequest.Impression.ApiFramework api = 19;`
`OpenrtbCommon.CreativeAttribute`	`getBattr(int index)` `repeated .openrtb.CreativeAttribute battr = 10;`
`int`	`getBattrCount()` `repeated .openrtb.CreativeAttribute battr = 10;`
`List<OpenrtbCommon.CreativeAttribute>`	`getBattrList()` `repeated .openrtb.CreativeAttribute battr = 10;`
`OpenrtbCommon.Flag`	`getBoxingallowed()` `optional .openrtb.Flag boxingallowed = 14 [default = YES];`
`Openrtb.BidRequest.Impression.Banner`	`getCompanionad(int index)` `repeated .openrtb.BidRequest.Impression.Banner companionad = 18;`
`int`	`getCompanionadCount()` `repeated .openrtb.BidRequest.Impression.Banner companionad = 18;`
`List<Openrtb.BidRequest.Impression.Banner>`	`getCompanionadList()` `repeated .openrtb.BidRequest.Impression.Banner companionad = 18;`
`Openrtb.BidRequest.Impression.BannerOrBuilder`	`getCompanionadOrBuilder(int index)` `repeated .openrtb.BidRequest.Impression.Banner companionad = 18;`
`List<? extends Openrtb.BidRequest.Impression.BannerOrBuilder>`	`getCompanionadOrBuilderList()` `repeated .openrtb.BidRequest.Impression.Banner companionad = 18;`
`OpenrtbCommon.Enums.BidRequest.Impression.Video.CompanionType`	`getCompaniontype(int index)` `repeated .openrtb.Enums.BidRequest.Impression.Video.CompanionType companiontype = 20;`
`int`	`getCompaniontypeCount()` `repeated .openrtb.Enums.BidRequest.Impression.Video.CompanionType companiontype = 20;`
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.CompanionType>`	`getCompaniontypeList()` `repeated .openrtb.Enums.BidRequest.Impression.Video.CompanionType companiontype = 20;`
`OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery`	`getDelivery(int index)` `repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;`
`int`	`getDeliveryCount()` `repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;`
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery>`	`getDeliveryList()` `repeated .openrtb.Enums.BidRequest.Impression.Video.ContentDelivery delivery = 16;`
`Extension.VideoExtensions`	`getExt()` `optional .openrtb.VideoExtensions ext = 1000;`
`Extension.VideoExtensionsOrBuilder`	`getExtOrBuilder()` `optional .openrtb.VideoExtensions ext = 1000;`
`int`	`getH()` `optional int32 h = 7;`
`OpenrtbCommon.Enums.BidRequest.Impression.Video.Linearity`	`getLinearity()` `optional .openrtb.Enums.BidRequest.Impression.Video.Linearity linearity = 2 [default = LINEAR];`
`int`	`getMaxbitrate()` `optional int32 maxbitrate = 13;`
`int`	`getMaxduration()` `optional int32 maxduration = 4;`
`int`	`getMaxextended()` `optional int32 maxextended = 11 [default = 0];`
`String`	`getMimes(int index)` `repeated string mimes = 1;`
`com.google.protobuf.ByteString`	`getMimesBytes(int index)` `repeated string mimes = 1;`
`int`	`getMimesCount()` `repeated string mimes = 1;`
`com.google.protobuf.ProtocolStringList`	`getMimesList()` `repeated string mimes = 1;`
`int`	`getMinbitrate()` `optional int32 minbitrate = 12;`
`int`	`getMinduration()` `optional int32 minduration = 3;`
`OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod`	`getPlaybackmethod(int index)` `repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;`
`int`	`getPlaybackmethodCount()` `repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;`
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod>`	`getPlaybackmethodList()` `repeated .openrtb.Enums.BidRequest.Impression.Video.PlaybackMethod playbackmethod = 15;`
`OpenrtbCommon.Enums.BidRequest.Impression.AdPosition`	`getPos()` `optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 17 [default = POSITION_UNKNOWN];`
`OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol`	`getProtocols(int index)` `repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;`
`int`	`getProtocolsCount()` `repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;`
`List<OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol>`	`getProtocolsList()` `repeated .openrtb.Enums.BidRequest.Impression.Video.Protocol protocols = 5;`
`int`	`getSequence()` `optional int32 sequence = 9 [default = 1];`
`int`	`getStartdelay()` `optional int32 startdelay = 8 [default = -3];`
`int`	`getW()` `optional int32 w = 6;`
`boolean`	`hasBoxingallowed()` `optional .openrtb.Flag boxingallowed = 14 [default = YES];`
`boolean`	`hasExt()` `optional .openrtb.VideoExtensions ext = 1000;`
`boolean`	`hasH()` `optional int32 h = 7;`
`boolean`	`hasLinearity()` `optional .openrtb.Enums.BidRequest.Impression.Video.Linearity linearity = 2 [default = LINEAR];`
`boolean`	`hasMaxbitrate()` `optional int32 maxbitrate = 13;`
`boolean`	`hasMaxduration()` `optional int32 maxduration = 4;`
`boolean`	`hasMaxextended()` `optional int32 maxextended = 11 [default = 0];`
`boolean`	`hasMinbitrate()` `optional int32 minbitrate = 12;`
`boolean`	`hasMinduration()` `optional int32 minduration = 3;`
`boolean`	`hasPos()` `optional .openrtb.Enums.BidRequest.Impression.AdPosition pos = 17 [default = POSITION_UNKNOWN];`
`boolean`	`hasSequence()` `optional int32 sequence = 9 [default = 1];`
`boolean`	`hasStartdelay()` `optional int32 startdelay = 8 [default = -3];`
`boolean`	`hasW()` `optional int32 w = 6;`

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

com.google.protobuf.ProtocolStringList getMimesList()

repeated string mimes = 1;

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

getMimesCount

int getMimesCount()

repeated string mimes = 1;

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

getMimes

String getMimes(int index)

repeated string mimes = 1;

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

getMimesBytes

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

repeated string mimes = 1;

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

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

getLinearity

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

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

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

hasMinduration

boolean hasMinduration()

optional int32 minduration = 3;

 Minimum video ad duration in seconds.

getMinduration

int getMinduration()

optional int32 minduration = 3;

 Minimum video ad duration in seconds.

hasMaxduration

boolean hasMaxduration()

optional int32 maxduration = 4;

 Maximum video ad duration in seconds.

getMaxduration

int getMaxduration()

optional int32 maxduration = 4;

 Maximum video ad duration in seconds.

getProtocolsList

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

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

 Video bid response protocols.

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

getProtocols

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

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

 Video bid response protocols.

hasW

boolean hasW()

optional int32 w = 6;

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

getW

int getW()

optional int32 w = 6;

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

hasH

boolean hasH()

optional int32 h = 7;

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

getH

int getH()

optional int32 h = 7;

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

hasStartdelay

boolean hasStartdelay()

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

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

getStartdelay

int getStartdelay()

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

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

hasSequence

boolean hasSequence()

optional int32 sequence = 9 [default = 1];

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

getSequence

int getSequence()

optional int32 sequence = 9 [default = 1];

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

getBattrList

List<OpenrtbCommon.CreativeAttribute> getBattrList()

repeated .openrtb.CreativeAttribute battr = 10;

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

getBattrCount

int getBattrCount()

repeated .openrtb.CreativeAttribute battr = 10;

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

getBattr

OpenrtbCommon.CreativeAttribute getBattr(int index)

repeated .openrtb.CreativeAttribute battr = 10;

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

hasMaxextended

boolean hasMaxextended()

optional int32 maxextended = 11 [default = 0];

 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.

getMaxextended

int getMaxextended()

optional int32 maxextended = 11 [default = 0];

 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.

hasMinbitrate

boolean hasMinbitrate()

optional int32 minbitrate = 12;

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

getMinbitrate

int getMinbitrate()

optional int32 minbitrate = 12;

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

hasMaxbitrate

boolean hasMaxbitrate()

optional int32 maxbitrate = 13;

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

getMaxbitrate

int getMaxbitrate()

optional int32 maxbitrate = 13;

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

hasBoxingallowed

boolean hasBoxingallowed()

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

 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.

getBoxingallowed

OpenrtbCommon.Flag getBoxingallowed()

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

 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.

getPlaybackmethodList

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

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

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

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

getPlaybackmethod

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

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

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

getDeliveryList

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

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

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

getDeliveryCount

int getDeliveryCount()

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

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

getDelivery

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

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

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

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

getPos

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

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

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