nimbus-android/com.adsbynimbus.openrtb.request/Video

Video

@Serializable
class Video(var bidfloor: Float = 0.0f, var mimes: Array<String>? = null, var minduration: Int = 0, var maxduration: Int = 60, var protocols: ByteArray? = null, var w: Int = 0, var h: Int = 0, var startdelay: Int = 0, var placement: Byte = 0, var linearity: Byte = 0, var skip: Byte = 0, var delivery: ByteArray? = null, var skipmin: Int = 0, var skipafter: Int = 0, var minbitrate: Int = 0, var maxbitrate: Int = 0, var pos: Byte = 0, var playbackmethod: ByteArray? = null, var api: ByteArray? = null, var companionad: Array<Banner>? = null, var companiontype: ByteArray? = null, var ext: MutableMap<String, Byte> = mutableMapOf( "is_rewarded" to 0 ))

This object represents an in-stream video impression.

Many of the fields are non-essential for minimally viable transactions, but are included to offer fine control when needed. Video in OpenRTB generally assumes compliance with the VAST standard. As such, the notion of companion ads is supported by optionally including an array of Banner objects that define these companion ads. The presence of a Video as a subordinate of the Impression object indicates that this impression is offered as a video type impression. At the publisher’s discretion, that same impression may also be offered as banner, audio, and/or native by also including as Imp subordinates objects of those types. However, any given bid for the impression must conform to one of the offered types.

OpenRTB Section 3.2.7

Constructors

Link copied to clipboard
constructor(bidfloor: Float = 0.0f, mimes: Array<String>? = null, minduration: Int = 0, maxduration: Int = 60, protocols: ByteArray? = null, w: Int = 0, h: Int = 0, startdelay: Int = 0, placement: Byte = 0, linearity: Byte = 0, skip: Byte = 0, delivery: ByteArray? = null, skipmin: Int = 0, skipafter: Int = 0, minbitrate: Int = 0, maxbitrate: Int = 0, pos: Byte = 0, playbackmethod: ByteArray? = null, api: ByteArray? = null, companionad: Array<Banner>? = null, companiontype: ByteArray? = null, ext: MutableMap<String, Byte> = mutableMapOf( "is_rewarded" to 0 ))

Properties

Link copied to clipboard
@JvmField
var api: ByteArray?

Set of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported.

Link copied to clipboard
@JvmField
var bidfloor: Float

Minimum bid for this video impression expressed in CPM.

Link copied to clipboard
@JvmField
var companionad: Array<Banner>?

Array of Banner objects if companion ads are available

Link copied to clipboard
@JvmField
var companiontype: ByteArray?

Supported VAST companion ad types. Recommended if requesting companion ads.

Link copied to clipboard
@JvmField
var delivery: ByteArray?

Supported delivery methods; if none specified, assume all are supported.

Link copied to clipboard
@JvmField
var ext: MutableMap<String, Byte>

Video extensions

Link copied to clipboard
@JvmField
var h: Int

Height of the video player in device independent pixels (DIPS).

Link copied to clipboard
var is_rewarded: Byte

Indicates this video request is for a rewarded video

Link copied to clipboard
@JvmField
var linearity: Byte

Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.

Link copied to clipboard
@JvmField
var maxbitrate: Int

Maximum bit rate in Kbps.

Link copied to clipboard
@JvmField
var maxduration: Int

Maximum video ad duration in seconds.

Link copied to clipboard
@JvmField
var mimes: Array<String>?

Content MIME types supported (e.g., "video/3gp", "video/mp4").

Link copied to clipboard
@JvmField
var minbitrate: Int

Minimum bit rate in Kbps.

Link copied to clipboard
@JvmField
var minduration: Int

Minimum video ad duration in seconds.

Link copied to clipboard
@JvmField
var placement: Byte

Placement type for this video impression

Link copied to clipboard
@JvmField
var playbackmethod: ByteArray?

The event that causes playback to start

Link copied to clipboard
@JvmField
var pos: Byte

Ad position on screen.

Link copied to clipboard
@JvmField
var protocols: ByteArray?

Set of supported video protocols

Link copied to clipboard
@JvmField
var skip: Byte

Indicates if the player will allow the video to be skipped. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of CreativeAttribute.HAS_SKIP_BUTTON indicating skippable video. Refer to CreativeAttribute. 0 = no 1 = yes.

Link copied to clipboard
@JvmField
var skipafter: Int

Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.

Link copied to clipboard
@JvmField
var skipmin: Int

Videos of total duration greater than this number of seconds can be skippable. Only applicable if the ad is skippable.

Link copied to clipboard
@JvmField
var startdelay: Int

Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. >0: Mid roll where the value indicates the start delay 0: pre roll -1: generic mid roll -2: generic post roll

Link copied to clipboard
@JvmField
var w: Int

Width of the video player in device independent pixels (DIPS).