Revenue Outcomes

Learn when and how to log revenue outcomes in ContextSDK to optimize monetization and improve model accuracy.

This API is only available in iOS at the moment. Please reach out to our team if you need this API in Android.

What is a revenue outcome?

A revenue outcome represents the result of a monetization event in your app, such as an in-app purchase or an ad impression.

Why is it important?

Understanding how and when users contribute to revenue allows ContextSDK to make informed predictions about the best moments to display monetization opportunities. Logging revenue outcomes helps ContextSDK optimize your ML models, ensuring that monetization decisions align with real-world user behavior, so we can optimize your app for revenue generation.

When should I log revenue outcomes?

Always log a revenue outcome when a monetization event occurs. This includes but it's not limited to:

• In-app purchases (IAPs): When a user successfully purchases a product.

• Ad clicks: When a user taps on an ad.

• Ad impressions: When an ad is displayed to a user.

• Tips: When a user leaves a tip.

If a positive event in your flow results in revenue, log a revenue outcome instead of a general positive outcome. Use a positive outcome only when the event does not directly generate revenue, such as app permission prompts or rating requests. If the user does not complete a revenue-generating action — such as dismissing an offer or leaving without interaction — log a negative outcome instead. Record revenue outcomes only when the user actively contributes to revenue generation.

How to log revenue outcomes

Here's a few examples of how to log revenue outcomes for different scenarios.

In-app purchases

If you're using StoreKit 2, log a purchase like this:

// `product` is the StoreKit 2 product that was purchased.
context.logRevenueOutcome(from: product)

If you're using RevenueCat, retrieve the StoreKit 2 product and log it:

// `storeProduct` is the RevenueCat StoreProduct object.
context.logRevenueOutcome(from: storeProduct.sk2Product)

If you’re using a different in-app purchase framework, retrieve the equivalent StoreKit product object and pass it to logRevenueOutcome(from:).

There's no need to call context.log(.positive) after logging a revenue outcome from a Product, as the positive outcome is already logged internally. Alternatively, you can customize the outcome to be logged directly, via logRevenueOutcome(from:outcome:).

Ad clicks and impressions

For an ad click, log the revenue outcome as follows:

let event = RevenueEvent(source: .adClick, revenue: 0.09, currency: .usd)
context.logRevenueOutcome(from: event, outcome: .positiveAdTapped)

Or for an ad impression:

let event = RevenueEvent(source: .adImpression, revenue: 0.00175, currency: .usd)
context.logRevenueOutcome(from: event, outcome: .negativeNotInteracted)

The revenue values in these examples are placeholders. Use the actual revenue values from your ad network's SDK, preferring the most precise values available. If exact values aren't provided, an estimate is acceptable, however, greater precision improves accuracy.

Some ad networks may provide callbacks that contain live revenue data. Use this data to log revenue outcomes in real-time, ensuring that the revenue data is as accurate as possible.

Best practices

• Avoid duplicate logging: Use logRevenueOutcomeIfNotLoggedYet(from:) for events where duplicate logging may occur.