p

io.bidmachine

protobuf

package protobuf

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package analytics
  2. package headerbidding
  3. package rendering
  4. package sdk

Type Members

  1. sealed abstract class ActionType extends GeneratedEnum

    Use for tracking process errors insert this codes in BM_ACTION_CODE macros in error

  2. sealed abstract class AdCacheControl extends GeneratedEnum
  3. final case class AdCachePlacementControl(maxCacheSize: Int = 0, maxRetainCount: Int = 0, maxAge: Int = 0) extends GeneratedMessage with Updatable[AdCachePlacementControl] with Product with Serializable
    Annotations
    @SerialVersionUID()
  4. final case class AdExtension(preload: Boolean = false, loadSkipoffset: Int = 0, viewabilityTimeThreshold: Int = 0, viewabilityPixelThreshold: Float = 0.0f, viewabilityDurationThreshold: Float = 0.0f, event: Seq[Event] = _root_.scala.Seq.empty, customParams: Map[String, String] = _root_.scala.collection.immutable.Map.empty, skipoffset: Int = 0, companionSkipoffset: Int = 0, useNativeClose: Boolean = false, r1: Boolean = false, r2: Boolean = false, countdown: Option[ControlAsset] = _root_.scala.None, closeButton: Option[ControlAsset] = _root_.scala.None, ignoresSafeAreaLayoutGuide: Boolean = false, storeUrl: String = "", progress: Option[ControlAsset] = _root_.scala.None, progressDuration: Int = 0, viewabilityIgnoreWindowFocus: Boolean = false, adCacheControl: AdCacheControl = io.bidmachine.protobuf.AdCacheControl.AD_CACHE_CONTROL_DISABLED, adCacheMaxAge: Int = 0, r1Delay: Int = 0, adMarkupLoadingTimeout: Int = 0, useEmbeddedBrowser: Boolean = false, preloadAd: Boolean = false, creativeLoadingMethod: CreativeLoadingMethod = io.bidmachine.protobuf.CreativeLoadingMethod.FullLoad, placeholderTimeout: Float = 0.0f, eventConfiguration: Option[EventConfiguration] = _root_.scala.None, viewabilityIgnoreOverlap: Boolean = false, creativeExtension: Option[CreativeExtension] = _root_.scala.None, adFlexibleSize: Boolean = false, renderingConfiguration: Option[Rendering] = _root_.scala.None, mraidCreativeValidationRequired: Boolean = false, creativeLoadingTimeout: Int = 0, cridMonitoringEnabled: Boolean = false, viewabilityConfiguration: Option[ViewabilityConfiguration] = _root_.scala.None) extends GeneratedMessage with Updatable[AdExtension] with Product with Serializable

    preload

    Preload ad's markup before rendering with ad framework

    loadSkipoffset

    Number of seconds an ad must load before user can close it

    viewabilityTimeThreshold

    Minimal time in view for ad to be considered viewable

    viewabilityPixelThreshold

    Minimal percentage of the pixels in view for ad to be considered viewable 0.5 = 50% of pixels

    viewabilityDurationThreshold

    Minimal completed duration for video ad to be considered viewable 0.5 = 50% of video duration

    event

    List of custom tracking events

    customParams

    Map of custom parameters

    skipoffset

    Number of seconds an ad must be displayed before user can close it

    companionSkipoffset

    Number of seconds a companion ad must be displayed before user can close it

    useNativeClose

    Enforce native close button and skipoffsets

    r1

    Additional custom features flag r1

    r2

    Additional custom features flag r2

    countdown

    Countdown view (shows remaining time before close button appears)

    closeButton

    Close button view

    ignoresSafeAreaLayoutGuide

    Allows the player to place native components outside safe area layout on iOS

    storeUrl

    Store url

    progress

    Progress view

    progressDuration

    Progress duration

    viewabilityIgnoreWindowFocus

    If true - always track on Android no matter of current window focus

    adCacheControl

    Sets cache policy: enabled/disabled on per ad basis

    adCacheMaxAge

    Ad cache TTL in seconds

    r1Delay

    Deleay for r1 feature

    adMarkupLoadingTimeout

    Ad markup loading timeout in seconds

    useEmbeddedBrowser

    Use embedded browser instead of native browser (or store kit)

    preloadAd

    Load ad right after a response receiving (ios only)

    creativeLoadingMethod

    Loading method partial stream full

    placeholderTimeout

    Timeout for creative loading placeholder

    eventConfiguration

    New event configuration

    viewabilityIgnoreOverlap

    disable viewability overlap track

    creativeExtension

    IAB configuration ( deprecate? )

    adFlexibleSize

    Stretching the banner to the full width of the container For false (default) render in center of the container with specified size in advance For true - render banner in full width

    renderingConfiguration

    Adaptive rendering configuration

    mraidCreativeValidationRequired

    Indicates if MRAID creative needs validation.

    creativeLoadingTimeout

    Creative loading timeout in milliseconds

    cridMonitoringEnabled

    Indicates if CRID monitoring is enabled on the SDK side

    viewabilityConfiguration

    Viewability configuration

    Annotations
    @SerialVersionUID()
  5. final case class AdNetwork(name: String = "", className: String = "", customParams: Map[String, String] = _root_.scala.collection.immutable.Map.empty, adUnits: Seq[AdUnit] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[AdNetwork] with Product with Serializable
    Annotations
    @SerialVersionUID()
  6. final case class CreativeExtension(asset: Option[AssetAppearance] = _root_.scala.None, features: Seq[Feature] = _root_.scala.Seq.empty, postbanners: Seq[Postbanner] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[CreativeExtension] with Product with Serializable
    Annotations
    @SerialVersionUID()
  7. sealed abstract class CreativeLoadingMethod extends GeneratedEnum
  8. sealed abstract class ErrorReason extends GeneratedEnum

    Use for tracking errors of both error types insert this codes in BM_ERROR_REASON macros in error

  9. sealed abstract class EventTypeExtended extends GeneratedEnum

    Use for tracking events Insert this codes in BM_EVENT_CODE macros in error tracking

  10. final case class Extras(private: Option[Struct] = _root_.scala.None, internal: Option[Struct] = _root_.scala.None, public: Option[Struct] = _root_.scala.None) extends GeneratedMessage with Updatable[Extras] with Product with Serializable
    Annotations
    @SerialVersionUID()
  11. sealed abstract class HeaderBiddingType extends GeneratedEnum
  12. final case class InitRequest(sellerId: String = "", bundle: String = "", os: OS = com.explorestack.protobuf.adcom.OS.OS_INVALID, osv: String = "", geo: Option[Geo] = _root_.scala.None, sdk: String = "", sdkver: String = "", ifa: String = "", ifv: String = "", bmIfv: String = "", deviceType: DeviceType = com.explorestack.protobuf.adcom.DeviceType.DEVICE_TYPE_INVALID, contype: ConnectionType = com.explorestack.protobuf.adcom.ConnectionType.CONNECTION_TYPE_INVALID, appVer: String = "", sessionId: String = "", ext: Option[Struct] = _root_.scala.None, make: String = "", model: String = "", hwv: String = "", context: Option[Context] = _root_.scala.None, platformData: PlatformData = io.bidmachine.protobuf.InitRequest.PlatformData.Empty) extends GeneratedMessage with Updatable[InitRequest] with Product with Serializable

    sellerId

    Exchange Source ID

    bundle

    Bundle or package name of the app.

    os

    Device operating system.

    osv

    Device operating system version.

    geo

    Location of the device.

    sdk

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

    sdkver

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

    ifa

    ID sanctioned for advertiser use in the clear (i.e., not hashed).

    ifv

    ID generated by the OS on device for debug and fraud detection

    bmIfv

    ID generated on device for debug and fraud detection

    deviceType

    The general type of device.

    contype

    Network connection type.

    appVer

    Application version.

    sessionId

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

    ext

    Optional extensions.

    make

    Device make (e.g., "Apple").

    model

    Device model (e.g., "iPhone").

    hwv

    Hardware version of the device.

    Annotations
    @SerialVersionUID()
  13. final case class InitRequestV2(context: Option[Context] = _root_.scala.None, ext: Option[Struct] = _root_.scala.None) extends GeneratedMessage with Updatable[InitRequestV2] with Product with Serializable
    Annotations
    @SerialVersionUID()
  14. final case class InitResponse(endpoint: String = "", event: Seq[Event] = _root_.scala.Seq.empty, sessionResetAfter: Int = 0, adNetworks: Seq[AdNetwork] = _root_.scala.Seq.empty, adCacheControl: AdCacheControl = io.bidmachine.protobuf.AdCacheControl.AD_CACHE_CONTROL_DISABLED, adCacheMaxAge: Int = 0, adRequestTmax: Int = 0, adCachePlacementControl: Map[String, AdCachePlacementControl] = _root_.scala.collection.immutable.Map.empty, adNetworksLoadingTimeout: Int = 0, sdkAnalyticConfig: Option[SdkAnalyticConfig] = _root_.scala.None, eventConfiguration: Option[EventConfiguration] = _root_.scala.None, tokenConfigurations: Seq[TokenConfiguration] = _root_.scala.Seq.empty, showWithoutInternet: Boolean = false, extras: Option[Extras] = _root_.scala.None, sdkAnalyticConfigV2: Option[Configuration] = _root_.scala.None, assetCacheConfiguration: Option[Configuration] = _root_.scala.None, restrictionMode: RestrictionMode = io.bidmachine.protobuf.sdk.RestrictionMode.RESTRICTION_MODE_STRICT, bmifvTtlSessions: Int = 0) extends GeneratedMessage with Updatable[InitResponse] with Product with Serializable

    adCachePlacementControl

    Placement keys: banner, interstitial, rewarded, native, richmedia

    adNetworksLoadingTimeout

    Third party ad network adapters global loading timeout in seconds

    restrictionMode

    Privacy engine restriction mode resolved by backend

    bmifvTtlSessions

    The number of sessions the SDK can keep existed BMIFV ID

    Annotations
    @SerialVersionUID()
  15. sealed abstract class OSExecutionEnvironment extends GeneratedEnum
  16. sealed abstract class PostbannerType extends GeneratedEnum
  17. final case class RequestExtension(sellerId: String = "", sellerData: Map[String, String] = _root_.scala.collection.immutable.Map.empty, headerBiddingType: HeaderBiddingType = io.bidmachine.protobuf.HeaderBiddingType.HEADER_BIDDING_TYPE_INVALID, ifv: String = "", bmIfv: String = "", sessionId: String = "", integrationType: String = "") extends GeneratedMessage with Updatable[RequestExtension] with Product with Serializable

    sellerData

    Extra data

    ifv

    ID generated by the OS on device for debug and fraud detection

    bmIfv

    ID generated on device for debug and fraud detection

    sessionId

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

    integrationType

    Type of integration - waterfall, prebid, postbid etc.

    Annotations
    @SerialVersionUID()
  18. final case class RequestTokenPayload(tokenHashValue: String = "", adType: String = "", placementData: Option[SDK] = _root_.scala.None, sessionData: Option[SessionData] = _root_.scala.None, session: Option[sdk.Session] = _root_.scala.None, deviceData: Option[Device] = _root_.scala.None, userData: Option[User] = _root_.scala.None, appData: Option[App] = _root_.scala.None, regsData: Option[Regs] = _root_.scala.None, hbPlacement: Option[HeaderBiddingPlacement] = _root_.scala.None, customData: Map[String, String] = _root_.scala.collection.immutable.Map.empty, placement: Option[Placement] = _root_.scala.None, ext: Option[Struct] = _root_.scala.None) extends GeneratedMessage with Updatable[RequestTokenPayload] with Product with Serializable

    adType

    Moved to placement

    regsData

    CMP regulation data and privacy engine state

    hbPlacement

    Moved to placement

    customData

    Moved to placement

    placement

    SDK specific placement

    Annotations
    @SerialVersionUID()
  19. final case class ResponsePayload(cacheTime: Option[Timestamp] = _root_.scala.None, requestItemSpec: Option[Placement] = _root_.scala.None, payloadOneof: PayloadOneof = io.bidmachine.protobuf.ResponsePayload.PayloadOneof.Empty) extends GeneratedMessage with Updatable[ResponsePayload] with Product with Serializable

    cacheTime

    The time at which this payload cache was created

    requestItemSpec

    Item spec (adcom.Placement in this case) from original openrtb.Request Strictly it should be google.protobuf.Any as defined in openrtb.Request, but for convenience reasons Layer-3 (Transaction) and Layer-4 (Domain) models are mixed here.

    Annotations
    @SerialVersionUID()
  20. final case class SdkAnalyticConfig(url: String = "", context: String = "", interval: Int = 0, count: Int = 0, metricConfigs: Seq[MetricConfig] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[SdkAnalyticConfig] with Product with Serializable

    url

    Url for metric track

    context

    Session context from init request

    interval

    Interval between sending metrics, in seconds

    count

    Number of metrics in one request

    Annotations
    @SerialVersionUID()
  21. final case class SdkAnalyticContext(sourceId: String = "", bundle: String = "", os: OS = com.explorestack.protobuf.adcom.OS.OS_INVALID, osv: String = "", geo: Option[Geo] = _root_.scala.None, sdk: String = "", sdkver: String = "", ifa: String = "", ifv: String = "", bmIfv: String = "", deviceType: DeviceType = com.explorestack.protobuf.adcom.DeviceType.DEVICE_TYPE_INVALID, contype: ConnectionType = com.explorestack.protobuf.adcom.ConnectionType.CONNECTION_TYPE_INVALID, appVer: String = "", sessionId: String = "", dcid: String = "", ext: Option[Struct] = _root_.scala.None, experiments: Seq[String] = _root_.scala.Seq.empty, make: String = "", model: String = "", hwv: String = "") extends GeneratedMessage with Updatable[SdkAnalyticContext] with Product with Serializable

    SdkAnalyticContext contains all information from InitRequest plus any information our server can add.

    SdkAnalyticContext contains all information from InitRequest plus any information our server can add.

    sourceId

    Exchange Source ID

    bundle

    Bundle or package name of the app.

    os

    Device operating system.

    osv

    Device operating system version.

    geo

    Location of the device.

    sdk

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

    sdkver

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

    ifa

    ID sanctioned for advertiser use in the clear (i.e., not hashed).

    ifv

    ID generated by the OS on device for debug and fraud detection

    bmIfv

    ID generated on device for debug and fraud detection

    deviceType

    The general type of device.

    contype

    Network connection type.

    appVer

    Application version.

    sessionId

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

    dcid

    ID of a datacenter.

    ext

    Optional extensions.

    experiments

    Init Feature Labels, i.e. experiments

    make

    Device make (e.g., "Apple").

    model

    Device model (e.g., "iPhone").

    hwv

    Hardware version of the device.

    Annotations
    @SerialVersionUID()
  22. final case class TokenConfiguration(type: String = "", expirationTime: Int = 0, adNetworks: Seq[String] = _root_.scala.Seq.empty) extends GeneratedMessage with Updatable[TokenConfiguration] with Product with Serializable
    Annotations
    @SerialVersionUID()
  23. final case class Waterfall(payload: Payload = io.bidmachine.protobuf.Waterfall.Payload.Empty) extends GeneratedMessage with Updatable[Waterfall] with Product with Serializable
    Annotations
    @SerialVersionUID()

Deprecated Type Members

  1. final case class AppExtension(installTime: Option[Timestamp] = _root_.scala.None, uptime: Long = 0L) extends GeneratedMessage with Updatable[AppExtension] with Product with Serializable

    installTime

    Application installation time

    uptime

    Application up time in mills

    Annotations
    @SerialVersionUID() @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. final case class DeviceExtension(battery: Int = 0, rooted: Boolean = false) extends GeneratedMessage with Updatable[DeviceExtension] with Product with Serializable

    battery

    Battery level in percent

    rooted

    Device root status

    Annotations
    @SerialVersionUID() @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  3. final case class RegsCcpaExtension(usPrivacy: String = "") extends GeneratedMessage with Updatable[RegsCcpaExtension] with Product with Serializable

    usPrivacy

    CCPA privacy string

    Annotations
    @SerialVersionUID() @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  4. final case class Session(id: String = "", uptime: Long = 0L) extends GeneratedMessage with Updatable[Session] with Product with Serializable

    Used in Context extension

    Used in Context extension

    id

    Session uuid generated on device

    uptime

    Application session up time in mills

    Annotations
    @SerialVersionUID() @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Value Members

  1. object ActionType extends GeneratedEnumCompanion[ActionType]
  2. object AdCacheControl extends GeneratedEnumCompanion[AdCacheControl]
  3. object AdCachePlacementControl extends GeneratedMessageCompanion[AdCachePlacementControl]
  4. object AdExtension extends GeneratedMessageCompanion[AdExtension]
  5. object AdNetwork extends GeneratedMessageCompanion[AdNetwork]
  6. object CacheProto extends GeneratedFileObject
  7. object CreativeExtension extends GeneratedMessageCompanion[CreativeExtension]
  8. object CreativeLoadingMethod extends GeneratedEnumCompanion[CreativeLoadingMethod]
  9. object ErrorReason extends GeneratedEnumCompanion[ErrorReason]
  10. object EventTypeExtended extends GeneratedEnumCompanion[EventTypeExtended]
  11. object ExtensionsProto extends GeneratedFileObject
  12. object Extras extends GeneratedMessageCompanion[Extras]
  13. object HeaderBiddingType extends GeneratedEnumCompanion[HeaderBiddingType]
  14. object InitProto extends GeneratedFileObject
  15. object InitRequest extends GeneratedMessageCompanion[InitRequest]
  16. object InitRequestV2 extends GeneratedMessageCompanion[InitRequestV2]
  17. object InitResponse extends GeneratedMessageCompanion[InitResponse]
  18. object OSExecutionEnvironment extends GeneratedEnumCompanion[OSExecutionEnvironment]
  19. object PostbannerType extends GeneratedEnumCompanion[PostbannerType]
  20. object RequestExtension extends GeneratedMessageCompanion[RequestExtension]
  21. object RequestTokenPayload extends GeneratedMessageCompanion[RequestTokenPayload]
  22. object ResponsePayload extends GeneratedMessageCompanion[ResponsePayload]
  23. object SdkAnalyticConfig extends GeneratedMessageCompanion[SdkAnalyticConfig]
  24. object SdkAnalyticContext extends GeneratedMessageCompanion[SdkAnalyticContext]
  25. object TokenConfiguration extends GeneratedMessageCompanion[TokenConfiguration]
  26. object Waterfall extends GeneratedMessageCompanion[Waterfall]
  27. object WaterfallProto extends GeneratedFileObject

Deprecated Value Members

  1. object AppExtension extends GeneratedMessageCompanion[AppExtension]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  2. object DeviceExtension extends GeneratedMessageCompanion[DeviceExtension]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  3. object RegsCcpaExtension extends GeneratedMessageCompanion[RegsCcpaExtension]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

  4. object Session extends GeneratedMessageCompanion[Session]
    Annotations
    @deprecated
    Deprecated

    (Since version ) Marked as deprecated in proto file

Ungrouped