Nimbus Android SDK

2.35.2

nimbus-android/com.adsbynimbus.openrtb.response/BidResponse

BidResponse

@Serializable

class BidResponse(val type: String, val auction_id: String, val adomain: Array<String>? = null, val bid_in_cents: Int = 0, val bid_raw: Float = 0.0f, val content_type: String? = null, val crid: String? = null, val height: Int = 0, val width: Int = 0, val is_interstitial: Byte = 0, val markup: String, val network: String = "", val placement_id: String? = null, val is_mraid: Byte = 0, val position: String, val trackers: Map<String, Array<String>> = emptyMap(), val duration: Int = 0, val exp: Int = -1, val external_notifications: Map<String, String> = emptyMap())

A winning bid response from Nimbus

Constructors

constructor(type: String, auction_id: String, adomain: Array<String>? = null, bid_in_cents: Int = 0, bid_raw: Float = 0.0f, content_type: String? = null, crid: String? = null, height: Int = 0, width: Int = 0, is_interstitial: Byte = 0, markup: String, network: String = "", placement_id: String? = null, is_mraid: Byte = 0, position: String, trackers: Map<String, Array<String>> = emptyMap(), duration: Int = 0, exp: Int = -1, external_notifications: Map<String, String> = emptyMap())

Types

object Companion

Properties

val adomain: Array<String>?

An optional list of the advertising domains associated with this ad.

val auction_id: String

This unique auction id. Represented as a GUID.

val bid_in_cents: Int

This winning auction's bid in cents.

val bid_raw: Float

This winning auction's precise winning bid.

val click_trackers: Array<String>?

Urls to fire a request to when a click is registered

val content_type: String?

The content type of this creative. "text/html" for static or a mime type for video ads

val crid: String?

The creative ID of this ad if known

val duration: Int

The duration in seconds or 0 if unknown or another ad type.

val exp: Int

Number of seconds a bidder can wait before rendering the impression.

external_notifications

val external_notifications: Map<String, String>

Contains urls used to notify external services.

val height: Int

The height of the creative if available. Will not be set for Video or Native ads

impression_trackers

val impression_trackers: Array<String>?

Urls to fire a request to when an impression is registered

is_interstitial

val is_interstitial: Byte

Set to 1 if the original request was for an interstitial ad

val is_mraid: Byte

Set to 1 if Nimbus has determined the creative returned requests MRAID in the creative markup

val loss_response: String?

Url to fire a request to when this bid loses an auction

val markup: String

The markup returned by Nimbus. Will be in the format of html for static or xml VAST for video

val network: String

The network that won this auction

val placement_id: String?

The winning placement id if the winning bid maps to a line item

val position: String

The position from the request for this ad.

val trackers: Map<String, Array<String>>

Contains additional tracking urls for measurement.

val type: String

The type of creative returned. This maps to one of "static", "video", or "native"

The width of the creative if available. Will not be set for Video or Native ads

val win_response: String?

Url to fire a request to when this bid wins an auction