-
- All Implemented Interfaces:
public interface AdThe Ad API represents a VAST creative. It is either a linear or non-linear ad.
-
-
Method Summary
Modifier and Type Method Description abstract StringgetId()The identifier of the creative, provided in the VAST-file. abstract List<CompanionAd>getCompanions()The List of CompanionAds associated to the ad, if available within the same Creatives element. abstract StringgetType()The type of the Ad. abstract AdBreakgetAdBreak()A reference to the AdBreak of which the ad is a part of. abstract intgetSkipOffset()The number of seconds after which the Ad can be skipped. abstract AdIntegrationKindgetIntegration()The type of ad integration. -
-
Method Detail
-
getId
@NonNull() abstract String getId()
The identifier of the creative, provided in the VAST-file.
Default: Empty string.
-
getCompanions
@NonNull() abstract List<CompanionAd> getCompanions()
The List of CompanionAds associated to the ad, if available within the same Creatives element.
-
getType
@Nullable() abstract String getType()
The type of the Ad.
- It can be either 'linear' or 'nonlinear', depending on the concrete implementor.
-
getAdBreak
@Nullable() abstract AdBreak getAdBreak()
A reference to the AdBreak of which the ad is a part of.
-
getSkipOffset
abstract int getSkipOffset()
The number of seconds after which the Ad can be skipped.
- Only available when the ad is skippable.
- Only available for LinearAd.
Default: 0
-
getIntegration
@Nullable() abstract AdIntegrationKind getIntegration()
The type of ad integration.
- For all possibilities, see: AdIntegrationKind.
-
-
-
-