Getting Started

Install the Gameball Android SDK into your app

Gameball's Android SDK enables you to use the show Gameball customer profile in your app, track app customer events, integrate referrals and display Gameball's in-app push notifications.

Setting up Gameball SDK

Follow the below steps to start installing Gameball's Android SDK to your app.

Add JitPack repository to your project's build.gradle (or settings.gradle if you're on newer versions) file.

dependencyResolutionManagement {
    ...
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Add the following dependency to the application's build.gradle file to import Gameball's SDK into your project.

dependencies {
    ...
    implementation 'com.github.gameballers:gb-mobile-android:1.3.0'  
}

Make sure that you added the INTERNET permission in your application's AndroidManifest.xml file as follows:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools">
    ...
    <uses-permission android:name="android.permission.INTERNET" />
    ...
</manifest>
    

To install Firebase Google Play Services dependencies

Gameball SDK uses Firebase Dynamic Links to track referrals and Firebase Messaging for sending push notifications, you'll need to add the following dependencies.

dependencies {
    ...
    // Make sure to include this dependency even if you won't include Firebase Messaging
    implementation platform('com.google.firebase:firebase-bom:<latest_version>')
    // Firebase Dynamic Links only - must be included
    implementation "com.google.firebase:firebase-dynamic-links"    
    // Firebase Messaging only - optional depending on whether or not you want to use FCM
    implementation 'com.google.firebase:firebase-messaging'  
}

For the latest Firebase SDK (BOM, Cloud Messaging, Deep Links, and Google Services) versions check their release notes.

You also need to add google-services plugin to your application.

App's build.gradle file:

plugins {
    ...
    id 'com.google.gms.google-services'
}

Project's build.gradle file:

buildscript{
    ...
    dependencies {
        ...
        classpath 'com.google.gms:google-services:<latest_version>'

    }
}

Don't forget to include your google-services.json to your app root after registering it to a Firebase project.

Follow this tutorial to learn more on how to register your Android application to Firebase.

When publishing your app, make sure if you are using ProGuard rules, to exclude gameball packages to avoid Reductions/Code obfuscation by adding the following line in the proguard-rules.pro file.

-keep class com.gameball.gameball.** { *; }