nimbus-android/com.adsbynimbus.request

Package-level declarations

Contains the classes used for making a Request to Nimbus.

Types

Link copied to clipboard
class AuctionData(val auctionPrice: String? = null, val auctionMinToWin: String? = null, val winningSource: String? = null)
Link copied to clipboard
class GzipRequestInterceptor(val jsonMediaType: MediaType) : Interceptor

Interceptor to Gzip requests

Link copied to clipboard
Link copied to clipboard
class NimbusRequest(val position: String, val request: BidRequest = BidRequest( imp = arrayOf(Impression(ext = Impression.Extension(position))), app = app, user = user, source = Source().takeUnless { !Nimbus.thirdPartyViewabilityEnabled }?.apply { omidpn = Nimbus.sdkName omidpv = Nimbus.version }, ).apply { session_id = Nimbus.sessionId })

A request to Nimbus.

Link copied to clipboard
class NimbusResponse(val bid: BidResponse) : NimbusAd

A response from Nimbus.

Link copied to clipboard
class OkHttpNimbusClient(builder: OkHttpClient.Builder = Builder()) : RequestManager.Client, Component

OkHttp Request Client

Link copied to clipboard
interface RequestManager

Interface for making a request to Nimbus.

Properties

Link copied to clipboard
@get:RequiresPermission(anyOf = ["android.permission.ACCESS_NETWORK_STATE", "android.permission.READ_PHONE_STATE"], conditional = true)
val Context.connectionType: Byte
Link copied to clipboard
var RequestManager.Companion.interceptorTimeout: Long

Sets a timeout in milliseconds for interceptors to all subsequent requests

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var User.nimbusAge: Int?

Property representing the user age to be sent to Nimbus

Link copied to clipboard
var User.nimbusGender: NimbusUserGender?

Property representing the user gender to be sent to Nimbus see NimbusUserGender for possible values

Functions

Link copied to clipboard
fun Asset.Companion.data(id: Int, required: Boolean, type: Byte = DataType.DESC, length: Int = TitleLength.LONG): Asset

Creates an Asset that only contains a Data parameter

Link copied to clipboard
fun device(adId: String = Nimbus.EMPTY_AD_ID, limitAdTracking: Byte = if (adId == Nimbus.EMPTY_AD_ID) 1 else 0, userAgent: String = "", language: String?, connectionType: Byte = ConnectionType.UNKNOWN, widthPixels: Int = 0, heightPixels: Int = 0, pixelRatio: Float, manufacturer: String, model: String, osVersion: String): Device
Link copied to clipboard
fun Asset.Companion.image(id: Int, required: Boolean, type: Byte, format: Format): Asset

Creates an Asset that only contains an Image parameter

Link copied to clipboard
fun RequestManager.notifyLoss(nimbusResponse: NimbusResponse, auctionData: AuctionData?, requestHandler: RequestHandler = Tracker.requestHandler, dispatcher: CoroutineDispatcher = Dispatchers.IO)

Notifies Nimbus of an external auction Loss

Link copied to clipboard
fun RequestManager.notifyWin(nimbusResponse: NimbusResponse, auctionData: AuctionData?, requestHandler: RequestHandler = Tracker.requestHandler, dispatcher: CoroutineDispatcher = Dispatchers.IO)

Notifies Nimbus of an external auction Win

Link copied to clipboard
fun Asset.Companion.title(id: Int, required: Boolean, length: Int): Asset

Creates an Asset that only contains a Title parameter

Link copied to clipboard
fun Asset.Companion.video(id: Int, required: Boolean, mimes: Array<String>? = null, minduration: Int = 1, maxduration: Int = 60, protocols: ByteArray? = null): Asset

Creates an Asset that only contains a Video parameter