Initial SDK setup

Important

The next version of FollowAnalytics SDK will remove the support of GCM and instead will use Firebase services.

Install using gradle

If you use gradle as your build system, you can fetch the library from our private nexus repository.

Add the FollowAnalytics repository to your build.gradle repositories.

repositories {
    ...
    maven {
        url 'http://nexus.follow-apps.com/nexus/content/repositories/releases/'
    }
}

Add the FollowAnalytics SDK to your module's build.gradle dependencies.

dependencies {
    ...
    implementation "com.followapps.android:sdk:5.1.0"
    ...
}

The FollowAnalytics dependencies

For information the FollowAnalytics sdk depends on the following libraries. If you're using gradle, they are automatically added by the manifest merging process.

implementation "com.android.support:support-v4:27.0.1"
implementation "com.android.support:cardview-v7:27.0.1"
implementation "com.google.android.gms:play-services-gcm:11.6.0"
implementation "com.google.android.gms:play-services-location:11.6.0"
implementation "me.leolin:ShortcutBadger:1.1.19@aar"

ShortcutBadger dependency

This dependency allows some devices to show the count of unread messages as a badge on the application shortcut.

Permissions

The SDK adds automatically the following permissions to your manifest.

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

If the minimum version of the sdk android is lower than 14, you must add the permission GET_TASKS

<uses-permission android:name="android.permission.GET_TASKS"/>

To allow the SDK to log the user location

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>

To use geofencing feature

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>

Android M and permissions

The following permissions are qualified by Android 6.0 (Marshmallow) as dangerous:

  • android.permission.ACCESS_COARSE_LOCATION
  • android.permission.ACCESS_FINE_LOCATION (if you use the geofencing feature).

For best user experience, you can follow the guidelines as described here.

Initialize with your API key

Prepare your API key

Be sure to have your API key for this step of the configuration. If you are not sure where to find it, please reach out to your Customer Success Manager or message support@followanalytics.com

To add your API key to your app project, add the following line in your Manifest file, within the application tag:

<application>
    [...]
   <meta-data android:name="FAID" android:value="YOUR_API_KEY"/>
    [...]
 </application>

The FollowAnalytics SDK must be initialized in the onCreate() method of an Application class. This allows the SDK to be constantly initialized, whether the user launches the app himself, or if the Android system wakes any receiver or service of the application (for example for a push notification).

Open your Application subclass, or create a new one, and add the following lines to override the onCreate method:

public class MyAwesomeApplication extends Application {
    [...]
    @Override
    public void onCreate() {
        super.onCreate();
        FollowAnalytics.init(this);
        [...]
    }
    [...]
}

If you just created an Application subclass, do not forget to declare it in your AndroidManifest.xml file:

<application
    android:name=".MyAwesomeApplication"
    [...] />

Register for notifications

The FollowAnalytics SDK supports push notifications based on Google Cloud Messaging. To ensure notifications cannot be caught by other applications than yours, please follow the steps below.

  1. Add the following permissions to your manifest:

    <permission android:name="%YOUR_APP_PACKAGE_NAME%.permission.C2D_MESSAGE"
                    android:protectionLevel="signature" />
     <uses-permission android:name="%YOUR_APP_PACKAGE_NAME%.permission.C2D_MESSAGE" />
  2. Add the GCM Receiver to your manifest

    <receiver
                android:name="com.google.android.gms.gcm.GcmReceiver"
                android:exported="true"
                android:permission="com.google.android.c2dm.permission.SEND"
                >
            <intent-filter>
                <action android:name="com.google.android.c2dm.intent.RECEIVE"/>
                <!-- for Gingerbread GSF backward compat -->
                <action android:name="com.google.android.c2dm.intent.REGISTRATION"/>
                <category android:name="%YOUR_APP_PACKAGE_NAME%"/>
            </intent-filter>
     </receiver>

Notification icon and color

The SDK will use your app icon launcher as default notification icon. If you want a custom icon for your FollowAnalytics notification, add a ic_fa_notification.png file in your drawable folders (also, beware of the guidelines related to icon's notification). If you wish to have a custom background color on your notifications, you can add a value to your color.xml: <color name="ic_fa_notification_color">#ff0000</color>.

Android 8.0 (Oreo) Version

Since this version, Notification system was refactored (Google's documentation). With those changes, FollowAnalytics SDK uses this id for NotificationChannel object : default_notification_fa.

Notifiations on wearables

Should you need to disable notifications on wearables, you can use the FollowAnalytics.setGcmRegistrationEnabled(true or false) method.

Validate

The SDK has a Validator that will ensure that everything is properly configured.

No matter whether you use jar or gradle, you should check your configuration. The SDK allows you to use the Validator in two ways:

  1. The validator can be displayed in a dialog using the following code

    if(Configuration.isApplicationInDebug()){
        InstallationChecker.displaySDKConfigurationCheckingInDialog(ActivityContext);
    }
  2. Alternatively, you can have it displayed in the console

    if(Configuration.isApplicationInDebug()){
        InstallationChecker.showSDKConfigurationInLog(this);
    }

Validator description

To know more about what the validator checks and how, please refer to its dedicated page.

Logging

Data sent in debug mode will not appear on dashboards

When your app runs in DEBUG mode or in a simulator, the data is automatically sent as development logs, and is therefore not processed to be shown on the main UI page. DEBUG logs can be checked using the method given in the FAQ section.

See related entry in FAQ for more information on debug & release modes.

Logging best practices

To ensure your tags are relevant and will end up empowering your team through FollowAnalytics, please read the Logging best practices entry in the FAQ section.

Events vs Attributes

The FollowAnalytics SDK allows you to tag both events and attributes. If you are unsure about the difference, please refer to the corresponding FAQ entry.

Limit bandwidth for sending logs to FollowAnalytics

If your app runs in a context where bandwidth is limited, for instance on a wearable, you can set a minimum time between the SDK network calls using FollowAnalytics.setGcmRegistrationEnabled(true or false)

Tag events

Regular, native event logging

The SDK allows you to log events happening in your code. These are the two methods you can call on the SDK:

// Log an event without details
FollowAnalytics.logEvent(String eventName);
FollowAnalytics.logError(String errorName);

// Log an event with String details
FollowAnalytics.logEvent(String eventName, String details);
FollowAnalytics.logError(String errorName, String details);

// Log an event with Map details
// This is useful to pass pairs of key-values into a single event
// Note that this Map should only contains basic types as values, including
// Integer, Long, Float, Double, String, Boolean
FollowAnalytics.logEvent(String eventName, Map<String, ?> details);
FollowAnalytics.logError(String errorName, Map<String, ?> details);

Use the name as the unique identifier of your tag, use the details section to add specific details, context. Events can be renamed later: the name that you give to your event here can be overridden in the FollowAnalytics UI.

The details field can either be a String or a Map, so that you can associated multiple key-values for additional context.

For instance, logging the appearance of a view could be done the following ways:

FollowAnalytics.logEvent("Product Page", "Product #42");
FollowAnalytics.logError("Error log", "This is an error!");

You may use a Map for details. In this case, the Map values should only contain basic java types, such as Integer, Long, Float, Double, String, and Boolean.

HashMap<String, ?> detailsMap = new HashMap<String, Object>();
detailsMap.put("product_id", 42);
detailsMap.put("product_category", "Jeans");
FollowAnalytics.logEvent("Add product to cart", detailsMap);

In debug mode, the SDK will acknowledge the saving by writing in the console whatever it receives.

If the parameters sent to these methods are over 60Kb, the method will refuse them, return NO, and write a message in the console, if it is running in debug mode.

Logging from a web view

Limitations

This feature is only activated for Android 4.2 (jelly Bean) (API Version >= 17) to prevent a security flaw in Google Android SDK, documented here by Google.

If you happen to use a web view to display elements of your app, you can also tag events and errors from within your HTML/JS code. To do so:

  1. You can use the FAWebView a subclass of native WebView.

  2. Use the following method calls in your web page code to save events. For instance, you can do:

    <a onclick="FollowAnalytics.logEvent('My event');">Send event without detail</a>
    <a onclick="FollowAnalytics.logEvent('My event', 'My event details');">Send event with detail</a>
    <a onclick="FollowAnalytics.logError('fromWebView without detail');">Send error without detail</a>
    <a onclick="FollowAnalytics.logError('fromWebView with detail','Error detail');">Send error with detail</a>
  3. User Attributes

     :::html
     <div class="button" onclick="FollowAnalytics.UserAttributes.setFirstName('Isaac');">Set first name</div><br>
     <div class="button" onclick="FollowAnalytics.UserAttributes.setLastName('Newton');">Set last name</div><br>
     <div class="button" onclick="FollowAnalytics.UserAttributes.setEmail('ali@followanalytics.com');">Set email</div><br>
     <div class="button" onclick="FollowAnalytics.getDeviceId(displayDeviceID);">Get Device ID</div><br>
  4. InApp properties

      :::html
      <div class="button" onclick="FollowAnalytics.InApp.pauseCampaignDisplay();">Pause Campaign</div><br>
      <div class="button" onclick="FollowAnalytics.InApp.resumeCampaignDisplay();">Resume Campaign</div><br>

Make sure to test if FollowAnalytics object exists with if (typeof FollowAnalytics !== 'undefined'). This way, you can reuse the exact same HTML code for your mobile web site without impact.

User ID and attributes

You don't need a user ID to set attributes

Attributes are tied to the device when no user ID is provided. If a user ID is set, a profile is created and can be shared across apps.

In both cases, attributes can be used in segments and campaigns to target users.

User ID

If users can sign in somewhere in your app, you can specify their identifier to the SDK. This way, you will be able to relate crashes to specific users, link your users between FollowAnalytics and your CRM, and more.

This identifier is usually an e-mail address, client identifier, phone number, or anything else that uniquely ties your customers to you.

To register the user identifier, use:

FollowAnalytics.setUserId(String UserId);

If you want to remove the user identifier (in case of a sign out for instance) use the following method:

FollowAnalytics.setUserId(null);

Predefined attributes

The SDK allows to set values for both custom and predefined attributes.

For predefined attributes, the SDK has the following properties:

setLastName(String lastName);
setFirstName(String firstName);
setRegion(String region);
setCountry(String country);
setCity(String city);
setCountry(String country);
setEmail(String email);
...

They are "predefined" in the sense that they will be attached to default fields on your user profiles.

For example, to set user Joe's city to "Paris", you would proceed as follows:

FollowAnalytics.UserAttributes.setCity("Paris");
FollowAnalytics.UserAttributes.setFirstName("Joe");

Custom attributes

Double check your custom attribute types

When a value for an unknown attribute is received by the server, the attribute is declared with the type of that first value.

If you change the type of an attribute in the SDK, values might be refused server-side. Please ensure the types match by visiting the profile data section of the product.

Set a custom attribute

To set your custom attributes, you can use methods that are adapted for each type: setInt, setString,setBoolean, setDate, setDateTime and setDouble.

For example, to set the user's job:

FollowAnalytics.UserAttributes.setString("key_job", "Taxi driver");
Delete a custom attribute value

You can delete the value of an attribute using its key. For example, to delete the user's job:

FollowAnalytics.UserAttributes.clear("key_job");
Set of attributes

You can add or remove an item to or from a set of attributes.

To add an item:

FollowAnalytics.UserAttributes.addToSet("fruits","apple");
FollowAnalytics.UserAttributes.addToSet("fruits","strawberry");
FollowAnalytics.UserAttributes.addToSet("fruits","lemon");

To remove an item:

FollowAnalytics.UserAttributes.removeFromSet("fruits","lemon"); // Removes "lemon" from set of fruits.

And to clear a set:

FollowAnalytics.UserAttributes.clearSet("fruits");  #Removes all the items from the set.

For further information, refer to the SDK header file.

Advanced Use Cases

Deep-linking: URL, Parameters

Campaigns created through FollowAnalytics allow to deep link to content in your app. You can either use an App Link, or use key-value parameters that are forwarded to your code.

Version 4.1.0 of the SDK introduced the possibility to use direct App Links like twitter://messages, which will send you to the corresponding screen inside the Twitter application.

You're able to access the functionality by enabling the Deep Linking switch in our UI, when creating a campaign. There you'll find the field App Link that expects you to enter these type of url schemas. It can either be an URL Schema to an external application or for your own application.

Deep-linking parameters

In FollowAnalytics campaigns, you can specify deep-linking parameters, e.g. in your push messages or for in-app button actions.

These parameters are given to the developer's code by the SDK. It is then up to the developer to implement the deep-linking in the app (specific path of screens, format of the arguments, etc.).

To obtain these parameters, you can extend the DefaultMessageHandler class or implement MessageHandler, like in the following example:

public class CustomMessageHandler implements DefaultMessageHandler {
     @Override
     public void onPushMessageClicked(Context context, Map<String, String> data) {
         String value1 = data.get("a_custom_param_key");
         String value2 = data.get("another_key");

         // Silently do stuff ...
         // .. or start an activity

         Intent intent = new Intent(context, SpecificActivity.class);
         intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
         context.startActivity(intent);
     }

       @Override
         public void onPushMessageClicked(Context context, String url, Map<String, String> data) {
            //Do something with the url
         }

     @Override
     public void onInAppMessageClicked(Context context, String buttonText, Map<String, String> data) {
         // Same as the above method, but from a in-app message!
     }
}

If you chose to define a custom MessageHandler, you must declare it in your Application manifest as meta-data:

<application>
    [...]
    <meta-data android:name="com.followanalytics.deeplinking.handler" android:value="fully_qualified_identifier_to_your_class"/>
   [...]
</application>;

Through the key value format, FollowAnalytics supports both standardized deep-linking (by defining the key you'll always use to give the path), and more direct parameter passing for simpler use cases integrations.

Regular deep-linking is usually implemented using a Router, that will handle the URL called on the app and translate it into the display of the right page, with the right content.

Control over campaigns

Custom push notifications

If you need to customize your push notifications, you have to extend this class FollowAnalytics.DefaultMessageHandler and override the method onPushMessageNotificationBuilding(...) to the class that you created.

For example:

public class FollowPushHandler extends FollowAnalytics.DefaultMessageHandler {

    @Override
    public void onPushMessageNotificationBuilding(Context context, NotificationCompat.Builder notificationBuilder,  FollowAnalytics.Message message) {
     //customize the notification
    }
}

Then, add to the manifest file the path of the class that extends FollowAnalytics.DefaultMessageHandler as a meta-data tag under the aplication tag. For example:

<meta-data android:name=“com.followanalytics.deeplinking.handler” android:value=“the_full_path_of_your_message_FollowPushHandler”/>

Now that everything is set up, customize your notification under the method onPushMessageNotificationBuilding.

An example of adding buttons to the notification is available below.

@Override
    public void onPushMessageNotificationBuilding(Context context, NotificationCompat.Builder notificationBuilder, FollowAnalytics.Message message) {
    super.onPushMessageNotificationBuilding(context, notificationBuilder, message);
    if (message.getCategory().equalsIgnoreCase("social")) {
        PendingIntent pendingIntentActions1 = null; //your pendingIntent when user click on button like
        PendingIntent pendingIntentActions2 =  null; //your pendingIntent when user click on button comment
        NotificationCompat.Action action1 = new NotificationCompat.Action.Builder(android.R.drawable.ic_menu_send, "Like", pendingIntentActions1).build();
        NotificationCompat.Action action2 = new NotificationCompat.Action.Builder(android.R.drawable.ic_menu_help, "comment", pendingIntentActions2).build();
        notificationBuilder.addAction(action1);
        notificationBuilder.addAction(action2);
    }
}

Custom handling of rich campaigns

Rich campaigns can be handled directly by the application code, instead of being showed automatically by the SDK. The behavior is defined when creating the campaign, using the "automatically display content" switch.

For campaigns where the content is not handled by FollowAnalytics, you will need to extend com.followapps.android.CustomRichCampaignBaseReceiver and declare it in your AndroidManifest.xml. You'll need to use an intent-filter on BROADCAST_RICH_CAMPAIGNS_ACTION. For instance:

<receiver android:name=".RichCampaignDataReceiver" >
    <intent-filter>
        <action android:name="%YOUR_APP_PACKAGE_NAME%.BROADCAST_RICH_CAMPAIGNS_ACTION" />
    </intent-filter>
</receiver>

Where %YOUR_APP_PACKAGE_NAME% is your application package name.

The method onRichCampaignDataReceived must be overridden. Rich campaign parameters are provided as method arguments:

Embedded View

Configuration

In your layout.xml, add the following configuration where you intend to display :

               <com.followapps.android.view.EmbeddedView
                android:layout_width="match_parent"
                android:layout_height="wrap_content"
                android:visibility="gone"
                >
                </com.followapps.android.view.EmbeddedView>

The sdk will handle them automatically.

Pausing in-app campaigns

You can prevent in-app campaigns from being displayed on certain views of your app. This can be useful when you are displaying a media content, or if the topmost screen is only shown for a few seconds, for instance.

Any campaign supposed to be displayed when the mechanism is paused is stacked and shown as soon as it is resumed.

To tell the SDK to prevent the display of rich campaigns, and then to activate it back, use the following methods:

FollowAnalytics.InApp.pauseCampaignDisplay();  # will pause campaign display
FollowAnalytics.InApp.resumeCampaignDisplay();  # will resume campaign display

Tip: use view lifecycle methods

If you want to prevent the display on a given page, you can call the pause method when an intent starts, and the resume one when it stops.

Tip: only allow display in some places of the app

You can use these methods the other way round, by pausing all campaigns when the app starts, right after the SDK is initialized, and then resuming where the messages can be shown. Just pause again when the user leaves that "safe" area of your app.

Enable message archiving

FollowAnalytics SDK allows you to store all campaigns and push notifications received by your application, making them available to your custom usage. To enable this feature, add the following line in the application manifest under the tag application

Firebase integration

If you use Firebase to manage your push notifications, you will need to follow these steps.

  1. Firebase token

To allow FollowAnalytics console to send notification to your application, you have to pass your Firebase token to FollowAnalytics SDK.

public class MyFirebaseInstanceIDService extends FirebaseInstanceIdService
    {
    @Override
    public void onTokenRefresh()
    {
        String token = FirebaseInstanceId.getInstance().getToken();
        FollowAnalytics.setPushToken(token);
    }
}

Then add MyFirebaseInstanceIDService to the application Manifest as following :

<service
  android:name=".MyFirebaseInstanceIDService">
  <intent-filter>
    <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
  </intent-filter>
</service>
  1. Show Firebase Notification

Create a class that extends FirebaseMessagingService, and check if the received message is from FollowAnalytics or not.

public class MyFirebaseMessagingService  extends FirebaseMessagingService{
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        super.onMessageReceived(remoteMessage);
        RemoteMessage.Notification notification = remoteMessage.getNotification();
        if(notification !=null){
            String data = notification.getBody();
            if(FollowAnalytics.isFollowAnalyticsPushData(data)){
                FollowAnalytics.processFollowAnalyticsPush(this,data);
                return;
            }
        }
        //proces the notification by yourself

    }
}

Then add FirebaseMessagingService to the application Manifest by :

<service
  android:name=".MyFirebaseMessagingService">
  <intent-filter>
    <action android:name="com.google.firebase.MESSAGING_EVENT"/>
  </intent-filter>
</service>

Working with multiple GCMs

If you are already using GCM in your application, you will have to check the sender of each notification, as it can now come from different providers (e.g.you and FollowAnalytics).

Let FollowAnalytics do the process for you

To handle your push message inside the FollowAnalytics SDK, you have to extend the service FollowPushService of Follow and override its method onPushMessageArrived:

import android.os.Bundle;
public class OtherExternalPushService extends FollowPushService{

  @Override
  public void onPushMessageArrived(String from, Bundle data) {
    super.onPushMessageArrived(from, data);
    //process data not from Follow SDK
  }
}

And declare the service in the manifest:

<service
        android:name=".mypackage....OtherExternalPushService"
        android:exported="false"
        >
    <intent-filter>
        <action android:name="com.google.android.c2dm.intent.RECEIVE"/>
    </intent-filter>
</service>

Forward the push message to FollowAnalytics SDK

  1. If you have implemented the BroadcastReceiver you should proceed as follows:

    public class MyCustomReceiver extends GcmReceiver {
        @Override
        public void onReceive(Context context, Intent intent) {
            super.onReceive(context, intent);
            String mypush = intent.getExtras().getString(PushManager.BUNDLE_KEY_MESSAGE)
            if(FollowAnalytics.isFollowAnalyticsPushData(mypush)){
                 FollowAnalytics.processFollowAnalyticsPush(this,mypush);
                 return;
            }else{
                //DoSomething with it
            }
        }
    }

    And declare it in manifest:

    <receiver
            android:name="mypackage_name.MyCustomReceiver"
            android:exported="true"
            android:permission="com.google.android.c2dm.permission.SEND"
            >
        <intent-filter>
            <action android:name="com.google.android.c2dm.intent.RECEIVE"/>
            <!-- for Gingerbread GSF backward compat -->
            <action android:name="com.google.android.c2dm.intent.REGISTRATION"/>
            <category android:name="mypackage_name"/>
        </intent-filter>
    </receiver>
  2. If you have implemented Google's GcmListenerService you should proceed as follows:

    public class MyGcmListenerService extends GcmListenerService {
    
        public MyGcmListenerService() {
            super();
        }
    
        @Override
        public void onMessageReceived(String from, Bundle data) {
            super.onMessageReceived(from, data);
            String mypush = data.getString(PushManager.BUNDLE_KEY_MESSAGE)
            if(FollowAnalytics.isFollowAnalyticsPushData(mypush)){
                 FollowAnalytics.processFollowAnalyticsPush(this,mypush);
                 return;
            }
        }
    }

    And then declare it in manifest:

    <service
            android:name=".mypackage....MyGcmListenerService"
            android:exported="false"
            >
        <intent-filter>
            <action android:name="com.google.android.c2dm.intent.RECEIVE"/>
        </intent-filter>
    </service>

Misc

Opt-out

The FollowAnalytics SDK allows to handle opt-out states for different features.

Flags

The SDK supplies methods to change some authorization flags:

boolean authorized = true;

// authorized to log events
FollowAnalytics.setCollectLogsAuthorization(authorized);

// authorized to log location events
FollowAnalytics.setCollectLocationLogsAuthorization(boolean authorized);

// authorized to receive push notifications
FollowAnalytics.setPushNotificationsEnabled(boolean authorized);

Note that for logging locations events, both the collect logs and collect location logs authorizations must be true. In practice, the location logs are collected if and only if FollowApps.canCollectLocationLogs() returns true.

Proguard

If you need to obfuscate and/or shrink your app before Google Play publication, be sure you protect the FollowAnalytics SDK, otherwise logs won't be sent.

Here is the ProGuard configuration:

-keep class com.followanalytics.** { *; }
-keep interface com.followapps.android.** { *; }