Prerequisites

In this section, we explain how to get started with the FollowAnalytics SDK for Android. Before you start to integrate the SDK into your app, you need to do the following on the FollowAnalytics platform:

• Register your app and generate its API key by following the instructions here.
• Set the FCM server key in your app.

Set the FCM server key in your app

Get started with Firebase

Sending push notifications for Android requires Firebase Cloud Messaging, Google's standard messaging service. If you don't already use Firebase, you will need to do the following:

• Add Firebase to your project
• Create Firebase project to Firebase console

Before you start adding Firebase to your project, we recommend you take the time to familiarize yourself with firebase and its console. You will find this information (and much more) by referring to the Google documentation.

Add the FCM key

You will find the Firebase Cloud Messaging Key (FCM key) in the console of your app. To find the key in the console:

1. Select your project

2. In the project page, on the app, it is located under the title of with your project name

   

3. Click the Gear icons, this will open the "Settings" page

4. From the "Settings" page, click the second tab, it is called "Cloud Messaging"

5. Copy the token for the key you wish to use. The FCM key can be either the "server key", or the "legacy server key". As it is mentioned in the bubble, it is recommended that you use the "server key".

   

6. Paste the key in your app settings on the FollowAnalytics platform (Administration > Apps > YourApp) in the field entitled "Firebase Cloud Messaging (FCM) key"

   

7. Save the changes

Now that you have added the FCM key, you will be able to send push notifications on Android.

Integration

Here are the minimal steps for integrating the SDK in your application:

• Installing the SDK in your app
• Initializing the SDK using your API key
• Registering for notifications

Once the integration is finished, you can validate your setup, and start tagging events and saving attributes in your application.

Install using Gradle

The best way to install the SDK is with Gradle:

1. Fetch the library from the private nexus repository

2. Add the FollowAnalytics repository to your build.gradle repositories.

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

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

   dependencies {
     ...
     implementation "com.followapps.android:sdk:6.4.+"
     ...
   }
   

Once installation is over you will notice that dependencies and permissions are automatically added. For more information on dependencies and permissions, refer to the two subsections .

Dependencies

Using Gradle, dependencies will automatically be added while merging the manifest. The FollowAnalytics SDK depends on the following libraries:

implementation 'com.android.support:support-v4:26.1.0'
implementation 'com.android.support:cardview-v7:26.1.0'
implementation 'com.android.support:appcompat-v7:26.1.0'
implementation 'com.google.android.gms:play-services-location:16.0.0'
implementation 'com.google.firebase:firebase-messaging:17.4.0'
implementation 'me.leolin:ShortcutBadger:1.1.19@aar'

Conflicts in dependencies

If your project doesn't use AndroidX and you implemented some com.android.support:* libraries in your app module dependencies, it's possible that they conflict with FollowAnalytics SDK dependencies.

For solving those conflicts, consider to add each conflicting library in your app module's build.gradle and to set the proper version for each of them.

Here is an example of possible fixes when you have com.android.support:appcompat-v7:28.0.0 in your dependencies, and compileSdkVersion set to 28:

implementation 'com.android.support:cardview-v7:28.0.0' // Do not forget to set the correct library version
implementation 'com.android.support:support-v4:28.0.0'
implementation 'com.android.support:animated-vector-drawable:28.0.0'
implementation 'com.android.support:support-media-compat:28.0.0'

Permissions

Automatically added permissions

Using Gradle, the SDK automatically adds the following normal permissions to your app 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" />

Additional permissions

• To use InApp template campaigns on devices running Android API level < 19, add the following permissions to your app manifest:

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

• To use the geofencing feature, add the following permissions to your app manifest:

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

Initialize with your API key

To initialize the FollowAnalytics SDK, call FollowAnalytics.init(Context context, Configuration configuration) inside the onCreate() method of the Application class.

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(){
    [...]
    FollowAnalytics.init(this.getApplicationContext(), new FollowAnalytics.Configuration() {
      {
            this.apiKey = "MY_API_KEY";
      }
    });
    [...]
  }
}

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

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

Register for notifications

The FollowAnalytics SDK supports push notifications based on Firebase Cloud Messaging. If you haven't done so already, you will need to add your project to Firebase in order to continue in the following steps. In this section we will explain to you how to use Firebase Cloud Messaging (or FCM) with the FollowAnalytics SDK. This means that we will cover:

• Installing FCM in your project
• Integrating FCM with the FollowAnalytics SDK

Install Firebase Cloud Messaging

1. Add the library FCM to your build.gradle file in your application module.

   implementation "com.google.firebase:firebase-messaging:17.4.0"
   

2. Create a class that extends to FirebaseMessagingService and override the two methods onMessageReceived and onNewToken.

   import com.google.firebase.messaging.FirebaseMessagingService;
   import com.google.firebase.messaging.RemoteMessage;
   
   public class MyFirebaseMessagingService extends FirebaseMessagingService {
   
     /**
     * Every push notification will arrive through this method
     */
     @Override
     public void onMessageReceived(RemoteMessage remoteMessage) { }
   
   
     /**
     * Every new token will arrive through this method
     */
     @Override
     public void onNewToken(String s){ }
   }
   

3. Add the following service tag in your AndroidManifest application file. Be sure that the value in android:name is the relative path to your new service previously created.

   <service
       android:name=".MyFirebaseMessagingService"> <!-- Relative path of service class-->
       <intent-filter>
           <action android:name="com.google.firebase.MESSAGING_EVENT"/>
       </intent-filter>
   </service>
   

Interacting Firebase Cloud Messaging with FollowAnalytics SDK

Now that you have installed FCM, you need it to interact with the FollowAnalytics SDK. For this, access the your Firebase Cloud Messaging Service class (a class we previously called MyFirebaseMessagingService that was created and extended to FirebaseMessagingService).

Set push token

• FollowAnalytics.setPushToken(String token) is a function that passes a FCM token to FollowAnalytics SDK. Add it to the function onNewToken.

For example:

@Override
public void onNewToken(String s){
    android.util.Log.d(TAG, "Token is : "+s);
    FollowAnalytics.setPushToken(s); // <-- Insert this method
}

Process Firebase Message

• FollowAnalytics.processFirebaseMessage(Context context, RemoteMessage remoteMessage) is a function that passes the push message notification to FollowAnalytics SDK.

This function must be added to onMessageReceived in cases to transmit the push notification to FollowAnalytics SDK.

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    FollowAnalytics.processFirebaseMessage(this, remoteMessage); // <-- Insert this method
}

Migrating from GCM to FCM

1. Remove any reference to GCM in your build.gradle file.

   dependencies {
     compile "com.google.android.gms:play-services-gcm:<VERSION>"
   }
   

2. Edit your app's manifest file by removing some required permissions and receiver functionality from GCM.

   <uses-permission android:name="android.permission.WAKE_LOCK" />
   <permission android:name="<PACKAGE_NAME>.permission.C2D_MESSAGE"
               android:protectionLevel="signature" />
   <uses-permission android:name="<PACKAGE_NAME>.permission.C2D_MESSAGE" />
   
   ...
   
   <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" />
           <category android:name="<PACKAGE_NAME>" />
       </intent-filter>
   </receiver>
   ...
   <service
       android:name=".MyInstanceIDListenerService"
       android:exported="false">
       <intent-filter>
           <action android:name="com.google.android.gms.iid.InstanceID" />
       </intent-filter>
   </service>
   ...
   <service
       android:name=".MyGcmListenerService"
       android:exported="false">
       <intent-filter>
           <action android:name="com.google.android.c2dm.intent.RECEIVE" />
       </intent-filter>
   </service>
   

3. Migrate the code available in InstanceIDListenerService class to FirebaseMessagingService class.

   //BEFORE
   public class MyInstanceIDListenerService extends InstanceIDListenerService {
   
     ...
   
     @Override
     public void onTokenRefresh() {
         //Code available here
     }
   }
   
   //------------------------------------------------------------------------
   
   //AFTER
   public class MyFirebaseMessagingService extends FirebaseMessagingService {
       ...
   
       @Override
       public void onNewToken(String s){
           //Migrate the code here and do not forget to refactor your code
           FollowAnalytics.setPushToken(s);
       }
   }
   

   Do not forget to refactor your code, due to Google API changes

4. Migrate the code available in GcmListenerService class to FirebaseMessagingService class. Also do not forget to refactor your code, due to Google API changes.

   //BEFORE
   public class MyGcmListenerService extends GcmListenerService {
   
     ...
   
     @Override
     public void onMessageReceived(String from, Bundle data){
         .....
         //Code available here
     }
   }
   
   //------------------------------------------------------------------------
   
   //AFTER
   public class MyFirebaseMessagingService extends FirebaseMessagingService {
       ...
   
       @Override
       public void onMessageReceived(RemoteMessage remoteMessage) {
           //Migrate the code here and do not forget to refactor your code
           FollowAnalytics.processFirebaseMessage(this, remoteMessage);
       }
   }
   

   Do not forget to refactor your code, due to Google API changes

5. Finally, delete InstanceIDListenerService and GcmListenerService class from your project.

Validate your setup

Checking your SDK integration is valid can be done in two ways :

• At runtime, look into your console logs, some FollowAnalytics SDK logs will appear just after the app launch.

  For instance :

  --------Checking FollowAnalytics SDK setup--------
  Configuration
  OptInAnalyticsDefault : false
  Archive Push Messages : true
  Archive InApp Messages : true
  IsDataWalletEnabled : true
  Default Policy File Path : null
  ✅ ApiKey : HF7naIcl4f
  Environment Protocol : https
  Environment Domain : follow-apps.com
  ApiMode : PROD
  IsVerbose : true
  MaxBackgroundTimeWithinSession : 120
  Manifest
  ✅ Coarse location permission
  ✅ Fine location permission
  ✅ SDK services are all declared
  ✅ SDK receivers are all declared
  ✅ SDK activities are all declared
  

• Call the following method to display the validator in a dialog :

  FollowAnalytics.displaySDKValidatorDialog(Activity activity);
  

Analytics

To enrich User Analytics on the platform, FollowAnalytics SDK allows you to:

• Log your users events, errors and locations.
• Set attributes for your users.

Logs and attributes can also be used to target specific audiences when creating campaigns on the platform. You can find more information about the difference between logs and attributes here.

Our CSM team can help you creating relevant logs in your app. You can also find our recommendations here.

Logging Events and Errors

You can log Events and Errors in your app by calling the following methods:

static boolean logEvent(String name);
static boolean logError(String name);

static boolean logEvent(String name, String details);
static boolean logError(String name, String details);

static boolean logEvent(String name, Map<String, String> details);
static boolean logError(String name, Map<String, String> details);

Those methods return true if the log is valid, otherwise false is returned and an error description is printed to the console. If details exceeds 60KB it will be considered as invalid. A valid log will be sent to the platform only if opt-in analytics is true.

Use name as a unique identifier for your log. Use details to pass specific context to your log.

The following code shows an example of how you can log the viewing and the purchasing of a product:

FollowAnalytics.logEvent("Product view", "RF1672") // Product viewing

HashMap<String, String> details = new HashMap<String, String>();
details.put("reference", "RF1672");
details.put("payment_mode", "credit_card");
details.put("color", "red");
FollowAnalytics.logEvent("Product purchased", details); // Product purchasing

Logging Locations

There are two ways for logging locations:

static boolean logLocation(double latitude, double longitude);
static boolean logLocation(Location location);

Those methods return true if the log is valid, otherwise false is returned and an error description is printed to the console:

• if the location distance from the last logged location is less than 100 meters, the log will be ignored and logLocation returns false.
• if the location time interval from the last logged location is less that 1 hour, the log will be ignored and logLocation returns false.

A valid log will be sent to the platform only if opt-in analytics is true.

One way to use the logLocation method, is to implement a LocationCallback in your application, request location updates and log the last location update. FollowAnalytics SDK will take care of ignoring a location log if this location is too close from the last one:

LocationRequest locationRequest = LocationRequest.create()
        .setFastestInterval(5*1000)
        .setInterval(10*1000)
        .setMaxWaitTime(30*1000)
        .setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY);

FusedLocationProviderClient client = LocationServices.getFusedLocationProviderClient(your_context);
LocationCallback locationCallback = new LocationCallback() {
  @Override
  public void onLocationResult(LocationResult locationResult) {
    Location location = locationResult.getLastLocation();
    if (location != null) {
        FollowAnalytics.logLocation(location);
    }
  }
};
client.requestLocationUpdates(locationRequest, locationCallback, null);

User Attributes

A user can be defined by setting its identifier. This identifier is a string that you provide to the SDK to uniquely identify a user of your app. It can be an e-mail address, an identifier from your own backend (for instance a primary key), a phone number, or anything else that could allow you to uniquely identify a user.

Attributes (like first name, date of birth...) can be associated to a user if it's defined. Attributes are associated to the device when no user is defined.

When a user is defined, a user profile is created server-side and can be shared across apps.

You can set predefined as well as custom attributes.

Define a user

To define a user, set its user ID:

FollowAnalytics.setUserId("UniqueIdentifier");

To remove a user (for example in case of a sign out), just pass null to setUserId:

FollowAnalytics.setUserId(null);

Predefined attributes

To set predefined attributes, you can call the following methods on the UserAttributes class provided by the SDK:

static boolean setFirstName(String firstName);
static boolean setLastName(String lastName);
static boolean setEmail(String email);
static boolean setDateOfBirth(Date birthDate);
static boolean setGender(Gender gender);
static boolean setCountry(String country);
static boolean setCity(String city);
static boolean setRegion(String region);
static boolean setProfilePictureUrl(String profilePictureUrl);

Those methods return:

• true, when the attribute has been successfully saved and will be sent to the platform.
• false, if the passed argument is invalid or if opt-in analytics is false. In this case the attribute is not sent to the platform.

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

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

Custom attributes

In addition to predefined attributes, you can set your own custom attributes.

Set a custom attribute

To set custom attributes, you can call the following methods on the UserAttributes class provided by the SDK:

static boolean setNumber(String key, Integer value);
static boolean setNumber(String key, Long value);
static boolean setNumber(String key, Double value);
static boolean setNumber(String key, Float value);
static boolean setNumber(String key, BigDecimal value);
static boolean setString(String key, String value);
static boolean setBoolean(String key, Boolean value);
static boolean setDate(String key, Date value);
static boolean setDateTime(String key, Date value);

Those methods return:

• true, when the attribute has been successfully saved and will be sent to the platform.
• false, if the key or value is invalid or if opt-in analytics is false. In this case the attribute is not sent to the platform.

For instance, to set the user's job:

FollowAnalytics.UserAttributes.setString("job", "Taxi driver");

Delete a custom attribute value

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

FollowAnalytics.UserAttributes.clear("job");

Set of attributes

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

To add an item to a set:

FollowAnalytics.UserAttributes.addToSet("fruits", "apple"); // Adds "apple" to set "fruits"
FollowAnalytics.UserAttributes.addToSet("fruits", "strawberry"); // Adds "strawberry" to set "fruits"
FollowAnalytics.UserAttributes.addToSet("fruits", "lemon"); // Adds "lemon" to set "fruits"

// This is the equivalent, by using the variable number of arguments mechanism
FollowAnalytics.UserAttributes.addToSet("fruits", "apple", "strawberry", "lemon");

To remove an item from a set:

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

// This is the equivalent, by using the variable number of arguments mechanism
FollowAnalytics.UserAttributes.removeFromSet("fruits", "lemon", "strawberry");

To clear a set:

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

Opt-in Analytics

FollowAnalytics SDK opt-in analytics state define whether to send logs and attributes to the platform. Opt-in analytics is true by default, meaning logs and attributes will be sent to FollowAnalytics platform.

You can set it to opt-in analytics to false at SDK initialization by setting the optInAnalyticsDefault parameter to false in the FollowAnalytics.Configuration object passed to the initialization method. This is only used to set the default opt-in value at initialization. Moreover you can change the opt-in value at runtime.

To change opt-in analytics state at runtime, use the setOptInAnalytics method:

static void setOptInAnalytics(boolean state);

This value is persisted in memory and the opt-in analytics state is changed for all subsequent launch of your application, meaning optInAnalyticsDefault is ignored.

To retrieve the current opt-in analytics state, use the getOptInAnalytics method:

static boolean getOptInAnalytics();

GDPR

To request the data collected with FollowAnalytics SDK, call the following method on the GDPR class provided by the SDK:

static void requestToAccessMyData()

To delete the data that has been collected with FollowAnalytics SDK, call the following method on the GDPR class provided by the SDK:

 static void requestToDeleteMyData()

Campaigns

In this section, we cover all you need for your app to receive the campaigns sent from the FollowAnalytics platform, and how you can add the features the fully take advantage of the SDK's capabilities.

Before you start, be sure that the SDK is properly initialized. This includes registration for push notifications, which is covered in the "Integration" section above.

Customize 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 application 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);
  }
}

Handling notifications

FollowAnalyticsSDK provides you a way to handle notification events thanks to callbacks.

Notification reception

You can handle the reception of a notification by implementing the onNotificationReceived callback in FollowAnalytics.Configuration. This allows you to access notification information like deep-link url or key/value pairs and perform specific actions accordingly.

new FollowAnalytics.Configuration() {
        ...
        @Override
        public void onNotificationReceived(Message message) {
          // YOUR BEHAVIOR
        }
        ...
}

The onNotificationReceived callback handles:

• Push notifications
• Contextual notifications
• Silent push notifications

Deep-linking: URL, Parameters

Push notification campaigns created through FollowAnalytics allow to deep link to content in an app (not limited to your own). You can use either an App Link, or use a customized key-value parameters that are forwarded to your code.

App Links

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

You're able to access the functionality by enabling the Deep Linking on the platform, 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 app or for your own application.

Customizing deep-linking parameters

In FollowAnalytics campaigns through the platform, 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 code by the SDK. It is then up to the developer to implement the deep-links in the app (specific path of screens, format of the arguments, etc.).

To obtain these parameters, extend the FollowAnalytics.DefaultMessageHandler class, like in this example:

public class CustomMessageHandler extends FollowAnalytics.DefaultMessageHandler {

     /**
     * This method is executed with no App Links. Only key-values were set.
     **/
     @Override
     public void onPushMessageClicked(Context context, Map<String, String> data) {
         String value1 = data.get("a_custom_param_key");
         if(value1 !=null && data.get(value1).equals("a_custom_param_value_expected")){
             //Execute the code for the customized deep-link with a key : "a_custom_param_key" and a value : "a_custom_param_value_expected"
             Intent intent = new Intent(context, SpecificActivity.class);
             intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
             context.startActivity(intent);
         }else{
            //Let the SDK handle the notification
            super.onPushMessageClicked(context, data);
         }

     }

    /**
     * This method is executed when an App Link was, at least, set (through the clients portal)
     **/
     @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 app 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-link 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.

Custom Handling of Rich Campaigns

Rich campaigns can be handled directly by the app code, instead of being shown 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 example:

<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 app package name.

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

• Campaign title: title
• Campaign URL: url
• Custom Parameters associated to the campaign: customParams

Pausing and resuming in-app campaigns

To pause and resume campaigns, add the following methods in you code at the location you wish the pause and resume to take effect:

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

Enable campaign archiving

FollowAnalytics SDK allows you to store all campaigns and push notifications received by your application. This makes them available for custom usage, like building an inbox. To enable this feature, add the following line in the app manifest under the tag application.

• You can choose to enable the message archiving as following:

  <meta-data android:name="com.followanalytics.message.push.enable" android:value="true" />
  <meta-data android:name="com.followanalytics.message.inapp.enable" android:value="true" />
  

• To get all in-app or push messages:

  FollowAnalytics.InApp.getAll()       //for in-app messages
  FollowAnalytics.Push.getAll()        //for push notifications
  

• To get an in-app or a push message by identifier:

  FollowAnalytics.InApp.get(message.id)     //for an in-app message
  FollowAnalytics.Push.get(message.id)    //for a push notification
  

• To delete an in-app or a push message:

  FollowAnalytics.InApp.delete(message.id)    //for an in-app message
  FollowAnalytics.Push.delete(message.id)   //for a push notification
  

• To mark as read an in-app or a push message:

  FollowAnalytics.InApp.markAsRead(message.id)    //for an in-app message
  FollowAnalytics.Push.markAsRead(message.id)   //for a push notification
  

• To mark as unread an in-app or a push message:

  FollowAnalytics.InApp.markAsUnread(message.id)    //for an in-app message
  FollowAnalytics.Push.markAsUnread(message.id)    //for a push notification
  

Data Wallet

Local Policy

FollowAnalytics SDK offers you the possibility to add a default policy file.

When no other policy is yet available, the SDK returns a default empty policy having version 0.0.

Follow these steps below in order to add the policy file in your project:

1. Create an assets folder in your app project.

2. Add the policy file in the assets folder (policy file downloaded from the platform).

3. Initialize dataWalletDefaultPolicyPath in the configuration, with the path of the policy file. The path must be a relative path from the assets folder.

For instance :

[...]
FollowAnalytics.init(this.getApplicationContext(), new FollowAnalytics.Configuration() {
  {
    this.dataWalletDefaultPolicyPath = "FollowAnalytics/Policy.config"; // <- Path of the default policy file
  }
});
[...]

Callback Policy

FollowAnalytics SDK has a callback method that is triggered whenever a significant policy version is retrieved (for instance, going from version 1.8 to 2.4). The method is triggered when the leftmost digit of the version is increased.

Override onDataWalletPolicyChanged() in Configuration to interact with the newest and significant updated policy in your application.

[...]
FollowAnalytics.init(this.getApplicationContext(), new FollowAnalytics.Configuration() {
  @Override
  public void onDataWalletPolicyChanged(){
      //insert code to interact with your application
  }
});
[...]

Policy methods

Get Policy

To access the latest available policy, call the method getPolicy :

FollowAnalytics.DataWallet.getPolicy();

This method returns an object called Policy. Policy allows you to acquire and process the information related to the policy set in the Data Wallet (version, legal texts, data categories, etc).

Policy status

To check the read status of the policy, use the following method :

FollowAnalytics.DataWallet.isRead();

This method returns a boolean value.

To change the read status of the policy, use the method setIsRead(boolean read) with a boolean value as parameter.

FollowAnalytics.Datawallet.setIsRead(boolean read);

The policy is read when the boolean parameter is true and is not read when it is false.

Web Views

If your app contains web views, you can use FollowAnalytics SDK from within your JavaScript code. This is possible using our FAWebView to display your web pages, instead of the regular Android WebView.

Using FAWebView

1. Declare the FAWebView element into your <layout>.xml. For instance:

   <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
       android:orientation="vertical"
       android:padding="20dp"
       android:layout_width="match_parent"
       android:layout_height="match_parent" >
   
       <com.followapps.android.FAWebView
           android:layout_width="match_parent"
           android:id="@+id/fa_webview"
           android:layout_height="match_parent"/>
   
   </LinearLayout>
   

2. In the corresponding activity which uses the <layout>.xml layout, retrieve the FAWebView instance:

   FAWebView faWebView = (FAWebView) view.findViewById(R.id.fa_webview);
   

3. Load your HTML page in the FAWebView by using the loadUrl method:

   faWebView.loadUrl("file:///android_asset/webView.html");
   

4. If your app's minSdkVersion is lower that 19, make sure to add the following script to your HTML page in order to have the FollowAnalytics JS interface properly initialised on devices running Android API level < 19:

   <script>window.addEventListener('DOMContentLoaded',function(e){if(typeof(FollowAnalytics)!=='undefined'){if(typeof(InApp)!=='undefined'){FollowAnalytics.InApp=InApp;}if(typeof(Push)!=='undefined'){FollowAnalytics.Push=Push;}if(typeof(UserAttributes)!=='undefined'){FollowAnalytics.UserAttributes=UserAttributes;}FollowAnalytics.Gender={REMOVE:0,MALE:1,FEMALE:2,OTHER:3};FollowAnalytics.UserAttributes.setDateOfBirth=function(value){if(Object.prototype.toString.call(value)==='[object Date]'){FollowAnalytics.UserAttributes.__setDateOfBirth(value.getTime());}else{FollowAnalytics.UserAttributes.clear('date_of_birth');}};FollowAnalytics.UserAttributes.setDateTime=function(key,value){if(Object.prototype.toString.call(value)==='[object Date]'){FollowAnalytics.UserAttributes.__setDateTime(key,value.getTime());}else{FollowAnalytics.UserAttributes.clear(key);}};FollowAnalytics.UserAttributes.setDate=function(key,value){if(Object.prototype.toString.call(value)==='[object Date]'){FollowAnalytics.UserAttributes.__setDate(key,value.getTime());}else{FollowAnalytics.UserAttributes.clear(key);}};}});</script>
   

FollowAnalytics SDK JS interface

Here are the SDK methods you can call from the JavaScript code:

• Environment information:

  FollowAnalytics.getUserId();
  FollowAnalytics.setUserId("aUserId");
  FollowAnalytics.getSDKPlatform();
  FollowAnalytics.getSDKVersion();
  FollowAnalytics.getDeviceId();
  

• Logging events/errors/locations:

  FollowAnalytics.logEvent("anEventName");
  FollowAnalytics.logEvent("anEventName", "anEventDetail");
  FollowAnalytics.logError("anErrorName");
  FollowAnalytics.logError("anErrorName", "anErrorDetail");
  FollowAnalytics.logLocation(48.8410646, 2.3210844);
  

• User attributes:

  FollowAnalytics.UserAttributes.setFirstName("aFirstName");
  FollowAnalytics.UserAttributes.setLastName("aLastName");
  FollowAnalytics.UserAttributes.setEmail("something@domain.com");
  FollowAnalytics.UserAttributes.setDateOfBirth(new Date("1998-08-01"));
  FollowAnalytics.UserAttributes.setGender(FollowAnalytics.Gender.MALE); // Can be MALE, FEMALE or OTHER
  FollowAnalytics.UserAttributes.setCountry("France");
  FollowAnalytics.UserAttributes.setCity("Paris");
  FollowAnalytics.UserAttributes.setRegion("Île-de-France");
  FollowAnalytics.UserAttributes.setProfilePictureUrl("https://picture_url");
  FollowAnalytics.UserAttributes.setNumber("aKey", 10.5);
  FollowAnalytics.UserAttributes.setDateTime("aKey", Date.now());
  FollowAnalytics.UserAttributes.setDate("aKey", Date.now());
  FollowAnalytics.UserAttributes.setString("aKey", "aString");
  FollowAnalytics.UserAttributes.setBoolean("aKey", true);
  FollowAnalytics.UserAttributes.addToSet("aSetKey", "aSetElement");
  FollowAnalytics.UserAttributes.removeFromSet("aSetKey", "aSetElement");
  FollowAnalytics.UserAttributes.clear("aKey");
  FollowAnalytics.UserAttributes.clearSet("aSetKey");
  

• InApp campaigns archiving:

  FollowAnalytics.InApp.markAsRead("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.InApp.markAsUnread("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.InApp.delete("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.InApp.get("aCampaignId"); // Returns an campaign Message json object as a String
  FollowAnalytics.InApp.getAll(); // Returns an array of campaign Message json object as a String
  

• Push campaigns archiving:

  FollowAnalytics.Push.markAsRead("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.Push.markAsUnread("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.Push.delete("campaignId1", "campaignId2"/*,..., "campaignIdN"*/);
  FollowAnalytics.Push.get("aCampaignId"); // Returns an campaign Message json object as a String
  FollowAnalytics.Push.getAll(); // Returns an array of campaign Message json object as a String
  

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

Watch face

Follow Analytics SDK can be used with a watch face.

The watch face architecture has a different approach relatively to Android architecture with their lifecycle that needs to be settle down.

Two different types of background and foreground states exist in CanvasWatchFaceService.Engine.class:

• onVisibilityChanged()
• onAmbientModeChanged()

The method onVisibilityChanged() will be executed whenever the watch face becomes visible or hidden in the smartwatch.

However, the method onAmbientModeChanged() will be executed whenever the device enters or exits ambient mode (this mode will switch to a black (hidden seconds) and white display (displayed seconds)).

Now in order to use watch face with FollowAnalytics SDK, two methods are available :

FollowAnalytics.WatchFace.enterForeground();
FollowAnalytics.WatchFace.enterBackground();

The function FollowAnalytics.WatchFace.enterForeground() triggers the information of entering in foreground.

The function FollowAnalytics.WatchFace.enterBackground() triggers the information of entering in background.

Those methods must be added in two different places :

@Override
 public void onAmbientModeChanged(boolean inAmbientMode) {
     super.onAmbientModeChanged(inAmbientMode);

     ...

     if (inAmbientMode) {
         FollowAnalytics.WatchFace.enterBackground();
     } else {
         FollowAnalytics.WatchFace.enterForeground();
     }
     ...
 }

@Override
public void onVisibilityChanged(boolean visible) {
    super.onVisibilityChanged(visible);

    if (visible) {
        ...
        FollowAnalytics.WatchFace.enterForeground();
    } else {
        FollowAnalytics.WatchFace.enterBackground();
        ...
    }
    ...
}

Configuration

In order to customize the behavior of FollowAnalytics SDK, it is possible to change the default configuration by creating your own configuration in the project.

It can be achieved by creating an anonymous FollowAnalytics.Configuration, see all parameters here.

public class MyAwesomeApplication extends Application {
  public static boolean isPolicyCalled = false;

  @Override
  public void onCreate(){
    [...]
    FollowAnalytics.init(this.getApplicationContext(), new FollowAnalytics.Configuration() {
            {
              this.apiKey = "API_KEY";
              this.archiveInAppMessages = true;
            }

            @Override
            public void onDataWalletPolicyChanged() {
                isPolicyCalled = true;
            }

        });
    [...]
  }
}

Or it can be achieved by creating a class that extends FollowAnalytics.Configuration, see all parameters here.

import com.followanalytics.FollowAnalytics;

public class MyConfiguration extends FollowAnalytics.Configuration {
    public static boolean isPolicyCalled = false;

    public MyConfiguration(){
      this.apiKey = "API_KEY";
      this.archiveInAppMessages = true;
    }

    @Override
    public void onDataWalletPolicyChanged(){
        isPolicyCalled = true;
    }
}

And then, you can initialize FollowAnalytics SDK with instantiating and passing the configuration object. For Instance:

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

Parameters

A description table with the properties that can be modified with FollowAnalytics.Configuration.

Advanced Use Cases

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.** { *; }

-keep class com.{path_to_your_custom_class}

Updating from older versions

Updating from 6.3 to 6.4

Prior to version 6.4.0, for apps that had the fine location permission, the SDK was requesting periodic location updates internally and was sending locations logs to the FollowAnalytics platform. Since version 6.4.0, it's the responsibility of the developer to send location logs to the platform by using the new logLocation() methods, as explained in the Tagging Locations section.