Nimbus

Nimbus is Real Time Bidding solution that connects publisher inventory to demand partners through a server managed open auction.

This class represents the entry point for initializing the Nimbus SDK to request and render ads served through Nimbus. The SDK must be initialized by calling initialize and passing in the key that identifies the publisher and associated api key.

Since

1.0

Types

Logger

fun interface Logger

Interface to listen to logs from the Nimbus SDK.

Properties

adVisibilityMinPercentage

@JvmStatic

var adVisibilityMinPercentage: Int

applicationContext

val applicationContext: Application

closeDrawable

@JvmField

var closeDrawable: Drawable?

A drawable to use as the standard close button

COPPA

@JvmField

var COPPA: Boolean

Mark the app as governed by COPPA regulations.

EMPTY_AD_ID

const val EMPTY_AD_ID: String

isInitialized

val isInitialized: Boolean

muteDrawable

@JvmField

var muteDrawable: Drawable?

A drawable to use as the standard mute button

sdkName

const val sdkName: String

The partner name assigned by the IAB used to identify the Nimbus SDK

sessionId

@JvmField

var sessionId: String

The session id of this Nimbus instance.

testMode

@JvmField

var testMode: Boolean

Enable or disable test mode.

userAgent

@JvmStatic

val userAgent: String

Returns the user agent from the system WebView.

usPrivacyString

@JvmField

var usPrivacyString: String?

Sets a publisher generated string representing compliance with CCPA.

version

const val version: String

The Nimbus SDK version

videoMimeTypes

@JvmField

var videoMimeTypes: Array<String>

Functions

addLogger

@JvmStatic

fun addLogger(logger: Nimbus.Logger)

Add a logger to the Nimbus SDK.

initialize

@JvmStatic

@JvmOverloads

fun initialize(context: Context, publisherKey: String, apiKey: String, components: Set<Component> = emptySet())

Initialize the Nimbus SDK.

removeLogger

@JvmStatic

fun removeLogger(logger: Nimbus.Logger)

Remove a logger from the Nimbus SDK.