SVSAdPlacement

Objective-C

@interface SVSAdPlacement : NSObject <NSCoding, NSCopying>

Swift

class SVSAdPlacement : NSObject, NSCoding, NSCopying

Class used to create instream video ad placement.

Placement initialization

  • Initialize a new instance of SVSAdPlacement.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSiteId:(unsigned long)siteId
                                pageId:(unsigned long)pageId
                              formatId:(unsigned long)formatId;

    Swift

    init(siteId: UInt, pageId: UInt, formatId: UInt)

    Parameters

    siteId

    The siteId created on the Smart AdServer manage interface. Create a new site Id for every unique application on your network.
    pageId

    The pageId created on the Smart AdServer manage interface. It is recommanded to create a new page id for every unique screen in your application.
    formatId

    The formatId created on the Smart AdServer manage interface. It is recommanded to create a new format Id for every type of ad you will integrate in your application.

    Return Value

    An initialized instance of SVSAdPlacement.

  • Initialize a new instance of SVSAdPlacement.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSiteId:(unsigned long)siteId
                              pageName:(nonnull NSString *)pageName
                              formatId:(unsigned long)formatId;

    Swift

    init(siteId: UInt, pageName: String, formatId: UInt)

    Parameters

    siteId

    The siteId created on the Smart AdServer manage interface. Create a new site Id for every unique application on your network.
    pageName

    The pageName created on the Smart AdServer manage interface. It is recommanded to create a new page name for every unique screen in your application.
    formatId

    The formatId created on the Smart AdServer manage interface. It is recommanded to create a new format Id for every type of ad you will integrate in your application.

    Return Value

    An initialized instance of SVSAdPlacement.

  • Returns an initialized SVSAdPlacement object.

    Declaration

    Objective-C

    + (nonnull instancetype)adPlacementWithSiteId:(unsigned long)siteId
                                       pageId:(unsigned long)pageId
                                     formatId:(unsigned long)formatId;

    Parameters

    siteId

    The siteId created on the Smart AdServer manage interface. Create a new site Id for every unique application on your network.
    pageId

    The pageId created on the Smart AdServer manage interface. It is recommanded to create a new page id for every unique screen in your application.
    formatId

    The formatId created on the Smart AdServer manage interface. It is recommanded to create a new format Id for every type of ad you will integrate in your application.

    Return Value

    An initialized instance of SVSAdPlacement.

  • Returns an initialized SVSAdPlacement object.

    Declaration

    Objective-C

    + (nonnull instancetype)adPlacementWithSiteId:(unsigned long)siteId
                                     pageName:(nonnull NSString *)pageName
                                     formatId:(unsigned long)formatId;

    Parameters

    siteId

    The siteId created on the Smart AdServer manage interface. Create a new site Id for every unique application on your network.
    pageName

    The pageName created on the Smart AdServer manage interface. It is recommanded to create a new page name for every screen in your application.
    formatId

    The formatId created on the Smart AdServer manage interface. It is recommanded to create a new format Id for every type of ad you will integrate in your application.

    Return Value

    An initialized instance of SVSAdPlacement.

  • Returns an initialized SVSAdPlacement object corresponding to a test video ad breaks.

    A test video ad breaks will always deliver and will always be from a specific type. You can use these tests to verify that your integration will work properly with all types of ads.

    Available test video ad breaks are listed in the SVSAdPlacementTest object.

    Warning

    If you set a test placement, make sure to remove it before submitting your application to the App Store.

    Declaration

    Objective-C

    + (nonnull instancetype)adPlacementForTestAd:(SVSAdPlacementTest)type;

    Swift

    convenience init(forTestAd type: SVSAdPlacementTest)

    Parameters

    type

    The type of ad breaks you want to get for ad calls.

    Return Value

    An initialized instance of SVSAdPlacement corresponding to a test video ad breaks.

Targeting

  • A string representing a set of keywords that will be passed to Smart AdServer to receive more relevant advertising.

    Keywords are typically used to target ad campaign insertions at specific user segments. They should be formatted as comma-separated key-value pairs (e.g. “gender=female,age=27”).

    On the Smart AdServer manage interface, keyword targeting options can be found under the Targeting / Keywords section when managing campaign insertions.

    The global targeting will be used if no targeting is set for a given Ad Break.

    Declaration

    Objective-C

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

    Swift

    var globalKeywordsTargeting: String? { get set }

  • A string representing a set of keywords that will be passed to Smart AdServer to receive more relevant ads when performing an Ad call for a Preroll Ads.

    If nil, the globalKeywordsTargeting will be used.

    Declaration

    Objective-C

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

    Swift

    var preRollKeywordsTargeting: String? { get set }

  • A string representing a set of keywords that will be passed to Smart AdServer to receive more relevant ads when performing an Ad call for a Midroll Ads.

    If nil, the globalKeywordsTargeting will be used.

    Declaration

    Objective-C

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

    Swift

    var midRollKeywordsTargeting: String? { get set }

  • A string representing a set of keywords that will be passed to Smart AdServer to receive more relevant ads when performing an Ad call for a Postroll Ads.

    If nil, the globalKeywordsTargeting will be used.

    Declaration

    Objective-C

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

    Swift

    var postRollKeywordsTargeting: String? { get set }

  • A string representing the Supply Chain Object that will be passed to Smart AdServer during ad calls.

    You should fill this parameter if you are reselling inventory from direct publishers. You can find more information about Supply Chain Object at this URL:

    https://help.smartadserver.com/s/article/Sellers-json-and-SupplyChain-Object

    If nil, no Supply Chain Object will be added to the ad call and Smart will add its own node.

    Declaration

    Objective-C

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

    Swift

    var supplyChainObjectString: String? { get set }

Placement properties

  • A Long representing the siteId that should be passed to Smart AdServer to receive advertising.

    Declaration

    Objective-C

    @property (nonatomic, readonly) unsigned long siteId;

    Swift

    var siteId: UInt { get }

  • A Long representing the page id (if page name is not set) that should be passed to Smart AdServer to receive advertising.

    Declaration

    Objective-C

    @property (nonatomic, readonly) unsigned long pageId;

    Swift

    var pageId: UInt { get }

  • A String representing the page name (if page id is not set) that should be passed to Smart AdServer to receive advertising.

    Declaration

    Objective-C

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

    Swift

    var pageName: String? { get }

  • A Long representing the format id that should be passed to Smart AdServer to receive instream advertising format.

    Declaration

    Objective-C

    @property (nonatomic, readonly) unsigned long formatId;

    Swift

    var formatId: UInt { get }