com.pubmatic.sdk.common.viewability

Interface POBMeasurementProvider

All Known Subinterfaces:

POBHTMLMeasurementProvider, POBVideoMeasurementProvider

public interface POBMeasurementProvider

This interface list all basic methods to be implement by viewability measurement provider for html and video ad formats.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	POBMeasurementProvider.POBFriendlyObstructionPurpose Obstruction purpose on ad view
static interface	POBMeasurementProvider.POBScriptListener Notifies the loading event of measurement service script

Method Summary

Modifier and Type	Method and Description
void	addFriendlyObstructions(android.view.View obstructionView, POBMeasurementProvider.POBFriendlyObstructionPurpose obstructionPurpose) OpenWrap SDK calls this method to add obstruction on Ad view.
void	finishAdSession() OpenWrap SDK calls this method to finish view-ability measurement session.
void	omidJsServiceScript(android.content.Context context, POBMeasurementProvider.POBScriptListener listener) OpenWrap SDK calls this method to inject omid JS into creative.
java.lang.String	omSDKVersion() OpenWrap SDK calls this method to get the current Open Measurement SDK version.
void	removeFriendlyObstructions(android.view.View obstructionView) OpenWrap SDK calls this method to remove existing obstruction on Ad view.
void	setTrackView(android.view.View view) OpenWrap SDK calls this method to update Ad view for viewability measurement events.

Method Detail

omSDKVersion

@NonNull
java.lang.String omSDKVersion()

OpenWrap 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(@NonNull
                  android.view.View view)

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

Parameters:

view - Ad view.

finishAdSession

void finishAdSession()

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

omidJsServiceScript

void omidJsServiceScript(@NonNull
                         android.content.Context context,
                         @NonNull
                         POBMeasurementProvider.POBScriptListener listener)

OpenWrap 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

listener - provides callback when measurement service script is available

addFriendlyObstructions

void addFriendlyObstructions(@NonNull
                             android.view.View obstructionView,
                             @NonNull
                             POBMeasurementProvider.POBFriendlyObstructionPurpose obstructionPurpose)

OpenWrap 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

obstructionPurpose - purpose of obstruction to add based on obstruction view

removeFriendlyObstructions

void removeFriendlyObstructions(@Nullable
                                android.view.View obstructionView)

OpenWrap 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