RevenueCat purchases-android

The RevenueCat AdMob Adapter wraps standard AdMob ad lifecycle callbacks to automatically track ad events within the RevenueCat dashboard. It acts as a drop-in replacement for standard AdMob loading calls, allowing you to track events such as loaded, displayed, opened, revenue, and failed-to-load with minimal code changes.

Note on Language Support:

• Kotlin: Full support for the load-and-track helper APIs.
• Java: Helper APIs are not currently available. Java users must call the core AdTracker APIs (e.g., trackAdDisplayed, trackAdRevenue) directly.

The Purchases SDK is a client-side wrapper for the RevenueCat subscription and purchase tracking system. It wraps the Google Play BillingClient and communicates with the RevenueCat backend to simplify implementing in-app purchases and subscriptions on Android.

Key capabilities include:

• Receipt Validation: Server-side validation of purchases.
• Subscription Status Tracking: Cross-platform tracking of whether a user is currently subscribed.
• Remote Configuration: Managing products, offerings, and entitlements via the RevenueCat dashboard.
• Webhooks: Real-time server-to-server notifications for events like renewals, cancellations, and purchases.
• Analytics: Automatic calculation of business metrics like MRR, churn, and conversion.

The purchases-android-admob adapter library automates the mapping of Google AdMob callbacks to RevenueCat ad events. Instead of manually calling RevenueCat trackers, you use the adapter's extension functions or adTracker methods to load ads. This ensures that events like Ad Loaded, Ad Displayed, Ad Opened, Ad Revenue, and Ad Failed to Load are automatically sent to your RevenueCat Dashboard.

Supported formats include:

• Banner Ads
• Interstitial Ads
• App Open Ads
• Rewarded Ads
• Rewarded Interstitial Ads
• Native Ads
• Native Video Ads

// The adapter sits between AdMob and RevenueCat, automatically mapping callbacks.
// Example of the flow:
// AdMob SDK (Load Ads) -> Adapter Library (Tracks events) -> RevenueCat Dashboard

Custom Entitlements Computation mode is a specialized behavior mode for the RevenueCat SDK designed for apps that perform their own entitlement computation independently of RevenueCat.

Key characteristics of this mode:

• Entitlement Management: Apps rely on webhooks to signal their backends to refresh entitlements with RevenueCat.
• User IDs: RevenueCat will not generate anonymous user IDs.
• Caching: The CustomerInfo cache is not refreshed automatically. It is only refreshed when a purchase is completed.
• API Restrictions: Most SDK methods are disallowed; only methods for configuration, switching users, getting offerings, and making purchases are available.
• Configuration Timing: The SDK should only be configured once the initial appUserID is known.

All supported ad formats automatically report the following RevenueCat ad events to ensure accurate analytics and revenue tracking:

• Ad Loaded: The ad was successfully loaded.
• Ad Displayed: An impression was recorded.
• Ad Opened: The user clicked or interacted with the ad.
• Ad Revenue: Revenue reported via AdMob's OnPaidEventListener.
• Ad Failed to Load: A load error occurred.

The PurchaserInfo type and its associated functions have been renamed to CustomerInfo to maintain parity with iOS. You should update all references to these types and methods in your codebase.

| Old type name | New type name |
|------------|------|
| `PurchaserInfo` | `CustomerInfo` |
| `ReceivePurchaserInfoListener` | `ReceiveCustomerInfoCallback` |
| `UpdatedPurchaserInfoListener` | `UpdatedCustomerInfoListener` |
| `ReceiveOfferingsListener` | `ReceiveOfferingsCallback` |
| `PurchasesErrorListener` | `PurchasesErrorCallback` |

The Purchases Codegen plugin is best suited for stable identifiers (Entitlement IDs, Offerings, and Packages) because it provides compile-time safety and autocomplete.

Key Trade-off: Dynamic vs. Static Content

• Static (Codegen): Any change in the RevenueCat dashboard (renaming an offering, adding a package) requires a new build and app release to update the generated Kotlin code.
• Dynamic (Runtime API): If you access offering.availablePackages directly via the standard SDK, your app can pick up new packages from the backend at runtime without a new release.

Decision Rule: Use Codegen when you want to reference specific IDs in your logic (e.g., RCEntitlementId.PREMIUM_ACCESS). Use the raw API if you manage paywall presentation entirely from the dashboard without touching code.

Every tracking method in the AdMob Adapter accepts an optional placement string. This string tags all events associated with a specific ad, allowing you to distinguish performance across different screens or ad slots in your RevenueCat dashboard.

Examples of logical placement names include:

• "home_banner"
• "level_complete_interstitial"
• "feed_native"
• "bonus_coins_rewarded"

Placements are free-form strings; you should establish a consistent naming convention for your application.

To use Custom Entitlements Computation mode, you must include the specific purchases-custom-entitlement-computation artifact in your Gradle dependencies.

Add the following to your build.gradle file:

implementation("com.revenuecat.purchases:purchases-custom-entitlement-computation:6.8.0")

In version 5 and later, the configure function has changed. Instead of passing multiple parameters directly, you must now use a PurchasesConfiguration.Builder to create a configuration object. This change supports both Google Play and Amazon Appstore.

// For Google Play
Purchases.configure(PurchasesConfiguration.Builder(this, "public_google_sdk_key").build())

// For Amazon
Purchases.configure(AmazonConfiguration.Builder(this, "public_amazon_sdk_key").build())