Checksum

To verify the checksum of dependencies in Gradle 6.2 or higher, follow the instructions at this link: Dependency Verification

Checksum

To verify the checksum of dependencies in Gradle 7.0 or higher, follow the instructions at this link: Dependency Verification

Checksum

To verify the checksum of dependencies in Gradle 7.0 or higher, follow the instructions at this link: Dependency Verification

Checksum

To verify the checksum of dependencies in Gradle 7.0 or higher, follow the instructions at this link: Dependency Verification

Project Configuration

You need to use the following dependencies in your project:

• play-services-location
• play-services-ads-identifier

To do this, in the dependencies section, add the following information to your project's Gradle file:

dependencies {
    // Other project dependencies.
    //...

    // Required Dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior:7.0.0'
    api 'com.google.android.gms:play-services-location:21.0.1'
}
        

dependencies {
    // Other project dependencies.
    //...

    // Required Dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior:6.0.8'
    api 'com.google.android.gms:play-services-location:21.0.1'
}
        

dependencies {
    // Other project dependencies.
    //...

    // Required Dependencies:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior:6.0.0'
    api 'com.google.android.gms:play-services-location:21.0.1'
}       

Project Configuration

You need to use the following dependencies in your project:

• play-services-location
• play-services-ads
• gson

To do this, in the dependencies section, add the following information to your project's Gradle file:

dependencies {
    // Other project dependencies.
    //...

    // Required Dependencies:
    implementation 'com.google.android.gms:play-services-ads:18.3.0'
    api 'com.google.code.gson:gson:2.8.6'
    implementation 'sale.clear.behavior:sdk-behavior:3.0.2'

    // Optional Dependencies:
    api 'com.google.android.gms:play-services-location:17.0.0'
}           

Learn more:

Learn more:

• The dependency 'com.google.android.gms:play-services-ads-identifier:18.0.1' is used to obtain the device's advertising identifier information.
• The dependency 'com.google.android.gms:play-services-location:21.0.1' should be used whenever it is necessary to collect geolocation information from the device.

Proguard

Include this rule if you are using Proguard:

-keep class sale.clear.behavior.** { *; }

App Permissions

To use the SDK, it is necessary to request some permissions in the manifest file. They are:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Attention: For applications targeting version 26 or higher of Android, and that wish to capture geolocation information, it is necessary, in addition to adding the permissions ACCESS_FINE_LOCATION and ACCESS_COARSE_LOCATION in the manifest, to also request user permission to collect geolocation data. To do this, follow this Android recommendation.

For applications targeting version 33 (Android 13) or higher, it will be necessary to include the AD_ID permission to capture information related to the advertisingID.

Play Store Privacy

If the user has consented to the collection of geolocation and the list of applications, the methods allowGeoLocation() allowAppList() should be called before the start() method, as shown in the example below:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.allowGeoLocation(); // Enables geolocation capture
        mBehavior.allowAppList(); //Enables the capture of information from applications installed on the device
        mBehavior.start(); //Initialization of information capture.
        
        String sessionId = mBehavior.generateSessionID();

        //Only on screens where you want to send the collected data to ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferably after some user interaction time.
    }
    catch (CaptureWasStartedException e) {
        //This error occurs when the start() method was called more than once without using the stop() method.
        //Each capture (which starts with the start method) needs to be ended (with the stop method call)
    }
}
            

Behavior Class

Behavior is the class responsible for collecting information.

• Static Method

• Other Methods

Security Module

The Android SDK security module consists of features aimed at protecting our products and services against attacks.

Usage

This module is available from SDK version 7.0.0. To enable it, you need to call the new method allowSecurity() before collection.

@Override
public void onResume() {
    super.onResume();
        try {
            mBehavior.allowGeoLocation(); // Enables geolocation capture
            mBehavior.allowAppList(); // Enables capture of information about installed apps on the device
            mBehavior.allowSecurity(); // Enables the security module
            mBehavior.start(); // Initializes information capture.

            String sessionId = mBehavior.generateSessionID();

            // Only on screens where you want to send the collected data to ClearSale
            mBehavior.collectDeviceInformation(sessionId); // Preferably after some user interaction.
        } catch (CaptureWasStartedException e) {
            // This error occurs when the start() method was called more than once without using the stop() method.
            // Each capture (which starts with the start method) needs to be ended (with the stop method call)
        }
}

Update Flow

The security module has a lifecycle that allows the application to be more secure. By using this module, there will be a requirement to always be on the latest version available, with release dates in April and October of each year.

These versions are valid for 6 months. For proper functioning, it is necessary to update before the previous version expires.

Examples

There are two ways to initialize the SDK. This depends on the type of screen that will be used. If the screen is an Activity, initialization should be done in the onCreate() method. If it is a Fragment, initialization should be done in the onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) method.

Note: In both cases (Activity or Fragment), if the stop() method is not called within the onStop() method of one of the screens, since it is a singleton, the next screen when start() is called will throw the exception CaptureWasStartedException.

In all examples, the following variables are assumed to exist:

• mBehavior which represents the instance of the Behavior class. It can be replaced by Behavior.getInstance(context, CLEAR_SALE_APP).
• CLEAR_SALE_APP a string variable, the value of this variable must be provided by ClearSale.

To initialize the call when the screen is a Fragment.

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
    // To get the Context in a Fragment.
    View rootView = inflater.inflate(R.layout.fragment_login, container, false);
    Context context = rootView.getContext();
    //CLEAR_SALE_APP is a unique identification value that must be provided by ClearSale.
    mBehavior = Behavior.getInstance(context, CLEAR_SALE_APP);
    return rootView;
}

When the screen is an Activity

@Override
public void onCreate() {
    //CLEAR_SALE_APP is a unique identification value that must be provided by ClearSale.
    mBehavior = Behavior.getInstance(this, CLEAR_SALE_APP);
}

To start the capture:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.start(); //Initialization of information capture.
        String sessionId = mBehavior.generateSessionID();
        //Only on screens where you want to send the collected data to ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferably after some user interaction time.
    } catch (CaptureWasStartedException e) {
        //This indicates that the mBehavior.start() method has already been called previously and
        //the collection was not properly finalized using the mBehavior.stop() method.
    } catch (SessionIDAlreadyUsedException e) {
        //The same sessionId was used previously. The SessionID must be unique per collection.
    }
}

The methods start() and stop() should be implemented only on the screen where the information capture will be performed. The collectDeviceInformation(SESSION_ID) method should be called when you want to send the collected information to ClearSale, on the same screen where the previous methods were implemented.

Note: The collectDeviceInformation method must be called after the start() method has been executed.

We recommend that these methods be implemented on a "finalization" screen where there is user interaction for at least 3 seconds.

To end the capture:

@Override
public void onStop() {
    super.onStop();
    mBehavior.stop(); //Finalization of information capture.
}                         

Complete implementation example:

public class ExampleImplementationActivity extends AppCompatActivity {

    private Behavior mBehavior;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //CLEAR_SALE_APP is a unique identification value that must be provided by ClearSale.
        mBehavior = Behavior.getInstance(this, "CLEAR_SALE_APP");
    }

    @Override
    public void onResume() {
        super.onResume();
        try {
            mBehavior.start(); //Initialization of information capture.
            String sessionId = mBehavior.generateSessionID();

            //Only on the screen where you want to send the collected data to ClearSale
            mBehavior.collectDeviceInformation(sessionId); //Preferably after some user interaction time.
        } catch (CaptureWasStartedException e) {
            //This indicates that the mBehavior.start() method has already been called previously and
            //the collection was not properly finalized using the mBehavior.stop() method.
        } catch (SessionIDAlreadyUsedException e) {
            //The same sessionId was used previously. The SessionID must be unique per collection.
        }
    }

    @Override
    public void onStop() {
        super.onStop();
        mBehavior.stop(); //Finalization of information capture.
    }
}

FAQ

Click here to access our FAQ