SASMediationNativeAdInfo

Objective-C

@interface SASMediationNativeAdInfo : NSObject

Swift

class SASMediationNativeAdInfo : NSObject

Represents a native ad that has been retrieved from a third party mediation SDK.

Use this class to forward information from a mediation SDK to the Smart Display SDK so it can use it in its mediation waterfall.

Required information

  • The title of the ad (required).

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull title;

    Swift

    var title: String { get }

Optional information

  • The subtitle of the ad.

    Can be used as a short description.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *subtitle;

    Swift

    var subtitle: String? { get set }

  • The body of the ad.

    Can be used as a long description.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *body;

    Swift

    var body: String? { get set }

  • The call to action text of the ad.

    This text represents the action that will be made when the ad is clicked: for instance ‘Open’ or ‘Download’.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *callToAction;

    Swift

    var callToAction: String? { get set }

  • The icon of the ad.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SASNativeAdImage *icon;

    Swift

    var icon: SASNativeAdImage? { get set }

  • The cover image of the ad.

    A cover image is an image that is generally larger that the icon and that will generally be used as a background image.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) SASNativeAdImage *coverImage;

    Swift

    var coverImage: SASNativeAdImage? { get set }

  • The video URL that should be displayed by a media view.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSURL *videoURL;

    Swift

    var videoURL: URL? { get set }

  • An optional dictionary of video tracking events that will be called by the media view.

    These video events must have a valid event name (NSString type) as key and a valid URL (NSURL type) as object, otherwise they will be ignored.

    Valid event names are:

    • click
    • creativeView
    • start
    • firstQuartile
    • midpoint
    • thirdQuartile
    • complete
    • mute
    • unmute
    • pause
    • rewind
    • resume
    • fullscreen
    • exitFullscreen
    • progress
    • timeToClick
    • skip
    • vpaidAdInteraction

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDictionary *videoTrackingEvents;

    Swift

    var videoTrackingEvents: [AnyHashable : Any]? { get set }

  • The ‘sponsored by’ message of the ad.

    Generally contains the brand name of the sponsor.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *sponsored;

    Swift

    var sponsored: String? { get set }

  • The rating between 0-5 of the advertised app / product or SASRatingUndefined if not set.

    Declaration

    Objective-C

    @property (nonatomic) float rating;

    Swift

    var rating: Float { get set }

  • Number of social likes of the advertised app / product or SASLikesUndefined if not set.

    Declaration

    Objective-C

    @property (nonatomic) long likes;

    Swift

    var likes: Int { get set }

  • Number of downloads / installs of the advertised app or SASDownloadsUndefined if not set.

    Declaration

    Objective-C

    @property (nonatomic) long downloads;

    Swift

    var downloads: Int { get set }

  • The price of of the advertised app / product, value will generally include currency symbol in localized format.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *price;

    Swift

    var price: String? { get set }

  • A list of impression URLs that should be called by the Smart SDK when the impression is counted.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray *impressionURLs;

    Swift

    var impressionURLs: [Any]? { get set }

  • A list of click counting URLs that should be called by the Smart SDK when the ad is clicked.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray *countClickURLs;

    Swift

    var countClickURLs: [Any]? { get set }

Init method

  • Initialize a new instance of SASMediationNativeAdInfo.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTitle:(nonnull NSString *)title;

    Swift

    init(title: String)

    Parameters

    title

    The title of the mediation ad.

    Return Value

    An Initialized new instance of SASMediationNativeAdInfo.