Package 

Interface AdRendererInterface

  • 
public interface AdRendererInterface

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

    Interface for ad rendering functionality in the OSMOS SDK. Provides methods for fetching and preparing different types of ads.

    • Method Detail

      • fetchBannerAdsWithAu

         abstract Map<String, Object> fetchBannerAdsWithAu(String cliUbid, String pageType, String adUnit, List<TargetingParams> targetingParams, ErrorCallback errorCallback)

        Fetch banner ads with ad units.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        pageType - : page type from which request made.
        adUnit - : Ad unit tags defined for the different slots on the page.
        targetingParams - : Optional filter params that you want to apply
        errorCallback - : Optional error callback for handling errors

      • fetchCarouselAdWithAu

         abstract Map<String, Object> fetchCarouselAdWithAu(String cliUbid, String pageType, String adUnit, List<TargetingParams> targetingParams, ErrorCallback errorCallback)

        Fetch carousel ads with ad units.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        pageType - : page type from which request made.
        adUnit - : Ad unit tags defined for the different slots on the page.
        targetingParams - : Optional filter params that you want to apply
        errorCallback - : Optional error callback for handling errors

      • fetchMultiAdCarouselWithAu

         abstract Map<String, Object> fetchMultiAdCarouselWithAu(String cliUbid, String pageType, String adUnit, Integer productCount, List<TargetingParams> targetingParams, ErrorCallback errorCallback)

        Fetch multiple ads in carousel format with ad units.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        pageType - : page type from which request made.
        adUnit - : Ad unit tags defined for the different slots on the page.
        productCount - : Number of ads responded.
        targetingParams - : Optional filter params that you want to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaCategoryPageAds

         abstract Map<String, Object> fetchNativePlaCategoryPageAds(String cliUbid, Integer productCount, List<String> categories, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Product Listing Ads (PLA) for category pages.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        categories - : List of category names to filter ads
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaTpaPageAds

         abstract Map<String, Object> fetchNativePlaTpaPageAds(String cliUbid, Integer productCount, List<Object> skuIds, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Tagged Product Ads (TPA) for specific products.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        skuIds - : List of SKU identifiers for the products
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaHomePageAds

         abstract Map<String, Object> fetchNativePlaHomePageAds(String cliUbid, Integer productCount, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Native Product Listing Ads (PLA) for home pages.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaSearchPageAds

         abstract Map<String, Object> fetchNativePlaSearchPageAds(String cliUbid, Integer productCount, String keyword, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Native Product Listing Ads (PLA) for search pages.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        keyword - : Search keyword to filter ads
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaProductPageAds

         abstract Map<String, Object> fetchNativePlaProductPageAds(String cliUbid, Integer productCount, List<String> skuIds, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Native Product Listing Ads (PLA) for product pages.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        skuIds - : List of SKU identifiers for the products
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaAds

         abstract Map<String, Object> fetchNativePlaAds(String cliUbid, PlaPageType pageType, Integer productCount, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Native Product Listing Ads (PLA) based on page type.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        pageType - : Type of page (HOME, SEARCH, CATEGORY, PRODUCT, PURCHASE, TPA)
        productCount - : Number of ads to fetch.
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchNativePlaPurchasePageAds

         abstract Map<String, Object> fetchNativePlaPurchasePageAds(String cliUbid, Integer productCount, List<String> skuIds, String pageName, ProductAdsFilter filters, ErrorCallback errorCallback)

        Fetch Native Product Listing Ads (PLA) for purchase pages.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        productCount - : Number of ads to fetch.
        skuIds - : List of SKU identifiers for the purchased products
        pageName - : Optional page name identifier
        filters - : Optional additional filters to apply
        errorCallback - : Optional error callback for handling errors

      • fetchPdaAdWithAu

         abstract Map<String, Object> fetchPdaAdWithAu(String cliUbid, String pageType, String adUnit, List<TargetingParams> targetingParams, ErrorCallback errorCallback)

        Fetch PDA (Product Display Ad) ads with ad units.

        Parameters:
        cliUbid - : Retailers Generated Id to identify unique shopper
        pageType - : page type from which request made.
        adUnit - : Ad unit tags defined for the different slots on the page.
        targetingParams - : Optional filter params that you want to apply
        errorCallback - : Optional error callback for handling errors

      • parseDisplayAdResponse

         abstract Map<String, Object> parseDisplayAdResponse(String adData, String cliUbid, DisplayAdFormat adFormat)

        Parse display ad response data into structured format

        Parameters:
        adData - Raw ad data from API response
        cliUbid - Client unique browser ID for tracking
        adFormat - Display ad format type (Banner, Carousel, MultiAdCarousel)

      • parseNativeAdResponse

         abstract Map<String, Object> parseNativeAdResponse(String adData, String cliUbid, NativeAdFormat adFormat)

        Parse native ad response data into structured format.

        Parameters:
        adData - Raw ad data from API response
        cliUbid - Client unique browser ID for tracking
        adFormat - Native ad format type (NativeAd, NativeCarouselAd)