THEOplayer Web SDK
    Preparing search index...

    Interface CompanionAd

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

    interface CompanionAd {
        adSlotId?: string;
        altText: string;
        clickThrough?: string;
        contentHTML: string;
        height: number;
        resourceURI: string;
        width: number;
    }
    Index

    Properties

    adSlotId? altText clickThrough? contentHTML height resourceURI width

    Properties

    adSlotId?: string

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


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

    altText: string

    The alternative description for the ad.


    - 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?: string

    The website of the advertisement.


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

    contentHTML: string

    The content of the ad, as HTML.


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

    height: number

    The height of the ad, in pixels.


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

    resourceURI: string

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


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

    width: number

    The width of the ad, in pixels.


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

    Settings

    Member Visibility

    On This Page

    Properties