THEOplayer > CompanionAd

CompanionAd interface

Represents a companion ad which is displayed near the video player.

Signature:

export interface CompanionAd 

Properties

Property	Type	Description
adSlotId (optional)	string	The identifier of the element in which the companion ad should be appended, if available.
altText	string	The alternative description for the ad.
clickThrough (optional)	string	The website of the advertisement.
contentHTML	string	The content of the ad, as HTML.
height	number	The height of the ad, in pixels.
resourceURI	string	The URI of the ad content as specified in the VAST file.
width	number	The width of the ad, in pixels.

Property Details

adSlotId

The identifier of the element in which the companion ad should be appended, if available.

Signature:

adSlotId?: string;

Remarks

Only available for Google DAI and THEO ads if provided in the VAST.

altText

The alternative description for the ad.

Signature:

altText: string;

Remarks

- Returns value as reported in the VAST StaticResource. If not specified, it returns an empty string.
- Returns an empty string for THEO ads if not available.
- Returns an empty string for Google IMA / Google DAI integrations.

clickThrough

The website of the advertisement.

Signature:

clickThrough?: string;

Remarks

- Only available for StaticResource if specified by the VAST. Otherwise returns an empty string.

contentHTML

The content of the ad, as HTML.

Signature:

contentHTML: string;

Remarks

- Available for StaticResource and HTMLResource in THEO ad system.
- Available in the DAI ad system.

height

The height of the ad, in pixels.

Signature:

height: number;

Remarks

- Only available for IMA ad system and THEO ad system.

resourceURI

The URI of the ad content as specified in the VAST file.

Signature:

resourceURI: string;

Remarks

- Only available in the THEO ad system for StaticResource. Otherwise returns an empty string.

width

The width of the ad, in pixels.

Signature:

width: number;

Remarks

- Only available for IMA ad system and THEO ad system.