Interface Ad

  • All Implemented Interfaces:

    
    public interface Ad
    
                        

    Represents a parsed <Ad> element.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getId() the ad server-defined identifier string for the ad
      abstract Integer getSequence() the identifies the sequence in which an ad should play
      abstract Boolean getConditionalAd() the value that that identifies a conditional ad.
      abstract AdType getAdType() the optional string that identifies the type of ad.
      abstract InLine getInLine() within the nested elements of an <InLine> ad are all the files and URIs necessary to play and track the ad.
      abstract Wrapper getWrapper() VAST Wrappers are used to redirect the media player to another server for either an additional <Wrapper> or the VAST <InLine> ad.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getId

         abstract String getId()

        the ad server-defined identifier string for the ad

      • getSequence

         abstract Integer getSequence()

        the identifies the sequence in which an ad should play

      • getConditionalAd

         abstract Boolean getConditionalAd()

        the value that that identifies a conditional ad.

        In the case of programmatic ad serving, a VPAID ad unit or other mechanism might be used to decide whether there is an ad that matches the placement. When there is no match, an ad may not be served. Use of the conditionalAd attribute enables publishers to avoid accepting these ads in placements where an ad must be served. A value of true indicates that the ad is conditional and should be used in all cases where the InLine executable unit (such as VPAID) is not an ad but is instead a framework for finding an ad; a value of false is the default value and indicates that an ad is available.

        Deprecated in VAST 4.1, along with apiFramework.

      • getAdType

         abstract AdType getAdType()

        the optional string that identifies the type of ad. This allows VAST to support audio ad scenarios.

      • getInLine

         abstract InLine getInLine()

        within the nested elements of an <InLine> ad are all the files and URIs necessary to play and track the ad. In a chain of <Wrapper> VAST responses, an <InLine> response ends the chain.

      • getWrapper

         abstract Wrapper getWrapper()

        VAST Wrappers are used to redirect the media player to another server for either an additional <Wrapper> or the VAST <InLine> ad. In addition to the URI that points to another file, the Wrapper may contain tracking elements that provide tracking for the InLine ad that is served following one or more wrappers. A Wrapper may also contain <Companion> creative and <Icon> creative. And while <Linear> and <NonLinear> elements are available in the Wrapper, they are only used for tracking. No media files are provided for Linear elements, nor are resource files provided for NonLinear elements. Other elements offered for InLine ads may not be offered for Wrappers.