logo

THEOplayer > GoogleImaAd

GoogleImaAd interface

Inherits from Ad . See parent page for inherited properties and methods.

Represents a Google IMA creative compliant to the VAST specification.

Signature:

export interface GoogleImaAd extends Ad 

Remarks


- Available since v2.60.0.

Properties

Property

Type

Description

adSystem

string | undefined

The source ad server information included in the ad response.

apiFramework

string | undefined

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

bitrate

number

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

contentType

string | undefined

The content type of the ad.

creativeId

string | undefined

The identifier of the selected creative for the ad.

mediaUrl

string | undefined

The url of the chosen media file.

title

string | undefined

Return title of the advertisement.

traffickingParameters

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

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

traffickingParametersString

string | undefined

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

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.

Property Details

adSystem

The source ad server information included in the ad response.

Signature:

adSystem: string | undefined;

Remarks


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

apiFramework

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

Signature:

apiFramework: string | undefined;

Remarks


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

bitrate

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

Signature:

readonly bitrate: number;

contentType

The content type of the ad.

Signature:

contentType: string | undefined;

Remarks


- 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

The identifier of the selected creative for the ad.

Signature:

creativeId: string | undefined;

Remarks


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

mediaUrl

The url of the chosen media file.

Signature:

mediaUrl: string | undefined;

Remarks


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

title

Return title of the advertisement.

Signature:

title: string | undefined;

Remarks


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

traffickingParameters

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

Signature:

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

Remarks


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

traffickingParametersString

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

Signature:

traffickingParametersString: string | undefined;

Remarks


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

wrapperAdIds

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

Signature:

wrapperAdIds: string[];

wrapperAdSystems

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

Signature:

wrapperAdSystems: string[];

wrapperCreativeIds

List of wrapper creative identifiers.

Signature:

wrapperCreativeIds: string[];

Remarks


- Starts with the first wrapper ad.

github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona