Class POBVastCreative
-
- All Implemented Interfaces:
-
com.pubmatic.sdk.video.xmlserialiser.POBXMLNodeListener
public abstract class POBVastCreative implements POBXMLNodeListener
Interface to interact with various types of creatives e.g. linear, non-linear, companion etc.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumPOBVastCreative.POBEventTypespublic enumPOBVastCreative.CreativeTypeDifferent types of Creative's
-
Constructor Summary
Constructors Constructor Description POBVastCreative()
-
Method Summary
Modifier and Type Method Description StringgetClickThroughURL()A URI to open when companion ad is clicked. List<String>getClickTrackers()A URI to notify the player that ad was clicked. List<String>getTrackingEventUrls(@NonNull() POBVastCreative.POBEventTypes event)List of event specific event tracker URL's List<POBTracking>getTrackingEvents(@NonNull() POBVastCreative.POBEventTypes event)List of event specific event tracker URL's abstract POBVastCreative.CreativeTypegetVastCreativeType()Getter method, provides type of creative which is implemented at child classes specific event type classes List<POBVastCreativeExtension>getCreativeExtensions()List of CreativeExtension objects from CreativeExtensions element. voidsetCreativeExtensions(@Nullable() List<POBVastCreativeExtension> creativeExtensions)Sets the CreativeExtensions list. POBVastCreativeExtensiongetPubMaticExtension()Returns the first PubMatic CreativeExtension from the stored list. -
-
Method Detail
-
getClickThroughURL
@Nullable() String getClickThroughURL()
A URI to open when companion ad is clicked.
- Returns:
click through URL
-
getClickTrackers
@Nullable() List<String> getClickTrackers()
A URI to notify the player that ad was clicked.
- Returns:
click tracking URL
-
getTrackingEventUrls
@NonNull() List<String> getTrackingEventUrls(@NonNull() POBVastCreative.POBEventTypes event)
List of event specific event tracker URL's
- Parameters:
event- Type of tracking event- Returns:
List of the tracking URLs
-
getTrackingEvents
@Nullable() List<POBTracking> getTrackingEvents(@NonNull() POBVastCreative.POBEventTypes event)
List of event specific event tracker URL's
- Parameters:
event- Type of tracking event- Returns:
List of the tracking URLs
-
getVastCreativeType
abstract POBVastCreative.CreativeType getVastCreativeType()
Getter method, provides type of creative which is implemented at child classes specific event type classes
- Returns:
creative type(linear, non-linear, campanion)
-
getCreativeExtensions
@Nullable() List<POBVastCreativeExtension> getCreativeExtensions()
List of CreativeExtension objects from CreativeExtensions element. According to IAB VAST schema, CreativeExtensions is a child of Creative element, making it a sibling of Linear/NonLinear elements.
- Returns:
list of POBVastCreativeExtension
-
setCreativeExtensions
void setCreativeExtensions(@Nullable() List<POBVastCreativeExtension> creativeExtensions)
Sets the CreativeExtensions list. This is called during parsing from POBVastAd.
- Parameters:
creativeExtensions- list of CreativeExtension objects
-
getPubMaticExtension
@Nullable() POBVastCreativeExtension getPubMaticExtension()
Returns the first PubMatic CreativeExtension from the stored list. If multiple PubMatic extensions are present, only the first one is returned.
- Returns:
first PubMatic CreativeExtension, or null if none found
-
-
-
-