Nimbus Android SDK

//sdk/com.adsbynimbus.request/NimbusResponse

NimbusResponse

class NimbusResponse(val bid: BidResponse) : NimbusAd

A response from Nimbus.

This class wraps a NimbusResponse from Nimbus to be passed into a Renderer.

Constructors

NimbusResponse constructor(bid: BidResponse)

Types

Name Summary
Listener fun interface Listener
Listener for the response from a NimbusRequest.

Properties

Name Summary
auctionId open override val auctionId: String
bid @JvmField
val bid: BidResponse
companionAds @Transient
@JvmField
var companionAds: Array<CompanionAd>?
defaultMapping val NimbusResponse.defaultMapping: Mapping
Returns the default Dynamic Price Mappings for a NimbusResponse
placementIdOverride @JvmField
@Transient
var placementIdOverride: String?
Overrides the placement id of the winning ad for use with SDK demand providers
renderInfoOverride @JvmField
@Transient
var renderInfoOverride: MutableMap<String, String>
Overrides the render info of the winning ad for use with SDK demand providers

Functions

Name Summary
applyDynamicPrice @JvmOverloads
fun NimbusResponse.applyDynamicPrice(request: AdManagerAdRequest.Builder, mapping: Mapping = defaultMapping)
Applies Dynamic Price targeting to an AdManagerAdRequest.
bidInCents open override fun bidInCents(): Int
The bid in cents of the winning ad.
bidRaw open override fun bidRaw(): Float
The raw bid value of the ad's winning bid as a float.
companionAds open override fun companionAds(): Array<CompanionAd>?
height open override fun height(): Int
The height of the ad unit in density independent pixels 0 if not available.
isInterstitial open override fun isInterstitial(): Boolean
Returns true if the ad is an interstitial ad.
isMraid open override fun isMraid(): Boolean
Returns true if the ad is MRAID.
markup open override fun markup(): String
The markup of the winning ad.
network open override fun network(): String
The network name of the winning ad.
placementId open override fun placementId(): String?
The placement id of the winning ad.
position open override fun position(): String
The named position from the request for this winning ad.
renderInfo open override fun renderInfo(): Map<String, String>
targetingMap fun NimbusResponse.targetingMap(mapping: Mapping = defaultMapping): Map<String, String>
Returns a targeting map that must be applied for Dynamic Price to function properly
trackersForEvent open override fun trackersForEvent(event: AdEvent): Collection<String>?
Returns a list of tracker urls for the requested AdEvent
type open override fun type(): String
The ad type.
width open override fun width(): Int
The width of the ad unit in density independent pixels 0 if not available.