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

Package-level declarations

Types

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

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

AdjustAnalyticsService

class AdjustAnalyticsService(adjust: AdjustInstance, config: AdjustConfig, identityParameter: String = DEFAULT_IDENTITY_PARAMETER) : AnalyticsLifecycleService, IdentifiableUserService, ConsentService

Adjust's lifecycle and identity, over an AdjustConfig the consumer builds.

AdjustAnalyticsTrackerService

class AdjustAnalyticsTrackerService(eventTrackerFactory: AdjustEventTrackerFactory, propertySetterFactory: AdjustPropertySetterFactory) : EventTrackerService, PropertyTrackerService

AdjustEventTracker

fun interface AdjustEventTracker

One pending call to Adjust on behalf of one event.

AdjustEventTrackerFactory

fun interface AdjustEventTrackerFactory

Turns an event into the Adjust calls it should produce — or declines it.

AdjustPropertySetter

fun interface AdjustPropertySetter

One pending call to Adjust on behalf of one property.

AdjustPropertySetterFactory

fun interface AdjustPropertySetterFactory

The AdjustEventTrackerFactory counterpart for properties, with the same partial contract.

AdjustRevenueEvent

data class AdjustRevenueEvent(val name: String, val revenue: Double, val currency: String, val deduplicationId: String? = null, val parameters: Map<String, AnalyticsValue> = emptyMap()) : Event

A purchase as Adjust counts revenue: a tokened event that also carries the amount, so Adjust attributes it to the campaign that brought the user in.

AdjustToken

class AdjustToken<E : Event>(eventClass: KClass<E>, token: String)

The Adjust dashboard token for events of type E, or of a subclass of it: AdjustToken<SignUpCompleted>("abc123").

CompositeAdjustEventTrackerFactory

class CompositeAdjustEventTrackerFactory(factories: List<AdjustEventTrackerFactory>) : AdjustEventTrackerFactory

Asks each factory in order and takes the first answer that is not a decline.

CompositeAdjustPropertySetterFactory

class CompositeAdjustPropertySetterFactory(factories: List<AdjustPropertySetterFactory>) : AdjustPropertySetterFactory

Asks each factory in order and takes the first answer that is not a decline.

GenericAdjustPropertySetterFactory

class GenericAdjustPropertySetterFactory(adjust: AdjustInstance) : AdjustPropertySetterFactory, FallbackFactory

Registers any property as an Adjust global callback parameter, appended to the callbacks Adjust fires for later sessions and events. Claims everything, so it belongs last in a chain.

RequireMappedAdjustEventTrackerFactory

object RequireMappedAdjustEventTrackerFactory : AdjustEventTrackerFactory, FallbackFactory

Fails on any event that reaches it. Put it last in a chain to turn an event nobody wired up into a loud failure rather than a silent no-op.

RequireMappedAdjustPropertySetterFactory

object RequireMappedAdjustPropertySetterFactory : AdjustPropertySetterFactory, FallbackFactory

The RequireMappedAdjustEventTrackerFactory counterpart for properties, and the alternative to ending a chain with GenericAdjustPropertySetterFactory.

TokenAdjustEventTrackerFactory

class TokenAdjustEventTrackerFactory(tokens: List<AdjustToken<*>>, adjust: AdjustInstance) : AdjustEventTrackerFactory

Sends each event that has a token in tokens under that token, and declines everything else:

Functions

AdjustToken

inline fun <E : Event> AdjustToken(token: String): AdjustToken<E>

The Adjust dashboard token for events of type E: AdjustToken<SignUpCompleted>("abc123").

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.

fun AdjustRevenueEvent.toAdjustEvent(eventToken: String): AdjustEvent

Builds the Adjust payload under eventToken: the revenue, the deduplication id when there is one, and AdjustRevenueEvent.parameters as callback parameters. Public because a custom AdjustEventTracker almost always needs it.