SCAdConfiguration

@interface SCAdConfiguration : NSObject

This class is used for configuring the advertisement behavior

  • The request url for you advertisement content

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull adURL;

  • BundleId of the app

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull bundleId;

  • AdvertiserId

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull advertisementId;

  • Use this to enable bitrate calculation, or set desiredBitrate

    Declaration

    Objective-C

    @property (nonatomic, strong) SCAdEnvironment *_Nonnull environment;

  • If you use opener, closer or bumper, SCAdVariants is the place to define them

    Declaration

    Objective-C

    @property (nonatomic, strong) SCAdVariants *_Nonnull variants;

  • Use this property to specify a custom title for the ad.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull customTitle;

  • Use this property to specify a custom title color for the ad.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull customTitleColor;

  • Use this property to specify a custom progress bar color for the ad.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull customProgressBarColor;

  • You can prevent ad skipping with this boolean value, defaults to true

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowAdSkipping;

  • You can define an offset value, when you want to allow ad skipping (defaults to -1, meaning never)

    Declaration

    Objective-C

    @property (nonatomic) NSInteger skipOffset;

  • true if the audio of the advertisement should be muted from the beginning. Defaulting to false.

    Declaration

    Objective-C

    @property (nonatomic) BOOL initialMuted;

  • true to show the mute button. Defaulting to true.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showMuteToggleButton;

  • name of the image asset used for the off state of the sound button

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull soundButtonOffImageName;

  • name of the image asset used for the on state of the sound button

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull soundButtonOnImageName;

  • message to be displayed on the clickThrough dialog (default: “Open in Browser?”)

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull clickThroughDialogMessage;

  • string to be displayed on the clickThrough dialog`s positive answer button (default: “YES”)

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull clickThroughPositiveAnswer;

  • string to be displayed on the clickThrough dialog`s negative answer button (default: “NO”)

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull clickThroughNegativeAnswer;

  • clickType for clickThrough handling (default: ClickableWithConfirmationDialog)

    Declaration

    Objective-C

    @property (nonatomic) enum SCClickType clickType;

  • onEndBehavior defines the behavior at the end of an (outstream) ad (nothing, collapse, repeat)

    Declaration

    Objective-C

    @property (nonatomic) enum SCOnEndBehavior onEndBehavior;

  • name of the image asset used for the replay button (outstream only)

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull replayButtonImageName;

  • name of OMID Partner for adVerification

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull omidPartnerName;

  • OMID version string for adVerification

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull omidVersion;

  • force opener playback

    Declaration

    Objective-C

    @property (nonatomic) BOOL forceOpener;

  • force closer playback

    Declaration

    Objective-C

    @property (nonatomic) BOOL forceCloser;

  • force bumper playback

    Declaration

    Objective-C

    @property (nonatomic) BOOL forceBumper;

  • The default configuration can be accessed through this static method

    Declaration

    Objective-C

    + (nonnull SCAdConfiguration *)
    defaultConfigurationWith:(nonnull NSString *)requestURL
                    variants:(nonnull SCAdVariants *)variants;

  • Default configuration initialized with the given SCAdEnvironment values

    Declaration

    Objective-C

    + (nonnull SCAdConfiguration *)
    defaultConfigurationWith:(nonnull NSString *)requestURL
                    variants:(nonnull SCAdVariants *)variants
                 environment:(nonnull SCAdEnvironment *)environment;

  • defaultInstreamConfiguration for use with sequencer

    Declaration

    Objective-C

    + (nonnull SCAdConfiguration *)defaultInstreamConfigurationWith:
    (nonnull SCAdEnvironment *)environment;

  • defaultOutstreamConfiguration for use with sequencer

    Declaration

    Objective-C

    + (nonnull SCAdConfiguration *)defaultOutstreamConfigurationWith:
    (nonnull SCAdEnvironment *)environment;

  • SpotXSDK version string

    Declaration

    Objective-C

    + (nonnull NSString *)sdkVersionString;

  • OMIDSDK version string

    Declaration

    Objective-C

    + (nonnull NSString *)omidSDKVersionString;