Interface AdErrorEvent

  • This documentation describes the AdErrorEvent, which is triggered when an error occurs during the loading of an ad from Google or DoubleClick servers.

  • The AdErrorEvent extends the ImaEvent and can be registered on AdsLoader and AdsManager types.

  • The getError method returns the specific AdError that caused the event.

  • The getUserRequestContext method retrieves an object that was provided during the ads load request, enabling correlation between the response and the request.

  • Inherited methods such as preventDefault and stopPropagation are available, along with inherited properties like currentTarget, target, and type.
Extends ImaEvent
This event is raised when an error occurs when loading an ad from the Google or DoubleClick servers. The types on which you can register for the event are AdsLoader and AdsManager.
Properties
currentTarget?
Deprecated. 
target?
The object on which the event was raised (and to which a listener was added).
type
Methods
getError
Returns the AdError that caused this event.
getUserRequestContext
During ads load request it is possible to provide an object that is available once the ads load is complete or fails.
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

getError

getError(): AdError
Returns the AdError that caused this event.
Returns
AdError The AdError that caused this event.

getUserRequestContext

getUserRequestContext(): object
During ads load request it is possible to provide an object that is available once the ads load is complete or fails. One possible use case: relate ads response to a specific request and use user request content object as the key for identifying the response. If an error occurred during ads load, you can find out which request caused this failure.
Returns
object Object that was provided during ads request.

preventDefault

preventDefault(): void