Example app for Android SDK

The Exponea Android SDK includes an example application you can use as a reference implementation. You can build and run the app, test Engagement features, and compare the code and behavior of your implementation with the expected behavior and code in the example app.

Prerequisites

You must have the following software installed to be able to build and run the example app:

• Android Studio with a virtual device set up

Build and run the example app

1. Clone the exponea-android-sdk repository on GitHub:
   Shell

   git clone https://github.com/exponea/exponea-android-sdk.git

2. Open the exponea-android-sdk project in Android Studio.
3. Open the file sdk/build.gradle and find the following line
   Groovy

   apply from: 'publish-maven.gradle'

   Comment it out so it look like this:
   Groovy

   //apply from: 'publish-maven.gradle'

4. Run the example app on the Android emulator (Run > Run 'app' or Ctrl + R).

📘

To enable push notifications in the example app, you must also configure the Firebase Cloud Messaging for Android SDK or Huawei integration in the Exponea web app.

Navigate the example app

When you run the app in the emulator, you'll see the Authentication view. The screen fields change depending on the selected integration type. Here's how to set it up:

1. Select your integration type from the Integration Config dropdown: Project Config or Stream Config.
2. For Project Config:
   • Enter your Project Token.
   • Enter your Authentication Code (API key).
   • Optional: Enter the API key ID of Private to enable customer token authorization.
3. For Stream Config:
   • Enter your Stream ID.
   • Optional: Enter JWT Key ID and JWT Secret to enable local JWT token generation for testing. Both must be provided together. Refer to SDK auth token authorization for details.
4. Enter the API Url (API base URL for the Bloomreach platform).
5. Optional: Enter an email address hard ID in the Registered field to identify the customer. Leave blank for anonymous tracking.
6. Optional: Enter Application ID if your Engagement project supports multiple mobile apps. If you leave this blank, the SDK uses the default value default-application. Learn more about Configuration for Android SDK.
7. Click Authenticate to initialize the SDK.

The Clear local data button invokes Exponea.clearLocalCustomerData() to delete all locally stored data without initializing the SDK.

AuthenticationActivity.kt

👍

When using Project Config, make sure to prefix your API key with Token , for example:
Token 0b7uuqicb0fwuv1tqz7ubesxzj3kc3dje3lqyqhzd94pgwnypdiwxz45zqkhjmbf.

The app provides several views, accessible using the bottom navigation, to test the different SDK features:

• The Fetch view enables you to fetch recommendations and consents, and open the app inbox.

  FetchFragment.kt

• The Track view enables you to test tracking of different events and properties. It also provides options to set the SDK auth token and identify customers with auth tokens. The Custom Event and Identify Customer buttons lead to their separate views to enter test data.

  TrackFragment.kt
IdentifyCustomerDialog.kt
TrackCustomEventDialog.kt

• The Manual Flush view lets you trigger a manual data flush.

  FlushFragment.kt

• The Anonymize view lets you anonymize the current user and stop the SDK integration.

  AnonymizeFragment.kt

• The InAppCB view displays in-app content blocks. Use placeholder IDs example_top, ph_x_example_Android, example_list, example_carousel, and example_carousel_and in your in-app content block settings.

  InAppContentBlocksFragment.kt
fragment_inapp_content_blocks.xml

Try out the different features in the app, then find the customer profile in the Engagement web app (under Data & Assets > Customers) to see the properties and events tracked by the SDK.

If you left the Registered field blank, the customer is tracked anonymously using a cookie soft ID. You can look up the cookie value in the logs and find the corresponding profile in the Engagement web app.

If you entered a hard ID (use an email address as value) in the Registered field, the customer is identified and can be found in Engagement web app by their email address.

📘

Refer to Customer identification for more information on soft IDs and hard IDs.

Troubleshooting

If you encounter any issues building the example app, the following may help:

• In Android Studio, select Build > Clean Project, then Build > Rebuild Project.