Public repo for the Braze Android SDK
Java HTML JavaScript
Clone or download

README.md

Braze Logo

Android SDK

Successful marketing automation is essential to the future of your mobile app. Braze helps you engage your users beyond the download. Visit the following links for details and we'll have you up and running in no time!

Components

  • android-sdk-base - the Braze SDK base analytics library.
  • android-sdk-ui - the Braze SDK user interface library for in-app messages, push, and the news feed.
  • droidboy - a sample app demonstrating how to use Braze in-depth.
  • hello-appboy - a sample app demonstrating a basic Braze integration.
  • china-push-sample - a sample app demonstrating the Braze + Baidu push integration.
  • android-sdk-unity - a library that enables Braze SDK integrations on Unity.
  • samples - a folder containing several sample apps for various integration options.

Version Support

  • The Braze Android SDK supports Android 4.0+ / API 14+ (Ice Cream Sandwich and up).
  • Last Target SDK Version: 26
  • Last Compiled Support Library Version: 27.1.0
  • Last Compiled Google Play Services Version (Optional): 12.0.1
  • Braze uses Font Awesome 4.3.0 for in-app message icons. Check out the cheat sheet to browse available icons.
  • Braze requires either a custom IAppboyImageLoader or Facebook's Fresco image library to display animated gif images. Fresco is not included nor enabled by default in the Braze library, and must be included and enabled explicitly by the parent app. Braze supports Fresco 0.6.0 through 1.3.0.

Remote repository for gradle

The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   maven { url "https://appboy.github.io/appboy-android-sdk/sdk" }
   ...
}
dependencies {
   compile 'com.appboy:android-sdk-ui:2.4.+'
   ...
}

Installing android-sdk-ui to Your Local Maven Repository

To install the UI library as an AAR file to your local maven repository, run the install task with ./gradlew install. You can reference it with groupId com.appboy and artifactId android-sdk-ui. The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
   mavenLocal()
   ...
}
dependencies {
  compile 'com.appboy:android-sdk-ui:2.4.+'
}

Building and Running the Sample Applications

  1. Make sure the ANDROID_HOME environment variable is set to the location of your installed SDK or you have a local.properties file which defines the sdk.dir property. You can check this by running echo $ANDROID_HOME, or echo %ANDROID_HOME% in Windows.
  2. To assemble the UI library and the Droidboy APK, run ./gradlew assemble (use gradlew.bat on Windows). You can find assembled files in the build/ subdirectories of the android-sdk-ui and droidboy projects. You can also use the installDebug task if you have a device or emulator connected to adb and want to run Droidboy or Hello-Appboy. You can see other available tasks by running ./gradlew tasks.

Questions?

If you have questions, please contact support@braze.com.