BMPVastAdData

Objective-C

@protocol BMPVastAdData <BMPAdData>

Swift

protocol VastAdData : AdData

Holds various additional ad data that’s available in the VAST response.

  • A common name for the ad. Specified in InLine.AdTitle in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *adTitle;

    Swift

    var adTitle: String? { get }

    Return Value

    A common name for the ad. Specified in InLine.AdTitle in the VAST response.

  • The AdSystem that returned the ad. Specified in InLine.AdSystem in the VAST response.

    See

    BMPAdSystem

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BMPAdSystem *adSystem;

    Swift

    var adSystem: AdSystem? { get }

    Return Value

    The AdSystem that returned the ad. Specified in InLine.AdSystem in the VAST response.

  • The IDs of the Wrapper ads, starting at the InLine ad and ending at the outermost Wrapper ad. Contains an empty array if there are no Wrapper ads.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull wrapperAdIds;

    Swift

    var wrapperAdIds: [String] { get }

    Return Value

    The IDs of the Wrapper ads, starting at the InLine ad and ending at the outermost Wrapper ad. Contains an empty array if there are no Wrapper ads.

  • A longer description of the ad. Specified in InLine.Description in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *adDescription;

    Swift

    var adDescription: String? { get }

    Return Value

    A longer description of the ad. Specified in InLine.Description in the VAST response.

  • The Advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

    See

    BMPAdvertiser

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BMPAdvertiser *advertiser;

    Swift

    var advertiser: Advertiser? { get }

    Return Value

    The Advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

  • Identifies the API needed to execute an interactive media file or communicate with the creative. Specified in MediaFile.apiFramework for linear ads or NonLinear.apiFramework for non-linear ads in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *apiFramework;

    Swift

    var apiFramework: String? { get }

    Return Value

    Identifies the API needed to execute an interactive media file or communicate with the creative. Specified in MediaFile.apiFramework for linear ads or NonLinear.apiFramework for non-linear ads in the VAST response.

  • Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

    See

    BMPCreative

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BMPCreative *creative;

    Swift

    var creative: Creative? { get }

    Return Value

    Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

  • The media file ID. Specified in MediaFile.id in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *mediaFileId;

    Swift

    var mediaFileId: String? { get }

    Return Value

    The media file ID. Specified in MediaFile.id in the VAST response.

  • Either ‘progressive’ for progressive download protocols or ‘streaming’ for streaming protocols. Specified in MediaFile.delivery in the VAST response.

    @returns either ‘progressive’ for progressive download protocols or ‘streaming’ for streaming protocols. Specified in MediaFile.delivery in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *delivery;

    Swift

    var delivery: String? { get }

  • The codec used to encode the file which can take values as specified by https://tools.ietf.org/html/rfc4281. Specified in MediaFile.codec in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *codec;

    Swift

    var codec: String? { get }

    Return Value

    The codec used to encode the file which can take values as specified by https://tools.ietf.org/html/rfc4281. Specified in MediaFile.codec in the VAST response.

  • The minimum suggested duration that the creative should be displayed. Specified in NonLinear.minSuggestedDuration in the VAST response.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval minSuggestedDuration;

    Swift

    var minSuggestedDuration: TimeInterval { get }

    Return Value

    The minimum suggested duration that the creative should be displayed. Specified in NonLinear.minSuggestedDuration in the VAST response.

  • Used to provide a value that represents an AdPricing information that can be used by real-time bidding (RTB) systems. Specified in Inline.Pricing in the VAST response.

    See

    BMPAdPricing

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BMPAdPricing *pricing;

    Swift

    var pricing: AdPricing? { get }

    Return Value

    A value that represents an AdPricing information that can be used by real-time bidding (RTB) systems. Specified in Inline.Pricing in the VAST response.

  • URI to any resource relating to an integrated AdSurvey. Specified in InLine.Survey in the VAST response.

    See

    BMPAdSurvey

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) BMPAdSurvey *survey;

    Swift

    var survey: AdSurvey? { get }

    Return Value

    URI to any resource relating to an integrated AdSurvey. Specified in InLine.Survey in the VAST response.