Class CompanionTelemetryHelper

  • All Implemented Interfaces:

    
    public final class CompanionTelemetryHelper
    
                        

    A helper class for submitting telemetry events related to companion ads.

    This class provides methods for submitting telemetry events for various companion ad states, such as availability, load success, load failure, rendering, and dropping. It uses the provided AdContext for event context.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Unit submitCompanionAdAvailable() Submits a telemetry event indicating that a companion ad is available.
      final Unit submitCompanionAdLoadSuccess() Submits a telemetry event indicating that a companion ad has loaded successfully.
      final Unit submitCompanionAdLoadFailure() Submits a telemetry event indicating that a companion ad has failed to load.
      final Unit submitCompanionAdRendered() Submits a telemetry event indicating that a companion ad has been rendered.
      final Unit submitCompanionAdDropped() Submits a telemetry event indicating that a companion ad has been dropped.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CompanionTelemetryHelper

        CompanionTelemetryHelper(AdContext adContext)
    • Method Detail

      • submitCompanionAdAvailable

         final Unit submitCompanionAdAvailable()

        Submits a telemetry event indicating that a companion ad is available.

        This event is triggered when a companion ad is available to be loaded.

      • submitCompanionAdLoadSuccess

         final Unit submitCompanionAdLoadSuccess()

        Submits a telemetry event indicating that a companion ad has loaded successfully.

        This event is triggered when a companion ad has been loaded without errors.

      • submitCompanionAdLoadFailure

         final Unit submitCompanionAdLoadFailure()

        Submits a telemetry event indicating that a companion ad has failed to load.

        This event is triggered when a companion ad fails to load due to an error.

      • submitCompanionAdRendered

         final Unit submitCompanionAdRendered()

        Submits a telemetry event indicating that a companion ad has been rendered.

        This event is triggered when a companion ad is displayed on the screen.

      • submitCompanionAdDropped

         final Unit submitCompanionAdDropped()

        Submits a telemetry event indicating that a companion ad has been dropped.

        This event is triggered when a companion ad is not displayed for some reason.