Constructor Detail

Method Detail

• getRenderableContent

  @Nullable() abstract String getRenderableContent()

  Returns the content to be render

  Returns:

  content to be render

• isVideo

   abstract boolean isVideo()

  Returns the state of type video

  Returns:

  true if current descriptor has video details else return false

• isCompanion

   abstract boolean isCompanion()

  Returns if descriptor id of companion or not

  Returns:

  true if current descriptor is companion else return false

• getContentWidth

   abstract int getContentWidth()

  Returns the width of the content to be render

  Returns:

  width of the content to be render

• getContentHeight

   abstract int getContentHeight()

  Returns the height of the content to be render

  Returns:

  height of the content to be render

• getRawBid

  @Nullable() abstract JSONObject getRawBid()

  Returns the JSON object of the Bid

  Returns:

  JSON object of the Bid

• getRefreshInterval

   abstract int getRefreshInterval()

  Returns the refresh interval from the ad response descriptor

  Returns:

  refresh interval from the ad response descriptor

• getId

  @Nullable() abstract String getId()

  Returns the Id associated with the Ad descriptor's sub class

  Returns:

  Id associated with the Ad descriptor's sub class

• getCreativeType

  @Nullable() abstract String getCreativeType()

  To get creative type of ad descriptor

  Returns:

  creative type

• getStatus

   abstract int getStatus()

  Returns status of bid. If there are multiple bids, it returns true even if at least status of one of the bid is true.

  Returns:

  Bid status

• getTargetingInfo

  @Nullable() abstract Map<String, String> getTargetingInfo()

  Returns the map of bid-targeting information only, that needs to be passed to ad server SDK.

  Returns:

  Map of bid-targeting information

• buildWithRefreshAndExpiryTimeout

  @Nullable() abstract POBAdDescriptor buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)

  Create new descriptor type by updating existing descriptor's refresh interval and expiryTimeout

  Parameters:

  refreshInterval - the refresh interval in seconds

  expiryTimeout - the expiryTimeout in milliseconds

  Returns:

  newly instance descriptor with updated refresh interval and expirytimeout

• getBundle

  @Nullable() abstract String getBundle()

  Returns bundle id received from ad response

  Returns:

  bundle id string

• getPaidBy

  @Nullable() abstract String getPaidBy()

  Returns the paid value. The Advertiser who paid for the ad.

  Returns:

  paid value

• enableDsaInfoIcon

   abstract boolean enableDsaInfoIcon()

  Returns whether sdk should render the dsa data.

  Returns:

  boolean indicating whether sdk should render the dsa data.

• getDisplayedOnBehalfOf

  @Nullable() abstract String getDisplayedOnBehalfOf()

  Returns the behalf value. The entity on whose behalf the ad is displayed. Maximum 100 characters.

  Returns:

  behalf value

• getTransparencyData

  @Nullable() abstract List<POBDSATransparencyInfo> getTransparencyData()

  Array of entities that applied user parameters and the parameters they applied.

  Returns:

  List of POBDSATransparencyInfo

• getClickTrackers

  @Nullable() abstract List<String> getClickTrackers()

  Returns the PubMatic's click trackers

  Returns:

  List of click trackers

• getImpressionCountingMethod

  @NonNull() abstract POBImpressionCountingMethod getImpressionCountingMethod()

  Returns the method of impression tracking

  Returns:

  enum value of POBImpressionCountingMethod the method of impression tracking default value is ON_LOAD when value received from ad response is 0