com.pubmatic.sdk.omsdk

Class POBMeasurement

java.lang.Object

com.pubmatic.sdk.omsdk.POBMeasurement

All Implemented Interfaces:

com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Direct Known Subclasses:

POBHTMLMeasurement, POBVideoMeasurement

public abstract class POBMeasurement
extends java.lang.Object
implements com.pubmatic.sdk.common.viewability.POBMeasurementProvider

An abstract class having the implementation of the basic methods to be implement by viewability measurement provider for html and video ad formats.

Nested Class Summary

Nested classes/interfaces inherited from interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBFriendlyObstructionPurpose, com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBScriptListener

Field Summary

Fields

Modifier and Type	Field and Description
protected com.iab.omid.library.pubmatic.adsession.AdEvents	adEvents
protected com.iab.omid.library.pubmatic.adsession.AdSession	adSession
protected static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
POBMeasurement()

Method Summary

Modifier and Type	Method and Description
void	addFriendlyObstructions(android.view.View obstructionView, com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBFriendlyObstructionPurpose obstructionPurpose) Add the obstruction to existing Ad session.
void	finishAdSession() Finishes the Ad session.
void	omidJsServiceScript(android.content.Context context, com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBScriptListener listener) Loads the service script to inject.
java.lang.String	omSDKVersion() OpenWrap SDK calls this method to get the current Open Measurement SDK version.
void	removeFriendlyObstructions(android.view.View obstructionView) Removes the obstruction view from existing Ad session.
void	setTrackView(android.view.View view) Change the tracking view for an Ad session.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

protected static final java.lang.String TAG

See Also:

Constant Field Values

adSession

@Nullable
protected com.iab.omid.library.pubmatic.adsession.AdSession adSession

adEvents

@Nullable
protected com.iab.omid.library.pubmatic.adsession.AdEvents adEvents

Constructor Detail

POBMeasurement

public POBMeasurement()

Method Detail

omSDKVersion

@NonNull
public java.lang.String omSDKVersion()

OpenWrap SDK calls this method to get the current Open Measurement SDK version.

Specified by:

omSDKVersion in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Returns:

Current open measurement SDK version.

setTrackView

public void setTrackView(@NonNull
                         android.view.View view)

Change the tracking view for an Ad session.

Specified by:

setTrackView in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Parameters:

view - Ad view.

finishAdSession

public void finishAdSession()

Finishes the Ad session. This method should be called before Ad view is destroyed.

Specified by:

finishAdSession in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

omidJsServiceScript

public void omidJsServiceScript(@NonNull
                                android.content.Context context,
                                @NonNull
                                com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBScriptListener listener)

Loads the service script to inject.

Specified by:

omidJsServiceScript in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Parameters:

context - application context to load script

listener - provides callback when measurement service script is available

addFriendlyObstructions

public void addFriendlyObstructions(@NonNull
                                    android.view.View obstructionView,
                                    @NonNull
                                    com.pubmatic.sdk.common.viewability.POBMeasurementProvider.POBFriendlyObstructionPurpose obstructionPurpose)

Add the obstruction to existing Ad session.

Specified by:

addFriendlyObstructions in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Parameters:

obstructionView - obstruction View

obstructionPurpose - purpose of obstruction to add based on obstruction view

removeFriendlyObstructions

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

Removes the obstruction view from existing Ad session. Note: Passing null to this method will remove all existing obstructions.

Specified by:

removeFriendlyObstructions in interface com.pubmatic.sdk.common.viewability.POBMeasurementProvider

Parameters:

obstructionView - obstruction View