herald-adjust/io.github.mkhytarmkhoian.herald.adjust/AdjustAdRevenueEvent

AdjustAdRevenueEvent

data class AdjustAdRevenueEvent(val name: String, val source: String, val revenue: Double, val currency: String, val adImpressionsCount: Int? = null, val adRevenueNetwork: String? = null, val adRevenueUnit: String? = null, val adRevenuePlacement: String? = null, val parameters: Map<String, AnalyticsValue> = emptyMap()) : Event(source)

Ad revenue reported by a mediation SDK, as Adjust's dedicated ad-revenue API takes it rather than as a tokened event.

A final class, so an app event can't be one. The app's Adjust factory builds one from its own event and sends it through AdRevenueEventTracker.

For revenue on a purchase, see AdjustRevenueEvent, which stays a tokened event.

Constructors

AdjustAdRevenueEvent

constructor(name: String, source: String, revenue: Double, currency: String, adImpressionsCount: Int? = null, adRevenueNetwork: String? = null, adRevenueUnit: String? = null, adRevenuePlacement: String? = null, parameters: Map<String, AnalyticsValue> = emptyMap())

Properties

adImpressionsCount

val adImpressionsCount: Int?

adRevenueNetwork

val adRevenueNetwork: String?

adRevenuePlacement

val adRevenuePlacement: String?

adRevenueUnit

val adRevenueUnit: String?

currency

val currency: String

ISO 4217 code, as Adjust expects it.

name

open override val name: String

Usually the app event's own. It isn't sent: Adjust's ad-revenue API has no event name.

parameters

open override val parameters: Map<String, AnalyticsValue>

Sent as callback parameters, as on every other Adjust event. Usually the app event's own.

revenue

val revenue: Double

source

val source: String

Adjust's name for the mediation SDK: applovin_max_sdk, admob_sdk, and so on.

Functions

toAdjustAdRevenue

fun AdjustAdRevenueEvent.toAdjustAdRevenue(): AdjustAdRevenue

Builds the Adjust payload for ad revenue, with AdjustAdRevenueEvent.parameters as callback parameters. Public because a custom AdjustEventTracker almost always needs it.

toAdjustEvent

fun Event.toAdjustEvent(eventToken: String): AdjustEvent

Builds the Adjust payload for an event under eventToken, carrying the event's parameters as callback parameters. Public because a custom AdjustEventTracker almost always needs it.