Package 

Interface RegisterEventInterface

  • 
public interface RegisterEventInterface

    Project Name: OSMOS-Android-SDK File Name: IRegisterEvent

    Interface for event tracking functionality in the OSMOS SDK. Provides methods for registering various user interaction events.

    • Method Detail

      • registerAdClickEvent

         abstract Map<String, Object> registerAdClickEvent(String cliUbid, String uclid, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers an ad click event for tracking user interactions with advertisements.

        Parameters:
        cliUbid - Unique identifier.
        uclid - Unique identifier for the ad click event.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerViewProductEvent

         abstract Map<String, Object> registerViewProductEvent(String cliUbid, String skuId, Float price, String merchantId, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers a "view product" event for tracking user interactions.

        Parameters:
        cliUbid - Unique identifier.
        skuId - The unique identifier of the product being viewed.
        price - Optional: Prices of the product, if applicable.
        merchantId - Optional: Identifier of the merchant selling the product.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerAdd2CartEvent

         abstract Map<String, Object> registerAdd2CartEvent(String cliUbid, String skuId, Float price, String merchantId, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers an "add to cart" event for tracking user interactions.

        Parameters:
        cliUbid - Unique identifier.
        skuId - The unique identifier of the product being added to the cart.
        price - Optional: The price of the product, if available.
        merchantId - Optional: The identifier of the merchant selling the product.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerPurchaseEvent

         abstract Map<String, Object> registerPurchaseEvent(String cliUbid, Integer sales, String orderId, List<Product> products, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers a "purchase" event for tracking completed sales.

        Parameters:
        cliUbid - Unique identifier.
        sales - The total number of sales associated with the purchase.
        orderId - The unique identifier for the order (item identifier).
        products - A list of Product objects representing purchased items.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerAdImpressionEvent

         abstract Map<String, Object> registerAdImpressionEvent(String cliUbid, String uclid, Integer position, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers an "ad impression" event for tracking ad views.

        Parameters:
        cliUbid - Unique identifier.
        uclid - Unique identifier for the ad impression.
        position - Optional: The position of the ad in the UI.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerVideoProgressEvent

         abstract Map<String, Object> registerVideoProgressEvent(String cliUbid, String uclid, Float videoViewSec, Float videoDurationSec, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers a "video progress" event for tracking user engagement.

        Parameters:
        cliUbid - Unique identifier.
        uclid - Unique identifier for the video being tracked.
        videoViewSec - Number of seconds the video has been viewed.
        videoDurationSec - Total duration of the video in seconds.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.

      • registerVideoActionEvent

         abstract Map<String, Object> registerVideoActionEvent(String cliUbid, String uclid, Float videoViewSec, VideoActionType actionType, TrackingParams trackingParams, ErrorCallback errorCallback)

        Registers a "video action" event to track user interactions with a video.

        Parameters:
        cliUbid - Unique identifier.
        uclid - Unique identifier for the video being tracked.
        videoViewSec - The timestamp (in seconds) at which the action occurred.
        actionType - The type of action performed on the video from VideoActionType enum.
        trackingParams - Optional: Additional tracking parameters.
        errorCallback - Optional: Callback for handling errors.