fl-foundation/com.quickplay.vstb7.util/VASTAd

VASTAd

data class VASTAd(val title: String, val errorURI: String?, val impressionTrackingURLs: List<String>, val videoDuration: String?, val videoMediaFiles: List<VASTMediaFile>, val videoClickThroughURL: String?, val videoClickTrackingURLs: List<String>, val companions: List<VASTCompanion>, val vastAdTagURL: String?)

Representation of VAST document's element.

Constructors

VASTAd

constructor(title: String, errorURI: String?, impressionTrackingURLs: List<String>, videoDuration: String?, videoMediaFiles: List<VASTMediaFile>, videoClickThroughURL: String?, videoClickTrackingURLs: List<String>, companions: List<VASTCompanion>, vastAdTagURL: String?)

Properties

companions

val companions: List<VASTCompanion>

The container for one or more VASTCompanion elements, where each element provides the creative files and tracking details.

errorURI

val errorURI: String?

The A URI supplied by the ad server and used to report the no ad response.

impressionTrackingURLs

val impressionTrackingURLs: List<String>

The collection of impression-tracking URLs, where each URL directs the video player to a tracking resource file that the video player must use to notify the ad server when the impression occurs. NOTE: All URLs should be triggered at the same time when the impression for the ad occurs, or as close in time as possible to when the impression occurs, to prevent impression-counting discrepancies.

title

val title: String

The title for the ad.

vastAdTagURL

val vastAdTagURL: String?

The URI to a secondary VAST response. This secondary response may be another wrapper, but eventually a VAST wrapper must return an ad. In VAST 4.0 the player is only required to accept five wrappers ads. If no inline ads are returned after five wrappers, the player may move on to the next option.

videoClickThroughURL

val videoClickThroughURL: String?

The URL to the advertiser’s site that the video player opens when a viewer clicks the ad.

videoClickTrackingURLs

val videoClickTrackingURLs: List<String>

The collection of video-click-tracking URLs, and each collection element can be used in the case where multiple parties would like to track the linear ad click-through.

videoDuration

val videoDuration: String?

The intended playback videoDuration for the Linear component of the ad. Time value may be in the format HH:MM:SS.mmm where .mmm indicates milliseconds. Providing milliseconds is optional.

videoMediaFiles

val videoMediaFiles: List<VASTMediaFile>

The collection of VASTMediaFile.