Version: 2.67.0

Ad

THEOplayer > Ad

Ad interface

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

Signature:
export interface Ad

Properties

Property

Type

Description

adBreak

AdBreak

The ad break which the ad is part of.

clickThrough

string | undefined

The website of the advertisement.

companions

CompanionAd

List of companions which can be displayed outside the player.

duration (optional)

number

The duration of the ad, in seconds.

height

number | undefined

The height of the ad.

id

string | undefined

The identifier of the creative.

integration (optional)

string

The integration of the ad, represented by a value from the following list:
- 'theo'
- 'google-ima'
- 'google-dai'
- 'freewheel'

readyState (optional)

AdReadyState

The ready state of the ad.

resourceURI (optional)

string

The URI of the the ad content.

skipOffset

number | undefined

Offset after which the ad break may be skipped, in seconds.

type

string

The type of the ad, represented by a value from the following list:
- 'linear'
- 'nonlinear'

width

number | undefined

The width of the ad, in pixels.