Interface AdErrorEvent

Note: This reference page follows TypeScript documentation structure. If you have suggestions for or see issues with the reference documentation, open a thread with your feedback on the IMA technical forum.

---

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.  Inherited from ImaEvent.currentTarget
target?	The object on which the event was raised (and to which a listener was added). Inherited from ImaEvent.target
type	Inherited from ImaEvent.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.  Inherited from ImaEvent.preventDefault

Properties

---

Optional currentTarget

currentTarget?: object

Deprecated: Use target instead.

---

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

Deprecated: No-op. IMA events do not have a default action.