Package com.pubmatic.sdk.omsdk

Class POBMeasurement

  • All Implemented Interfaces:
    com.pubmatic.sdk.common.viewability.POBMeasurementProvider , com.pubmatic.sdk.common.viewability.POBObstructionUpdateListener 
    
public abstract class POBMeasurement
 implements 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 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description
      POBMeasurement()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBMeasurement

        POBMeasurement()

    • Method Detail

      • omSDKVersion

        @NonNull() String omSDKVersion()

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

        Returns:

        Current open measurement SDK version.

      • setTrackView

         void setTrackView(@NonNull() View view)

        Change the tracking view for an Ad session.

        Parameters:
        view - Ad view.

      • finishAdSession

         void finishAdSession()

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

      • omidJsServiceScript

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

        Loads the service script to inject.

        Parameters:
        context - application context to load script
        listener - provides callback when measurement service script is available

      • addFriendlyObstructions

         void addFriendlyObstructions(@NonNull() View obstructionView, @NonNull() POBObstructionUpdateListener.POBFriendlyObstructionPurpose obstructionPurpose)

        Add the obstruction to existing Ad session.

        Parameters:
        obstructionView - obstruction View
        obstructionPurpose - purpose of obstruction to add based on obstruction view

      • removeFriendlyObstructions

         void removeFriendlyObstructions(@Nullable() View obstructionView)

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

        Parameters:
        obstructionView - obstruction View