com.pubmatic.sdk.common.viewability

Interface POBHTMLMeasurementProvider

public interface POBHTMLMeasurementProvider

This interface list all methods to be implemented by viewability measurement provider to ensure its compatibility with OpenBid SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	POBHTMLMeasurementProvider.POBAdEventType Open Measurement Event Types
static interface	POBHTMLMeasurementProvider.POBScriptListener

Method Summary

Modifier and Type	Method and Description
void	addFriendlyObstructions(android.view.View obstructionView) OpenBid SDK calls this method to add obstruction on Ad view.
void	finishAdSession() OpenBid SDK calls this method to finish view-ability measurement session.
void	omidJsServiceScript(android.content.Context context, POBHTMLMeasurementProvider.POBScriptListener listener) OpenBid SDK calls this method to inject omid JS into creative.
java.lang.String	omSDKVersion() OpenBid SDK calls this method to get the current Open Measurement SDK version.
void	removeFriendlyObstructions(android.view.View obstructionView) OpenBid SDK calls this method to remove existing obstruction on Ad view.
void	setTrackView(android.view.View view) OpenBid SDK calls this method to update Ad view for viewability measurement on mraid events.
void	signalAdEvent(POBHTMLMeasurementProvider.POBAdEventType event) OpenBid SDK calls this method to signal POBAdEventType for viewability measurement session.
void	startAdSession(android.webkit.WebView webView) OpenBid SDK calls this method to start view-ability measurement session on Ad load on ad expand/resize.

Method Detail

omSDKVersion

java.lang.String omSDKVersion()

OpenBid SDK calls this method to get the current Open Measurement SDK version. This method is used return OM SDK version.

Returns:

Current open measurement SDK version.

setTrackView

void setTrackView(android.view.View view)

OpenBid SDK calls this method to update Ad view for viewability measurement on mraid events. Use this method to register Ad view to track its viewability.

Parameters:

view - Ad view.

startAdSession

void startAdSession(android.webkit.WebView webView)

OpenBid SDK calls this method to start view-ability measurement session on Ad load on ad expand/resize. Use this method to initialize measurement provider SDK once and start Ad session.

Parameters:

webView - web view on which ad is rendered.

finishAdSession

void finishAdSession()

OpenBid SDK calls this method to finish view-ability measurement session. Use this method to finish Ad session and do any final cleanup.

signalAdEvent

void signalAdEvent(POBHTMLMeasurementProvider.POBAdEventType event)

OpenBid SDK calls this method to signal POBAdEventType for viewability measurement session. Use this method to signal different Ad events like impression, click etc.

Parameters:

event - type of event to signal

omidJsServiceScript

void omidJsServiceScript(android.content.Context context,
                         POBHTMLMeasurementProvider.POBScriptListener listener)

OpenBid SDK calls this method to inject omid JS into creative. Use this method to load OM SDK service script and return its content

Parameters:

context - application context

addFriendlyObstructions

void addFriendlyObstructions(android.view.View obstructionView)

OpenBid SDK calls this method to add obstruction on Ad view. Use this method to register any obstruction displayed over Ad view to be considered for viewability measurement

Parameters:

obstructionView - obstruction view

removeFriendlyObstructions

void removeFriendlyObstructions(android.view.View obstructionView)

OpenBid SDK calls this method to remove existing obstruction on Ad view. Use this method to remove any obstruction displayed over Ad view. Note: Passing null to this method will remove all existing obstructions.

Parameters:

obstructionView - obstruction view