Interface AdsManagerLoadedEvent

  • This document outlines the AdsManagerLoadedEvent, which is triggered when ads are loaded from Google or DoubleClick ad servers via an AdsLoader.

  • The AdsManagerLoadedEvent extends ImaEvent and inherits several properties and methods, including currentTarget, target, type, preventDefault, and stopPropagation.

  • The getAdsManager method, available after ads are loaded, returns an AdsManager object used for managing and playing ads in either a publisher's own video player or the Google-provided one, and it takes a contentPlayback object and optional adsRenderingSettings as parameters.

  • The getUserRequestContext method retrieves an object provided during the ad load request, allowing publishers to associate the ad response with a specific request.
Extends ImaEvent
This event is raised when ads are successfully loaded from the Google or DoubleClick ad servers through an AdsLoader. You can register for this event on AdsLoader.
Properties
currentTarget?
Deprecated. 
target?
The object on which the event was raised (and to which a listener was added).
type
Methods
getAdsManager
After ads are loaded from the Google or DoubleClick ad servers, the publisher needs to play these ads either in their own video player or in the Google-provided video player.
getUserRequestContext
During ads load request it is possible to provide an object that is available once the ads load is complete.
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

getAdsManager

getAdsManager(contentPlayback: object, adsRenderingSettings?: AdsRenderingSettings): AdsManager
After ads are loaded from the Google or DoubleClick ad servers, the publisher needs to play these ads either in their own video player or in the Google-provided video player. This method returns an AdsManager object. The AdsManager supports playing ads and allows the publisher to subscribe to various events during ad playback.
Parameters
contentPlayback: object Player that plays back publisher's content. This must be an object that contains the property currentTime, which allows the SDK to query playhead position to properly display midrolls in case ad server responds with an ad rule. The HMTL5 video element fulfills these requirements. You may optionally implement your own playhead tracker, as long as it fulfills the above requirements.
Optional adsRenderingSettings: AdsRenderingSettings Optional settings to control the rendering of ads.
Returns
AdsManager AdsManager that manages and plays ads.

getUserRequestContext

getUserRequestContext(): object
During ads load request it is possible to provide an object that is available once the ads load is complete. One possible use case: relate ads response to a specific request and use user request content object as a key for identifying the response.
Returns
object The user request content object.

preventDefault

preventDefault(): void