Getting Started
Rules and screens
Web-to-App Solution
Integrations
Android
This guide describes how to add and use Apphud SDK to your Android app.
Features
Currently we support the following features for Android:
- Only Google Play Store is currently supported
- Auto-renewing subscriptions validation and renewals tracking
- One time purchases validation
- Refunds / Revokes tracking
- Grace Period and On Hold states are supported
- Fraud detection (basically verifying that purchase is valid and doesn't belong to another user)
- Promo-Codes are supported
- Introductory Prices are supported
- Integrations with 3rd party services
- Cross Platform is supported
- If purchase is made through SDK's billing method, then it will be acknowledged / consumed by SDK.
Requirements
Apphud SDK requires minimum Android 4.1 and supports only Google Play store.
Installation
Add the following lines to your
build.gradle file:1
repositories {
2
google()
3
mavenCentral() // if using Maven Central
4
}
5
6
allprojects {
7
repositories {
8
...
9
mavenCentral() // if using Maven Central
10
maven { url 'https://jitpack.io' } // if using Jitpack
11
}
12
}
Copied!
1
dependencies {
2
// if using Maven Central
3
implementation 'com.apphud:ApphudSDK-Android:{LATEST_VERSION_NUMBER}'
4
5
// if using Jitpack
6
implementation 'com.github.apphud:ApphudSDK-Android:{LATEST_VERSION_NUMBER}'
7
}
Copied!
Initialize SDK
To initialize Apphud SDK you will need API Key. It is a unique identifier of your Apphud application. You can get it in your Apphud application settings under
General tab.Basic initialization looks like this:
Kotlin
Java
1
Apphud.start(this, "API_KEY")
Copied!
1
Apphud.start(this, "API_KEY");
Copied!
Initialize with Custom User ID
There is additional parameter which sets custom user id:
Kotlin
Java
1
Apphud.start(this, "API_KEY", "custom_user_id")
Copied!
1
Apphud.start(this, "API_KEY", "custom_user_id");
Copied!
Configure Real-time Developer Notifications
Make sure you have correctly set up Google Real-time Developer Notifications. It helps to detect in-app purchase events in real-time. Read more here.
Handle In-App Purchases
You are not required to use Apphud purchase method. If you purchase products by yourself, then you should sync purchases with Apphud. So there are two options:
Purchase using Apphud Billing Client
To make a purchase call:
Kotlin
Java
1
Apphud.purchase(activity, skuDetails) { _ -> }
Copied!
1
Apphud.purchase(activity, skuDetails, purchases -> { return null;});
Copied!
At the launch of the app Apphud automatically fetches SKU Details for products that are added in Apphud dashboard. You can set
ApphudListener and implement the following method:1
fun apphudFetchSkuDetailsProducts(details: List<SkuDetails>)
Copied!
Store array of
SkuDetails somewhere in your app.If using Apphud Billing Client all purchases will be acknowledged or consumed automatically.
Observer Mode
Check Subscription Status
Kotlin
Java
1
Apphud.hasActiveSubscription()
Copied!
1
Apphud.hasActiveSubscription();
Copied!
Returns
true if user has active subscription. Use this method to determine whether to unlock premium functionality to the user. This method works regardless of which billing you are using for purchases.
Migrate existing purchases
Match User IDs for integrations
Some integrations require you to match user ids between Apphud and corresponding integration. Please see documentation for your integration for details.
User Properties
Last modified 3mo ago
Copy link