Nimbus

class Nimbus

Nimbus SDK global object

  • Singleton

    Declaration

    Swift

    static let shared: Nimbus

  • Name of the SDK (also used for viewability)

    Declaration

    Swift

    let sdkName: String

  • Undocumented

    Declaration

    Swift

    let version: String

  • Unique session id for the current app session

    Declaration

    Swift

    var sessionId: String

  • Whether the ads are subject to the COPPA regulations established by the USA FTC

    Declaration

    Swift

    var coppa: Bool

  • Whether Nimbus test mode is on. Default: false

    Declaration

    Swift

    var testMode: Bool

  • SDK wide logger. Override this if you want to do custom logging.

    Declaration

    Swift

    var logger: Logger

  • Log level. Default: NimbusLogLevel.off

    Declaration

    Swift

    var logLevel: NimbusLogLevel { get set }

  • Renderers used for given auction types. Override this to use your own.

    Declaration

    Swift

    var renderers: [NimbusRendererType : AdRenderer] { get set }

  • Configure CCPA / US privacy string.

    The CCPA privacy string is a 4 character string in the following format:

    • Integer - Privacy string version.
    • [Y, N, -] - Publisher has provided explicit user notice.
    • [Y, N, -] - User opted out of sale
    • [Y, N, -] - Publisher operating under the Limited Service Provider Agreement

    If the user does not fall within a US Privacy jurisdiction, hyphens should be used in the last three positions, generating this privacy string: “1—”

    Declaration

    Swift

    var usPrivacyString: String?

  • Enable viewability for OM

    Declaration

    Swift

    var isThirdPartyViewabilityEnabled: Bool

  • Tracks ad viewability

    Declaration

    Swift

    var viewabilityProvider: NimbusViewabilityProvider?

  • Initializes the Nimbus SDK, call inside AppDelegate’s didFinishLaunchingWithOptions

    Declaration

    Swift

    func initialize(publisher: String, apiKey: String)

    Parameters

    publisher

    Nimbus publisher name
    apiKey

    Nimbus API key