Checksum

Para verificar o checksum das dependencias no Gradle 6.2 ou superior, siga as instruções desse link: Dependency Verification

Checksum

Para verificar o checksum das dependencias no Gradle 7.0 ou superior, siga as instruções desse link: Dependency Verification

Checksum

Para verificar o checksum das dependencias no Gradle 7.0 ou superior, siga as instruções desse link: Dependency Verification

Checksum

Para verificar o checksum das dependencias no Gradle 7.0 ou superior, siga as instruções desse link: Dependency Verification

Configuração do Projeto

É necessário utilizar as seguintes dependências no seu projeto:

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

Para isso, na seção de dependências, adicione as seguintes informações no arquivo Gradle do seu projeto:

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:7.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.8'
    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'
}       

Configuração do Projeto

É necessário utilizar as seguintes dependências no seu projeto:

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

Para isso, na seção de dependências, adicione as seguintes informações no arquivo Gradle do seu projeto:

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'
}           

Saiba mais:

Saiba mais:

• 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.
• 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.

Proguard

Inclua esta regra se estiver utilizando o Proguard:

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

Permissões no aplicativo

Para o uso do sdk é necessário requisitar algumas permissões no arquivo de manifesto. São elas:

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

Atenção: Para aplicações que utilizam como Target a versão 26 ou superior do Android, e que desejem capturar informações de geolocalização, é necessário, além de adicionar no manifest as permissões ACCESS_FINE_LOCATION e ACCESS_COARSE_LOCATION, também solicitar permissão ao usuário para coletar dados de geolocalização. Para isso, siga esta recomendação do Android.

Já as aplicações que utilizam como Target a versão 33 (Android 13) ou superior, será necessário incluir a permissão AD_ID para que possa ser possível capturar as informações referentes ao advertisingID.

Privacidade Play Store

Caso o usuário tenha consentido com as coletas de geolocalização e da lista de aplicativos, os métodos allowGeoLocation() 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

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

• Método Estático

• Outros Métodos

Módulo de Segurança

O módulo de segurança do SDK Android é composto por funcionalidades que visam proteger nossos produtos e serviços contra ataques.

Modo de Uso

Esse módulo está disponível a partir da versão 7.0.0 do SDK. Para habilitá-lo é necessário chamar o novo método allowSecurity() antes da coleta.

@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.allowSecurity(); // Habilita o módulo de segurança
            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)
        }
}

Fluxo de Atualização

O módulo de segurança possui um ciclo de vida que permite o aplicativo ser mais seguro. Ao utilizar este módulo, existirá a obrigatoriedade de sempre estar com a última versão disponibilizada, sendo as datas de disponibilização em abril e outubro de cada ano.

Essas versões possuem validade de 6 meses. E, para o funcionamento correto, é necessário realizar a atualização antes que a versão anterior expire.

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.
    }
}

FAQ

Acesse nosso FAQ Clicando Aqui