Version: 2.69.0

Ad

THEOplayer > Ad

Ad interface

Represents a VAST creative. It is either a linear or non-linear ad.

Signature:
export interface Ad

Properties

PropertyTypeDescription
adBreakAdBreakThe ad break which the ad is part of.
clickThroughstring | undefinedThe website of the advertisement.
companionsCompanionAd[]List of companions which can be displayed outside the player.
durationnumberThe duration of the ad, in seconds.
heightnumber | undefinedThe height of the ad.
idstring | undefinedThe identifier of the creative.
integrationstringThe integration of the ad, represented by a value from the following list:
- 'theo'
- 'google-ima'
- 'google-dai'
- 'freewheel'
readyStateAdReadyStateThe ready state of the ad.
resourceURIstringThe URI of the the ad content.
skipOffsetnumber | undefinedOffset after which the ad break may be skipped, in seconds.
typestringThe type of the ad, represented by a value from the following list:
- 'linear'
- 'nonlinear'
widthnumber | undefinedThe width of the ad, in pixels.