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

AdRequestFeatures

io.predictor.v1.AdRequestFeatures
See theAdRequestFeatures companion object
final case class AdRequestFeatures(requestId: String, sellerId: String, adType: AdType, isRewardedRequest: Boolean, app: Option[String], os: Option[OperatingSystem], osVersion: Option[String], language: Option[String], country: Option[String], region: Option[String], city: Option[String], zip: Option[String], deviceWidth: Option[Int], deviceHeight: Option[Int], connectionType: Option[ConnectionType], deviceType: Option[DeviceType], ifa: Option[String], bmCachedLurlPrice: Option[Double], cachedLurlMillisPassed: Option[Long], originalFloor: Option[Double], mediationStackId: Option[String], sdk: Option[String], placementWidth: Option[Int], placementHeight: Option[Int], adRequestTimestamp: Option[Timestamp], sessionMetrics: Option[SessionMetrics], mediationMode: Option[String], topframe: Option[Boolean], lurlStats: Option[LurlMetricsForAdType], isCoppa: Option[Boolean], device: Option[Struct], userExt: Option[Struct], metrics: Option[Struct], userImwp: Option[Float], userWp: Option[Float], userImd: Option[Int], userImimd: Option[Int], userSc: Option[Int], userRetention: Option[Int], sessionDuration: Option[Long], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[AdRequestFeatures]

Shared First-Look ad-request features — the request-level base fields sent on every First-Look call, factored out so request messages reference them instead of re-declaring the block. Field numbers mirror the existing GetBidMachine*Request layout so the correspondence stays obvious.

Value parameters

app

app bundle

country

Alpha2 code (e.g., "US")

device
language

ISO-639-1-alpha-2

metrics

request.ext.metrics (session., depth.)

originalFloor

Publisher's declared floor (request.ext.original_floor). At this pre-auction stage request.flr is unmodified, so this is the floor the predictor conditions on (the model's bid_floor feature). The unified flow also masks grid bins <= original_floor so the auction never lowers the declared floor.

requestId

Adrequest id, uuid

sdk

display manager

sessionDuration

user.ext.sessionduration

userExt

request.context.user.ext (e.g. retention, sessionduration, imwp/wp)

userImd

user.ext.imd, >= 0

userImimd

user.ext.imimd, >= 0

userImwp
userRetention

user.ext.retention

userSc

user.ext.sc

userWp

user.ext.wp, eCPM-like, >= 0

Attributes

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

Members list

Value members

Concrete methods

def getAdRequestTimestamp: Timestamp
def getApp: String
def getBmCachedLurlPrice: Double
def getCity: String
def getCountry: String
def getDevice: Struct
def getDeviceHeight: Int
def getDeviceWidth: Int
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
def getIfa: String
def getIsCoppa: Boolean
def getLanguage: String
def getMediationMode: String
def getMediationStackId: String
def getMetrics: Struct
def getOriginalFloor: Double
def getOsVersion: String
def getRegion: String
def getSdk: String
def getSessionDuration: Long
def getTopframe: Boolean
def getUserExt: Struct
def getUserImd: Int
def getUserImimd: Int
def getUserImwp: Float
def getUserRetention: Int
def getUserSc: Int
def getUserWp: Float
def getZip: String
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 withAdRequestTimestamp(`__v`: Timestamp): AdRequestFeatures
def withApp(`__v`: String): AdRequestFeatures
def withCity(`__v`: String): AdRequestFeatures
def withCountry(`__v`: String): AdRequestFeatures
def withDevice(`__v`: Struct): AdRequestFeatures
def withIfa(`__v`: String): AdRequestFeatures
def withIsCoppa(`__v`: Boolean): AdRequestFeatures
def withLanguage(`__v`: String): AdRequestFeatures
def withMediationMode(`__v`: String): AdRequestFeatures
def withMetrics(`__v`: Struct): AdRequestFeatures
def withOriginalFloor(`__v`: Double): AdRequestFeatures
def withOsVersion(`__v`: String): AdRequestFeatures
def withRegion(`__v`: String): AdRequestFeatures
def withRequestId(`__v`: String): AdRequestFeatures
def withSdk(`__v`: String): AdRequestFeatures
def withSellerId(`__v`: String): AdRequestFeatures
def withTopframe(`__v`: Boolean): AdRequestFeatures
def withUnknownFields(`__v`: UnknownFieldSet): AdRequestFeatures
def withUserExt(`__v`: Struct): AdRequestFeatures
def withUserImd(`__v`: Int): AdRequestFeatures
def withUserImimd(`__v`: Int): AdRequestFeatures
def withUserImwp(`__v`: Float): AdRequestFeatures
def withUserSc(`__v`: Int): AdRequestFeatures
def withUserWp(`__v`: Float): AdRequestFeatures
def withZip(`__v`: String): AdRequestFeatures
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[AdRequestFeatures, AdRequestFeatures] => () => AdRequestFeatures*): AdRequestFeatures

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