Interface AdEvent

  • This document describes the AdEvent type, which is triggered when an ad's state changes or when users interact with it, extending from the ImaEvent type.

  • The AdEvent object includes properties currentTarget, target, and type, all of which are inherited from ImaEvent.

  • The getAd method allows you to retrieve the currently playing or recently played ad, while the getAdData method enables the retrieval of additional data passed from the ad.

  • preventDefault and stopPropagation methods are inherited from ImaEvent to control the event flow.

  • The getAdData method is exemplified in a code snippet that checks for log events of type AdEvent for error handling.
Extends ImaEvent
This event type is raised by the ad as a notification when the ad state changes and when users interact with the ad. For example, when the ad starts playing, is clicked on, and more. You can register for the various state changed events on AdsManager.
Properties
currentTarget?
Deprecated. 
target?
The object on which the event was raised (and to which a listener was added).
type
Methods
getAd
Get the current ad that is playing or just played.
getAdData
Allows extra data to be passed from the ad.
preventDefault
Deprecated. 

Properties

Optional currentTarget

currentTarget?: object

Optional target

target?: object
The object on which the event was raised (and to which a listener was added).

type

type: string

Methods

getAd

getAd(): Ad
Get the current ad that is playing or just played.
Returns
Ad The ad associated with the event, or null if there is no relevant ad.

getAdData

getAdData(): object
Allows extra data to be passed from the ad.

Example:

  if (event.type == google.ima.AdEvent.Type.LOG) { let adData = event.getAdData(); if (adData['adError']) { console.log('Non-fatal error occurred: ' + adData['adError'].getMessage()); } }
Returns
object Extra data for the event. Log events raised for error carry object of type 'google.ima.AdError' which can be accessed using 'adError' key.

preventDefault

preventDefault(): void