Package org.prebid.mobile.rendering.session.manager

Class OmAdSessionManager

java.lang.Object

org.prebid.mobile.rendering.session.manager.OmAdSessionManager

public class OmAdSessionManager
extends Object

OmAdSessionManager is an implementation of Open Measurement used to track web and native video ad events.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARTNER_NAME
static final String	PARTNER_VERSION

Method Summary

Modifier and Type	Method	Description
static boolean	activateOmSdk(android.content.Context applicationContext)	First step to begin with when working with this class.
void	addObstruction(InternalFriendlyObstruction friendlyObstruction)	Registers any native view elements which are considered to be a part of the ad (e.g.
static OmAdSessionManager	createNewInstance(JSLibraryManager jsLibraryManager)
void	displayAdLoaded()	Registers the display ad load event.
void	initVideoAdSession(AdVerifications adVerifications, String contentUrl)	Initializes Native Video AdSession from AdVerifications.
void	initWebAdSessionManager(android.webkit.WebView adView, String contentUrl)
String	injectValidationScriptIntoHtml(String html)
void	nonSkippableStandaloneVideoAdLoaded(boolean isAutoPlay)	Registers the video ad load event.
void	registerAdView(android.view.View adView)	Registers a view on which to track viewability.
void	registerImpression()	Signals the impression event occurring.
void	startAdSession()	Prepares the AdSessions for tracking.
void	stopAdSession()	Stop the AdSessions when the impression has completed and the ad will be destroyed
void	trackAdVideoEvent(VideoAdEvent.Event adEvent)	Registers ad video events.
void	trackDisplayAdEvent(TrackingEvent.Events adEvent)	Registers display events.
void	trackPlayerStateChangeEvent(InternalPlayerState playerState)	Registers video player state change events.
void	trackVolumeChange(float volume)	Registers volume change event.
void	videoAdStarted(float duration, float videoPlayerVolume)	Registers video ad started event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARTNER_NAME

public static final String PARTNER_NAME

See Also:

• Constant Field Values

PARTNER_VERSION

public static final String PARTNER_VERSION

See Also:

• Constant Field Values

Method Details

activateOmSdk

public static boolean activateOmSdk(android.content.Context applicationContext)

First step to begin with when working with this class. NOTE: The OmAdSessionManager(org.prebid.mobile.rendering.sdk.JSLibraryManager) instance won't be created if OMSDK activation fails.

createNewInstance

public static OmAdSessionManager createNewInstance(JSLibraryManager jsLibraryManager)

Returns:

SessionManager instance or null, if OMSDK is not active.

injectValidationScriptIntoHtml

public String injectValidationScriptIntoHtml(String html)

initWebAdSessionManager

public void initWebAdSessionManager(android.webkit.WebView adView,
 String contentUrl)

initVideoAdSession

public void initVideoAdSession(AdVerifications adVerifications,
 String contentUrl)

Initializes Native Video AdSession from AdVerifications.

Parameters:

adVerifications - VAST AdVerification node

displayAdLoaded

public void displayAdLoaded()

Registers the display ad load event.

nonSkippableStandaloneVideoAdLoaded

public void nonSkippableStandaloneVideoAdLoaded(boolean isAutoPlay)

Registers the video ad load event.

Parameters:

isAutoPlay - indicates if ad starts after load.

videoAdStarted

public void videoAdStarted(float duration,
 float videoPlayerVolume)

Registers video ad started event.

Parameters:

duration - native video ad duration.

videoPlayerVolume - native video player volume.

registerImpression

public void registerImpression()

Signals the impression event occurring. Generally accepted to be on ad render.

trackVolumeChange

public void trackVolumeChange(float volume)

Registers volume change event.

Parameters:

volume - changed volume.

trackAdVideoEvent

public void trackAdVideoEvent(VideoAdEvent.Event adEvent)

 Registers ad video events.

 Playback:
                      VideoAdEvent.Event.AD_FIRSTQUARTILE,
                      VideoAdEvent.Event.AD_MIDPOINT,
                      VideoAdEvent.Event.AD_THIRDQUARTILE,
                      VideoAdEvent.Event.AD_COMPLETE;
 Visibility:
                      VideoAdEvent.Event.AD_PAUSE,
                      VideoAdEvent.Event.AD_RESUME,
 player state change:
                      VideoAdEvent.Event.AD_FULLSCREEN,
                      VideoAdEvent.Event.AD_EXITFULLSCREEN,
 impression:
                      VideoAdEvent.Event.AD_IMPRESSION
 adUserInteraction:
                      VideoAdEvent.Event.AD_CLICK

Parameters:

adEvent - events which are handled.

trackDisplayAdEvent

public void trackDisplayAdEvent(TrackingEvent.Events adEvent)

 Registers display events.
 Supported events:
                      TrackingEvent.Events.IMPRESSION
                      TrackingEvent.Events.LOADED

Parameters:

adEvent - events which are handled.

trackPlayerStateChangeEvent

public void trackPlayerStateChangeEvent(InternalPlayerState playerState)

Registers video player state change events.

Parameters:

playerState - current video player state.

startAdSession

public void startAdSession()

Prepares the AdSessions for tracking. This does not trigger an impression.

stopAdSession

public void stopAdSession()

Stop the AdSessions when the impression has completed and the ad will be destroyed

registerAdView

public void registerAdView(android.view.View adView)

Registers a view on which to track viewability.

Parameters:

adView - View on which to track viewability.

addObstruction

public void addObstruction(InternalFriendlyObstruction friendlyObstruction)

Registers any native view elements which are considered to be a part of the ad (e.g. close button).