POBVastAd (video API)

java.lang.Object
- com.pubmatic.sdk.video.vastmodels.POBVastAd

All Implemented Interfaces:

POBXMLNodeListener
```
public class POBVastAd
extends java.lang.Object
implements POBXMLNodeListener
```
Instance of this modal class saves the data of VAST Ad node.
This object may be an inline ad or a wrapper.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`POBVastAd.POBVastAdParameter` Enum to specify vast ad parameter type
`static class`	`POBVastAd.POBVastAdType` Vast ad type

Constructor Summary

Constructors
Constructor and Description

POBVastAd()

Constructors
Constructor and Description
`POBVastAd()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`build(POBNodeBuilder builder)` POBXMLParser calls this method to build model class object with node builder
`java.lang.String`	`getAdServingId()` A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.
`java.lang.String`	`getAdSystem()` A string that provides the name of the ad server that returned the ad
`java.lang.String`	`getAdTitle()` A string that provides a common name for the ad
`POBVastAd.POBVastAdType`	`getAdType()` Vast ad type inline or wrapper
`java.util.List<POBAdVerification>`	`getAdVerification()` List of the AdVerification objects
`POBIcon`	`getClosestIcon()` Returns the closest Icon from the Linear ad of current Vast ad.
`java.util.List<POBCompanion>`	`getCombinedCompanions()` List of combined companions from all the wrappers
`java.util.List<java.lang.String>`	`getCombinedList(POBVastAd.POBVastAdParameter parameter)` List of the specified Vast ad parameter
`java.util.List<POBXMLNodeListener>`	`getCombinedObjectList(POBVastAd.POBVastAdParameter parameter)` List of the specified Vast ad parameter
`java.util.List<java.lang.String>`	`getCombinedTrackingEventList(POBVastCreative.POBEventTypes eventTypes)` List of the specified Vast ad parameter
`java.util.List<com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider.POBVerificationScriptResource>`	`getCombinedVerificationList()` List of the specified Vast ad parameter
`java.util.List<POBCompanion>`	`getCompanions()` List of companion creatives.
`POBVastCreative`	`getCreative()` Creative of type POBVastCreative.
`java.lang.String`	`getDescription()` A string value that describes a longer description of the ad
`java.util.List<java.lang.String>`	`getErrorURLs()` List of URIs to tracking resource to be used when an error in ad playback occurs.
`int`	`getExpires()` An integer value that defines the expiry period (in seconds).
`java.util.List<java.lang.String>`	`getImpressions()` List of URLs to notify the ad server when the impression occurs.
`java.util.List<java.lang.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.
`java.lang.String`	`getPricing()` A numerical value that represents a price that can be used in real-time bidding systems
`java.lang.String`	`getVASTAdTagURI()` A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.
`java.util.List<java.lang.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.
`java.util.List<java.lang.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.
`POBVastAd`	`getWrapper()` Reference of wrapper through which current VastAd is received.
`void`	`setWrapper(POBVastAd wrapper)` Setter to set wrpper ad on current VAST ad

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - POBVastAd
```
public POBVastAd()
```
- Method Detail
  - build
```
public void build(POBNodeBuilder builder)
```
    Description copied from interface: POBXMLNodeListener
    
    POBXMLParser calls this method to build model class object with node builder
    
    Specified by:
    
    build in interface POBXMLNodeListener
  - getAdType
```
public POBVastAd.POBVastAdType getAdType()
```
    Vast ad type inline or wrapper
    
    Returns:
    
    ad type
  - getAdSystem
```
public java.lang.String getAdSystem()
```
    A string that provides the name of the ad server that returned the ad
    
    Returns:
    
    ad server name
  - getAdTitle
```
public java.lang.String getAdTitle()
```
    A string that provides a common name for the ad
    
    Returns:
    
    ad name
  - getAdServingId
```
public java.lang.String getAdServingId()
```
    A unique or pseudo-unique (long enough to be unique when combined with timestamp data) numerical value.
    
    Returns:
    
    ad serving id
  - getDescription
```
public java.lang.String getDescription()
```
    A string value that describes a longer description of the ad
    
    Returns:
    
    ad description
  - getPricing
```
public java.lang.String getPricing()
```
    A numerical value that represents a price that can be used in real-time bidding systems
    
    Returns:
    
    price value
  - getExpires
```
public int getExpires()
```
    An integer value that defines the expiry period (in seconds).
    
    Returns:
    
    expiry period
  - getVASTAdTagURI
```
public java.lang.String getVASTAdTagURI()
```
    A URI to a VAST response that may be another VAST Wrapper or a VAST InLine ad.
    
    Returns:
    
    VAST Ad Tag URL
  - getCreative
```
public POBVastCreative getCreative()
```
    Creative of type POBVastCreative. The creative may be linear or non-linear
    
    Returns:
    
    linear or non-linear creative
  - getCompanions
```
public java.util.List<POBCompanion> getCompanions()
```
    List of companion creatives.
    
    Returns:
    
    list of POBCompanion
  - getAdVerification
```
public java.util.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
  - getCombinedTrackingEventList
```
@NonNull
public java.util.List<java.lang.String> getCombinedTrackingEventList(@NonNull
                                                                              POBVastCreative.POBEventTypes eventTypes)
```
    List of the specified Vast ad parameter
    
    Returns:
    
    string list of POBVastAdParameter
  - getClosestIcon
```
@Nullable
public 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
public java.util.List<java.lang.String> getCombinedList(@NonNull
                                                                 POBVastAd.POBVastAdParameter parameter)
```
    List of the specified Vast ad parameter
    
    Returns:
    
    string list of POBVastAdParameter
  - getCombinedCompanions
```
public java.util.List<POBCompanion> getCombinedCompanions()
```
    List of combined companions from all the wrappers
    
    Returns:
    
    list of companions
  - getCombinedObjectList
```
public java.util.List<POBXMLNodeListener> getCombinedObjectList(@NonNull
                                                                POBVastAd.POBVastAdParameter parameter)
```
    List of the specified Vast ad parameter
    
    Returns:
    
    POBXMLNodeListener list of POBVastAdParameter
  - getCombinedVerificationList
```
public java.util.List<com.pubmatic.sdk.common.viewability.POBVideoMeasurementProvider.POBVerificationScriptResource> getCombinedVerificationList()
```
    List of the specified Vast ad parameter
    
    Returns:
    
    POBXMLNodeListener list of POBVastAdParameter
  - getWrapper
```
public POBVastAd getWrapper()
```
    Reference of wrapper through which current VastAd is received.
    
    Returns:
    
    wrapper ad
  - getImpressions
```
public java.util.List<java.lang.String> getImpressions()
```
    List of URLs to notify the ad server when the impression occurs.
    
    Returns:
    
    list of impression URL's
  - getErrorURLs
```
public java.util.List<java.lang.String> getErrorURLs()
```
    List of URIs to tracking resource to be used when an error in ad playback occurs.
    
    Returns:
    
    error URL list
  - getViewableImpressions
```
public java.util.List<java.lang.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
```
public java.util.List<java.lang.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
```
public java.util.List<java.lang.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
  - setWrapper
```
public void setWrapper(POBVastAd wrapper)
```
    Setter to set wrpper ad on current VAST ad
    
    Parameters:
    
    wrapper - previous wrapper ad

Class POBVastAd

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

POBVastAd

Method Detail

build

getAdType

getAdSystem

getAdTitle

getAdServingId

getDescription

getPricing

getExpires

getVASTAdTagURI

getCreative

getCompanions

getAdVerification

getCombinedTrackingEventList

getClosestIcon

getCombinedList

getCombinedCompanions

getCombinedObjectList

getCombinedVerificationList

getWrapper

getImpressions

getErrorURLs

getViewableImpressions

getNotViewableImpressions

getViewUndeterminedImpressions

setWrapper