Android Application Pixel Integration

📘

Integration Prerequisite

The version of the Android SDK used in your application should be 24 or above.

To set up Bloomreach pixels in your Android application, follow the steps below:

1. Add the dependency for pixels

The first step is to add the dependency that contains the Bloomreach Pixels for the Android client library.
To add the dependency, follow these steps:

1. Download the .aar file from https://github.com/bloomreach/discovery-android-sdk/releases under "Assets".

   

2. Add the .aar file in the libs directory at the root level of your project. If the libs directory does not exist already, create the directory and add the .aar file.

3. Now, to add the local .aar file as a dependency, add the following code to the settings.gradle file:

flatDir {
  dirs 'libs'
}

4. Finally, add the following code to the app level build.gradle file under the existing dependencies section inside it:

dependencies { 
… 
implementation (name: 'bloomreach-client-<LATEST-RELEASED-VERSION>', ext: 'aar') 
}

2. Initialization

In order to initialize the pixel library with your correct credentials at the start of your application, call the following method at the launch point of your app, in the onCreate() method inside the Applications file or Launcher Activity:

val brPixel = BrPixel(
  accountId = "<ACCOUND_ID>",
  uuid = “<13_digit_rand>”,
  visitorType = VisitorType.NEW_USER,
  baseUrl = "http://merchantname.app/"
)
PixelTracker.init(brPixel)

Make sure to replace all the placeholder values for the parameter values in the snippet above.


Here is a reference of all the different parameters you can set based on your requirements:

📘

The value of any of the above parameters can be modified later in the code, even after initialization. It can be done by using the following line:

PixelTracker.brPixel.<PARAMETER_NAME> = <VALUE>

3. Triggering Pixels

Refer to the following guides to Trigger specific pixels in your Android Application:

• Page View Pixels

• Event Pixels

• Widget Pixels

4. Pixel validation

You can test the integration of the Pixel SDK using the Pixel validator built inside the SDK. No additional integration is needed.
The Pixel validator only works in debug mode. The response from Pixel validation will be printed in Logcat of Android Studio on its own, as below: