Guia de integração do SDK do Unity para desenvolvedores

Use este link do Github para fazer o download do plugin:  https://github.com/AppsFlyerSDK/Unity.

1. Importe o AppsFlyerUnityPlugin.unitypackage para o seu projeto Unity.
   
2. Vá paraRecursos> Importar Pacote >Pacote Personalizado.
3. Selecione o arquivo  AppsFlyerUnityPlugin.unitypackage

Sua chave do desenvolvedor da AppsFlyer é única e identifica sua conta. Somente o administrador da conta pode recuperar a chave do desenvolvedor.

Seu uso é obrigatório porque permite que o SDK envie e recupere com segurança dados que pertencem à sua conta da AppsFlyer.

Fazer:

1. Vá para a plataforma da AppsFlyer.
2. Na barra de menu, vá em  Configuração e clique em Definições do Aplicativo.
3. Em Instalação do SDK, copie sua chave do desenvolvedor.
   

   

Etapa 1: Crie um objeto vazio da AppsFlyer

Para inicializar o SDK crie um objeto vazio da AppsFlyer.

1. No menu superior, selecione GameObject > Criar Vazio.
2.  Selecione o objeto e nomeie-o AppsFlyerObject.
3. Clique em Adicionar componente.
4. Escolha Novo script e denomine  AppsFlyerObject.

Etapa 2: adicione o código init ao AppsFlyerObject

Insira o seguinte código no novo script que você criou na etapa 1.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
public class AppsFlyerObject : MonoBehaviour {
   void Start () {
   /* Mandatory - set your AppsFlyer’s Developer key. */
   AppsFlyer.setAppsFlyerKey ("YOUR_APPSFLYER_DEV_KEY");
   /* For detailed logging */
   /* AppsFlyer.setIsDebug (true); */
   #if UNITY_IOS
      /* Mandatory - set your apple app ID
      NOTE: You should enter the number only and not the "ID" prefix */
      AppsFlyer.setAppID ("YOUR_APP_ID_HERE");
      AppsFlyer.getConversionData();
      AppsFlyer.trackAppLaunch ();
   #elif UNITY_ANDROID
     /* For getting the conversion data in Android, you need to add the "AppsFlyerTrackerCallbacks" listener.*/
     AppsFlyer.init ("YOUR_APPSFLYER_DEV_KEY","AppsFlyerTrackerCallbacks");
  #endif
   }
}

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
public class Apps FlyerObject : MonoBehaviour {
  void Start () {
     /* Mandatory - set your AppsFlyer’s Developer key. */
     AppsFlyer.setAppsFlyerKey ("YOUR_APPSFLYER_DEV_KEY");
     /* For detailed logging */
     /* AppsFlyer.setIsDebug (true); */
     #if UNITY_IOS
        /* Mandatory - set your apple app ID
        NOTE: You should enter the number only and not the "ID" prefix */
        AppsFlyer.setAppID ("YOUR_APP_ID_HERE");
        AppsFlyer.getConversionData();
        AppsFlyer.trackAppLaunch ();
     #elif UNITY_ANDROID
        AppsFlyer.init ("YOUR_APPSFLYER_DEV_KEY");
     #endif
   }
}

Etapa 3:crie um objeto AppsFlyerTrackerCallbacks vazio

1. No menu superior, selecione GameObject > Criar Vazio.
2.  Selecione o objeto e nomeie-o AppsFlyerTrackerCallbacks.
3. Clique em Adicionar componente.
4. Selecione o script AppsFlyerTrackerCallbacks.

Etapa 4: especifique o pacote Android no projeto do Unity

1. No Unity, clique em Arquivo>Criar Definições.
2. Escolha Plataforma Android> Definições do Jogador.
3. Abaixo de Jogador, selecione Outras Definições>Identificação>Nome do Pacote.
4. Especifique o nome do pacote Android no campo Nome do Pacote.

Primeiro, inclua na lista branca o dispositivo que você usará para testar as instalações.

Instalações orgânicas são instalações não atribuídas; normalmente são o resultado de instalações feitas diretamente por meio de lojas de aplicativos.

Para simular uma instalação orgânica, consulte as instruções relevantes do sistema operacional:

• Android
• iOS

Instalações não orgânicas são instalações atribuídas; elas geralmente são o resultado de um engajamento de anúncio. 

Para simular uma instalação não orgânica (usando links de atribuição), consulte as instruções relevantes do sistema operacional.

• Android
• iOS

Para enviar eventos:

• Especifique o nome e os parâmetros do evento.
• Veja as listas relacionadas: 
  • Lista de nomes e estruturas de eventos recomendados
  • Lista encontrada na classe AFInAppEvents.

Prática recomendada! Use nomes de eventos e parâmetros pelos seguintes motivos:

• Nomeação padrão: AppsFlyer pode automaticamente mapear eventos para SRNs, como Facebook, Google, Twitter e Snapchat.
• Compatibilidade com versões anteriores:  Não há problema se a AppsFlyer alterar um nome ou parâmetro de evento, pois sua implementação é compatível com versões anteriores.

Envie receita com qualquer evento in-app usando o parâmetro do evento af_revenue :

• Preenchaaf_revenue com qualquer valor numérico, positivo ou negativo.
• É o ÚNICO parâmetro de evento considerado como receita real nos relatórios de dados brutos e no painel. 
  Clique aqui para mais detalhes. 

Boas práticas! Saiba mais sobre configurações de moeda, exibição e conversão de moeda.

Considere estes fatores de código de moeda ao enviar eventos com receita:

• Moeda padrão: USD
• Defina códigos de moeda como 3-character ISO 4217 code (veja o exemplo abaixo).
• Defina o código de moeda para todos os eventos chamando esta API:
  

  AppsFlyer.setCurrencyCode("ZZZ")

• Os valores da receita não podem conter separadores de vírgula, símbolos de moeda ou texto.
  Exemplo de evento de receita: 1234.56

Exemplo: Evento de compra in-app com receita

Este evento de compra tem $200 em receita e aparece como receita no painel.

System.Collections.Generic.Dictionary<string, string> purchaseEvent = new  
System.Collections.Generic.Dictionary<string, string> ();
purchaseEvent.Add(AFInAppEvents.CURRENCY, "USD");
purchaseEvent.Add(AFInAppEvents.REVENUE, "200");
purchaseEvent.Add(AFInAppEvents.QUANTITY, "1");
purchaseEvent.Add(AFInAppEvents.CONTENT_TYPE, "category_a",);
AppsFlyer.trackRichEvent ("af_purchase", purchaseEvent);

Gravar receita negativa

Às vezes, é necessário gravar a receita negativa. O código abaixo apresenta o seguinte:

• O valor da receita é precedido por um sinal de menos.
• O nome do evento tem um valor único, "cancel_purchase". Isso permite que você identifique eventos de receitas negativas nos relatórios de dados brutos e no painel.

Exemplo: um usuário do aplicativo recebe um reembolso ou cancela uma assinatura.

System.Collections.Generic.Dictionary<string, string> purchaseEvent = new  
System.Collections.Generic.Dictionary<string, string> ();
purchaseEvent.Add(AFInAppEvents.CURRENCY, "USD");
purchaseEvent.Add(AFInAppEvents.REVENUE, "-200");
purchaseEvent.Add(AFInAppEvents.QUANTITY, "1");
purchaseEvent.Add(AFInAppEvents.CONTENT_TYPE, "category_a");
AppsFlyer.trackRichEvent ("cancel_purchase", purchaseEvent);

O SDK da AppsFlyer fornece verificação do servidor para compras in-app.

Para validar uma compra, veja as instruções relevantes do sistema operacional:

//To get the callbacks
AppsFlyer.createValidateInAppListener ("AppsFlyerTrackerCallbacks", 
"onInAppBillingSuccess", "onInAppBillingFailure");
AppsFlyer.validateReceipt(string publicKey, string purchaseData,
string signature, string price, string currency, Dictionary additionalParameters);

AppsFlyer.createValidateInAppListener ("AppsFlyerTrackerCallbacks", 
                                     "onInAppBillingSuccess", 
                                     "onInAppBillingFailure");

if (Debug.isDebugBuild) {
   AppsFlyer.setIsSandbox(true);
}
AppsFlyer.validateReceipt(string productIdentifier, 
              string price,string currency,string transactionId, 
              Dictionary additionalParameters);

Parâmetros do método

• Nome do evento: máximo de 45 caracteres
• Valor do evento: não deve exceder 1000 caracteres - caso exceda, pode ser necessário restringi-lo.
• Suporta caracteres que não estão em inglês para eventos no aplicativo (e outras APIs do SDK) a partir da versão 4.8.1 para iOS e Android
• Preços e receita:
  • Use somente números e decimais como 5 ou 5.2
  • Até 5 números após o decimal, como 5.12345

Grave eventos in-app chamando trackRichEvent e inclua o nome do evento e os parâmetros de valor.
Para mais detalhes, veja In-app events .

Exemplo: Como gravar um evento de compra in-app

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.

System.Collections.Generic.Dictionary<string, string> purchaseEvent = new  
System.Collections.Generic.Dictionary<string, string> ();
purchaseEvent.Add(AFInAppEvents.CURRENCY, "USD");
purchaseEvent.Add(AFInAppEvents.REVENUE, "200");
purchaseEvent.Add(AFInAppEvents.QUANTITY, "2");
purchaseEvent.Add(AFInAppEvents.CONTENT_TYPE, "category_a");
purchaseEvent.Add(AFInAppEvents.CONTENT_ID, "092");
AppsFlyer.trackRichEvent (AFInAppEvents.PURCHASE, purchaseEvent);

Às vezes os usuários produzem eventos in-app enquanto estão sem conexão com a internet. No entanto, a AppsFlyer é capaz de gravar o evento. Como isso 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. Após receber o próximo 200 como resposta, o evento armazenado em cache é reenviado ao servidor.
4. Se o cache armazena múltiplos eventos, eles são enviados ao servidor um após o outro.

OneLink:

• Detecta o tipo de dispositivo (Android e iOS, desktop etc.) quando um usuário clica e, então,
• redireciona o usuário para o destino correto: Google Play, loja de aplicativos do iOS, mercados fora da loja ou páginas da web.

Para implementar links de atribuição multiplataforma (sem necessidade de codificação SDK) e revisar os conceitos básicos de links diretos, veja o guia de  Redirecionamento OneLink.

Use links diretos para direcionar usuários existentes a atividades específicas e conteúdo personalizado. 

O proprietário do aplicativo e o desenvolvedor devem trabalhar juntos para configurar links diretos com o OneLink:

• O proprietário do aplicativo deve acessar o painel da AppsFlyer
• O desenvolvedor deve acessar o aplicativo

Veja Como definir links diretos com o OneLink.

A ligação direta adiada permite fazer links diretos com novos usuários para direcioná-los a atividades específicas e conteúdo customizado com a primeira inicialização de uma instalação do aplicativo. 

O link direto padrão também direciona os usuários para atividades específicas e conteúdo personalizado, mas um aplicativo já deve estar instalado no dispositivo do usuário.

Para configurar uma ligação direta adiada com o OneLink:

• O desenvolvedor precisa ter acesso à plataforma da AppsFlyer.
• A configuração da plataforma AppsFlyer para links diretos adiados e padrão é a mesma.
• É necessário implementar lógica adicional no aplicativo para aplicar link direto aos usuários e provê-los com conteúdo personalizado após a instalação e a inicialização do aplicativo.

Confira ligação direta adiada para mais informações.

O SDK da AppsFlyer fornece os dados de conversão ou engajamento após cada instalação ou evento de links diretos. Use esses dados para personalizar o conteúdo e/ou o comportamento programático do aplicativo.

Para receber dados de link direto:

• Implemente o callback onAppOpenAttribution(encontrado na classe AppsFlyerTrackerCallbacks) que é chamado pelo SDK da AppsFlyer.
• Os parâmetros OneLink/link de atribuição retornados acionam a abertura de um aplicativo.
• Analise os valores e aplique a lógica para acionar a página do aplicativo relevante.

public void onAppOpenAttribution(string validateResult) {
	print ("AppsFlyerTrackerCallbacks:: got onAppOpenAttribution = " + validateResult);
}

Confira dados de links diretos para mais informações.

Meça as taxas de desinstalações de usuários provenientes de diferentes fontes. Esse importante KPI permite que você analise e otimize suas campanhas.

Para saber como configurar as métricas de desinstalação, veja as instruções relevantes do sistema operacional.

void Start () {
  // register to push notifications
    UnityEngine.iOS.NotificationServices.RegisterForNotifications(UnityEngine.iOS.NotificationType.Alert | UnityEngine.iOS.NotificationType.Badge | UnityEngine.iOS.NotificationType.Sound);
    Screen.orientation = ScreenOrientation.Portrait;
}  void Update () {
    if (!tokenSent) { // tokenSent needs to be defined somewhere (bool tokenSent = false)
      byte[] token = UnityEngine.iOS.NotificationServices.deviceToken;      
      if (token != null) {   
        AppsFlyer.registerUninstall (token);
        tokenSent = true;
      }
    }  
}

Para fazer a integração no nível do SDK com várias plataformas de parceiros externos (incluindo Segment, Adobe e Urban Airshop), é necessário usar a API setAdditionalData.

Use esta API apenas se o artigo de integração do parceiro afirmar especificamente que a API setAdditionalData é necessária.

Exemplo: códigosetAdditionalData 

Dictionary<string, string> CustomDataMap = new Dictionary<string, string>();
CustomDataMap.Add("custom_param_1", "value_of_param_1");
AppsFlyer.setAdditionalData(CustomDataMap);

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. Use esta API para definir o tempo mínimo entre sessões:

AppsFlyer.setMinTimeBetweenSessions(custom_time_ins_seconds);

Atenção! Se você definir um valor alto para o tempo personalizado entre inicializações, isso pode gerar um impacto negativo nas APIS que dependem dos dados das sessões (como os links diretos).

Veja mais sobre como contar sessões de aplicativo.

Indisponível no Unity.

Alguns serviços de terceiros (como provedores de serviço de e-mail):

• Encurtam links em e-mails usando seus próprios domínios de gravação de cliques.
• Permitem que você defina seus próprios domínios de gravação de links.

No entanto, se o OneLink estiver agrupado nesses domínios, isso poderá limitar sua funcionalidade. Para não ter esse problema:

• Chame a API setResolveDeepLinkURLs antes da inicialização do SDK.
• A API obtém o OneLink de domínios de cliques que iniciam o aplicativo. 

Cenário: três domínios de clique redirecionam para seu OneLink em  https://mysubdomain.onelink.me/abCD.

Solução:

• Use a API setResolveDeepLinkURLs para obter o OneLink alcançado após os domínios de clique redirecionarem um usuário do aplicativo.
• Esse método de API recebe uma lista de domínios que o SDK resolve.
• O código a seguir permite usar seu domínio de clique sem deixar de preservar a funcionalidade do OneLink:

   Exemplo

  AppsFlyer.setResolveDeepLinkURLs("example.com", "click.example.com");

Agora, use os dados deste OneLink para fazer links diretos e personalizar o conteúdo do usuário.

Gravar notificação push como parte de suas campanhas de retargeting.

Para gravar notificação push:

• Chame o método sendPushNotificationData.
• Esse método está dentro do método onCreate de cada atividade iniciada após clicar nesta notificação:

handlePushNotification(Dictionary<string, string> payload)

Para mais informações, leia sobre  métricas de notificação push.

Se você permite que os usuários existentes convidem seus amigos e contatos para se tornarem novos usuários, isso 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. Veja  atribuição de convite do usuário.

Aplicativos de promoções cruzadas podem ser um importante fator de crescimento para impulsionar novas instalações para seus aplicativos.

Com a AppsFlyer, você pode atribuir e gravar instalações originadas de uma campanha de promoção cruzada—promova um de seus aplicativos a partir de outro de seus aplicativos já iniciados por um de seus usuários. Veja atribuição de promoções cruzadas.

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 com os registros de usuário em seus sistemas de back-end.
• Mapear entradas ao mesclar dados das APIs pull e push .

Use esta API para obter um ID exclusivo da AppsFlyer:

string AppsFlyerUID = AppsFlyer.getAppsFlyerId();

Configure seu próprio ID de usuário exclusivo (CUID) e faça referência cruzada com um ID exclusivo da AppsFlyer.

CUID exclusivo: 

• Aparece nos relatórios de dados brutos da AppsFlyer.
• Pode ser usado em APIs de postback para referência cruzada com seus IDs internos.

Para configurar seu CUID, use:

AppsFlyer.setCustomerUserID("someId");

Boas práticas! Configure o CUID no início do fluxo do aplicativo—ele está associado apenas a eventos relatados após sua configuração.

Chame  setCustomerUserId antesde chamarstartTracking

• Eventos gravados serão associados ao CUID.
• Dados relacionados aparecerão nos relatórios de dados brutos para instalações e eventos.

AppsFlyer.setCustomerUserID("someId");

Obter ID de usuário cliente

Confira CUID para mais informações.

Atrasar init do SDK para customerUserID

Configure o ID de usuário cliente (CUID) e só depois inicialize o SDK. Isso é útil se você deseja que os dados de instalação e eventos contenham seu CUID.

Veja as instruções relevantes do sistema operacional:

1. Android
2. iOS

Cenários diferentes, tais como problemas de conformidade legal e de privacidade, podem levar à decisão de optar por não participar e interromper todo o acompanhamento de SDK. 

Melhores práticas!Siga as  instruções exatasdo cenário relevante para seu aplicativo.

Para interromper o acompanhamento:

• Chame  isStopTracking e defina como verdadeiro.
  

  AppsFlyer.stopTracking(true);

• O SDK para de funcionar e não se comunica mais com os servidores da AppsFlyer.

Para reativar o acompanhamento: ChameisStopTrackinge defina como falso.

Para anonimizar um usuário do aplicativo:

1. Defina a API durante a inicialização do SDK
2. Chame deviceTrackingDisabled e defina comoverdadeiro.
   

   AppsFlyer.setDeviceTrackingDisabled(true);

3. Instalação de usuários do aplicativo, eventos e sessões serão anonimizados.

Para reiniciar o acompanhamento: ChamedeviceTrackingDisabled e defina comofalso.