Constructor Detail

• POBNativeAdLoader

  POBNativeAdLoader(Context context, String publisherId, int profileId, String adUnitId, POBNativeTemplateType templateType, POBNativeAdEvent eventHandler)

  Initializes &returns a newly allocated ad loader object for supporting 'Header Bidding Configuration'.

  Parameters:

  publisherId - Unique identifier assigned at the time of publisher on-boarding.

  profileId - Profile id of the ad tag.

  adUnitId - Ad unit id used to identify unique placement on screen.

  templateType - Instance of POBNativeTemplateType any custom properties such as ContextType, ContextSubType, placementType etc.

  eventHandler - Instance of POBNativeAdEvent or its subclass

• POBNativeAdLoader

  POBNativeAdLoader(Context context, String publisherId, int profileId, String adUnitId, POBNativeTemplateType templateType)

  Initializes &returns a newly allocated ad loader object for supporting 'No Ad Server Configuration'.

  Parameters:

  publisherId - Unique identifier assigned at the time of publisher on-boarding.

  profileId - Profile id of the ad tag.

  adUnitId - Ad unit id used to identify unique placement on screen.

  templateType - Instance of POBNativeTemplateType

• POBNativeAdLoader

  POBNativeAdLoader(Context context)

  Initializes a new instance of the POBNativeAdLoader class.

  Parameters:

  context - The context to be used by the ad loader.

Method Detail

• getConfig

  @NonNull() POBNativeAdLoaderConfig getConfig()

  Returns the Instance of the Ad Loader config class which publisher can use to pass any custom properties such as ContextType, ContextSubType, PlacementType etc.

  Returns:

  Instance of POBNativeAdLoaderConfig

• setNativeCustomAssets

   void setNativeCustomAssets(@NonNull() List<POBBaseNativeRequestAsset> customAssetList)

  Setter for native custom asset request list

  Parameters:

  customAssetList - List of custom assets created with the help POBBaseNativeRequestAsset and its derived classes.

• loadAd

  @RequiresPermission(value = Manifest.permission.INTERNET) void loadAd()

  Initiate the loading for the Native ad

• loadAd

  @RequiresPermission(value = Manifest.permission.INTERNET) void loadAd(@NonNull() String bidResponse, @NonNull() POBBiddingHost biddingHost)

  Initiates the loading of a native ad with oRTB bid response. This API expects the response with oRTB v2.5 specification and bidding host.

  Parameters:

  bidResponse - oRTB response of format - oRTB-2.5

  biddingHost - enum value representing the bidding server provider.

• getImpression

  @Nullable() POBImpression getImpression()

  Returns an instance of POBImpression which gets created internally. POBImpression provides the APIs to set PubMatic zone id and other custom parameters.

  Returns:

  Returns an instance of POBImpression.

• getAdRequest

  @Nullable() POBRequest getAdRequest()

  Returns an instance of POBRequest, required for setting targeting parameters.

  Returns:

  Instance of POBRequest

• destroy

   void destroy()

• addExtraInfo

   void addExtraInfo(@NonNull() String key, @NonNull() Object value)

• onAdReceived

   void onAdReceived(@NonNull() POBNativeAdManager adManager, @NonNull() POBNativeAd nativeAd)

  Notifies the callback that an Native Ad has been successfully loaded.

  Parameters:

  adManager - Instance of POBNativeAdManager over which native ad is loaded

  nativeAd - the newly loaded instance of POBNativeAd

• onFailedToLoad

   void onFailedToLoad(@NonNull() POBNativeAdManager adManager, @NonNull() POBError error)

  Notifies the callback of an error encountered while loading an adManager.

  Parameters:

  adManager - Instance of POBNativeAdManager over which native adManager is loaded

  error - The error encountered while attempting to load the native ad.

• onBidFailure

   void onBidFailure(@NonNull() POBNativeAdManager nativeAdManager)

  Notifies the callback that proceedOnError has been called for NoAdServer integration. Helps to manage the POBNativeAdManager count in POBNativeAdLoader's hashset.

  Parameters:

  nativeAdManager - Instance to be removed from POBNativeAdLoader's hashset.

• setAdLoaderListener

   void setAdLoaderListener(@Nullable() POBNativeAdLoaderListener adLoaderListener)

  Sets the POBNativeAdLoaderListener receiver for the ad loader events.

  Parameters:

  adLoaderListener - Instance of POBNativeAdLoaderListener

• setBidEventListener

   void setBidEventListener(@Nullable() POBBidEventListener bidEventListener)

  Sets Bid event listener to notify bid events

  Parameters:

  bidEventListener - reference of POBBidEventListener