Axon Mobile App Integration

This guide shows how to integrate the Axon SDK into your native Android mobile app so that you can track events for that app.

Caution

SDK integration remains in beta and is only available in certain regions at this time.

Download the Latest SDK

You can download the SDK through Gradle as a dependency. The SDK requires the minSdkVersion to be 19 or above.

Add the following to your app-level build.gradle file:

Groovy

repositories {
  google()
  mavenCentral()
  ⋮
}
dependencies {
  implementation 'com.applovin:axon-sdk:+'
  ⋮
}

Kotlin

repositories {
  google()
  mavenCentral()
  ⋮
}
dependencies {
  implementation("com.applovin:axon-sdk:+")
  ⋮
}

ProGuard Rules

If you use ProGuard, note that the AppLovin Axon SDK comes bundled with the required ProGuard rules in the AARs. Therefore, you do not need to add any additional ProGuard rules to your project.

Note

The SDK collects the Google Advertising ID. This requires the Android Advertising ID (AAID) module (com.google.android.gms:play-services-ads-identifier). See Google Play services dependencies.

Initialize the SDK

Initialize the AxonSDK with the event key at startup to maximize how long the SDK can take to ready core services. Replace “«your-event-key»” with your Axon Event Key.

You can find your Axon Event Key in the Account > General > Keys section of the AppLovin dashboard.

Java

import com.applovin.sdk.Axon;

Axon.getInstance().initialize( "«your-event-key»", new Axon.InitializationListener()
{
  @Override
  public void onInitialized()
  {
    ⋮
  }
} );

Kotlin

import com.applovin.sdk.Axon

Axon.getInstance().initialize("«your-event-key»", {
  ⋮
})

Processing Deep Links

You must provide a deep link so that when a user clicks an ad, either your app seamlessly opens if it is installed, or the click routes them to a browser otherwise. In your Activity that handles the deep link, call Axon SDK’s processDeepLink() API to handle inbound deep links and associated metadata.

Note

AppLovin only processes URLs that originate from AppLovin.

Java

@Override
protected void onNewIntent(final Intent intent)
{
  super.onNewIntent( intent );

  if ( Intent.ACTION_VIEW.equals( intent.getAction() ) )
  {
    final Uri uri = intent.getData();
    if ( uri != null )
    {
      Axon.getInstance().processDeepLink( uri );
    }
  }
}

Kotlin

override fun onNewIntent(intent: Intent?)
{
  super.onNewIntent(intent)

  if (Intent.ACTION_VIEW == intent?.action)
  {
    intent.data?.let { uri ->
      Axon.getInstance().processDeepLink(uri)
    }
  }
}

Tracking Events with the Axon SDK

Note

At a minimum, provide page_view, view_item, add_to_cart, begin_checkout, and purchase events. Also include sign_up or login if your site uses these events.

To send an occurrence of an ecommerce event to Axon, use the following syntax. Each event should trigger when its corresponding event happens in the data layer.

Java

sdk.getEventService().trackEvent( «event-name», «event-data» );

Kotlin

sdk.eventService.trackEvent(«event-name», «event-data»)

Parameters

Name	Type	Description
event_name	string	The name for this event. See Axon Pixel Events and Objects for available events.
event_data	object	The data for this event. See Axon Pixel Events and Objects for data to send. (Note: you do not need to send event_data with page_view.)

All events require the event_name argument. Each event except for page_view also requires certain event_data, described in the event-specific sections below.

Passing Data to the Axon SDK

For each of the events that requires event_data, AppLovin recommends that you create a Map that is the payload. For example:

Java

Map<String, Object> parameters = new HashMap<>();
parameters.put( "currency", "USD" );
parameters.put( "value", 99.99 );

List<Map<String, Object>> items = new ArrayList<>();
...
parameters.put( "items", items );
sdk.getEventService().trackEvent( "add_to_cart", parameters );

Kotlin

sdk.eventService.trackEvent("add_to_cart", mapOf(
  "currency" to "USD",
  "value" to 99.99,
  "items" to listOf(
    ⋮
  )
))