-
public final class Video
-
-
Field Summary
Fields Modifier and Type Field Description private List<String>minesprivate IntegerminDurationprivate IntegermaxDurationprivate List<Integer>protocolsprivate Integerwidthprivate Integerheightprivate IntegerstartDelayprivate Integerplacementprivate Integerlinearityprivate Integerskipprivate IntegerskipMinprivate IntegerskipAfterprivate Integersequenceprivate Array<CreativeAttribute>attributesprivate IntegermaxExtendedprivate IntegerminBitrateprivate IntegermaxBitrateprivate IntegerboxingAllowedprivate Array<Integer>playbackMethodprivate IntegerplaybackEndprivate Array<DeliveryMethod>deliveryMethodprivate AdPositionpositionprivate Array<Banner>companionAdsprivate Array<ApiFramework>apisprivate Array<CompanionType>companionTypesprivate Integerloopprivate Objectextension
-
Constructor Summary
Constructors Constructor Description Video()
-
Method Summary
Modifier and Type Method Description final List<String>getMines()Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”). final UnitsetMines(@SerializedName(value = mimes) List<String> mines)Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”). final IntegergetMinDuration()Minimum video ad duration in seconds. final UnitsetMinDuration(@SerializedName(value = minduration) Integer minDuration)Minimum video ad duration in seconds. final IntegergetMaxDuration()Maximum video ad duration in seconds. final UnitsetMaxDuration(@SerializedName(value = maxduration) Integer maxDuration)Maximum video ad duration in seconds. final List<Integer>getProtocols()Array of supported video Protocol. final UnitsetProtocols(@SerializedName(value = protocols) List<Integer> protocols)Array of supported video Protocol. final IntegergetWidth()Width of the video player in device independent pixels (DIPS). final UnitsetWidth(@SerializedName(value = w) Integer width)Width of the video player in device independent pixels (DIPS). final IntegergetHeight()Height of the video player in device independent pixels (DIPS). final UnitsetHeight(@SerializedName(value = h) Integer height)Height of the video player in device independent pixels (DIPS). final IntegergetStartDelay()Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. final UnitsetStartDelay(@SerializedName(value = startdelay) Integer startDelay)Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. final IntegergetPlacement()VideoPlacement type for the impression. final UnitsetPlacement(@SerializedName(value = placement) Integer placement)VideoPlacement type for the impression. final IntegergetLinearity()Indicates if the impression must be linear, nonlinear, etc. final UnitsetLinearity(@SerializedName(value = linearity) Integer linearity)Indicates if the impression must be linear, nonlinear, etc. final IntegergetSkip()Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. final UnitsetSkip(@SerializedName(value = skip) Integer skip)Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. final IntegergetSkipMin()Videos of total duration greater than this number of seconds can be skip-able; only applicable if the ad is skip-able. final UnitsetSkipMin(@SerializedName(value = skipmin) Integer skipMin)Videos of total duration greater than this number of seconds can be skip-able; only applicable if the ad is skip-able. final IntegergetSkipAfter()Number of seconds a video must play before skipping is enabled; only applicable if the ad is skip-able. final UnitsetSkipAfter(@SerializedName(value = skipafter) Integer skipAfter)Number of seconds a video must play before skipping is enabled; only applicable if the ad is skip-able. final IntegergetSequence()If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives. final UnitsetSequence(@SerializedName(value = sequence) Integer sequence)If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives. final Array<CreativeAttribute>getAttributes()Blocked creative attributes. final UnitsetAttributes(@SerializedName(value = battr) Array<CreativeAttribute> attributes)Blocked creative attributes. final IntegergetMaxExtended()Maximum extended ad duration if extension is allowed. final UnitsetMaxExtended(@SerializedName(value = maxextended) Integer maxExtended)Maximum extended ad duration if extension is allowed. final IntegergetMinBitrate()Minimum bit rate in Kbps. final UnitsetMinBitrate(@SerializedName(value = minbitrate) Integer minBitrate)Minimum bit rate in Kbps. final IntegergetMaxBitrate()Maximum bit rate in Kbps. final UnitsetMaxBitrate(@SerializedName(value = maxbitrate) Integer maxBitrate)Maximum bit rate in Kbps. final IntegergetBoxingAllowed()Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes. final UnitsetBoxingAllowed(@SerializedName(value = boxingallowed) Integer boxingAllowed)Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes. final Array<Integer>getPlaybackMethod()PlaybackMethod that may be in use. final UnitsetPlaybackMethod(@SerializedName(value = playbackmethod) Array<Integer> playbackMethod)PlaybackMethod that may be in use. final IntegergetPlaybackEnd()The event that causes playback to end. final UnitsetPlaybackEnd(@SerializedName(value = playbackend) Integer playbackEnd)The event that causes playback to end. final Array<DeliveryMethod>getDeliveryMethod()Supported delivery methods (e.g., streaming, progressive). final UnitsetDeliveryMethod(@SerializedName(value = delivery) Array<DeliveryMethod> deliveryMethod)Supported delivery methods (e.g., streaming, progressive). final AdPositiongetPosition()Ad position on screen. final UnitsetPosition(@SerializedName(value = pos) AdPosition position)Ad position on screen. final Array<Banner>getCompanionAds()Array of Banner objects if companion ads are available. final UnitsetCompanionAds(@SerializedName(value = companionad) Array<Banner> companionAds)Array of Banner objects if companion ads are available. final Array<ApiFramework>getApis()List of supported ApiFramework for this impression. final UnitsetApis(@SerializedName(value = api) Array<ApiFramework> apis)List of supported ApiFramework for this impression. final Array<CompanionType>getCompanionTypes()Supported VAST companion ad types. final UnitsetCompanionTypes(@SerializedName(value = companiontype) Array<CompanionType> companionTypes)Supported VAST companion ad types. final IntegergetLoop()final UnitsetLoop(@SerializedName(value = loop) Integer loop)final ObjectgetExtension()Placeholder for exchange-specific extensions to OpenRTB. final UnitsetExtension(@SerializedName(value = ext) Object extension)Placeholder for exchange-specific extensions to OpenRTB. -
-
Method Detail
-
getMines
final List<String> getMines()
Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”).
-
setMines
final Unit setMines(@SerializedName(value = mimes) List<String> mines)
Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”).
-
getMinDuration
final Integer getMinDuration()
Minimum video ad duration in seconds.
-
setMinDuration
final Unit setMinDuration(@SerializedName(value = minduration) Integer minDuration)
Minimum video ad duration in seconds.
-
getMaxDuration
final Integer getMaxDuration()
Maximum video ad duration in seconds.
-
setMaxDuration
final Unit setMaxDuration(@SerializedName(value = maxduration) Integer maxDuration)
Maximum video ad duration in seconds.
-
getProtocols
final List<Integer> getProtocols()
Array of supported video Protocol. At least one supported protocol must be specified in either the protocol or protocols attribute.
-
setProtocols
final Unit setProtocols(@SerializedName(value = protocols) List<Integer> protocols)
Array of supported video Protocol. At least one supported protocol must be specified in either the protocol or protocols attribute.
-
setWidth
final Unit setWidth(@SerializedName(value = w) Integer width)
Width of the video player in device independent pixels (DIPS).
-
setHeight
final Unit setHeight(@SerializedName(value = h) Integer height)
Height of the video player in device independent pixels (DIPS).
-
getStartDelay
final Integer getStartDelay()
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.
-
setStartDelay
final Unit setStartDelay(@SerializedName(value = startdelay) Integer startDelay)
Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.
-
getPlacement
final Integer getPlacement()
VideoPlacement type for the impression.
-
setPlacement
final Unit setPlacement(@SerializedName(value = placement) Integer placement)
VideoPlacement type for the impression.
-
getLinearity
final Integer getLinearity()
Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.
-
setLinearity
final Unit setLinearity(@SerializedName(value = linearity) Integer linearity)
Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.
-
getSkip
final Integer getSkip()
Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. If a bidder sends markup/creative that is itself skip-able, the Bid object should include the attr array with an element of 16 indicating skip-able video.
-
setSkip
final Unit setSkip(@SerializedName(value = skip) Integer skip)
Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. If a bidder sends markup/creative that is itself skip-able, the Bid object should include the attr array with an element of 16 indicating skip-able video.
-
getSkipMin
final Integer getSkipMin()
Videos of total duration greater than this number of seconds can be skip-able; only applicable if the ad is skip-able.
-
setSkipMin
final Unit setSkipMin(@SerializedName(value = skipmin) Integer skipMin)
Videos of total duration greater than this number of seconds can be skip-able; only applicable if the ad is skip-able.
-
getSkipAfter
final Integer getSkipAfter()
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skip-able.
-
setSkipAfter
final Unit setSkipAfter(@SerializedName(value = skipafter) Integer skipAfter)
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skip-able.
-
getSequence
final Integer getSequence()
If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
-
setSequence
final Unit setSequence(@SerializedName(value = sequence) Integer sequence)
If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
-
getAttributes
final Array<CreativeAttribute> getAttributes()
Blocked creative attributes.
-
setAttributes
final Unit setAttributes(@SerializedName(value = battr) Array<CreativeAttribute> attributes)
Blocked creative attributes.
-
getMaxExtended
final Integer getMaxExtended()
Maximum extended 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.
-
setMaxExtended
final Unit setMaxExtended(@SerializedName(value = maxextended) Integer maxExtended)
Maximum extended 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.
-
getMinBitrate
final Integer getMinBitrate()
Minimum bit rate in Kbps.
-
setMinBitrate
final Unit setMinBitrate(@SerializedName(value = minbitrate) Integer minBitrate)
Minimum bit rate in Kbps.
-
getMaxBitrate
final Integer getMaxBitrate()
Maximum bit rate in Kbps.
-
setMaxBitrate
final Unit setMaxBitrate(@SerializedName(value = maxbitrate) Integer maxBitrate)
Maximum bit rate in Kbps.
-
getBoxingAllowed
final Integer getBoxingAllowed()
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.
-
setBoxingAllowed
final Unit setBoxingAllowed(@SerializedName(value = boxingallowed) Integer boxingAllowed)
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.
-
getPlaybackMethod
final Array<Integer> getPlaybackMethod()
PlaybackMethod that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.
-
setPlaybackMethod
final Unit setPlaybackMethod(@SerializedName(value = playbackmethod) Array<Integer> playbackMethod)
PlaybackMethod that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.
-
getPlaybackEnd
final Integer getPlaybackEnd()
The event that causes playback to end.
-
setPlaybackEnd
final Unit setPlaybackEnd(@SerializedName(value = playbackend) Integer playbackEnd)
The event that causes playback to end.
-
getDeliveryMethod
final Array<DeliveryMethod> getDeliveryMethod()
Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported.
-
setDeliveryMethod
final Unit setDeliveryMethod(@SerializedName(value = delivery) Array<DeliveryMethod> deliveryMethod)
Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported.
-
getPosition
final AdPosition getPosition()
Ad position on screen.
-
setPosition
final Unit setPosition(@SerializedName(value = pos) AdPosition position)
Ad position on screen.
-
getCompanionAds
final Array<Banner> getCompanionAds()
Array of Banner objects if companion ads are available.
-
setCompanionAds
final Unit setCompanionAds(@SerializedName(value = companionad) Array<Banner> companionAds)
Array of Banner objects if companion ads are available.
-
getApis
final Array<ApiFramework> getApis()
List of supported ApiFramework for this impression. If an API is not explicitly listed, it is assumed not to be supported.
-
setApis
final Unit setApis(@SerializedName(value = api) Array<ApiFramework> apis)
List of supported ApiFramework for this impression. If an API is not explicitly listed, it is assumed not to be supported.
-
getCompanionTypes
final Array<CompanionType> getCompanionTypes()
Supported VAST companion ad types. Recommended if companion Banner objects are included via the companionAds. If one of these banners will be rendered as an end-card, this can be specified using the Banner.videoCompanion attribute with the particular banner.
-
setCompanionTypes
final Unit setCompanionTypes(@SerializedName(value = companiontype) Array<CompanionType> companionTypes)
Supported VAST companion ad types. Recommended if companion Banner objects are included via the companionAds. If one of these banners will be rendered as an end-card, this can be specified using the Banner.videoCompanion attribute with the particular banner.
-
getExtension
final Object getExtension()
Placeholder for exchange-specific extensions to OpenRTB.
-
setExtension
final Unit setExtension(@SerializedName(value = ext) Object extension)
Placeholder for exchange-specific extensions to OpenRTB.
-
-
-
-