Intégration SDK Android pour développeurs

Utilisez l'une des méthodes suivantes pour ajouter le SDK à votre app :

• [Méthode conseillée] Utiliser Gradle
• Ajout manuel du SDK

Le référent d'installation Android améliore la précision de l'attribution, protège contre les installations frauduleuses et bien plus encore. Il est pris en charge par le SDK Android AppsFlyer version 4.8.6.

Il existe deux façons d'ajouter le référent d'installation à votre app :

• Utiliser Gradle (recommandé)
• Ajouter manuellement le référent d'installation

L'ajout d'autorisations permet d'augmenter le taux d'attribution de modélisation probabiliste. Cela permet au SDK d'envoyer plus de données telles que les données de réseau Wi-Fi ou d'opérateurs. Vous pouvez trouver ces données dans les rapports de données brutes et les utiliser pour l'analyse et l'optimisation des campagnes.

Ajoutez les autorisations requises

1. Ajoutez les autorisations suivantes à 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" />
   

Le BroadcastReceiver obtient des informations de Google Play qu'AppsFlyer utilise pour l'attribution. L'utilisation du BroadcastReceiver augmente le taux d'attribution.

Les deux options suivantes sont disponibles pour mettre en place le récepteur de diffusion du référent d'installation :

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

AppsFlyer utilise la clé dev pour identifier votre compte de manière unique. La clé dev est obligatoire car elle permet au SDK d'envoyer et de récupérer en toute sécurité des données appartenant à votre compte AppsFlyer.

Attention ! En utilisant la mauvaise clé dev, ou une clé dev incorrecte, tout le trafic envoyé depuis le SDK est impacté, ce qui génère des problèmes d'attribution et de reporting.

Pour récupérer votre clé dev :

1. Allez au tableau de bord de votre app 
2. Sur le tableau de bord, sous Configuration, cliquez sur Paramètres d'app.
3. Copiez votre clé dev.
   

   

Enregistrer la classe d'apps globale

Dans le fichier AndroidManifest.xml, à l'intérieur de la balise application, ajoutez la ligne suivante :

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

• <APP.PACKAGE.NAME> - remplacez cette expression par le nom de package de l'app.
• <AFApplication> - remplacez cette valeur par le nom que vous avez défini pour la classe globale d'apps.

Cette ligne du fichier manifest.xml indique à l'application quelle est l'application globale. Comme mentionné ci-dessus, cela rend le SDK d'AppsFlyer globalement accessible dans l'ensemble de l'app.

Initialiser le SDK

Nous vous recommandons d'initialiser le SDK dans la classe d'applications globale de l'app. Cela permet au SDK de s'initialiser dans tous les scénarios, y compris le deep linking.

Les étapes ci-dessous sont à effectuer dans la classe d'applications globale de l'app.

1. Dans la classe globale de l'app, importez les bibliothèques suivantes
   

   import com.appsflyer.AppsFlyerLib;
   import com.appsflyer.AppsFlyerConversionListener;

2. Dans la classe globale, attribuez votre clé dev à une variable, de préférence nommée AF_DEV_KEY. 
   Java Kotlin

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

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

3. Dans la classe globale, après avoir appelé super.onCreate(), implémentez le code AppsFlyerConversionListener. Consultez le code ci-dessous à l'étape 4.
4. À l'intérieur de la classe globale, après ConversionListener, initialisez le SDK avec la méthode 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. Dans la classe globale de l'app, appelez start().
   
   Java Kotlin

   AppsFlyerLib.getInstance().start(this);
   

   AppsFlyerLib.getInstance().start(this)

Pour retarder l'initialisation du SDK, vous pouvez appeler start depuis la classe Activity.

Cette méthode peut être utilisée si, par exemple, vous devez reporter le démarrage de start en attendant le consentement de l'utilisateur vis-à-vis du RGPD, de la CCPA, etc.

Lorsque vous invoquez start dans la classe Activity :

• Assurez-vous de transmettre l'instance Activity en tant qu'argument et non en tant qu'Application.
• Si vous prévoyez d'utiliser les fonctions de deep linking, ajoutez l'API start() à tout autre élément Activity que vous pouvez deep-linker et qui ne contient pas start.

Avant de commencer à tester les installations, enregistrez l'appareil de test.

Les installations organiques sont des installations non attribuées qui sont généralement des installations directes à partir des app stores.

Pour simuler une installation organique :

1. Assurez-vous qu'un appareil mobile est connecté à votre ordinateur
2. Dans Android Studio, ouvrez le Logcat.
3. Depuis Android Studio, installez l'application sur l'appareil ou l'émulateur.
4. Attendez que l'application se lance.
5. Dans le Logcat, recherchez le nom du package de votre app.

Vous devriez voir ce qui suit :

La partie en surbrillance dans la capture d'écran indique que le SDK signale une installation organique. Ces données proviennent de la méthode onConversionDataSuccess de la classe AFApplication. L'obtention des données de conversion est mentionnée plus loin dans ce guide.

Remarque : depuis le SDK V5, onConversionDataSuccess est le nom de la méthode d'obtention des données de conversion. Si vous utilisez une version du SDK antérieure à 5.0.0, le nom de la méthode est onInstallConversionDataLoaded. Nous vous recommandons une mise à niveau vers le SDK 5.0.0. Pour en savoir plus, cliquez ici.

Une installation organique doit désormais apparaître sur la page Présentation du tableau de bord de l'application.

Si vous ne voyez pas l'installation sur le tableau de bord de l'app, consultez notre guide de dépannage du SDK.

Une installation non organique est une installation attribuée qui suit généralement un engagement publicitaire. Vous pouvez simuler une installation non organique en utilisant des liens d'attribution.

Pour simuler une installation non organique :

1. Dans le manifeste, recherchez le nom du package de votre app, par exemple, com.company.app.
   • Dans l'URL ci-dessous, remplacez <app_id> par le nom du package de votre app :
     

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

     Par exemple :

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

   • Le paramètre c indique renvoie au nom de la campagne.
   • Le paramètre pid indique le nom de la source média à laquelle l'installation est attribuée.
   • L'ID publicitaire (GAID) doit être ajouté si vous testez le clic depuis un ordinateur (an ajoutant &advertising_id=<GAID> à la fin du lien à l'étape 1).
2. Envoyez cette URL à l'appareil.  Vous pouvez effectuer cette opération via email ou WhatsApp, par exemple. 
3. Sur l'appareil, cliquez sur l'URL.
   • Si l'application est répertoriée dans l'app store, vous serez redirigé vers l'app store. Ne téléchargez et n'installez pas l'app depuis l'app store. Passez à l'étape 5.
   • Si l'app n'est pas répertoriée dans l'app store et est encore en développement, l'écran affiche un message indiquant que l'app n'est pas disponible dans l'app store. Passez à l'étape 5.
4. Dans Android Studio, ouvrez le Logcat.
5. Connectez l'appareil à votre ordinateur à l'aide d'un câble USB.
6. Depuis Android Studio, installez l'app sur l'appareil.
7. Dans le Logcat, recherchez le nom du package de votre app.

Vous devriez voir ce qui suit :

Une installation non organique apparait dorénavant sur la page Présentation du tableau de bord de l'application.

Le SDK possède deux interfaces liées aux évènements in-app :

• AFInAppEventType - constantes pour les noms d'événements in-app
• AFInAppEventParameterName - constantes pour les noms des paramètres d'évènements in-app

Nous recommandons fortement d'utiliser ces deux interfaces pour les raisons suivantes :

• La dénomination standard permet à AppsFlyer de mapper automatiquement les évènements sur des SRN tels que Facebook, Google, Twitter et Snapchat.
• Rétrocompatibilité - si AppsFlyer décide de modifier le nom ou le paramètre d'un évènement, votre implémentation est compatible avec les version antérieures.

Pour utiliser ces deux interfaces, importez-les :

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

Voici la liste des noms et structures d'évènements recommandés.

Vous pouvez envoyer des revenus avec n'importe quel évènement in-app. Utilisez le paramètre d'évènement af_revenue (AFInAppEventParameterName.REVENUE) pour intégrer le revenu dans l'évènement in-app. Vous pouvez lui affecter n'importe quelle valeur numérique, positive comme négative.

af_revenue est le seul paramètre d’évènement qu'AppsFlyer compte en tant que revenu réel dans les données brutes et le tableau de bord. Pour plus de détails, veuillez cliquer ici.

Lors de l'envoi d'évènements avec revenus, pensez aux éléments suivants :

• Si vous définissez un code de devise (voir exemple ci-dessous), il doit s'agir d'un code ISO 4217 de 3 caractères. (la valeur par défaut est USD).
• Vous pouvez définir le code devise pour tous les événements en appelant la méthode suivante : AppsFlyer.setCurrencyCode("ZZZ") Pour en savoir plus sur les paramètres de devise, l'affichage et la conversion de devise, consultez notre guide sur la devise du revenu.
• La valeur de revenu ne doit pas contenir de séparateurs sous forme de virgules, de symbole monétaire ou de texte. Un événement de revenu doit être similaire à 1234.56, par exemple.

Exemple : évènement d'achat d'évènement in-app avec revenus

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)

L’événement d’achat ci-dessus a un revenu de 1234,56 $ qui lui est associé et qui apparait comme revenu dans le tableau de bord.

Enregistrement de revenus négatifs

Dans certaines situations, vous voudrez peut-être enregistrer un revenu négatif.

Par exemple, un utilisateur reçoit un remboursement pour des chaussures qu'il a acheté chez vous.

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)

Le SDK d'AppsFlyer procède à une validation au niveau du serveur pour les achats in-app. Pour valider un achat, appelez la méthode validateAndLogInAppPurchase.

Cet appel génère automatiquement un évènement in-app af_purchase si l'achat est validé.

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

Paramètres de la méthode

• String publicKey - clé publique de la console développeur Google
• String signature – signature de transaction (renvoyée de l'API Google lorsque l'achat est terminé)
• String purchaseData – produit acheté en format JSON (renvoyé de l'API Google lorsque l'achat est terminé)
• String price – revenu de l'évènement in-app à signaler à AppsFlyer.
• String currency – devise de l'évènement in-app à signaler à AppsFlyer
• HashMap<String, String> additionalParameters – paramètres supplémentaires de l'évènement in-app qui apparaissent dans le champ event_value des données brutes de l'évènement in app.

Rappels de réussite et d'échec de validation d'achat

Lorsque vous voulez savoir si la tentative de validation d'un achat est réussie ou non, implémentez registerValidatorListener dans votre classe d'applications. Ce port d'écoute contient deux blocs de rappel, l'un pour la « réussite » et l'autre pour « l'échec » (quelle qu'en soit la raison, y compris l'échec de validation).

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")
   }
})

Exemple de validation d'un achat :

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

La validation d'un achat in-app envoie automatiquement un évènement d'achat in-app à AppsFlyer. Vous trouverez ci-dessous un exemple des données transmises dans le paramètre 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
}

• Nom de l'événement : 45 caractères maximum
• Valeur de l'événement : ne doit pas dépasser 1000 caractères - s'il est plus long, nous pourrions le tronquer
• Tarification et revenu : utilisez uniquement des chiffres et des décimales, par exemple 5 ou 5,2.
• Les valeurs de tarification et de revenu peuvent comporter jusqu'à 5 chiffres après le symbole de décimale, par exemple, 5.12345
• Les caractères non anglais sont pris en charge, dans les événements in-app, d'autres SDK d'API, à partir du SDK Android V4.8.1.

Vous pouvez enregistrer des évènements in-app en appelant trackEvent avec le nom de l'évènement et les paramètres de valeur. Consultez la documentation Événements in-app pour plus de détails.

Vous trouverez ci-dessous un exemple simple sur la façon d'enregistrer un évènement d'achat. Pour obtenir une liste complète des extraits de code prêts à l'emploi par secteur, consultez notre guide concernant les évènements rich in-app par secteur.

Exemple : évènement d'achat 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)

Si un utilisateur initie un évènement lorsque la connexion Internet est indisponible, Appsflyer est capable de l'enregistrer. Le fonctionnement est le suivant :

1. Le SDK envoie les événements aux serveurs AppsFlyer et attend une réponse.
2. Si le SDK ne reçoit pas une réponse 200, l'événement est stocké dans le cache.
3. Une fois que la réponse 200 suivante est reçue, l'événement stocké est renvoyé au serveur.
4. S'il y a plusieurs événements dans le cache, ils sont envoyés au serveur les uns après les autres.

Vous pouvez définir un port d'écoute lors de l'enregistrement d'événements in-app. Le port d'écoute vous permet de définir une logique pour deux cas :

• Événement in-app enregistré avec succès.
• Une erreur s'est produite lors de l'enregistrement d'un événement 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)
            }
        })

En cas d'erreur lors de l'enregistrement de l'événement in-app, un code d'erreur et une description de la chaîne sont fournis, comme indiqué dans le tableau qui suit.

OneLink détecte le type d'appareil lors du clic et redirige l'utilisateur vers une destination correspondante, par exemple, Google Play, app store iOS, marchés out-of-source ou pages Web.

Le guide sur les redirections OneLink aborde l'implémentation de liens d'attribution multiplate-forme (aucun codage SDK nécessaire). C'est également la base du deep linking.

Le deep linking vous permet d'envoyer les utilisateurs vers des activités spécifiques tout en leur offrant un contenu personnalisé. Cette fonction est particulièrement utile lors de l'exécution de campagnes de retargeting.

Pour configurer le deep linking avec OneLink, un marketeur ayant accès au tableau de bord d'AppsFlyer et un développeur ayant accès à l'app doivent travailler ensemble.

Consultez notre guide de configuration du deep linking avec OneLink.

Le deep linking différé vous permet d'effectuer le deep link des nouveaux utilisateurs et de leur offrir du contenu personnalisé après l'installation de l'app. Il est différent du deep linking habituel pour lequel l'app doit déjà être installée sur l'appareil de l'utilisateur.

Pour configurer le deep linking différé avec OneLink, le développeur doit également avoir accès au tableau de bord d'AppsFlyer.

La configuration du deep linking différé est la même que celle du deep linking. La seule différence est que vous devez implémenter une logique supplémentaire dans l'app de façon à pouvoir effectuer le deep link des utilisateurs et leur offrir du contenu personnalisé après installation et lancement de l'application.

Consultez notre guide sur le deep linking différé pour en savoir plus.

Le SDK vous fournit les données de conversion ou d'engagement après chaque installation ou évènement de deep linking. Vous pouvez utiliser ces données pour personnaliser du contenu et le comportement de l'app par programme.

Pour obtenir des données de deep linking lorsque le deep linking direct est utilisé et que l'app est ouverte, implémentez la méthode onAppOpenAttribution .

Pour obtenir manuellement des données de réengagement de deep linking à tout moment, implémentez la méthode performOnAppAttribution .Cela permet d'accéder aux données de réengagement sans avoir à enregistrer un nouveau réengagement.

Consultez notre guide sur les données de deep linking pour en savoir plus.

La méthode addPushNotificationDeepLinkPath offre une interface flexible aux propriétaires d'app pour configurer comment les deep links sont extraits des charges utiles des notifications push.

Par défaut, le SDK recherche une valeur de deep link dans la clé af de la charge utile JSON d'une notification push. Cependant, de nombreux fournisseurs de services de push utilisent des schémas propriétaires JSON que le SDK ne peut pas décoder sans configuration supplémentaire.

addPushNotificationDeepLinkPath vous permet de configurer quelle clé de la charge utile de la notification push sera utilisée par le SDK pour obtenir la valeur du deep link.

Veuillez utiliser cette méthode si vous intégrez votre app avec des fournisseurs de services de push qui n'utilisent pas le schéma JSON de notification push qui convient par défaut au SDK.

En appelant addPushNotificationDeepLinkPath, le SDK vérifie que :

• La clé requise est présente dans la charge utile.
• La clé contient une URL OneLink valide.

addPushNotificationDeepLinkPath doit impérativement être appelé avant d'appeler start()

Configuration de base

Prenez l'appel vers addPushNotificationDeepLinkPath suivant

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

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

ainsi que ces scénarios.

Scénario 1

Votre app est invoquée via notification push. Elle contient une charge utile structurée comme suit.

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

Dans ce cas, le SDK extrait la valeur de deep_link et procède au flux de deep linking.

Scénario 2

Votre app est invoquée via notification push. Elle contient une charge utile structurée comme suit.

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

Dans ce cas précis, lorsque l'appel s'exécute, le SDK ne peut pas trouver la clé deep_link dans la charge utile. En conséquence, rien ne se produit.

Scénario 3

Votre app est invoquée via notification push. Elle contient une charge utile structurée comme suit.

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

Dans ce cas, bien que le SDK trouve la clé deep_link , sa valeur de deep link est invalide. Il en résulte que, lorsque l'appel ci-dessus s'exécute, rien ne se produit.

Configuration avancée

Pour configurer différentes structures de charge utile possibles, appelez addPushNotificationDeepLinkPath plusieurs fois :

• Le premier appel qui soumettra une valeur de deep link valide sera utilisé
• Les autres appels seront ignorés

Si aucune des structures de la charge utile ne correspond, ou si aucune URL OneLink valide ne peut être trouvée dans la charge utile, rien ne se produit.

Prenons par exemple la charge utile suivante

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

ainsi que les appels suivants à 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");

Avec AppsFlyer, vous pouvez attribuer des installations pour des applications Android out-of-store. Cela vous permet de promouvoir vos applications et de toucher de plus larges audiences sur les marchés où Google Play n'est pas disponible. 

Pour plus de détails sur la façon d'attribuer des installations pour les applications out-of-store, cliquez ici.

Dans les campagnes de pré-installation, les propriétaires d'applications peuvent demander aux fabricants d'appareils de pré-installer leurs applications sur les appareils avant leur départ de l'usine.

Avec AppsFlyer, vous pouvez facilement attribuer les installations d'applications pré-installées. Lorsque les utilisateurs lancent votre application pour la première fois, AppsFlyer attribue l'installation au fabricant en tant que source média.

Pour plus de détails, veuillez cliquer ici.

Pour connaître la façon de configurer la mesure des désinstallations, cliquez ici.

Si vous souhaitez recevoir la confirmation que la demande a bien été reçue par les serveurs AppsFlyer, implémentez le port d'écoute AppsFlyerRequestListener.

La méthode de callback onRequestSuccess() est appelée toutes les 200 response (200 réponses) dans le cadre d'une demande d'attribution effectuée par le SDK.

La méthode de callback onRequestFailure(String error) est appelée pour toute autre réponse et renvoie la réponse sous forme de chaîne d'erreur.

Exemple d'implémentation

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

En cas d'erreur lors de l'enregistrement de l'événement in-app, un code d'erreur et une description de la chaîne sont fournis, comme indiqué dans le tableau qui suit.

L'API setAdditionalData est requise pour l'intégration au niveau SDK avec plusieurs plates-formes partenaires externes, dont Segment, Adobe et Urban Airship.
Utilisez cette API uniquement si l'article d'intégration de la plate-forme indique spécifiquement que l'API setAdditionalData est requise.

Exemple de code 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)

Les propriétaires d'app qui utilisent des App Links pour le deep linking (sans OneLink), et qui ont un domaine associé à leur app, peuvent attribuer des sessions initiées à partir de ce même domaine grâce à la méthode appendParametersToDeepLinkingURL.

Prenons comme exemple un utilisateur qui lance une recherche sur Google puis clique sur votre domaine, www.example.com :

• Si l'utilisateur n'a pas encore installé l'application, il est dirigé vers le site (www.example.com).
• Si l'utilisateur a installé l'app sur son appareil, il est deep linké à l'application qui est associée à www.example.com. La session est attribuée à la source média (paramètre pid ) qui est spécifiée dans appendParametersToDeepLinkingURL.

Voir la référence du SDK Android pour plus d'informations.

Remarque : les bannières intelligentes permettent aux propriétaires d'app d'augmenter la conversion des visiteurs d'un site en utilisateurs d'app.

Par défaut, il doit s'écouler au moins 5 secondes entre deux lancements d'apps pour que cela soit considéré comme deux sessions distinctes (pour en savoir plus sur le comptage de session).

Utilisez l'API suivante pour définir la durée minimale entre les sessions :

AppsFlyerLib.setMinTimeBetweenSessions(int seconds);

Le fait de définir une valeur élevée à la durée personnalisée entre les lancements peut avoir un impact négatif sur les API qui s'appuient sur les données de session, comme le deep linking.

Vous pouvez signaler de nouvelles sessions utilisateur à l'aide de cette méthode de SDK. Par exemple, cela peut être utile pour les applications utilitaires qui s'exécutent en arrière-plan.

Utilisez cette API dans la fonction onCreate() de votre activité :

public void logSession(Context context);

Exemple d'utilisation :

AppsFlyerLib.getInstance().logSession(context);

Certains services tiers tels que les prestataires de services de messagerie encapsulent des liens dans des emails avec leurs propres domaines d'enregistrement des clics. Certains vous permettent même de définir vos propres domaines d'enregistrement des clics. Si OneLink est encapsulé dans de tels domaines, il est possible que ses fonctionnalités soient limitées.

Pour résoudre ce problème, vous pouvez utiliser l'API setResolveDeepLinkURLs. Utilisez cette API pour obtenir le OneLink des domaines de clic qui lancent l'application.  Assurez-vous d'appeler cette API avant d'initialiser le SDK.

Par exemple, vous avez trois domaines de clic qui redirigent vers votre OneLink : https://mysubdomain.onelink.me/abCD. Utilisez cette API pour obtenir le OneLink vers lequel vos domaines de clic redirigent.  Cette méthode d'API reçoit une liste de domaines que le SDK résout. Ajoutez le code suivant avant l'initialisation du SDK.

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

Le code ci-dessus vous permet d'utiliser votre domaine de clic tout en conservant les fonctionnalités de OneLink. Les domaines de clic sont responsables du lancement de l'application. En retour, l'API obtient le OneLink de ces domaines de clic. Vous pouvez ensuite utiliser les données de ce OneLink pour le deep linking et personnaliser le contenu de l'utilisateur.

Avec AppsFlyer, vous pouvez mesurer les notifications push dans le cadre de campagnes de retargeting.

Pour activer cette fonctionnalité, appelez la méthode sendPushNotificationData dans la méthode onCreate de chaque activité lancée à la suite d'un clic sur la notification :

AppsFlyerLib.getInstance().sendPushNotificationData(this);

Pour plus d'informations concernant la mesure des notifications push, veuillez lirececi.

Le fait de permettre à vos utilisateurs existants d'inviter leurs amis et contacts en tant que nouveaux utilisateurs de votre application peut être un facteur de croissance important pour votre application. Avec AppsFlyer, vous pouvez attribuer et enregistrer les installations provenant d'invitations utilisateur au sein de votre app.

Pour obtenir plus d'informations, reportez-vous à l'article concernant l'attribution des invitations utilisateur.

Un ID AppsFlyer est créé pour chaque nouvelle installation d’une application. Vous pouvez utiliser l'ID AppsFlyer à différentes fins :

• Envoyez des événements in-app serveur à serveur.
• Faites correspondre l'ID AppsFlyer et les enregistrements utilisateur dans vos systèmes en arrière-plan.
• Mappez les entrées au moment de la fusion des données de l'API Pull et de l'API Push.

Utilisez l’API suivante pour obtenir l’ID AppsFlyer :

public String getAppsFlyerUID(Context context);

Exemple d'utilisation :

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

Pour définir votre ID Utilisateur-Client :

public void setCustomerUserId(String id);

Exemple d'utilisation :

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

Nous vous recommandons de définir l'ID utilisateur du client au début du flux de l'app, car il est uniquement associé aux évènements rapportés après son installation :

• Si setCustomerUserId est appelé avant start, l'ID utilisateur du client apparaîtra dans les rapports de données brutes relatifs aux installations et aux évènements.
• S'il est défini après, l'ID utilisateur du client est uniquement associé aux évènements enregistrés après la définition de l'ID utilisateur du client.

Obtenir l'ID Utilisateur-Client :

Pour éviter de redéfinir la valeur de l'ID utilisateur du client après le premier lancement et réduire le nombre d'appels à votre serveur afin d'obtenir l'ID utilisateur du client, vous pouvez vérifier si sa valeur est vide ou non en utilisant :

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

Pour plus d’informations sur l’ID Utilisateur-Client, cliquez ici.

Retarder l'initialisation du SDK dans l'attente du customerUserID

Il est possible d'attendre que le customerUserID soit défini pour lancer l'initialisation du SDK.

Pour indiquer que le SDK doit retarder l'initialisation dans l'attente de l'ID utilisateur du client, appelez :

AppsFlyerLib.getInstance().waitForCustomerUserId(true);

immédiatement avant la méthode init(). Le reste de l'initialisation du SDK doit rester inchangé.

Une fois le customerUserID fourni, appelez

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

afin de fournir au SDK l'ID utilisateur du client approprié et de déclencher le SDK.

Le code doit apparaître comme suit :

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

Pour en savoir plus sur la façon de retarder l'initialisation du SDK jusqu'à ce que l'ID utilisateur du client soit disponible, cliquez ici.

AppsFlyer collecte automatiquement le google_advertising_id depuis la version 4.8.0 du SDK.

L'obligation de collecte de l'ID Google Advertising s'applique uniquement aux versions 4.7.X et supérieures du SDK.

Un identifiant unique d'appareil au minimum doit être collecté pour activer l'attribution. Les identifiants suivants sont disponibles : GAID, ID Android, IMEI et OAID.

GAID - Google Advertising ID

Recueilli automatiquement dans les apps qui contiennent les services Google Play. Si le GAID est disponible, l'IMEI et l'ID Android ne doivent PAS être collectés par l'app afin d'éviter toute violation de la réglementation Google Play.

Numéro IMEI et ID Android

Désactivé par défaut.Peut être collecté UNIQUEMENT pour les apps qui ne contiennent AUCUN service Google Play.
Remarque : depuis Android 10 (niveau 29 de l'API), sorti fin 2019, l'accès au paramètre IMEI est restreint.

Pour envoyer ces ID à AppsFlyer :

1. Sur l'application ouverte, collectez l'IMEI et / ou l'ID Android de l'appareil.
2. Appelez les API suivantes AVANT d'appeler la méthode start :
   

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

OAID - Open Advertiser Identifier

Guide de mise en œuvre de l'OAID

Désactiver la collecte d'ID d'appareil

Les développeurs peuvent choisir de ne pas collecter les IMEI, ID Android et OAID en utilisant les API suivantes :

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

Dans certains cas extrêmes, vous pouvez décider d'arrêter toute identification via SDK en raison d'une mise en conformité juridique ou relative à la vie privée. L'API stop permet cette interruption. Une fois cette API appelée, le SDK cesse de fonctionner et ne communique plus avec les serveurs AppsFlyer.

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

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

Il existe différents scénarios d'exclusion d'utilisateurs. Nous recommandons vivement de suivre les instructions exactes du scénario qui correspond à votre application.

Le SDK peut être réactivé en appelant :

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'appelez pas start si stop est défini sur true. Vous pouvez vérifier l'état actuel du SDK en appelant :

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

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

Utilisez cette API lors de l'initialisation du SDK pour anonymiser explicitement les installations, les évènements et les sessions d'un utilisateur :

public void anonymizeUser(boolean isDisabled);

Exemple d'utilisation :

AppsFlyerLib.getInstance().anonymizeUser(true);

L'identification peut être redémarrée en appelant anonymizeUser réglé sur false.

Dans certains cas, les annonceurs peuvent choisir de cesser le partage de données de niveau utilisateur avec des réseaux publicitaires/partenaires pour certains utilisateurs. Parmi les motifs on retrouve : 

• Les politiques de confidentialité telles que la CCPA ou le RGPD
• Les mécanismes de retrait des utilisateurs
• La concurrence avec certains partenaires (ad networks, tiers)

AppsFlyer fournit deux méthodes d'API pour arrêter le partage de données avec l'ensemble des partenaires ou avec certains d'entre eux :

• setSharingFilter : utilisée par les annonceurs pour définir certains (un ou plusieurs) réseaux/partenaires intégrés à exclure de l'obtention de données.
• setSharingFilterForAllPartners : utilisée par les annonceurs pour exclure tous les réseaux/partenaires intégrés de l'obtention de données.

Ces méthodes de filtrage sont prises en charge à partir de la version 5.4.1 du SDK.

La méthode de filtrage doit être appelée à chaque fois que le SDK est initialisé et affecte la session entière.  Si un délai est requis pour déterminer si vous devez définir les filtres de partage, mieux vaut retarder l'initialisation du SDK. 

Lorsque la méthode est activée avant le premier appel start :

• Les utilisateurs des SRN sont attribués comme organiques, et leurs données ne sont pas partagées avec les partenaires intégrés.
• Les utilisateurs des réseaux publicitaires par clic (non-SRN) sont attribués correctement dans AppsFlyer, mais ne sont pas partagés avec ceux-ci via postback, API, rapport de données brutes, ou toute autre méthode.

Actuellement, les données de désinstallation ne peuvent pas être filtrées à l'aide de ces méthodes. Vous pouvez toutefois arrêter d'envoyer des événements de désinstallation aux partenaires en utilisant leurs pages de configuration dans AppsFlyer.