shared-proto
API
Generated with
shared-proto/io/io.predictor.v1/AdRequestContext

AdRequestContext

io.predictor.v1.AdRequestContext
See theAdRequestContext companion object
final case class AdRequestContext(exchange: String, appBundle: String, appId: String, os: String, osVersion: Option[OsVersion], country: String, deviceType: Int, deviceModel: String, deviceMake: String, displayManager: String, displayManagerVersion: Int, language: String, sellerName: String, sellerId: String, sourceId: String, sourceName: String, badv: Seq[String], bcat: Seq[String], bapp: Seq[String], adType: String, coppa: Boolean, test: Boolean, ifa: String, ifv: String, bidTimeSeconds: Long, rewardedBanner: Boolean, rewardedVideo: Boolean, skadnSupported: Boolean, region: String, city: String, zip: String, timezone: String, connType: Int, placementIsVertical: Boolean, ipAddress24: String, peakHours: Boolean, bidFloor: Float, placementW: Int, placementH: Int, placementSecure: Int, placementTopframe: Int, impInstl: Int, bannerApi: Seq[Int], bannerAttr: Seq[Int], bannerType: Seq[Int], bannerW: Int, bannerH: Int, videoMinduration: Int, videoMaxduration: Int, videoProtocols: Seq[Int], videoMimes: Seq[String], videoAttr: Seq[Int], videoW: Int, videoH: Int, bmExtensionWinnerDspId: String, bmExtensionWinnerBundle: String, bmExtensionWinnerPrice: Float, thirdPartyBidPrice: Float, minFloor: Float, cachedLurlPrice: Float, bmCachedLurlPrice: Float, cachedLurlMillisPassed: Long, sdkStackId: String, mediationStackId: String, mediationMode: String, originalFloor: Float, vectorId: String, bidmachinePlacementValue: Float, placementHistoricalValue: Float, depthAdreqs1H: Int, depthAdreqs1D: Int, depthAdreqs7D: Int, depthImps1H: Int, depthImps1D: Int, depthImps7D: Int, deviceExtBatterylevel: Float, deviceExtCharging: Int, deviceExtTotaldisk: Long, deviceExtTotalmem: Long, deviceExtFreemem: Long, deviceExtScreenbright: Float, userClickRate: Float, userLastClick: Long, userCompletionRate: Float, userSc: Float, userRetention: Float, userImwp: Float, userImd: Float, userImimd: Float, userImpDepth: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AdRequestContext]

Context derived from OpenRTB 2.5 bid request. All fields are optional — absent field means the filter that uses it is a pass-through.

Value parameters

adType
appBundle

app.bundle

appId

app.bundle used as ID by bidder

badv
bannerApi
bannerAttr

imp.banner.attr

bannerH

imp.banner.h

bannerType

imp.banner.type

bannerW

imp.banner.w

bapp

request.bapp — blocked app bundles

bcat

request.bcat — blocked IAB categories

bidFloor
bidTimeSeconds

wall-clock epoch seconds at bid evaluation time

bidmachinePlacementValue

request.ext.ml

bmCachedLurlPrice

request.ext.cachedLurlPrice

bmExtensionWinnerBundle

request.ext.winner.bundle

bmExtensionWinnerDspId
bmExtensionWinnerPrice

request.ext.winner.price

cachedLurlMillisPassed

request.ext.cached_lurl.millis_passed

cachedLurlPrice

request.ext.cached_lurl.price

city

device.geo.city

connType
coppa

request.regs.coppa != 0

country
depthAdreqs1D

request.ext.metrics.depth.adreqs.*.last_1d

depthAdreqs1H
depthAdreqs7D

request.ext.metrics.depth.adreqs.*.last_7d

depthImps1D

request.ext.metrics.depth.imps.*.last_1d

depthImps1H

request.ext.metrics.depth.imps.*.last_1h

depthImps7D

request.ext.metrics.depth.imps.*.last_7d

deviceExtBatterylevel
deviceExtCharging

device.ext.charging

deviceExtFreemem

device.ext.freemem, MB

deviceExtScreenbright

device.ext.screenbright

deviceExtTotaldisk

device.ext.totaldisk, MB

deviceExtTotalmem

device.ext.totalmem, MB

deviceMake

device.make, lowercase

deviceModel

device.model, lowercase

deviceType

device.devicetype: 1=mobile/tablet, 4=phone, 5=tablet

displayManager

imp.displaymanager, lowercase

displayManagerVersion

imp.displaymanagerver parsed as int

exchange
ifa

device.ifa (IDFA on iOS, GAID on Android)

ifv

device.ext.ifv or device.ext.idfv

impInstl

imp.instl: 1=interstitial

ipAddress24

derived: first 3 octets of device.ip + ".0"

language

device.language

mediationMode

request.ext.bm_ext.mediation_mode

mediationStackId

request.ext.mediation_stack_id

minFloor

request.ext.min_floor

originalFloor

request.ext.original_floor

os

device.os, lowercase: "ios" / "android"

osVersion

device.osv parsed as [major, minor, patch]

peakHours

derived: UTC hour > 14 or < 4

placementH

video.h or banner.h

placementHistoricalValue

request.ext.lurl

placementIsVertical

derived: imp.h > imp.w

placementSecure

imp.secure

placementTopframe

imp.banner.topframe

placementW

video.w or banner.w

region
rewardedBanner

derived from imp.banner.ext.* and imp.ext.*

rewardedVideo

derived from imp.video.ext.* and imp.ext.*

sdkStackId

request.ext.sdk_stack_id

sellerId

app.publisher.ext.sellerid

sellerName
skadnSupported

derived: sourceapp + overlay + matching skadnetid present

sourceId

app.publisher.ext.sourceid

sourceName

app.publisher.ext.sourcename

test

request.test != 0

thirdPartyBidPrice

request.ext.dsp_bid

timezone

device.geo.utcoffset formatted as +HHmm

userClickRate
userCompletionRate

user.ext.completionrate

userImd

user.ext.imd

userImimd

user.ext.imimd

userImpDepth

user.ext.impdepth or app.ext.imp.all

userImwp

user.ext.imwp

userLastClick

user.ext.lastclick, epoch seconds

userRetention

user.ext.retention

userSc

user.ext.sc

vectorId

request.ext.vector_id

videoAttr

imp.video.attr

videoH

imp.video.h

videoMaxduration

imp.video.maxduration

videoMimes

imp.video.mimes

videoMinduration
videoProtocols

imp.video.protocols

videoW

imp.video.w

zip

device.geo.zip

Attributes

Companion
object
Graph
Supertypes
trait Updatable[AdRequestContext]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllBadv(`__vs`: Iterable[String]): AdRequestContext
def addAllBannerApi(`__vs`: Iterable[Int]): AdRequestContext
def addAllBannerAttr(`__vs`: Iterable[Int]): AdRequestContext
def addAllBannerType(`__vs`: Iterable[Int]): AdRequestContext
def addAllBapp(`__vs`: Iterable[String]): AdRequestContext
def addAllBcat(`__vs`: Iterable[String]): AdRequestContext
def addAllVideoAttr(`__vs`: Iterable[Int]): AdRequestContext
def addAllVideoMimes(`__vs`: Iterable[String]): AdRequestContext
def addAllVideoProtocols(`__vs`: Iterable[Int]): AdRequestContext
def addBadv(`__vs`: String*): AdRequestContext
def addBannerApi(`__vs`: Int*): AdRequestContext
def addBannerAttr(`__vs`: Int*): AdRequestContext
def addBannerType(`__vs`: Int*): AdRequestContext
def addBapp(`__vs`: String*): AdRequestContext
def addBcat(`__vs`: String*): AdRequestContext
def addVideoAttr(`__vs`: Int*): AdRequestContext
def addVideoMimes(`__vs`: String*): AdRequestContext
def addVideoProtocols(`__vs`: Int*): AdRequestContext
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

def withAdType(`__v`: String): AdRequestContext
def withAppBundle(`__v`: String): AdRequestContext
def withAppId(`__v`: String): AdRequestContext
def withBadv(`__v`: Seq[String]): AdRequestContext
def withBannerApi(`__v`: Seq[Int]): AdRequestContext
def withBannerAttr(`__v`: Seq[Int]): AdRequestContext
def withBannerH(`__v`: Int): AdRequestContext
def withBannerType(`__v`: Seq[Int]): AdRequestContext
def withBannerW(`__v`: Int): AdRequestContext
def withBapp(`__v`: Seq[String]): AdRequestContext
def withBcat(`__v`: Seq[String]): AdRequestContext
def withBidFloor(`__v`: Float): AdRequestContext
def withCity(`__v`: String): AdRequestContext
def withConnType(`__v`: Int): AdRequestContext
def withCoppa(`__v`: Boolean): AdRequestContext
def withCountry(`__v`: String): AdRequestContext
def withDeviceMake(`__v`: String): AdRequestContext
def withDeviceModel(`__v`: String): AdRequestContext
def withDeviceType(`__v`: Int): AdRequestContext
def withDisplayManager(`__v`: String): AdRequestContext
def withExchange(`__v`: String): AdRequestContext
def withIfa(`__v`: String): AdRequestContext
def withIfv(`__v`: String): AdRequestContext
def withImpInstl(`__v`: Int): AdRequestContext
def withIpAddress24(`__v`: String): AdRequestContext
def withLanguage(`__v`: String): AdRequestContext
def withMediationMode(`__v`: String): AdRequestContext
def withMinFloor(`__v`: Float): AdRequestContext
def withOriginalFloor(`__v`: Float): AdRequestContext
def withOs(`__v`: String): AdRequestContext
def withPeakHours(`__v`: Boolean): AdRequestContext
def withPlacementH(`__v`: Int): AdRequestContext
def withPlacementW(`__v`: Int): AdRequestContext
def withRegion(`__v`: String): AdRequestContext
def withRewardedBanner(`__v`: Boolean): AdRequestContext
def withRewardedVideo(`__v`: Boolean): AdRequestContext
def withSdkStackId(`__v`: String): AdRequestContext
def withSellerId(`__v`: String): AdRequestContext
def withSellerName(`__v`: String): AdRequestContext
def withSkadnSupported(`__v`: Boolean): AdRequestContext
def withSourceId(`__v`: String): AdRequestContext
def withSourceName(`__v`: String): AdRequestContext
def withTest(`__v`: Boolean): AdRequestContext
def withTimezone(`__v`: String): AdRequestContext
def withUnknownFields(`__v`: UnknownFieldSet): AdRequestContext
def withUserClickRate(`__v`: Float): AdRequestContext
def withUserImd(`__v`: Float): AdRequestContext
def withUserImimd(`__v`: Float): AdRequestContext
def withUserImwp(`__v`: Float): AdRequestContext
def withUserRetention(`__v`: Float): AdRequestContext
def withUserSc(`__v`: Float): AdRequestContext
def withVectorId(`__v`: String): AdRequestContext
def withVideoAttr(`__v`: Seq[Int]): AdRequestContext
def withVideoH(`__v`: Int): AdRequestContext
def withVideoMimes(`__v`: Seq[String]): AdRequestContext
def withVideoProtocols(`__v`: Seq[Int]): AdRequestContext
def withVideoW(`__v`: Int): AdRequestContext
def withZip(`__v`: String): AdRequestContext
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
def update(ms: Lens[AdRequestContext, AdRequestContext] => () => AdRequestContext*): AdRequestContext

Attributes

Inherited from:
Updatable
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Generated with