THEOplayer Web SDK
    Preparing search index...

    Interface GoogleImaAd

    Represents a Google IMA creative compliant to the VAST specification.


    - Available since v2.60.0.

    interface GoogleImaAd {
        adBreak: AdBreak;
        adSystem: undefined | string;
        apiFramework: undefined | string;
        bitrate: number;
        clickThrough: undefined | string;
        companions: CompanionAd[];
        contentType: undefined | string;
        creativeId: undefined | string;
        customData: unknown;
        description: undefined | string;
        duration: undefined | number;
        height: undefined | number;
        id: undefined | string;
        integration?: CustomAdIntegrationKind | AdIntegrationKind;
        isSlate: boolean;
        mediaUrl: undefined | string;
        readyState?: AdReadyState;
        resourceURI: undefined | string;
        skipOffset: undefined | number;
        title: undefined | string;
        traffickingParameters: undefined | { [parameterKey: string]: string };
        traffickingParametersString: undefined | string;
        type: AdType;
        universalAdIds: UniversalAdId[];
        width: undefined | number;
        wrapperAdIds: string[];
        wrapperAdSystems: string[];
        wrapperCreativeIds: string[];
    }

    Hierarchy (View Summary)

    • Ad
      • GoogleImaAd
    Index

    Properties

    adBreak adSystem apiFramework bitrate clickThrough companions contentType creativeId customData description duration height id integration? isSlate mediaUrl readyState? resourceURI skipOffset title traffickingParameters traffickingParametersString type universalAdIds width wrapperAdIds wrapperAdSystems wrapperCreativeIds

    Properties

    adBreak: AdBreak

    The ad break which the ad is part of.


    - Available for VAST-ads.

    adSystem: undefined | string

    The source ad server information included in the ad response.


    - Available when the Ad.readyState is 'ready'.

    apiFramework: undefined | string

    The identifier of the API framework needed to execute the ad.


    - Available when the Ad.readyState is 'ready'.
    - This corresponds with the apiFramework specified in vast.

    bitrate: number

    The bitrate of the currently playing creative as listed in the VAST response or 0.

    clickThrough: undefined | string

    The website of the advertisement.


    - Available when the Ad.readyState is 'ready'.

    companions: CompanionAd[]

    List of companions which can be displayed outside the player.


    - Available when the Ad.readyState is 'ready'.
    - Only supported for 'csai' and 'google-dai'.

    contentType: undefined | string

    The content type of the ad.


    - Available when the Ad.readyState is 'ready'.
    - For linear ads, the content type is only going to be available after the 'adbegin' event, when the media file is selected.

    creativeId: undefined | string

    The identifier of the selected creative for the ad.


    - Available when the Ad.readyState is 'ready'.

    customData: unknown

    Additional integration-specific data associated with this ad.

    description: undefined | string

    The description of the ad from the VAST response.


    - Available since 8.6.0.
    - Available for google-ima and google-dai integrations only.

    duration: undefined | number

    The duration of the ad, in seconds.


    - Available when the Ad.readyState is 'ready'.
    - Only available for LinearAd.

    height: undefined | number

    The height of the ad.


    - Available when the Ad.readyState is 'ready'.

    id: undefined | string

    The identifier of the creative.


    - Available when the Ad.readyState is 'ready'.

    integration?: CustomAdIntegrationKind | AdIntegrationKind

    The integration of the ad, represented by a value from AdIntegrationKind or the identifier of a custom integration added with Ads.registerServerSideIntegration.

    'csai'


    - The 'theo' integration naming is deprecated and has been replaced with 'csai'.

    isSlate: boolean

    Whether the ad is a slate or not.


    - Only used for THEOads ads.

    mediaUrl: undefined | string

    The url of the chosen media file.


    - Available when the Ad.readyState is 'ready'.

    readyState?: AdReadyState

    The ready state of the ad.

    resourceURI: undefined | string

    The URI of the ad content.


    - Available when the Ad.readyState is 'ready'.

    skipOffset: undefined | number

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


    - Available when the Ad.readyState is 'ready'.
    - If the offset is -1, the ad is unskippable.
    - If the offset is 0, the ad is immediately skippable.
    - Otherwise it must be a positive number indicating the offset.

    title: undefined | string

    Return title of the advertisement.


    - Available when the Ad.readyState is 'ready'.

    traffickingParameters: undefined | { [parameterKey: string]: string }

    Record of custom parameters for the ad at the time of ad trafficking. Each entry contains a parameter name with associated value.


    - Available when the Ad.readyState is 'ready'.

    traffickingParametersString: undefined | string

    The custom parameters for the ad at the time of ad trafficking, as a string.


    - A parsed version is available as GoogleImaAd.traffickingParameters.
    - Available when the Ad.readyState is 'ready'.

    type: AdType

    The type of the ad.

    universalAdIds: UniversalAdId[]

    The list of universal ad ID information of the selected creative for the ad.


    - Only supported for 'csai' and 'google-ima'.

    width: undefined | number

    The width of the ad, in pixels.


    - Available when the Ad.readyState is 'ready'.

    wrapperAdIds: string[]

    List of wrapper ad identifiers as specified in the VAST response.

    wrapperAdSystems: string[]

    List of wrapper ad systems as specified in the VAST response.

    wrapperCreativeIds: string[]

    List of wrapper creative identifiers.


    - Starts with the first wrapper ad.

    Settings

    Member Visibility

    On This Page

    Properties