Constructor Detail

• POBVastAd

  POBVastAd()

Method Detail

• getWrapper

  @Nullable() POBVastAd getWrapper()

  Reference of wrapper through which current VastAd is received.

  Returns:

  wrapper ad

• setWrapper

   void setWrapper(@Nullable() POBVastAd wrapper)

  Setter to set wrpper ad on current VAST ad

  Parameters:

  wrapper - previous wrapper ad

• build

   void build(@NonNull() POBNodeBuilder builder)

  POBXMLParser calls this method to build model class object with node builder

  Parameters:

  builder - Instance of POBNodeBuilder, to be used for building the model class object

• getAdType

  @Nullable() POBVastAd.POBVastAdType getAdType()

  Vast ad type inline or wrapper

  Returns:

  ad type

• getAdSystem

  @Nullable() String getAdSystem()

  A string that provides the name of the ad server that returned the ad

  Returns:

  ad server name

• getAdTitle

  @Nullable() String getAdTitle()

  A string that provides a common name for the ad

  Returns:

  ad name

• getAdServingId

  @Nullable() String getAdServingId()

  A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.

  Returns:

  ad serving id

• getDescription

  @Nullable() String getDescription()

  A string value that describes a longer description of the ad

  Returns:

  ad description

• getPricing

  @Nullable() String getPricing()

  A numerical value that represents a price that can be used in real-time bidding systems

  Returns:

  price value

• getExpires

   int getExpires()

  An integer value that defines the expiry period (in seconds).

  Returns:

  expiry period

• getAdSequence

   int getAdSequence()

  Returns an integer value with sequence values those are part of a pod and are intended to be played in sequence. Returns -1, if not found in vast.

  Returns:

  Ad sequence in pod

• getVASTAdTagURI

  @Nullable() String getVASTAdTagURI()

  A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.

  Returns:

  VAST Ad Tag URL

• getCombinedTrackingEventList

  @NonNull() List<String> getCombinedTrackingEventList(@NonNull() POBVastCreative.POBEventTypes eventTypes)

  Returns the list of the Vast tracking URLs for Inline and all level of its wrapper, based on provided event type

  Parameters:

  eventTypes - Vast event type

  Returns:

  string list of Vast tracking URLs

• getClosestClickThroughURL

  @Nullable() String getClosestClickThroughURL()

  Returns the closest clickThrough URL from the Linear ad of current Vast ad. Preference give to Inline VAST followed by parent's wrapper VAST

  Returns:

  string closestClickThrough URL

• getCreative

  @Nullable() POBVastCreative getCreative()

  Creative of type POBVastCreative. The creative may be linear or non-linear

  Returns:

  linear or non-linear creative

• getClosestIcon

  @Nullable() POBIcon getClosestIcon()

  Returns the closest Icon from the Linear ad of current Vast ad. Preference give to Inline VAST followed by parent's wrapper VAST

  Returns:

  Instance of POBIcon

• getCombinedList

  @NonNull() List<String> getCombinedList(@NonNull() POBVastAd.POBVastAdParameter parameter)

  Returns the list of the Vast tracking URLs for Inline and all level of its wrapper based on provided parameter

  Parameters:

  parameter - Vast ad parameter

  Returns:

  string list of Vast tracking URLs

• getImpressions

  @Nullable() List<String> getImpressions()

  List of URLs to notify the ad server when the impression occurs.

  Returns:

  list of impression URL's

• getErrorURLs

  @Nullable() List<String> getErrorURLs()

  List of URIs to tracking resource to be used when an error in ad playback occurs.

  Returns:

  error URL list

• getViewableImpressions

  @Nullable() List<String> getViewableImpressions()

  A URI that directs the media player to a tracking resource file that the media player should request at the time that criteria is met for a viewable impression.

  Returns:

  list of viewable impressions URL's

• getNotViewableImpressions

  @Nullable() List<String> getNotViewableImpressions()

  A URI that directs the media player to a tracking resource file that the media player should request if the ad is executed but never meets criteria for a viewable impression.

  Returns:

  list of not viewable impressions URL's

• getViewUndeterminedImpressions

  @Nullable() List<String> getViewUndeterminedImpressions()

  A URI that directs the media player to a tracking resource file that the media player should request if the player cannot determine whether criteria is met for a viewable impression.

  Returns:

  list of view undetermined impressions URL's

• getCombinedCompanions

  @Nullable() List<POBCompanion> getCombinedCompanions()

  List of combined companions from all the wrappers

  Returns:

  list of companions

• getCompanions

  @Nullable() List<POBCompanion> getCompanions()

  List of companion creatives.

  Returns:

  list of POBCompanion

• getCombinedObjectList

   List<POBXMLNodeListener> getCombinedObjectList(@NonNull() POBVastAd.POBVastAdParameter parameter)

  Returns the list of the Vast Ad nodes for Inline and all level of its wrapper based on provided parameter

  Parameters:

  parameter - Vast ad parameter

  Returns:

  string list of Vast Ad nodes

• getCombinedVerificationList

   List<POBVerificationScriptResource> getCombinedVerificationList()

  List of the specified Vast ad parameter

  Returns:

  POBXMLNodeListener list of POBVastAdParameter

• getAdVerification

  @Nullable() List<POBAdVerification> getAdVerification()

  List of the AdVerification objects

  Each verification object element contains the executable and bootstrapping data required to run the measurement code for a single verification vendor.

  Returns:

  list of POBAdVerification