Android SDK

Requirements

The Extole Android SDK supports minSdkVersion 21 or later.

Integration

Add Extole’s SDK library

In the build.gradle for your project add Extole’s SDK library.

implementation 'com.extole.mobile:android-sdk:1.0.+'

Initialize Extole

Initialize Extole. We recommend that you have a single instance of the Extole class.

Extole.init(context = context, appName = "your-app-name")

In the example above, be sure to replace appName = "your-app-name" with a descriptive name for your application. You can also specify the type of sandbox you’d like to use, like sandbox = “production-test”, and pass a version, such as data = {"version" to "1.0"}.

Initialize Global Components

Initialize global components. The following example uses the dependency injection framework Dagger.

@Module
@InstallIn(SingletonComponent::class)
class Configuration {
    val threadPool = Executors.newFixedThreadPool(1);

    @Singleton
    @Provides
    fun extole(@ApplicationContext context: Context): FutureTask<Extole> {
        val extoleFuture = FutureTask<Extole> {
            Extole.init(
                context = context, appName = "your-app-name")
        }
        threadPool.submit(extoleFuture)
        return extoleFuture
    }

}

Dagger usage example:

val extole = withContext(Dispatchers.IO) {
     extoleFuture.get()
}

Connect to your Extole Account

In the AndroidManifest.xml file, under the tag <application></application> add the following code.

<meta-data
  android:name="com.extole.PROGRAM_DOMAIN"
  android:value="https://share.client.com/" />

You must use your program domain in order for the application to communicate with Extole. If you have not yet completed the CNAMEing process for your program, the unbranded domain can also be used.

Exchange Data with Extole

Customer Information

Send Extole information about the customer.

extole.identify("[email protected]", mapOf("member_id" to "123"))

You can choose to pass any type of data to describe the customer. Richer data about your customers gives your marketing team the information they need to better segment your program participants and target them with appropriate campaigns.

JWT Identification

If you would like to verify the identity of your customers with JWT instead of their email address, use the following method:

extole.identifyJwt(jwt: String, data: Map<String, String> = mapOf()): Id<Event>

For more information on generating JWTs, please reference our article on Verifying Consumers.

Events

Send Extole events, such as registers, signups, conversions, account openings, and so on.

extole.sendEvent("my_event", mapOf("key" to "values"))

For each event type, you can send additional data. For example, on a conversion event you may want to pass in order ID or order value and so on.

Call to Action Content

Populate a CTA with content from Extole.

CTAs such as mobile menu items can be fully customized in the My Extole Campaign Editor. Each CTA has a designated zone. The following code is an example of how to retrieve a CTA by fetching zone content.

// Usage example:
val (zone, campaign) = extole.fetchZone("mobile_cta")
runOnUiThread {
   findViewById<EditText>(R.id.cta_title)
       .setText(zone?.get("text").toString(),TextView.BufferType.NORMAL)
    findViewById<EditText>(R.id.cta_image)
       .setText(zone?.get("image").toString(),TextView.BufferType.NORMAL)

   // On CTA tap send the event to Extole
   zone.tap()
}

In order to be able to fetch the mobile_cta zone, the zone should be configured in My Extole and should return JSON content containing the image and title.

📘

Important Note

We encourage you to pull CTA content from My Extole because doing so ensures that your menu item or overlay message will reflect the copy and offer you’ve configured for your campaign.

Advanced Usage

The following topics cover advanced use cases for the Extole Android SDK. If you would like to explore any of these options, please reach out to our Support Team at [email protected].

Integrating with a Deep Link Provider

Completing a deep link integration is simple once you have integrated with a deep link provider, such as Branch. Send a mobile event to Extole, and based on the configuration of your mobile operations, our framework will execute the corresponding action.

DeepLinkListener { linkProperties, error ->
  GlobalScope.launch {
        ServiceLocator.getExtole(this@DeeplinkActivity)
                extole.sendEvent("deeplink", linkProperties)
  }
}

Configuring Actions from Events

You can set up a specific action to occur when an event is fired. For example, when a customer taps on your menu item CTA, you may want the event to trigger an action that loads your microsite and shows the share experience.

To set up this type of configuration, you will need to work with Extole Support to set up a zone in My Extole that returns JSON configurations with conditions and actions. The SDK executes actions for conditions that are passing for a specific event.

{
  "operations": [
    {
      "conditions": [
        {
          "type": "EVENT",
          "event_names": [
            "mobile_cta_tap"
          ]
        }
      ],
      "actions": [
        {
          "type": "VIEW_FULLSCREEN",
          "zone_name": "microsite"
        }
      ]
    }
  ]
}

📘

Adding additional operations

If you would like to add more operations, you will need to update the zone mobile_bootstrap. By default, this zone is not available to be updated. You must have already added the mobile SDK support component. Please reach out to our Support Team at [email protected] for help adding this component to your campaign.

Supported Actions

The following types of actions are supported by default in our SDK.

Custom Actions

If you would like to create custom actions beyond our defaults, use the format exhibited in the example below. Please reach out to our Support Team at [email protected] if you have any questions.

class CustomAction(@SerializedName("custom_action_value") val customParameter: String) : Action {

    companion object {
        val ACTION_TITLE = "CUSTOM_ACTION"
    }

    override suspend fun execute(event: AppEvent, extole: ExtoleInternal) {
        extole.getData()["custom_action_key"] = "custom_action_value"
    }

    override fun getType(): Action.ActionType = Action.ActionType.CUSTOM

    override fun getTitle(): String = ACTION_TITLE
}

Registering Custom Actions

Extole.registerAction(“CUSTOM_ACTION”, CustomAction::class.java)