Version: 2.67.0

GoogleImaAd

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

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.

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.

Remarks


- Available since v2.60.0.