Skip to main content

Android

The Gleap SDK for Android is the easiest way to integrate Gleap into your apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites.

For the SDK to work, you need an API key, which you can get for free at app.gleap.io.

🏗 Installation

Gleap is distributed through the maven. Add the following to you build.gradle (Module: app).

implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '8.2.3'

The Gleap SDK is now almost successfully installed. Let's carry on with the initialization 🎉

Troubleshooting

Bintray issue

The bintray service was sunset on May 2022. Due to this, we migrated our SDK to the mvnrepository. If you run into the following build issue, you must remove the bintray repository.

Issue:

> Could not resolve all dependencies for configuration ':app:debugRuntimeClasspath'.
> Could not determine artifacts for io.gleap:gleap-android-sdk:8.2.2
> Could not get resource 'https://jcenter.bintray.com/io/gleap/gleap-android-sdk/8.2.2/gleap-android-sdk-8.2.2.aar'.
> Could not HEAD 'https://jcenter.bintray.com/io/gleap/gleap-android-sdk/8.2.2/gleap-android-sdk-8.2.2.aar'.
> Read timed out

Solution:

Navigate to android/.idea/jarRepositories.xml and remove the bintray reference, to make sure the gleap SDK gets downloaded from the mvnrepository.

API level 30

info

Google Play will soon require that apps target API level 31 or higher. This will be required for new apps in August 2022, and for updates to existing apps in November 2022.

If your project depends on API level 30 please add the following to you build.gradle:

implementation( "androidx.appcompat:appcompat:1.3.0") {
force = true
}
implementation( "com.google.android.material:material:1.4.0") {
force = true
}

Old version of core:ktx

If you are using a older version of core:ktx please add the following:


implementation( "androidx.core:core-ktx:{your version}") {
force = true
}

👷‍♂️ Initialize & configure the SDK

Open your preferred development tool and add the following to your main class.

import io.gleap.Gleap;

These two includes are everything you need.

@Override
protected void onCreate(Bundle savedInstanceState) {
....
Gleap.initialize("YOUR_API_KEY", this);
}

You are all set now! Run the app and report your first bug 🎉.

info

Get your API key here.

🤝 Need help?

We are here to help, simply drop us an email at [email protected].