AdData

@objc(AASDKAdData)
public protocol AdData

The AdData protocol.

  • id

    ID for an ad. It may be missing.

    Declaration

    Swift

    var id: String? { get }

  • Title for the ad. If a longer description is needed, check the adDescription property.

    Declaration

    Swift

    var adTitle: String { get }

  • Description of the ad. It may be missing.

    Declaration

    Swift

    var adDescription: String? { get }

  • Type of VAST ad. The default is .audio.

    Declaration

    Swift

    var adType: AdType { get }

  • Asset data for the ad.

    Declaration

    Swift

    var asset: AdAsset { get }

  • Companions associated with the ad. May not be available when the ad is preparing/ready to play or has just started playing . Use hasCompanion instead to check for the presence of any companion data.

    Declaration

    Swift

    var companions: [Companion] { get }

  • The selected companion which will be displayed when the ad starts. If hasCompanion is true, expect a a non-nil value. Just like the companions array, it may not be available early in the succession of ad events.

    Declaration

    Swift

    var selectedCompanion: Companion? { get }

  • Marks a timeinterval in seconds that an ad can be skipped.

    Declaration

    Swift

    var skipOffset: NSNumber? { get }

  • VAST ad duration in seconds. It may be -1 when it is missing.

    Declaration

    Swift

    var duration: TimeInterval { get }

  • Ad extensions.

    Declaration

    Swift

    var extensions: [VastExtension] { get }

  • Ad parameters.

    Declaration

    Swift

    var adParameters: VastAdParameters? { get }

  • Creative extensions.

    Declaration

    Swift

    var creativeExtensions: [VastCreativeExtension] { get }

  • VAST pricing info for real-time bidding systems. Optional.

    Declaration

    Swift

    var pricing: VastPricing? { get }

  • VAST advertiser can help publishers prevent display of the ad with its competitors. Optional.

    Declaration

    Swift

    var advertiser: VastAdvertiser? { get }

  • Returns true if the ad has any companion banner information to display. This information is available early in the succession of ad events.

    Declaration

    Swift

    var hasCompanion: Bool { get }
  • isEmpty Extension method

    Checks if an ad object is empty. Returns false if the ad is playable, true otherwise.

    Declaration

    Swift

    public var isEmpty: Bool { get }