Guía de integración del plugin de Unity V4 para desarrolladores

Usa este enlace de Github para descargar el plugin:  https://github.com/AppsFlyerSDK/Unity.

1. Importa AppsFlyerUnityPlugin.unitypackage a tu proyecto de Unity.
   
2. Ve a Activos > Importar paquete > Paquete personalizado.
3. Selecciona el archivo AppsFlyerUnityPlugin.unitypackage .

Tu clave de desarrollador de AppsFlyer es única e identifica tu cuenta. Solo los administradores de cuentas pueden recuperar tu clave de desarrollador. 

Su uso es obligatorio porque permite que el SDK envíe y recupere datos que pertenecen a tu cuenta de AppsFlyer de manera segura.

Para hacer esto:

1. Ve a la plataforma de AppsFlyer.
2. En la barra de menú, ve a Configuración y haz clic en Configuración de la aplicación.
3. En Instalación del SDK, copia tu clave de desarrollador.
   

   

Paso 1: crea un objeto vacío de AppsFlyer

Para inicializar el SDK, crea un objeto vacío de AppsFlyer.

1. En el menú superior selecciona GameObject > Crear vacío.
2.  Selecciona el objeto y asígnale el nombre AppsFlyerObject.
3. Haz clic en Agregar componente.
4. Elige Script nuevo y asígnale el nombre AppsFlyerObject.

Paso 2: Agrégale el código de inicio a AppsFlyerObject

Pon el siguiente código en el script nuevo que creaste en el paso 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
   }
}

Paso 3: Crea un objeto AppsFlyerTrackerCallbacks vacío

1. En el menú superior selecciona GameObject > Crear vacío.
2.  Selecciona el objeto y asígnale el nombre AppsFlyerTrackerCallbacks.
3. Haz clic en Agregar componente.
4. Selecciona el script AppsFlyerTrackerCallbacks.

Paso 4: Especifica el paquete de Android en el proyecto Unity

1. En Unity, haz clic en File > Build Settings.
2. Elige Android Platform > Player Settings.
3. En Player, selecciona Other Settings > Identification > Package Name.
4. Especifica el nombre del paquete de Android en el campo Nombre del paquete.

Primero, agrega a la lista blanca el dispositivo que usarás para probar las instalaciones.

Las instalaciones orgánicas son instalaciones sin atribuir que, por lo general, son instalaciones que se hacen directamente desde las tiendas de aplicaciones.

Para simular una instalación orgánica, consulta las instrucciones pertinentes del sistema operativo:

• Android
• iOS

Las instalaciones no orgánicas son instalaciones atribuidas que, por lo general, son el resultado del engagement de un anuncio. 

Para simular una instalación no orgánica (mediante enlaces de atribución), consulta las instrucciones pertinentes del sistema operativo:

• Android
• iOS

Para enviar eventos:

• Especifica el nombre y los parámetros del evento.
• Ver listas relacionadas: 
  • Lista de estructuras y nombres de eventos recomendados.
  • Lista encontrada en la clase AFInAppEvents.

¡Práctica recomendada! Usa nombres y parámetros de eventos por los siguientes motivos:

• Nomenclatura estándar: AppsFlyer puede asignar automáticamente eventos a redes de autorreporte (SRN) como Facebook, Google, Twitter y Snapchat.
• Compatibilidad con versiones anteriores: no tendrás problemas si AppsFlyer decide cambiar el nombre o parámetro del evento, dado que tu implementación es compatible con las versiones anteriores.

Enviar ingresos con cualquier evento in-app utilizando el parámetro del evento af_revenue:

• Rellenar af_revenue con cualquier valor numérico, positivo o negativo.
• Es el ÚNICO de los parámetros de eventos considerado como ingresos reales en reportes de raw data y en el panel de control. 
  Haz clic aquí para obtener más detalles. 

¡Práctica aconsejable! Obtén información sobre la configuración, visualización y conversión de divisas.

Considera estos factores de códigos de divisa al enviar eventos con ingresos:

• Divisa predeterminada: USD
• Establece los códigos de divisa como un código ISO 4217 de 3 caracteres (consulta el ejemplo a continuación).
• Establece el código de divisa para todos los eventos llamando a esta API:
  

  AppsFlyer.setCurrencyCode("ZZZ")

• El valor de los ingresos no puede contener comas para separar, signos de divisas ni texto.
  Ejemplo de evento de ingresos: 1234.56

Ejemplo: evento de compra in-app con ingresos

Este evento de compra tiene asociados ingresos de $200 y aparece como ingresos en el panel de control.

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);

Registro de ingresos negativos

En ocasiones, se requiere registrar ingresos negativos. El siguiente código presenta lo siguiente:

• El valor de ingresos está precedido por un signo menos.
• El nombre del evento tiene un valor único, "cancel_purchase". Esto te permite identificar los eventos con ingresos negativos en los reportes de raw data y en el panel de control.

Ejemplo: un usuario de la aplicación recibe un reembolso o cancela una suscripción.

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);

El SDK de AppsFlyer proporciona verificación de servidor para las compras in-app.

Para validar una compra, consulta las instrucciones pertinentes del sistema operativo:

//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 de método

• Nombre del evento: máximo de 45 caracteres.
• Valor del evento: no debe superar los 1000 caracteres; si es más largo, es probable que lo trunquemos.
• Admite caracteres no ingleses para eventos in-app (y otras API del SDK) a partir de la versión 4.8.1 para iOS y Android.
• Precios e ingresos:
  • Solo usa números y decimales como 5 o 5.2.
  • Hasta 5 números después del decimal, p. ej. 5.12345.

Puedes atribuir eventos in-app al llamar a trackRichEvent con los parámetros de valor y nombre de evento.
Para más detalles, consulta Eventos in-app.

Ejemplo: cómo atribuir un evento de compra in-app.

Para ver una lista completa de fragmentos de código listos por segmento vertical, consulta nuestra guía de eventos in-app enriquecidos por segmento vertical.

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);

En ocasiones, los usuarios producen eventos in-app cuando no están conectados a Internet. Sin embargo, AppsFlyer puede atribuir dicho evento. ¿Cómo funciona?

1. El SDK envía los eventos a los servidores de AppsFlyer y espera una respuesta.
2. Si el SDK no recibe una respuesta 200, el evento se almacena en el caché.
3. Una vez recibida la respuesta 200, el evento almacenado en el caché se vuelve a enviar al servidor.
4. Si hay múltiples eventos en el caché, se envían al servidor uno tras otro.

OneLink:

• Detecta el tipo de dispositivo (Android e iOS, escritorio, etc.) cuando un usuario hace clic.
• Redirige al usuario al destino correspondiente: Google Play, tienda de aplicaciones de iOS, mercados fuera de la tienda o páginas web.

Para implementar enlaces de atribución multiplataforma (no se requiere codificación del SDK) y revisar los conceptos básicos de enlaces profundos, consulta la guía Redireccionamiento de OneLink.

Usa enlaces profundos para dirigir a los usuarios existentes a actividades específicas y contenido personalizado. 

El propietario y desarrollador de una aplicación deben trabajar juntos para configurar enlaces profundos con OneLink:

• El propietario de la aplicación debe acceder al panel de control de AppsFlyer.
• El desarrollador debe acceder a la aplicación.

Consulta nuestra guía sobre configuración de enlaces profundos con OneLink.

Los enlaces profundos diferidos te permiten establecer enlaces profundos con usuarios nuevos y ofrecerles actividades específicas y contenido personalizado después del primer inicio de una instalación de la aplicación. 

Los enlaces profundos estándar también dirigen a los usuarios a actividades específicas y contenido personalizado, pero una aplicación ya debe estar instalada en el dispositivo del usuario.

Para configurar los enlaces profundos diferidos con OneLink:

• El desarrollador debe acceder a la plataforma de AppsFlyer.
• La configuración de la plataforma de AppsFlyer para enlaces profundos diferidos y estándar es la misma.
• Se necesita implementar una lógica adicional en la aplicación a fin de establecer enlaces profundos con los usuarios y ofrecerles contenido personalizado después de que instalen e inicien la aplicación.

Consulta enlaces profundos diferidos para obtener más información.

El SDK de AppsFlyer te proporciona los datos de conversión o engagement después de cada evento de enlaces profundos o instalación. Puedes usar estos datos para personalizar el contenido o el comportamiento de la aplicación de manera programática.

Para recibir datos de enlaces profundos:

• Implementa el callback onAppOpenAttribution (que aparece en la claseAppsFlyerTrackerCallbacks), solicitado por el SDK de AppsFlyer.
• Los parámetros en el enlace de atribución/Onelink devueltos activan la apertura de la aplicación.
• Analiza los valores y aplica la lógica para abrir la página de la aplicación pertinente.

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

Consulta datos de enlaces profundos para obtener más información.

Mide la tasa de desinstalaciones de usuarios provenientes de distintas fuentes. Este importante KPI te ayuda a analizar y optimizar tus campañas.

Para saber cómo configurar la medición de desinstalaciones, consulta las instrucciones pertinentes del sistema operativo.

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 integrar en el nivel del SDK con varias plataformas de partners externos (incluidos Segment, Adobe y Urban Airship), es necesario utilizar la API setAdditionalData.

Usa esta API solo si el artículo de integración del partner indica que es necesaria la API setAdditionalData.

Ejemplo: código setAdditionalData

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

De manera predeterminada, deben pasar por lo menos 5 segundos entre dos instancias de inicio de la aplicación para que cuenten como dos sesiones separadas. Usa la siguiente API para establecer el tiempo mínimo entre sesiones:

AppsFlyer.setMinTimeBetweenSessions(custom_time_ins_seconds);

Nota:Si estableces un valor alto para el tiempo personalizado entre inicios podría afectar negativamente las API que dependen de los datos de sesión, como los enlaces profundos.

Obtén más información acerca del recuento de sesiones de una aplicación.

No está disponible en Unity.

Algunos servicios de terceros (como proveedores de servicios de correo electrónico):

• Encapsulan enlaces en correos electrónicos utilizando sus propios dominios de registro de clics.
• Te permiten configurar tus propios dominios de registro de clics.

Sin embargo, si OneLink está encapsulado en tales dominios, su funcionalidad podría verse limitada. Para superar esto debes:

• Llamar a la API setResolveDeepLinkURLs antes de la inicialización del SDK.
• La API obtiene el OneLink de los dominios de clics que inician la aplicación. 

Situación: tres dominios de clics te redirigen a tu OneLink en https://mysubdomain.onelink.me/abCD.

Solución:

• Usa la API setResolveDeepLinkURLs para obtener el OneLink que se alcanza después de que los dominios de clic redirigen a un usuario de la aplicación.
• Este método de API recibe una lista de dominios que el SDK resolverá.
• El siguiente código te permite usar tu dominio de clic y, al mismo tiempo, preservar la funcionalidad de OneLink:

   Ejemplo

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

Ahora, usa los datos de este OneLink para crear un enlace profundo y personalizar el contenido del usuario.

Atribuye notificaciones push como parte de tus campañas de retargeting.

Para atribuir notificaciones push:

• Llama al método sendPushNotificationData.
• Este método está dentro del método onCreate de cada actividad que se inicia tras hacer clic en la notificación:

handlePushNotification(Dictionary<string, string> payload)

Para obtener más información, lee sobre la medición de notificaciones push.

Si permites que los usuarios existentes de la aplicación inviten a sus amigos y contactos como usuarios nuevos, esto puede ser un factor de crecimiento clave para tu aplicación.

Con AppsFlyer, puedes atribuir y registrar instalaciones que se originen a partir de invitaciones de usuarios dentro de tu aplicación. Consulta atribución de invitaciones de usuarios.

Las aplicaciones de promoción cruzada pueden ser un importante factor de crecimiento para generar instalaciones adicionales para tus aplicaciones.

Con AppsFlyer, puedes registrar y atribuir instalaciones originadas en una campaña de promoción cruzada: promocionar una de tus aplicaciones dentro de otra que ya haya iniciado uno de tus usuarios. Consulta atribución de promoción cruzada.

Un ID de AppsFlyer se crea para cada instalación nueva de una aplicación. Puedes usar este ID de AppsFlyer con diversos fines:

• Enviar eventos in-app de servidor a servidor.
• Vincularlo con los registros de usuarios en tus sistemas de backend.
• Asignar entradas cuando se fusionan datos de las API de extracción y envío (Pull/Push API).

Usa esta API para obtener un ID único de AppsFlyer:

string AppsFlyerUID = AppsFlyer.getAppsFlyerId();

Configura tu propio ID de usuario de cliente (CUID) único y haz una referencia cruzada con un ID único de AppsFlyer.

CUID único: 

• Aparece en los reportes de raw data en formato CSV.
• También se puede usar en las API de postback para establecer referencias con tus ID internos.

Para configurar tu CUID, usa lo siguiente:

AppsFlyer.setCustomerUserID("someId");

¡Práctica aconsejable! Configura el CUID lo antes posible en el flujo de tu aplicación, ya que solo se asocia con los eventos reportados después de su configuración.

Llama a setCustomerUserId antes de llamar a startTracking.

• Los eventos atribuidos se asociarán con el CUID.
• Los datos relacionados aparecerán en los reportes de raw data para instalaciones y eventos.

AppsFlyer.setCustomerUserID("someId");

Obtener un ID de usuario de cliente:

Consulta CUID para obtener más información.

Retrasar la inicialización del SDK para customerUserID

Configura el ID de usuario de cliente (CUID) y solo luego de ello inicializa el SDK. Esto es útil si deseas que los datos de instalación y eventos contengan tu CUID.

Consulta las instrucciones pertinentes del sistema operativo:

1. Android
2. iOS

Diferentes situaciones, como problemas de cumplimiento legal y de privacidad, pueden llevar a la decisión de optar por la exclusión opcional y detener todo el tracking del SDK. 

¡Práctica recomendada!Sigue las instrucciones exactas para la situación correspondiente a tu aplicación.

Para detener el tracking:

• Llama a isStopTracking y configúralo como verdadero.
  

  AppsFlyer.stopTracking(true);

• El SDK deja de funcionar y ya no se comunica con los servidores de AppsFlyer.

Para reactivar el tracking: llama a isStopTracking y configúralo como falso.

Para anonimizar a un usuario de la aplicación:

1. Configura la API durante la inicialización del SDK
2. Llama a deviceTrackingDisabled y configúralo como verdadero.
   

   AppsFlyer.setDeviceTrackingDisabled(true);

3. Las sesiones, los eventos y las instalaciones de un usuario de la aplicación están anonimizados.

Para reiniciar el tracking: llama a deviceTrackingDisabled y configúralo como falso.