• Dashboard
  • API
  • Guides
  • FAQ
  • Android > Custom data

    Events

    Batch allows you to track events that happen in your application. They automatically keep track of their count, the last time it happened and their value.

    Important
    - Please read our guide on custom data before tagging your app.
    - Newly tracked events are hidden by default. You will need to manually display them from the dashboard settings > "Custom data" tab.

    Tracking events

    Events are easy to use, but have some rules:

    • Event names are strings. They should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
    • They can have a label, which is a string with no limitations (optional).
    • A custom data object can be attached. See the section "Event Data", right under this one.

    Here's an example:

    Batch.User.trackEvent("ad_seen");
    Batch.User.trackEvent("tab_clicked", "activity");

    Important
    Please test your implementation using our debug tool before releasing your app on the store.

    Event data

    Starting with Batch SDK 1.13.0, you can attach custom data to events using BatchEventData. You will then use this event when calling Batch.User.trackEvent(). It is very similar to BatchUserDataEditor.

    It supports setting the following data:

    • Tags: a collection of string values
      • They can't be longer than 64 characters, empty or null.
      • The SDK will automatically lowercase them, so two same strings with different casing does not count as two different tags.
    • Attributes: key/value pairs of data
      • Attributes associate values to keys.
      • Keys should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.
        They will be lowercased, so trying to use the same key with different casing will overwrite the previously set value.
      • Values can be of the following types:
        • Strings, not longer than 64 characters, can't be empty or null.
        • Booleans
        • Floats/Doubles
        • Integer/Longs

    An event supports at most 10 tags and 10 attributes.

    Any attempt to add an invalid tag or attribute will fail. Setting a value for an existing key will overwrite it.

    Example:

    BatchEventData data = new BatchEventData();
    data.addTag("sports");
    data.addTag("squash");
    data.addTag("daily_digest");
    
    data.put("premium", true);
    data.put("id", "123456");
    Batch.User.trackEvent("read_article", null, data);
    Batch.User.trackEvent("read_article", null, BatchEventData().apply {
        addTag("sports")
        addTag("squash")
        addTag("daily_digest")
    
        put("premium", true)
        put("id", "123456")
    })

    Note: Event data was available before Batch SDK 1.13.0, and worked with a plain JSONObject object.
    This method has been deprecated: BatchEventData must now be used to describe your custom data.

    Migrating from old event data

    Event data tracked using the legacy API will be converted to the new format, after logging a warning.

    There are a couple of limitations:

    • Any data that can't be represented using BatchEventData will be ignored.
    • Same size limits apply (key naming, string attribute length, number of attributes)

    Tags are not migrated from arrays found in the legacy data format.

    In order to use the new API, you will have to rewrite the code putting data in what used to be a JSONObject to use BatchEventData.

    See the class' documentation for the list of the available put methods.
    Consider using tags rather than tracking multiple events sharing the same name, but with different labels.

    Tracking transactions

    We also have a specialized kind of events: Transactions. They let you track a transaction of a certain amount, without any currency attached: You will need to make sure you only track comparable values.

    The amount should be a double.

    Here's an example:

    Batch.User.trackTransaction(20.5);

    Make sure you start Batch before or after tracking your events. Otherwise, they will not be sent!

    You can use this data to target users who already have or haven't made any transactions in your app yet from the dashboard. Batch also displays the income generated in your app in Batch analytics.

    Tracking user location

    Starting with Batch 1.8, you can now natively track a user location. This uses Android's standard Location object, which you usually get from the Location Service or Fused Location API. You can also instanciate one manually from a latitude/longitude.

    Here's an example:

    @Override
    public void onLocationChanged(Location location) {
        if (location != null) {
            Batch.User.trackLocation(location);
        }
    }

    This data will allow you to send geotargeted push notifications from the dashboard or the Campaigns API.

    The SDK will throttle location tracking to optimize network and battery usage. You can track one location event every 30 seconds, any attempt at updating the location sooner will be ignored by the SDK.