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 *_Nullable adURL;

  • BundleId of the app

    Declaration

    Objective-C

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

  • Use this to enable bitrate calculation, or set desiredBitrate

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nullable 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;

  • 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;

  • if you want to have control over the UIAlertController during clickThrough set this to “YES” (and leave clickType on default)

    Declaration

    Objective-C

    @property (nonatomic) BOOL customizableClickThroughAlert;

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

    Declaration

    Objective-C

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

  • use this function to set the verificationVendors whitelist if not set, all vendors are added to the whitelist

    Declaration

    Objective-C

    - (void)setOMIDVerificationVendorWhitelist:(nonnull NSArray *)vendors;

  • 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;

  • SpotXSDK version string

    Declaration

    Objective-C

    + (nonnull NSString *)sdkVersionString;

  • OMIDSDK version string

    Declaration

    Objective-C

    + (nonnull NSString *)omidSDKVersionString;