Type Members

1.  final case class AdFormat(spec: Spec = io.bidmachine.protobuf.sdk.AdFormat.Spec.Empty) extends GeneratedMessage with Updatable[AdFormat] with Product with Serializable

   Annotations

   @SerialVersionUID()

2.  final case class App(appName: String = "", appVer: String = "", release: Option[Release] = _root_.scala.None, installTime: Option[Timestamp] = _root_.scala.None, firstLaunchTime: Option[Timestamp] = _root_.scala.None, storecat: String = "", storesubcat: Seq[String] = _root_.scala.Seq.empty, fmwname: String = "", installReferrerUrl: String = "", installReferrerClickTimestamp: Option[Timestamp] = _root_.scala.None, installReferrerClickServerTimestamp: Option[Timestamp] = _root_.scala.None, installBeginServerTimestamp: Option[Timestamp] = _root_.scala.None, installVersion: String = "", isGooglePlayInstant: Boolean = false, sdkInstallTime: Option[Timestamp] = _root_.scala.None) extends GeneratedMessage with Updatable[App] with Product with Serializable
   installTime

   Unix timestamp in milliseconds of the application install (might be zero). Depends on install referer library.

   firstLaunchTime

   Unix timestamp in milliseconds of the first BidMachine SDK launch. Data can be incorrect for devices which updates from older app sdk version

   storecat

   App category name in app store

   storesubcat

   App subcategories name in app store

   fmwname

   Framework name. (unknown, native, unity)

   installReferrerUrl

   The referrer URL of the installed package. Depends on install referer library.

   installReferrerClickTimestamp

   The client-side timestamp, when the referrer click happened. Depends on install referer library.

   installReferrerClickServerTimestamp

   The server-side timestamp, when the referrer click happened. Depends on install referer library.

   installBeginServerTimestamp

   The server-side timestamp, when app installation began. Depends on install referer library.

   installVersion

   The app's version at the time when the app was first installed. Depends on install referer library.

   isGooglePlayInstant

   Indicates whether your app's instant experience was launched within the past 7 days. Depends on install referer library.

   sdkInstallTime

   The first recorded SDK initialization timestamp, marking the first time the SDK was present in this specific app. This field is empty if the SDK was updated from a legacy version that did not support it.

   Annotations

   @SerialVersionUID()

3.  final case class AssetCache() extends GeneratedMessage with Updatable[AssetCache] with Product with Serializable

   Annotations

   @SerialVersionUID()

4.  final case class Configuration(monitors: Seq[Monitor.Configuration] = _root_.scala.Seq.empty, readers: Seq[Reader.Configuration] = _root_.scala.Seq.empty, bpk: Option[String] = _root_.scala.None) extends GeneratedMessage with Updatable[Configuration] with Product with Serializable
   monitors

   Monitor configuration

   readers

   Reader configuration

   bpk

   Public encryption key base64 encoded

   Annotations

   @SerialVersionUID()

5.  final case class Context(sdk: Option[SDK] = _root_.scala.None, app: Option[App] = _root_.scala.None, user: Option[User] = _root_.scala.None, device: Option[Device] = _root_.scala.None, session: Option[Session] = _root_.scala.None, regs: Option[Regs] = _root_.scala.None) extends GeneratedMessage with Updatable[Context] with Product with Serializable

   Annotations

   @SerialVersionUID()

6.  final case class ContextualData(placement: String = "", mediatorName: String = "", data: Option[ImpressionData] = _root_.scala.None) extends GeneratedMessage with Updatable[ContextualData] with Product with Serializable
   placement

   Contextual data placement

   mediatorName

   Mediator name

   data

   Impression data

   Annotations

   @SerialVersionUID()

7.  final case class Device(ifv: String = "", bmIfv: String = "", inputlanguage: Seq[String] = _root_.scala.Seq.empty, diskspace: Long = 0L, totaldisk: Long = 0L, ringmute: Boolean = false, charging: Boolean = false, headset: Boolean = false, batterylevel: Float = 0.0f, batterysaver: Boolean = false, darkmode: Boolean = false, airplane: Boolean = false, dnd: Boolean = false, devicename: String = "", time: Long = 0L, screenbright: Float = 0.0f, jailbreak: Boolean = false, lastbootup: Long = 0L, lastbootupV2: Long = 0L, access: String = "", headsetname: String = "", totalmem: Long = 0L, atts: Int = 0, cpuname: String = "", cpuvendor: String = "", gpuname: String = "", gpuvendor: String = "", timezone: String = "", freemem: Long = 0L, apilevel: Int = 0, simCarrier: Option[String] = _root_.scala.None, simCountry: Option[String] = _root_.scala.None, networkRoaming: Option[Boolean] = _root_.scala.None, connection: Option[Connection] = _root_.scala.None, audioContext: Option[AudioContext] = _root_.scala.None) extends GeneratedMessage with Updatable[Device] with Product with Serializable
   ifv

   An alphanumeric string that uniquely identifies a device to the app’s vendor.

   bmIfv

   BidMachine specific alphanumeric string that uniquely identifies a device.

   inputlanguage

   A string array containing the languages set up on the user's device keyboard. Country codes are passed in the string array, where "en", "he" = English and Hebrew languages are enabled on the user's device keyboard

   diskspace

   An integer value describing the available disk space on the device in megabytes, where "18201" = device has 18201 MB of available disk space. MB will be passed as a whole number.

   totaldisk

   An integer value describing the total disk space on the device in megabytes, where "63989" = the device has 63989 MB of total disk space. MB will be passed as a whole number.

   ringmute

   (Android only) A bool value describing the device sound setting during the time of the ad request describing if the sound is set to ring or mute, where "false" = mute, "true" = ring

   charging

   A bool value describing if the device is connected to a charger

   headset

   A bool value indicating if the device is connected to a wired headset

   batterylevel

   An float describing percent battery remaining on the user's device

   batterysaver

   A bool value indicating if battery saver ('Low Power Mode' on iOS) has been enabled

   darkmode

   A bool value indicating if dark mode is enabled on the device

   airplane

   (Android only) A bool value indicating if airplane mode is enabled

   dnd

   (Android only) A bool value indicating if do not disturb setting is enabled

   devicename

   A value indicating the device name

   time

   POSIX timestamp. Depends on device time settings.

   screenbright

   A value in the range from 0.0 to 1.0 to represent the brightness level of the main screen of the device.

   jailbreak

   A bool value indicating if a device was jailbroken

   lastbootup

   POSIX timestamp of latest device boot with accuracy in seconds. Depends on device time settings

   lastbootupV2

   POSIX timestamp of latest device boot in nanoseconds. Depends on device time settings

   access

   User's accessibilities features. The sequence of "1" and 0" there every number means that some feature is enabled or not

   headsetname

   Identifier of connected wireless audio headset

   totalmem

   Total devices RAM in bytes

   atts

   (iOS Only) A value indicating the status of app tracking authorization. Possible values: 0 = not determined 1 = restricted 2 = denied 3 = authorized

   cpuname

   Name of CPU, eg: snapdragon, arm64

   cpuvendor

   Vendor name of CPU, eg: snapdragon 8 gen 2

   gpuname

   Name of device’s GPU, eg: Mali-T624

   gpuvendor

   Name of device’s GPU vendor, eg: mali

   timezone

   String that represent device timezone in IANA(https://timeapi.io/documentation/iana-timezones) format

   freemem

   Free device's RAM in bytes.

   apilevel

   Android-specific, API level of the SDK, e.g. 34 for Android 14

   simCarrier

   Name of the SIM card’s home carrier, eg: Vodafone, AT&T

   simCountry

   ISO country code of the SIM card, eg: US, DE

   networkRoaming

   Indicates whether the device is currently roaming on another network

   connection

   connection

   audioContext

   audio

   Annotations

   @SerialVersionUID()

8.  final case class Error(name: String = "", error: Option[Data] = _root_.scala.None, reason: Option[Data] = _root_.scala.None) extends GeneratedMessage with Updatable[Error] with Product with Serializable
   name

   Error module name, e.g. 'mraid'

   error

   SDK Main Error

   reason

   Module extended Error

   Annotations

   @SerialVersionUID()

9.  sealed abstract class ErrorReasonAnalytics extends GeneratedEnum
10.  final case class Event(payload: Payload = io.bidmachine.protobuf.sdk.Event.Payload.Empty, extrasPrivate: Option[Struct] = _root_.scala.None) extends GeneratedMessage with Updatable[Event] with Product with Serializable
    extrasPrivate

    Shared context. https://appodeal.atlassian.net/wiki/spaces/BS/pages/4938137641

    Annotations

    @SerialVersionUID()

11.  final case class GeometryMetric(minWidth: Option[Int] = _root_.scala.None, minHeight: Option[Int] = _root_.scala.None, visible: Boolean = false, minAlpha: Option[Double] = _root_.scala.None) extends GeneratedMessage with Updatable[GeometryMetric] with Product with Serializable

    View geometry properties

    View geometry properties

    minWidth

    Minimum width in platform specific points (dp on Android, points on iOS)

    minHeight

    Minimum height in platform specific points (dp on Android, points on iOS)

    visible

    View must not be hidden/invisible

    minAlpha

    Minimum opacity/alpha (0.0 to 1.0) Android: alpha, iOS: alpha

    Annotations

    @SerialVersionUID()

12.  final case class LifecycleMetric(requiredStates: Seq[LifecycleState] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[LifecycleMetric] with Product with Serializable

    App/view lifecycle state

    App/view lifecycle state

    Annotations

    @SerialVersionUID()

13.  final case class MaskedSignals(ifa: Option[String] = _root_.scala.None, lmt: Option[String] = _root_.scala.None, ifv: Option[String] = _root_.scala.None, userId: Option[String] = _root_.scala.None, buyeruid: Option[String] = _root_.scala.None, externalUserIds: Option[String] = _root_.scala.None, carrier: Option[String] = _root_.scala.None, mccmnc: Option[String] = _root_.scala.None, simCarrier: Option[String] = _root_.scala.None, deviceLat: Option[String] = _root_.scala.None, deviceLon: Option[String] = _root_.scala.None, accuracy: Option[String] = _root_.scala.None, lastfix: Option[String] = _root_.scala.None, deviceZip: Option[String] = _root_.scala.None, metro: Option[String] = _root_.scala.None, deviceCity: Option[String] = _root_.scala.None, userLat: Option[String] = _root_.scala.None, userLon: Option[String] = _root_.scala.None, userZip: Option[String] = _root_.scala.None, userCity: Option[String] = _root_.scala.None, model: Option[String] = _root_.scala.None, hwv: Option[String] = _root_.scala.None, ppi: Option[String] = _root_.scala.None, pxratio: Option[String] = _root_.scala.None, ua: Option[String] = _root_.scala.None, diskspace: Option[String] = _root_.scala.None, totaldisk: Option[String] = _root_.scala.None, totalmem: Option[String] = _root_.scala.None, freemem: Option[String] = _root_.scala.None, batterylevel: Option[String] = _root_.scala.None, screenbright: Option[String] = _root_.scala.None, headsetname: Option[String] = _root_.scala.None, volumeLevel: Option[String] = _root_.scala.None, devicename: Option[String] = _root_.scala.None, lastbootup: Option[String] = _root_.scala.None, lastbootupV2: Option[String] = _root_.scala.None, time: Option[String] = _root_.scala.None, inputlanguage: Option[String] = _root_.scala.None, access: Option[String] = _root_.scala.None, cpuname: Option[String] = _root_.scala.None, cpuvendor: Option[String] = _root_.scala.None, gpuname: Option[String] = _root_.scala.None, gpuvendor: Option[String] = _root_.scala.None, atts: Option[String] = _root_.scala.None, yob: Option[String] = _root_.scala.None, gender: Option[String] = _root_.scala.None, keywords: Option[String] = _root_.scala.None) extends GeneratedMessage with Updatable[MaskedSignals] with Product with Serializable

    Restriction matrix: [coppa, nonPersonalized, gdprNoConsent, ccpaOptOut]

    Restriction matrix: [coppa, nonPersonalized, gdprNoConsent, ccpaOptOut]

    ifa

    Identifiers [true, true, true, false]

    lmt

    [true, true, true, false]

    ifv

    [true, true, true, false]

    userId

    [true, true, true, false]

    buyeruid

    [true, true, true, false]

    externalUserIds

    [true, true, true, false]

    carrier

    Network [true, false, false, false]

    mccmnc

    [true, false, false, false]

    simCarrier

    [true, false, false, false]

    deviceLat

    Location — Device [true, false, false, false]

    deviceLon

    [true, false, false, false]

    accuracy

    [true, false, false, false]

    lastfix

    [true, false, false, false]

    deviceZip

    [true, false, false, false]

    metro

    [true, false, false, false]

    deviceCity

    [true, false, false, false]

    userLat

    Location — User [true, false, false, false]

    userLon

    [true, false, false, false]

    userZip

    [true, false, false, false]

    userCity

    [true, false, false, false]

    model

    Device — Standard [true, false, false, false]

    hwv

    [true, false, false, false]

    ppi

    [true, false, false, false]

    pxratio

    [true, false, false, false]

    ua

    [true, false, false, false]

    diskspace

    Device — Telemetry [true, false, false, false]

    totaldisk

    [true, false, false, false]

    totalmem

    [true, false, false, false]

    freemem

    [true, false, false, false]

    batterylevel

    [true, false, false, false]

    screenbright

    [true, false, false, false]

    headsetname

    [true, false, false, false]

    volumeLevel

    [true, false, false, false]

    devicename

    [true, false, false, false]

    lastbootup

    [true, false, false, false]

    lastbootupV2

    [true, false, false, false]

    time

    [true, false, false, false]

    inputlanguage

    [true, false, false, false]

    access

    [true, false, false, false]

    cpuname

    [true, false, false, false]

    cpuvendor

    [true, false, false, false]

    gpuname

    [true, false, false, false]

    gpuvendor

    [true, false, false, false]

    atts

    [true, false, false, false]

    yob

    Demographics [true, true, true, false]

    gender

    [true, true, true, false]

    keywords

    [true, true, true, false]

    Annotations

    @SerialVersionUID()

14.  final case class Measurement(count: Int = 0, intervalMs: Int = 0, failureTimeoutMs: Option[Int] = _root_.scala.None) extends GeneratedMessage with Updatable[Measurement] with Product with Serializable
    count

    Total number of measurements to perform Example: 3 means we check 3 times total

    intervalMs

    Interval between measurements in milliseconds

    failureTimeoutMs

    Timeout between failed measurements in milliseconds If a measurement cannot be completed (e.g., view not ready), wait this long before retrying

    Annotations

    @SerialVersionUID()

15.  final case class MetricRequirement(measurementIndex: Int = 0, metric: Metric = io.bidmachine.protobuf.sdk.MetricRequirement.Metric.Empty) extends GeneratedMessage with Updatable[MetricRequirement] with Product with Serializable
    measurementIndex

    Order of this metric in the measurement sequence

    Annotations

    @SerialVersionUID()

16.  final case class Monitor(name: String = "", records: Seq[Record] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[Monitor] with Product with Serializable
    name

    Monitor specific name

    records

    Records list

    Annotations

    @SerialVersionUID()

17.  final case class OSLog(records: Seq[Record] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[OSLog] with Product with Serializable

    Annotations

    @SerialVersionUID()

18.  final case class OverlapMetric(scope: OverlapScope = io.bidmachine.protobuf.sdk.OverlapMetric.OverlapScope.VIEW_SIBLINGS, maxOverlapPercentage: Double = 0.0) extends GeneratedMessage with Updatable[OverlapMetric] with Product with Serializable

    Overlap/occlusion by other views

    Overlap/occlusion by other views

    scope

    Scope of overlap check

    maxOverlapPercentage

    Maximum allowed overlap percentage (0.0 to 100.0) Example: 10.0 means max 10% of view can be occluded

    Annotations

    @SerialVersionUID()

19.  final case class Placement(adType: String = "", placementId: Option[String] = _root_.scala.None, customData: Option[Struct] = _root_.scala.None, hbPlacement: Option[HeaderBiddingPlacement] = _root_.scala.None, adFormat: Option[AdFormat] = _root_.scala.None) extends GeneratedMessage with Updatable[Placement] with Product with Serializable
    adType

    The ad type of the placement e.g. "banner", "interstitial", "native" deprecated 3.5.0

    placementId

    Optional placement id

    customData

    Optional SSP specific parameters

    hbPlacement

    Header Bidding placement

    adFormat

    AdFormat added in 3.5.0

    Annotations

    @SerialVersionUID()

20.  final case class Reader(name: String = "", timestamp: Option[Timestamp] = _root_.scala.None, records: Seq[Record] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[Reader] with Product with Serializable
    name

    Reader specific name

    timestamp

    Timestamp of the read

    records

    Result list

    Annotations

    @SerialVersionUID()

21.  final case class Regs(pub: Option[Pub] = _root_.scala.None, cmp: Option[CMP] = _root_.scala.None, restrictionKinds: Seq[RestrictionKind] = _root_.scala.Seq.empty, persistedMode: RestrictionMode = io.bidmachine.protobuf.sdk.RestrictionMode.RESTRICTION_MODE_STRICT, maskedSignals: Option[MaskedSignals] = _root_.scala.None) extends GeneratedMessage with Updatable[Regs] with Product with Serializable
    pub

    Publisher regulation data (optional — nil means not set by publisher)

    cmp

    CMP regulation data from UserDefaults / SharedPreferences

    restrictionKinds

    SDK-resolved restriction kinds

    persistedMode

    Restriction mode persisted from previous session

    maskedSignals

    XOR masked signals for MODERATE mode

    Annotations

    @SerialVersionUID()

22.  sealed abstract class RestrictionKind extends GeneratedEnum
23.  sealed abstract class RestrictionMode extends GeneratedEnum
24.  final case class SDK(sdk: String = "", sdkver: String = "", omidpn: String = "", omidpv: String = "") extends GeneratedMessage with Updatable[SDK] with Product with Serializable
    sdk

    Name of ad mediation partner, SDK technology, or player responsible for rendering ad.

    sdkver

    Version of the SDK specified in the "sdk" attribute.

    omidpn

    OMID partner name

    omidpv

    OMID partner version

    Annotations

    @SerialVersionUID()

25.  final case class Session(sessionId: String = "", context: Option[Session.Context] = _root_.scala.None) extends GeneratedMessage with Updatable[Session] with Product with Serializable
    sessionId

    Session ID - consistent between requests as long as application active (on screen)

    context

    Session context

    Annotations

    @SerialVersionUID()

26.  final case class User(consent: String = "", gdpr: Boolean = false, ccpa: String = "", gpp: String = "", gppSid: Seq[Int] = _root_.scala.Seq.empty, coppa: Boolean = false) extends GeneratedMessage with Updatable[User] with Product with Serializable
    consent

    User Consent

    gdpr

    GDPR

    ccpa

    US Privacy string

    gpp

    Full consent string in its encoded form

    gppSid

    Section ID(s) considered to be in force

    coppa

    Child app

    Annotations

    @SerialVersionUID()

27.  final case class ViewabilityConfiguration(rules: Seq[ViewabilityRule] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[ViewabilityConfiguration] with Product with Serializable
    rules

    List of viewability rules to track

    Annotations

    @SerialVersionUID()

28.  final case class ViewabilityRule(event: Int = 0, billable: Boolean = false, measurement: Option[Measurement] = _root_.scala.None, requiredMetrics: Seq[MetricRequirement] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[ViewabilityRule] with Product with Serializable
    event

    Event identifier (501, 502) TODO: refer to bidmachine.protobuf.extensions.AdExtension.EventTypeExtended cause circular dependency

    billable

    Whether this event is billable/monetizable

    measurement

    Measurement configuration

    requiredMetrics

    Required metrics that must pass for this rule

    Annotations

    @SerialVersionUID()

29.  final case class VisibilityMetric(scope: VisibilityScope = io.bidmachine.protobuf.sdk.VisibilityMetric.VisibilityScope.PARENT_VIEW, minVisiblePercentage: Double = 0.0) extends GeneratedMessage with Updatable[VisibilityMetric] with Product with Serializable

    Visibility within viewport

    Visibility within viewport

    minVisiblePercentage

    Minimum percentage visible (0.0 to 100.0) Example: 50.0 means at least 50% of view must be visible

    Annotations

    @SerialVersionUID()