Integração do SDK do Android para desenvolvedores

Use um dos seguintes métodos para adicionar o SDK ao seu aplicativo:

• [Melhores práticas] Usando Gradle
• Adicionar manualmente o SDK

O referenciador da instalação do Android melhora a precisão da atribuição, protege contra fraudes na instalação e muito mais. É compatível com o SDK da AppsFlyer para Android versão 4.8.6.

Há duas formas de adicionar o referenciador da instalação ao seu aplicativo:

• Use Gradle (recomendado)
• Adicione manualmente o referenciador da instalação

Adicionar permissões ajuda a aumentar a taxa de atribuição de modelagem probabilística. Também permite que o SDK envie mais dados, como Wifi e dados da rede da operadora. Você pode encontrar esses dados em relatórios de dados brutos e usá-los para análise e otimização de campanhas.

Adicionar permissões necessárias

1. Adicionar as seguintes permissões ao AndroidManifest.xml:
   

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

O BroadcastReceiver obtém informações do Google Play que a AppsFlyer usa para atribuição. O uso do BroadcastReceiver aumenta a taxa de atribuição.

As duas opções a seguir estão disponíveis para implementar o receptor de broadcast da referência de instalação:

<application>
	<receiver android:name="com.appsflyer.SingleInstallBroadcastReceiver" android:exported="true">
		<intent-filter>
			 <action android:name="com.android.vending.INSTALL_REFERRER" />
		 </intent-filter>
	</receiver>
</application>

<application>
	<receiver android:name="com.appsflyer.MultipleInstallBroadcastReceiver" android:exported="true">
		<intent-filter>
			<action android:name="com.android.vending.INSTALL_REFERRER" />
		</intent-filter>
	</receiver>
</application>

A AppsFlyer usa a chave do desenvolvedor para identificar exclusivamente sua conta. A chave do desenvolvedor é obrigatória porque permite que o SDK envie e recupere com segurança dados que pertencem à sua conta da AppsFlyer.

Aviso! Usar a chave de desenvolvedor errada ou uma chave de desenvolvedor incorreta afeta todo o tráfego enviado do SDK e interrompe a atribuição e os relatórios.

Para recuperar sua chave do desenvolvedor:

1. Acesse o painel do seu aplicativo 
2. No painel, em Configuração, clique em Configurações do Aplicativo.
3. Copie sua chave do desenvolvedor.
   

   

Registro da classe de aplicativo global

No arquivo AndroidManifest.xml, dentro da tag do aplicativo, adicione a seguinte linha:

android:name="<APP.PACKAGE.NAME>.<AFApplication>"

• <APP.PACKAGE.NAME> - substitua pelo nome do pacote do aplicativo.
• <AFApplication> - substitua pelo nome que você definiu para a classe global do aplicativo.

Esta linha no manifest.xml informa ao aplicativo qual é o aplicativo global. Como mencionado acima, isso torna o SDK da AppsFlyer acessível globalmente em todo o aplicativo.

Inicialize o SDK

Recomendamos inicializar o SDK na classe de aplicativo global do aplicativo. Isso permite que o SDK seja inicializado em todos os cenários, incluindo links diretos.

As etapas listadas abaixo ocorrem dentro da classe de aplicativo global do aplicativo.

1. Dentro da classe global do aplicativo, importe as seguintes bibliotecas
   

   import android.app.Application;
   import android.util.Log;
   import com.appsflyer.AppsFlyerLib;
   import com.appsflyer.AppsFlyerConversionListener;
   import java.util.Map;

2. Dentro da classe global, atribua sua chave do desenvolvedor a uma variável, preferencialmente denominada AF_DEV_KEY
   
   
   
   Importante: é crucial usar a chave do desenvolvedor correta ao inicializar o SDK. O uso da chave do desenvolvedor incorreta afeta todo o tráfego enviado pelo SDK e causa problemas de atribuição e relatório.
   
   
   Java Kotlin

   public class AFApplication extends Application {
       private static final String AF_DEV_KEY = "qrdZGj123456789";
       
       //...
       
   }
   

   class AFApplication : Application() {
       private val devKey = "qrdZGj123456789";
   
       //...
       
   }
   

3. Dentro da classe global, após a chamada para super.onCreate(), implemente o AppsFlyerConversionListener. Veja o código abaixo na etapa 4.
4. Dentro da classe global, após o ConversionListener, inicialize o SDK usando o método init(). 
   
   Java Kotlin

   public class AFApplication extends Application {
       private static final String AF_DEV_KEY = "qrdZGj123456789";
       
       @Override
       public void onCreate() {
           super.onCreate();
           AppsFlyerConversionListener conversionListener = new AppsFlyerConversionListener() {
               @Override
               public void onConversionDataSuccess(Map<String, Object> conversionData) {
               
                       for (String attrName : conversionData.keySet()) {
                       Log.d("LOG_TAG", "attribute: " + attrName + " = " + conversionData.get(attrName));
                   }
               }
   
               @Override
               public void onConversionDataFail(String errorMessage) {
   		   Log.d("LOG_TAG", "error getting conversion data: " + errorMessage);
               }
   
               @Override
               public void onAppOpenAttribution(Map<String, String> attributionData) {
                   for (String attrName : attributionData.keySet()) {
                       Log.d("LOG_TAG", "attribute: " + attrName + " = " + attributionData.get(attrName));
                   }
               }
   
               @Override
               public void onAttributionFailure(String errorMessage) {
                   Log.d("LOG_TAG", "error onAttributionFailure : " + errorMessage);
               }
           };
           
           AppsFlyerLib.getInstance().init(AF_DEV_KEY, conversionListener, this);
   
       }
   }
                 

   class AFApplication : Application() {
       private val devKey = "qrdZGj123456789";
   
       override fun onCreate() {
           super.onCreate()
           val conversionDataListener  = object : AppsFlyerConversionListener{
               override fun onConversionDataSuccess(data: MutableMap<String, Any>?) {
                   data?.let { cvData ->
                       cvData.map {
                           Log.i(LOG_TAG, "conversion_attribute:  ${it.key} = ${it.value}")
                       }
                   }
               }
   
               override fun onConversionDataFail(error: String?) {
                   Log.e(LOG_TAG, "error onAttributionFailure :  $error")
               }
   
               override fun onAppOpenAttribution(data: MutableMap<String, String>?) {
                   data?.map {
                       Log.d(LOG_TAG, "onAppOpen_attribute: ${it.key} = ${it.value}")
                   }
               }
   
               override fun onAttributionFailure(error: String?) {
                   Log.e(LOG_TAG, "error onAttributionFailure :  $error")
               }
           }
   
           AppsFlyerLib.getInstance().init(devKey, conversionDataListener, this)
       }
   }
   

5. Dentro da classe global do aplicativo, chame start().
   
   Java Kotlin

   AppsFlyerLib.getInstance().start(this);
   

   AppsFlyerLib.getInstance().start(this)

Para atrasar a inicialização do SDK, você pode chamar start da classe de Atividade.

Essa opção pode ser usada se, por exemplo, você precisar adiar o start até receber o consentimento do usuário devido aos requisitos de GDPR, CCPA ou outros.

Ao invocar start na classe Atividade:

• Certifique-se de passar instância de Atividade como um argumento e não um Aplicativo.
• Se você planeja usar recursos de deep linking, adicione a API start() a qualquer outra Atividade à qual você possa vincular deep links que não tenha 'start' nela.

Antes de iniciar o teste de instalações, registre o dispositivo de teste.

Instalações orgânicas são instalações não atribuídas, geralmente instalações diretas das lojas de aplicativos.

Para simular uma instalação orgânica:

1. Verifique se você tem um dispositivo móvel conectado ao seu computador
2. No Android Studio, abra o Logcat.
3. No Android Studio, instale o aplicativo no dispositivo ou emulador.
4. Aguarde o aplicativo iniciar.
5. No Logcat, procure o nome do pacote do seu aplicativo.

Você deve ver o seguinte:

A parte destacada na captura de tela indica que o SDK relata uma instalação orgânica. Esses dados são provenientes do método onConversionDataSuccess na classe AFApplication. A obtenção de dados de conversão é discutida mais adiante neste guia.

Observação: Ao iniciar o SDK V5, onConversionDataSuccess é o nome do método para obter os dados de conversão. Se você estiver usando uma versão do SDK abaixo de 5.0.0, o nome do método será onInstallConversionDataLoaded. Recomendamos que você atualize para o SDK 5.0.0. Clique aqui para saber mais.

Uma instalação orgânica agora deve aparecer na página Overview (Visão geral) do painel do aplicativo.

Se você não encontrar uma instalação no painel do aplicativo, consulte o guia de solução de problemas do SDK.

Uma instalação não orgânica é uma instalação atribuída que geralmente segue um engajamento de anúncio. Você pode simular uma instalação não orgânica usando links de atribuição.

Para simular uma instalação não orgânica:

1. No manifesto, descubra qual é o nome do pacote do seu aplicativo, por exemplo, com.company.app.
   • Na URL abaixo, substitua <app_id >pelo nome do pacote do aplicativo:
     

     https://app.appsflyer.com/<app_id>?pid=Test&c=Test

     Por exemplo:

     https://app.appsflyer.com/id0123456789?pid=Test&c=Test

   • O parâmetro c especifica o nome da campanha.
   • O parâmetro pid especifica o nome da fonte de mídia à qual a instalação é atribuída.
   • A ID de publicidade (GAID) deve ser adicionada se você testar o clique de um computador (adicionando &advertising_id=<GAID> ao final do link na etapa 1).
2. Envie este URL para o dispositivo.  Você pode fazê-lo, por exemplo, por e-mail ou WhatsApp. 
3. No dispositivo, clique no URL.
   • Se o aplicativo estiver listado na loja de aplicativos, você será redirecionado para a loja de aplicativos. Não baixe e instale o aplicativo da loja de aplicativos. Prossiga para a etapa 5.
   • Se o aplicativo não estiver listado na loja de aplicativos e ainda estiver em desenvolvimento, a tela mostrará uma mensagem de que o aplicativo não está disponível na loja de aplicativos. Simplesmente prossiga para a etapa 5.
4. No Android Studio, abra o Logcat.
5. Conecte o dispositivo ao seu computador usando um cabo USB.
6. No Android Studio, instale o aplicativo no dispositivo.
7. No Logcat, procure o nome do pacote do seu aplicativo.

Você deve ver o seguinte:

Uma instalação não orgânica agora deve aparecer na página de Visão Geral do dashboard do aplicativo.

O SDK possui duas interfaces relacionadas a eventos in-app:

• AFInAppEventType — constantes para nomes de eventos in-app
• AFInAppEventParameterName — constantes para nomes de parâmetros do evento in-app

É altamente recomendável usar essas duas interfaces pelos seguintes motivos:

• A nomeação padrão permite que a AppsFlyer mapeie automaticamente eventos para SRNs, como Facebook, Google, Twitter e Snapchat.
• Compatibilidade com versões anteriores — se a AppsFlyer decidir alterar o nome de qualquer evento ou parâmetro de evento, sua implementação será compatível com versões anteriores.

Para usar essas duas interfaces, importe-as:

import com.appsflyer.AFInAppEventParameterName;
import com.appsflyer.AFInAppEventType;

Esta é a lista de nomes de eventos e estruturas recomendados.

É possível enviar receita com qualquer evento in-app. Use o parâmetro de evento af_revenue (AFInAppEventParameterName.REVENUE) para incluir receita no evento in-app. Você pode preenchê-lo com qualquer valor numérico, positivo ou negativo.

af_revenue é o único parâmetro de evento que é contado na AppsFlyer como receita real nos dados brutos e painel. Para mais detalhes, clique aqui.

Ao enviar eventos com receita, lembre-se do seguinte:

• Se você definir o código de moeda (veja o exemplo abaixo), ele deverá ser um código ISO 4217 de 3 caracteres. (o padrão é USD).
• Você pode definir o código de moeda para todos os eventos chamando o método a seguir: AppsFlyer.setCurrencyCode("ZZZ") Para saber mais sobre definições de moeda, exibição e conversão de moeda, veja nosso guia sobre moeda de receita.
• O valor da receita não deve conter separadores de vírgula, símbolo de moeda ou texto. Um evento de receita deve ser semelhante a 1234,56, por exemplo.

Exemplo: evento de compra de eventos in-app com receita

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.REVENUE,1234.56);
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"Shirt");
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"1234567");
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD");
AppsFlyerLib.getInstance().logEvent(getApplicationContext() , AFInAppEventType.PURCHASE , eventValue);

val eventValue = HashMap<String, Any>() 
eventValue.put(AFInAppEventParameterName.REVENUE,1234.56)
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"Shirt")
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"1234567")
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD")
AppsFlyerLib.getInstance().logEvent(getApplicationContext() , AFInAppEventType.PURCHASE , eventValue)

O evento de compra acima tem $1.234,56 em receita associada a ele, que aparece como receita no painel.

Gravação de receita negativa

Pode haver situações em que você deseja registrar receita negativa.

Por exemplo, um usuário recebe um reembolso pelos sapatos que comprou de você.

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.REVENUE,-200);
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"shoes");
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"4875");
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD");
AppsFlyerLib.getInstance().logEvent(getApplicationContext() , "cancel_purchase" , eventValue);

val eventValue = HashMap<String, Any>()
eventValue.put(AFInAppEventParameterName.REVENUE, -200)
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE, "category_a")
eventValue.put(AFInAppEventParameterName.CONTENT_ID, "1234567")
eventValue.put(AFInAppEventParameterName.CURRENCY, "USD")
AppsFlyerLib.getInstance().logEvent(applicationContext,  "cancel_purchase", eventValue)

O SDK da AppsFlyer fornece validação de recebimento de servidor para compras in-app. Para validar uma compra, chame validateAndLogInAppPurchase.

Essa chamada gera automaticamente um evento in-app af_purchase, desde que a compra seja validada.

public static void validateAndLogInAppPurchase(Context context, 
String publicKey, String signature, String purchaseData, 
String price, String currency, HashMap<String, String> additionalParameters);

Parâmetros do método

• String publicKey — chave pública do Google Developer Console
• String signature — assinatura da transação (retornada da API do Google quando a compra é concluída)
• String purchaseData — produto adquirido no formato JSON (retornado da API do Google quando a compra é concluída)
• String price — receita de eventos in-app a ser relatada à AppsFlyer.
• String currency — moeda do evento in-app a ser relatada à AppsFlyer
• HashMap<String, String> additionalParameters — parâmetros adicionais do evento in-app que aparecem no campo event_value nos dados brutos do evento in-app.

Retornos de chamada de sucesso e falha na validação da compra

Se você deseja saber se a tentativa de validar a compra foi bem-sucedida ou não, implemente registerValidatorListener na sua classe de aplicativo. Esse ouvinte possui dois blocos de retorno de chamada, um para "Sucesso" e outro para "Falha" (por qualquer motivo, incluindo falha na validação).

AppsFlyerLib.getInstance().registerValidatorListener(this,new
   AppsFlyerInAppPurchaseValidatorListener() {
     public void onValidateInApp() {
       Log.d(TAG, "Purchase validated successfully");
     }
     public void onValidateInAppFailure(String error) {
       Log.d(TAG, "onValidateInAppFailure called: " + error);
     }
});

AppsFlyerLib.getInstance().registerValidatorListener(this, object : AppsFlyerInAppPurchaseValidatorListener {
    override fun onValidateInApp() {
       	Log.d(LOG_TAG, "Purchase validated successfully")
    }

    override fun onValidateInAppFailure(error: String) {
        Log.d(LOG_TAG, "onValidateInAppFailure called: $error")
   }
})

Exemplo de uso de validação de uma compra:

// Purchase object is returned by Google API in onPurchasesUpdated() callback
private void handlePurchase(Purchase purchase) {
    Log.d(LOG_TAG, "Purchase successful!");
    Map<String, String> additional_event_values = new HashMap<>();
    additional_event_values.put("some_parameter", "some_value");
    String price= "10";
    String currency = "USD";
    AppsFlyerLib.getInstance().validateAndLogInAppPurchase(getApplicationContext(), PUBLIC_KEY, purchase.getSignature(), purchase.getOriginalJson(), revenue, currency, additional_event_values);
}

// Purchase object is returned by Google API in onPurchasesUpdated() callback
private fun handlePurchase(Purchase purchase) {
   Log.d(LOG_TAG, "Purchase successful!");
   val additional_event_values = HashMap<String, String>()
   additional_event_values.put("some_parameter", "some_value");
   val price= "10";
   val currency = "USD";
   AppsFlyerLib.getInstance().validateAndLogInAppPurchase(this, PUBLIC_KEY, purchase.getSignature(), purchase.getOriginalJson(), revenue, currency, additional_event_values);
}

A validação da compra in-app envia automaticamente um evento de compra in-app à AppsFlyer. Veja abaixo um exemplo de dados que são passados no parâmetro event_value:

{
   "some_parameter":"some_value", // from additional_event_values
   "af_currency":"USD", // from currency
   "af_content_id":"test_id", // from purchase
   "af_revenue":"10", // from revenue
   "af_quantity":"1", // from purchase
   "af_validated":true // flag that AF verified the purchase
}

• Nome do evento: até 45 caracteres
• Valor do evento: não deve exceder 1000 caracteres - caso exceda, pode ser necessário restringi-lo.
• Preço e receita: use apenas dígitos e decimais, por exemplo, 5 ou 5,2
• Os valores de preço e receita podem ter até 5 dígitos após o ponto, por exemplo, 5.12345
• Os caracteres não ingleses são suportados em eventos no aplicativo,  outras APIs do SDK, a partir do Android SDK V4.8.1.

É possível gravar eventos in-app chamando trackEvent com os parâmetros de nome e valor do evento. Consulte a documentação sobre Eventos in-app para obter mais detalhes.

Veja abaixo um exemplo simples de como gravar um evento de compra. Para obter uma lista abrangente de trechos de código prontos por vertical, consulte nosso guia sobre eventos avançados dentro do aplicativo por verticais.

Exemplo: evento de compra in-app

Map<String,Object> eventValues = new HashMap<>();
eventValues.put(AFInAppEventParameterName.REVENUE, 1200);
eventValues.put(AFInAppEventParameterName.CURRENCY, "JPY");
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, "Shoes");
AppsFlyerLib.getInstance().logEvent(this, AFInAppEventType.PURCHASE, eventValues);

val eventValues = HashMap<String, Any>();
eventValues.put(AFInAppEventParameterName.REVENUE, 1200)
eventValues.put(AFInAppEventParameterName.CURRENCY, "JPY")
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, "Shoes")
AppsFlyerLib.getInstance().logEvent(this, AFInAppEventType.PURCHASE, eventValues)

Se um usuário iniciar um evento quando a conexão à internet estiver indisponível, a Appsflyer ainda pode realizar o registro do evento. Confira como funciona:

1. O SDK envia os eventos aos servidores da AppsFlyer e aguarda uma resposta.
2. Se o SDK não receber 200 como resposta, o evento é armazenado no cache.
3. Quando o próximo 200 como resposta for recebido, o evento armazenado é reenviado ao servidor.
4. Se houver vários eventos no cache, eles são enviados para o servidor, um imediatamente após o outro.

Você pode definir um ouvinte ao gravar eventos in-app. O ouvinte permite definir lógica para dois cenários:

• Evento in-app gravado com sucesso.
• Ocorreu um erro ao gravar um evento in-app.

AppsFlyerLib.getInstance().logEvent(getApplicationContext(), AFInAppEventType.PURCHASE, eventValue, new AppsFlyerRequestListener() {
                    @Override
                    public void onSuccess() {
                        Log.d(LOG_TAG, "Event sent successfully");
                    }
                    @Override
                    public void onError(int i, @NonNull String s) {
                        Log.d(LOG_TAG, "Event failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
                    }
                });

AppsFlyerLib.getInstance().logEvent(getApplicationContext(), AFInAppEventType.PURCHASE, eventValue, object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Event sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Event failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

Se um erro ocorrer ao gravar o evento in-app, um código de erro e uma descrição de string são fornecidos, conforme indicado na tabela a seguir.

O OneLink detecta o tipo de dispositivo após o clique, e redireciona o usuário para o destino correspondente, por exemplo, Google Play, loja de aplicativos para iOS, mercados fora da loja ou páginas da web.

O guia de redirecionamentos do OneLink discute a implementação de links de atribuição multiplataforma (não é necessária codificação do SDK). Também é a base para links diretos.

Os links diretos permitem enviar usuários a atividades específicas e servi-los com conteúdo personalizado. Isso é especialmente útil ao realizar campanhas de redirecionamento.

Para configurar links diretos com o OneLink, um profissional de marketing com acesso ao painel da AppsFlyer e um desenvolvedor com acesso ao aplicativo devem trabalhar juntos.

Consulte o nosso guia sobre configuração de links diretos com o OneLink.

A ligação direta adiada permite vincular novos usuários e servi-los com conteúdo personalizado após a instalação do aplicativo. Isso é diferente dos links diretos regulares, em que o aplicativo já deve estar instalado no dispositivo do usuário.

Para configurar a ligação direta adiada com o OneLink, o desenvolvedor também precisa de acesso ao painel da AppsFlyer.

A configuração para ligação direta adiada é a mesma que para links diretos. A única diferença é que você precisa implementar lógica adicional no aplicativo para aplicar link direto aos usuários e servi-los com conteúdo personalizado após a instalação e a inicialização do aplicativo.

Consulte o nosso guia sobre ligação direta adiada para saber mais.

O SDK fornece os dados de conversão ou engajamento após cada evento de instalação ou links diretos. É possível usar esses dados para personalizar o conteúdo e o comportamento do aplicativo programaticamente.

Para obter dados de links diretos quando o link direto é usado e o aplicativo é aberto, implemente o método onAppOpenAttribution.

Para obter dados de links diretos de reengajamento manualmente a qualquer momento, implemente o método performOnAppAttribution. Isso permite o acesso aos dados de reengajamento sem gravar um novo reengajamento.

Consulte o nosso guia sobre dados de links diretos para saber mais.

O método addPushNotificationDeepLinkPath fornece aos proprietários de aplicativos uma interface flexível para configurar como os deep links são extraídos de payloads de notificação push.

Por padrão, o SDK procura um valor de deep link na chave af do payload JSON de uma notificação push. No entanto, muitos provedores de push usam esquemas JSON próprios que o SDK não pode converter sem configuração adicional.

O addPushNotificationDeepLinkPath permite configurar qual chave no payload da notificação push o SDK usa para o valor do deep link.

Use esse método se você estiver integrando seu aplicativo com provedores de push que não usam o esquema JSON de notificação push padrão esperado pelo SDK.

Ao chamar addPushNotificationDeepLinkPath, o SDK verifica se:

• A chave necessária existe no payload.
• A chave contém uma URL do OneLink válida.

addPushNotificationDeepLinkPath deve ser chamado antes da chamada start().

Configuração básica

Considere a seguinte chamada para addPushNotificationDeepLinkPath

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");                       

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

e esses cenários.

Cenário 1

Seu aplicativo é ativado por notificação push. Ele contém um payload estruturado da seguinte forma.

{
    ...
    "deeply": {
        "nested": {
            "deep_link": "https://yourdeeplink2.onelink.me"
        }
    }
    ...
}

Nesse cenário, o SDK extrai o valor de deep_link e prossegue com o fluxo do deep link.

Cenário 2

Seu aplicativo é ativado por notificação push. Ele contém um payload estruturado da seguinte forma.

{
    ...
    "deeply": {
        "nested": {
            "banana": "https://yourdeeplink2.onelink.me"
        }
    },
    ...
}

Nesse cenário, quando a chamada executa o SDK, não consegue encontrar a chave deep_link no payload. Portanto, nada acontece.

Cenário 3

Seu aplicativo é ativado por notificação push. Ele contém um payload estruturado da seguinte forma.

{
    ...
    "deeply": {
        "nested": {
            "deep_link": "Corrupted url or regular string"
        }
    },
    ...
}

Nesse cenário, embora o SDK encontre a chave deep_link , seu valor de deep link é inválido. Portanto, quando a chamada acima é executada, nada acontece.

Configuração avançada

Para configurar várias estruturas de payload útil possíveis, faça a chamada addPushNotificationDeepLinkPath várias vezes:

• A primeira chamada que produz um valor de deep link válido é usada
• Outras chamadas são ignoradas

Se nenhuma das estruturas de payload corresponder ou nenhuma URL válida do OneLink for encontrada no payload, nada acontecerá.

Por exemplo, considere o seguinte payload:

{
    ...
    "deeply": {
        "nested": {
            “deep_link”: “https://yourdeeplink2.onelink.me”
        }
    },
    “this”: {
        “is”: {
            "banana": "phone"
        }
    }
    ...
}

e as seguintes chamadas para addPushNotificationDeepLinkPath.

// this.is.deep_link key isn’t found - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "deep_link");
// this.is.banana key found, but contains invalid OneLink URL - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "banana");
// deeply.nested.deep_link key found and contains valid OneLink URL - proceed deep linking flow
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

// this.is.deep_link key isn’t found - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "deep_link");
// this.is.banana key found, but contains invalid OneLink URL - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "banana");
// deeply.nested.deep_link key found and contains valid OneLink URL - proceed deep linking flow
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

Com a AppsFlyer, você pode atribuir instalações para aplicativos Android fora da loja. Isso permite que você promova seus aplicativos e alcance públicos maiores em mercados onde o Google Play não está disponível. 

Para obter mais detalhes sobre como atribuir instalações para aplicações fora da loja, leia aqui.

Nas campanhas de pré-instalação, os proprietários de aplicativos podem solicitar aos fabricantes de dispositivos que pré-instalem seus aplicativos nos dispositivos antes de saírem da fábrica.

Com a AppsFlyer, você pode atribuir facilmente instalações de aplicativos pré-instalados. Quando os usuários iniciam seu aplicativo pela primeira vez, a AppsFlyer atribui a instalação ao fabricante como uma fonte de mídia.

Para mais detalhes, clique aqui.

Para saber como configurar a métrica de desinstalação, leia aqui.

Se você deseja receber uma confirmação de que a solicitação foi recebida com sucesso pelos servidores da AppsFlyer, implemente o listener AppsFlyerRequestListener.

O método de retorno de chamada onRequestSuccess() é executado para cada resposta 200 a uma solicitação de atribuição feita pelo SDK.

O método de retorno de chamada onRequestFailure(String error) é executado para qualquer outra resposta e retorna a resposta como a sequência de caracteres de erro.

Exemplo de implementação

AppsFlyerLib.getInstance().start(getApplicationContext(), "devKey", new AppsFlyerRequestListener() {
            @Override
            public void onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully, got 200 response code from server");
            }
            @Override
            public void onError(int i, @NonNull String s) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
            }
        });

AppsFlyerLib.getInstance().start(this, "devKey", object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

Se ocorrer um erro durante o ouvinte de solicitação, um código de erro e uma descrição de string são fornecidos, conforme indicado na tabela a seguir.

É necessária a API setAdditionalData para integrar-se no nível do SDK com várias plataformas de parceiros externas, incluindo Segment, Adobe e Urban Airship.
Use esta API apenas se o artigo de integração da plataforma afirmar especificamente que a API setAdditionalData é necessária.

Exemplo de código setAdditionalData:

HashMap<String,Object> CustomDataMap = new HashMap<>();
CustomDataMap.put("custom_param_1","value_of_param_1");
AppsFlyerLib.getInstance().setAdditionalData(CustomDataMap);

val customDataMap = HashMap<String, Any>()
customDataMap.put("custom_param_1","value_of_param_1")
AppsFlyerLib.getInstance().setAdditionalData(customDataMap)

Os proprietários de aplicativos que usam links de aplicativos para links diretos (sem OneLink) e têm um domínio associado ao aplicativo podem atribuir sessões iniciadas por meio desse domínio usando o método appendParametersToDeepLinkingUrl.

Por exemplo, um usuário faz uma pesquisa no Google e clica no seu domínio, www.exemplo.com:

• Se o usuário não tiver o aplicativo instalado, ele será direcionado para o site (www.example.com).
• Se o usuário tiver o aplicativo instalado no seu dispositivo, haverá um link direto para o aplicativo associado com www.exemplo.com. A sessão é atribuída à fonte de mídia (parâmetro pid ) especificada em appendParametersToDeeplinkingUrl.

Consulte a referência do SDK do Android para obter informações adicionais.

Observação: Smart Banners ajudam os proprietários de aplicativos a converter visitantes do site em usuários do aplicativo.

Por padrão, deve haver um intervalo mínimo de 5 segundos entre duas inicializações de aplicativos para que essas duas sessões sejam contabilizadas separadamente (saiba mais sobre contabilização de sessões).

Use a seguinte API para definir o tempo mínimo entre sessões:

AppsFlyerLib.setMinTimeBetweenSessions(int seconds);

Definir um valor alto para o tempo personalizado entre inicializações pode gerar um impacto negativo nas APIs que dependem dos dados das sessões, como links diretos.

Você pode relatar sobre novas sessões de usuário usando esse método de SDK. Por exemplo, isso pode ser útil para aplicativos utilitários executados em segundo plano.

Use esta API no onCreate() da sua atividade:

public void logSession(Context context);

Exemplo de uso:

AppsFlyerLib.getInstance().logSession(context);

Alguns serviços de terceiros, como provedores de serviços de e-mail, envolvem links em e-mails com seus próprios domínios de gravação de links. Alguns até permitem que você defina seus próprios domínios de gravação de links. Se o OneLink estiver agrupado nesses domínios, poderá limitar sua funcionalidade.

Para superar esse problema, você pode usar a API setResolveDeepLinkURLs. Use esta API para obter o OneLink de domínios de clique que iniciam o aplicativo.  Certifique-se de chamar essa API antes da inicialização do SDK.

Por exemplo, você tem 3 domínios de clique que redirecionam para o seu OneLink, que é https://mysubdomain.onelink.me/abCD. Use essa API para obter o OneLink ao qual seus domínios de clique redirecionam.  Este método de API recebe uma lista de domínios que o SDK resolve. Adicione o seguinte código antes da inicialização do SDK.

AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");

O código acima permite usar seu domínio de clique, preservando a funcionalidade do OneLink. Os domínios de clique são responsáveis pela inicialização do aplicativo. A API, por sua vez, recebe o OneLink desses domínios de clique e, depois, é possível usar os dados desse OneLink para aplicar deep link e personalizar o conteúdo do usuário.

Com a AppsFlyer, você pode medir as notificações push como parte de campanhas de redirecionamento.

Para habilitar esse recurso, chame o método sendPushNotificationData dentro do método onCreate de cada atividade iniciada após clicar na notificação:

AppsFlyerLib.getInstance().sendPushNotificationData(this);

Para mais informações sobre medição de notificações por push, leia aqui.

Permitir que os usuários existentes convidem seus amigos e contatos como novos usuários para seu aplicativo pode ser um fator de crescimento importante para seu aplicativo. Com a AppsFlyer, você pode atribuir e registrar instalações originadas de convites do usuário em seu aplicativo.

Para obter detalhes, consulte o artigo de atribuição de convite do usuário.

Um ID da AppsFlyer é criado para cada nova instalação de um aplicativo. Você pode usar o ID da AppsFlyer para vários fins:

• Enviar eventos in-app de servidor para servidor.
• Combine o ID da AppsFlyer com os registros do usuário em seus sistemas de back-end.
• Mapear entradas ao mesclar dados das APIs pull e push.

Use a seguinte API para obter o ID da AppsFlyer:

public String getAppsFlyerUID(Context context);

Exemplo de uso:

String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);

Para definir sua ID de usuário cliente:

public void setCustomerUserId(String id);

Exemplo de uso:

AppsFlyerLib.getInstance().setCustomerUserId("myId");

Recomendamos definir o ID de usuário cliente no início do fluxo do aplicativo, pois ele está associado apenas aos eventos relatados após sua configuração:

• Se setCustomerUserID for chamado antes de chamar start, a ID de usuário cliente aparecerá nos relatórios de dados brutos para instalações e eventos.
• Se for definido depois, o ID de usuário cliente será associado apenas a eventos registrados após a configuração do ID de usuário cliente.

Obtenção de ID do cliente (Customer User ID):

Para evitar definir o valor do ID de usuário cliente novamente após a primeira inicialização e reduzir as chamadas para o servidor a fim de obter o ID de usuário cliente, você pode verificar se o valor está vazio ou não, usando:

AppsFlyerProperties.getInstance().getString(AppsFlyerProperties.APP_USER_ID)

Para mais informações sobre ID de usuário cliente, clique aqui .

Atrasar init do SDK para customerUserID

É possível atrasar a inicialização do SDK até que o customerUserID esteja definido.

Para indicar que o SDK deve atrasar a inicialização para a chamada do ID de usuário cliente:

AppsFlyerLib.getInstance().waitForCustomerUserId(true);

imediatamente antes do método init(). O resto da inicialização do SDK deve permanecer inalterado.

Uma vez que o customerUserID foi fornecido, chame

AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this);

para fornecer o SDK com o ID de usuário do cliente relevante e iniciar o SDK.

O código deve aparecer da seguinte maneira:

public class AFApplication extends Application {
  private static final String AF_DEV_KEY = "qrdZGj123456789";
  @Override
  public void onCreate() {
    super.onCreate();
    AppsFlyerConversionListener conversionDataListener = 
    new AppsFlyerConversionListener() {
      ...
    };
    AppsFlyerLib.getInstance().waitForCustomerUserId(true);
    //WARNING! Removing above line doesn't cancel its effect.
    // Replace with this to stop waiting for CUID:
    // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
    AppsFlyerLib.getInstance().init(AF_DEV_KEY, getConversionListener(), getApplicationContext());
    AppsFlyerLib.getInstance().start(this);
    // Do your magic to get the customerUserID
    // ...
    // any AppsFlyer SDK code invoked here will be discarded
   //Call the following API once the customerUserID is available:
 AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this);
  }
}

class AFApplication: Application() {
 private val afDevKey = ""

 override fun onCreate() {
  super.onCreate()
  val conversionDataListener = object: AppsFlyerConversionListener {
   ...
  }
  AppsFlyerLib.getInstance().waitForCustomerUserId(true);
  //WARNING! Removing above line doesn't cancel its effect.
  // Replace with this to stop waiting for CUID:
  // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
  AppsFlyerLib.getInstance().init(afDevKey, conversionDataListener, this)
  AppsFlyerLib.getInstance().start(this)
  // Do your magic to get the customerUserID
  // ...
  // any AppsFlyer SDK code invoked here will be discarded
  // Call the following API once the customerUserID is available:
  AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id", this)
 }
}

Para saber mais sobre como adiar a inicialização do SDK até que o ID de usuário cliente esteja disponível, acesse aqui.

A partir da versão 4.8.0 do SDK, a AppsFlyer coleta automaticamente a google_advertising_id.

O requisito para coletar esse código de publicidade do Google é relevante apenas para as versões 4.7.X ou inferiores do SDK.

Pelo menos um identificador de dispositivo exclusivo deve ser coletado para ativar a atribuição. Os seguintes identificadores estão disponíveis: GAID, ID do Android, IMEI e OAID.

GAID - Google Advertising ID (ID de publicidade do Google)

Coletado automaticamente de aplicativos que contêm o Google Play Services. Se o GAID estiver disponível , o IMEI e o ID do Android NÃO devem ser coletados pelo aplicativo para evitar a violação da política do Google Play.

IMEI e Android ID

Desabilitado por padrão. Pode ser coletado APENAS para aplicativos que NÃO contêm o Google Play Services
Observação: A partir do Android 10 (API nível 29), lançado no final de 2019, o acesso ao parâmetro IMEI é restrito.

Para enviar esses IDs para a AppsFlyer:

1. No aplicativo, abra Coletar IMEI do dispositivo e/ou ID do Android.
2. Chame as seguintes APIs ANTES de chamar o método start:
   

   AppsFlyerLib.getInstance().setImeiData("IMEI_HERE");
   AppsFlyerLib.getInstance().setAndroidIdData("ANDROID_ID_HERE");

OAID - Open Advertiser Identifier (Identificador aberto de anunciante)

Guia para implementar o OAID

Desativando a coleta de ID do dispositivo

Os desenvolvedores podem optar por não coletar IMEI, ID do Android e OAID usando as seguintes APIs: 

AppsFlyerLib.getInstance().setCollectIMEI(false);
AppsFlyerLib.getInstance().setCollectAndroidID(false);
AppsFlyerLib.getInstance().setCollectOaid(false);

Em alguns casos extremos, talvez seja necessário encerrar todos os registros do SDK devido à conformidade legal e de privacidade. Isso pode ser obtido com a API stop. Depois que essa API é chamada, o SDK para de funcionar e não se comunica mais com os servidores da AppsFlyer.

AppsFlyerLib.getInstance().stop(true, getApplicationContext());

AppsFlyerLib.getInstance().stop(true, applicationContext);

Há vários cenários diferentes para a exclusão (opt-out) de usuários. É altamente recomendado seguir as instruções exatas do cenário relevante para seu aplicativo.

O SDK pode ser reativado chamando:

AppsFlyerLib.getInstance().stop(false, getApplicationContext());
AppsFlyerLib.getInstance().start(getApplicationContext(), <AF_DEV_KEY>);

AppsFlyerLib.getInstance().stop(false, applicationContext);
AppsFlyerLib.getInstance().start(applicationContext, <AF_DEV_KEY>);

Não chame start se stop estiver definido como true. Você pode verificar o estado atual do SDK chamando:

AppsFlyerLib.getInstance().isStopped() // retorna true se o SDK for interrompido, caso contrário retorna false

AppsFlyerLib.getInstance().isStopped // returns true if SDK is stopped, false otherwise

Use esta API durante a inicialização do SDK para anonimizar explicitamente as instalações, eventos e sessões de um usuário:

public void anonymizeUser(boolean isDisabled);

Exemplo de uso:

AppsFlyerLib.getInstance().anonymizeUser(true);

O registro pode ser reiniciado chamando AnonymizeUser definido como false.

Em alguns casos, os anunciantes podem querer parar de compartilhar dados no nível do usuário com ad networks/parceiros para determinados usuários. Os motivos para isso incluem: 

• Políticas de privacidade como CCPA ou GDPR
• Mecanismos para o usuário optar por não participar
• Concorrência com alguns parceiros (ad networks, terceiros)

A AppsFlyer fornece dois métodos de API para interromper o compartilhamento de dados com alguns ou todos os parceiros:

• SetSharingFilter: usado por anunciantes para definir algumas (uma ou mais) redes/parceiros integrados para excluir da obtenção de dados.
• SetSharingFilterForAllPartners: usado por anunciantes para excluir todas as redes/parceiros integrados da obtenção de dados.

Esses métodos de filtragem são suportados a partir do SDK V5.4.1.

O método de filtragem deve ser chamado sempre que o SDK é inicializado e afeta a sessão toda. Se demorar para determinar se você precisa definir os filtros de compartilhamento, adie a inicialização do SDK. 

Quando o método for ativado antes do primeiro start chame:

• Os usuários de SRNs são atribuídos como orgânicos e seus dados não são compartilhados com parceiros integrados.
• Os usuários de ad networks de cliques (não-SRNs) são atribuídos corretamente na AppsFlyer, mas não são compartilhados com as ad networks por meio de postbacks, APIs, relatórios de dados brutos ou por qualquer outro método.

Atualmente, os dados de desinstalação não podem ser filtrados usando esses métodos. No entanto, você pode parar de enviar eventos de desinstalação para parceiros usando suas páginas de configuração na AppsFlyer.