Para realizar a atualização da versão 3.x.x para a versão 5.6.6, siga essas etapas:

1. Remova a dependencia 'com.google.code.gson:gson' se ela não for utilizada no seu projeto
2. Substitua o plugin play-services-ads pelo plugin play-services-ads-identifier:18.0.1
3. Atualize a versão do plugin play-services-location para a versão 19.0.1

Para realizar a atualização da versão 3.x.x para as versões 5.6.7+ , siga essas etapas:

1. Remova a dependencia 'com.google.code.gson:gson' se ela não for utilizada no seu projeto
2. Substitua o plugin play-services-ads pelo plugin play-services-ads-identifier:18.0.1
3. Atualize a versão do plugin play-services-location para a versão 21.0.1

Configuração do Projeto

É necessário utilizar as seguintes dependências no seu projeto: play-services-location, play-services-ads-identifier. Para isso adicione no arquivo Gradle do seu projeto, na seção de dependências, as seguintes informações.

dependencies {
    // Demais dependências do seu projeto.
    //...
    // Dependências Obrigatórias:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior: 5.6.7'
    api 'com.google.android.gms:play-services-location:21.0.1'
 }

dependencies {
    // Demais dependências do seu projeto.
    //...
    // Dependências Obrigatórias:
    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'
 }

dependencies {
    // Demais dependências do seu projeto.
    //...
    // Dependências Obrigatórias:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior: 6.0.4'
    api 'com.google.android.gms:play-services-location:21.0.1'
 }

A dependência 'com.google.android.gms:play-services-ads-identifier:18.0.1' é utilizada para obter as informações do identificador de publicidade do dispositivo.

Já a dependência 'com.google.android.gms:play-services-location:21.0.1' deve ser utilizada sempre que for necessário coletar informações de geolocalização do dispositivo.

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

<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"/>

Configuração do Projeto

É necessário utilizar as seguintes dependências no seu projeto: play-services-location, play-services-ads-identifier. Para isso adicione no arquivo Gradle do seu projeto, na seção de dependências, as seguintes informações.

dependencies {
    // Demais dependências do seu projeto.
    //...
    // Dependências Obrigatórias:
    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'sale.clear.behavior:sdk-behavior:5.6.6'
    api 'com.google.android.gms:play-services-location:19.0.1'
 }

A dependência 'com.google.android.gms:play-services-ads-identifier:18.0.1' é utilizada para obter as informações do identificador de publicidade do dispositivo.

Já a dependência 'com.google.android.gms:play-services-location:19.0.1' deve ser utilizada sempre que for necessário coletar informações de geolocalização do dispositivo.

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

<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"/>

Configuração do Projeto

É necessário utilizar as seguintes dependências no seu projeto: play-services-location, play-services-ads, gson. Para isso adicione no arquivo Gradle do seu projeto, na seção de dependências, as seguintes informações.

dependencies {
    // Demais dependências do seu projeto.
    //...
    // Dependências Obrigatórias:
    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'

    // Dependências Optativas:
    api 'com.google.android.gms:play-services-location:17.0.0'
 }

A dependência optativa 'com.google.android.gms:play-services-location:17.0.0' deve ser utilizada sempre que for necessário coletar informações de geolocation.

<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"/>

Privacidade da Play Store

Caso o usuário tenha consentido com as coletas de geolocalização e da lista de aplicativos, os métodos allowGeoLocation() e allowAppList() devem ser chamados, antes do método start(), conforme exemplo abaixo:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.blockGeoLocation(); // Bloqueia a captura de geolocalização
        mBehavior.blockAppList(); //Bloqueia a captura de informações dos apps instalados no dispositivo
        mBehavior.start(); //Inicialização da captura de informações.
        
        String sessionId = mBehavior.generateSessionID()

        //Apenas nas telas que se deseja enviar os dados coletados para a ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferencialmente após algum tempo de interação do usuário.
    }
    catch (CaptureWasStartedException e) {
        //Este erro ocorre quando o método start() foi chamado mais de uma vez sem a utilização do método stop().
        //Cada captura (que se inicia no método start) precisa ser encerrada (com a chamada do método stop)
    }
}

Privacidade da Play Store

Caso o usuário tenha consentido com as coletas de geolocalização e da lista de aplicativos, os métodos allowGeoLocation() e allowAppList() devem ser chamados, antes do método start(), conforme exemplo abaixo:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.allowGeoLocation(); // Habilita a captura de geolocalização
        mBehavior.allowAppList(); //Habilita a captura de informações dos aplicativos instalados no dispositivo
        mBehavior.start(); //Inicialização da captura de informações.
        
        String sessionId = mBehavior.generateSessionID()

        //Apenas nas telas que se deseja enviar os dados coletados para a ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferencialmente após algum tempo de interação do usuário.
    }
    catch (CaptureWasStartedException e) {
        //Este erro ocorre quando o método start() foi chamado mais de uma vez sem a utilização do método stop().
        //Cada captura (que se inicia no método start) precisa ser encerrada (com a chamada do método stop)
    }
}

Classe Behavior

Descrição

Behavior é a classe responsável pela coleta das informações.

Construtores

Esta classe não possui construtores públicos. A instância deverá ser feita através de um método estático.

Métodos Estáticos

Métodos

Exemplos

Existem duas formas de inicializar o SDK. Isso depende do tipo de tela que será utilizada. Caso a tela seja uma Activity, a inicialização deve ser feita no método onCreate(). Caso seja um Fragment, a inicialização deve ser feita no método onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Observação: Em ambos os casos (Activity ou Fragment), se o método stop() não for chamado dentro do método onStop() de uma das telas, por se tratar de um singleton, na próxima tela quando for chamado o start() será lançada a exceção CaptureWasStartedException.

Em todos os exemplos se assume a existência das seguintes variáveis:

• mBehavior que representa a instância da classe Behavior. Pode ser substituído por Behavior.getInstance(contexto, CLEAR_SALE_APP).
• CLEAR_SALE_APP variável do tipo string, o valor desta variável deve ser fornecido pela ClearSale.

Para inicializar a chamada, quando a tela é um Fragment.

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
    // Para obter o Context em um Fragment.
    View rootView = inflater.inflate(R.layout.fragment_login, container, false);
    Context context = rootView.getContext();
    //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
    mBehavior = Behavior.getInstance(context, CLEAR_SALE_APP);
    return rootView;
}

Quando a tela é uma Activity

@Override
public void onCreate() {
    //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
    mBehavior = Behavior.getInstance(this, CLEAR_SALE_APP);
}

Para iniciar a captura:

@Override
public void onResume() {
    super.onResume();
    try {
        mBehavior.start(); //Inicialização da captura de informações.
        String sessionId = mBehavior.generateSessionID()
        //Apenas nas telas que se deseja enviar os dados coletados para a ClearSale
        mBehavior.collectDeviceInformation(sessionId); //Preferencialmente após algum tempo de interação do usuário.
    }
    catch (CaptureWasStartedException e) {
        //Isso indica que o método mBehavior.start() já foi chamado anteriormente e
        //a coleta não foi finalizada corretamente com a utilização do método mBehavior.stop().
    }catch (SessionIDAlreadyUsedException e) {
        //O mesmo sessionId foi usado anteriormente. O SessionID deve ser único por coleta.
    }
}

Os métodos start() e stop() devem ser implementados apenas na tela em que a captura de informações será realizada. O método collectDeviceInformation(SESSION_ID) deve ser chamado no momento em que deseja enviar as informações coletadas para a ClearSale, na mesma tela em que foi implementado os métodos anteriores.

OBS: O método collectDeviceInformation deve ser, obrigatoriamente, chamado depois do método start() já ter sido executado.

Recomendamos que estes métodos sejam implementados em uma tela de "finalização" onde haja interação do usuário por, no mínimo, 3 segundos.

Para encerrar a captura:

@Override
public void onStop() {
    super.onStop();
    mBehavior.stop(); //Finalização da captura de informações.
}                         

Exemplo completo de implementação:

public class ExemploImplementacaoActivity extends AppCompatActivity {

    private Behavior mBehavior;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        //CLEAR_SALE_APP é um valor de identificação único que deve ser fornecido pela ClearSale.
        mBehavior = Behavior.getInstance(this, "CLEAR_SALE_APP");
    }

    @Override
    public void onResume() {
        super.onResume();
        try {
            mBehavior.start(); //Inicialização da captura de informações.
            String sessionId = mBehavior.generateSessionID();

            //Apenas na tela que se deseja enviar os dados coletados para a ClearSale
            mBehavior.collectDeviceInformation(sessionId); //Preferencialmente após algum tempo de interação do usuário.
        } catch (CaptureWasStartedException e) {
            //Isso indica que o método mBehavior.start() já foi chamado anteriormente e
            //a coleta não foi finalizada corretamente com a utilização do método mBehavior.stop().
        } catch (SessionIDAlreadyUsedException e) {
            //O mesmo sessionId foi usado anteriormente. O SessionID deve ser único por coleta.
        }
    }

    @Override
    public void onStop() {
        super.onStop();
        mBehavior.stop(); //Finalização da captura de informações.
    }
}