nimbus-android/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

Link copied to clipboard
constructor(bid: BidResponse)

Types

Link copied to clipboard
fun interface Listener

Listener for the response from a NimbusRequest.

Properties

Link copied to clipboard
open override val auctionId: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val NimbusResponse.defaultMapping: Mapping

Returns the default Dynamic Price Mappings for a NimbusResponse

Link copied to clipboard
@JvmField
@Transient
var placementIdOverride: String?

Overrides the placement id of the winning ad for use with SDK demand providers

Link copied to clipboard
@JvmField
@Transient
var renderInfoOverride: MutableMap<String, String>

Overrides the render info of the winning ad for use with SDK demand providers

Functions

Link copied to clipboard
open override fun bidInCents(): Int

The bid in cents of the winning ad.

Link copied to clipboard
open override fun bidRaw(): Float

The raw bid value of the ad's winning bid as a float.

Link copied to clipboard
open override fun companionAds(): Array<CompanionAd>?

Returns a list of companion ads that could be rendered with this ad

Link copied to clipboard
open override fun height(): Int

The height of the ad unit in density independent pixels 0 if not available.

Link copied to clipboard
open override fun isInterstitial(): Boolean

Returns true if the ad is an interstitial ad.

Link copied to clipboard
open override fun isMraid(): Boolean

Returns true if the ad is MRAID.

Link copied to clipboard
open override fun markup(): String

The markup of the winning ad.

Link copied to clipboard
open override fun network(): String

The network name of the winning ad.

Link copied to clipboard
open override fun placementId(): String?

The placement id of the winning ad.

Link copied to clipboard
open override fun position(): String

The named position from the request for this winning ad.

Link copied to clipboard
open override fun renderInfo(): Map<String, String>

Network specific render information. Internal use only.

Link copied to clipboard
fun NimbusResponse.targetingMap(mapping: Mapping = defaultMapping): Map<String, String>

Returns a targeting map that must be applied for Dynamic Price to function properly

Link copied to clipboard
open override fun trackersForEvent(event: AdEvent): Collection<String>?

Returns a list of tracker urls for the requested AdEvent

Link copied to clipboard
open override fun type(): String

The ad type.

Link copied to clipboard
open override fun width(): Int

The width of the ad unit in density independent pixels 0 if not available.