Vue d'ensemble

AppsFlyerLib est la classe principale du SDK Android AppsFlyer, et encapsule la plupart des méthodes.

Revenez à l'index de référence du SDK.

Importez la bibliothèque

import com.appsflyer.AppsFlyerLib;

Accédez à l'instance du SDK

Accédez à l'instance SDK singleton :

AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();

Méthodes

addPushNotificationDeepLinkPath

Signature de la méthode

void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)

Description
Configurez comment le SDK extrait les valeurs de deep link des charges utiles de notification push.

Arguments d'entrée

TypeNomDescription
String...deepLinkPathUn tableau de Stringqui correspond au chemin JSON du deep link.

Retours
void.

Exemple d'utilisation
Configuration de base :

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link")

Configuration avancée :

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

Cet appel correspond à la structure de charge utile suivante :

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

anonymizeUser

Signature de la méthode

void anonymizeUser(boolean shouldAnonymize)

Description
Anonymiser les installations, évènements et sessions d'un utilisateur.

Arguments d'entrée

TypeNomDescription
booleanshouldAnonymizeLa valeur par défaut est false.

Retours
void

Exemple d'utilisation

AppsFlyerLib.getInstance().anonymizeUser(true);
AppsFlyerLib.getInstance().anonymizeUser(true)

appendParametersToDeepLinkingURL

Signature de la méthode

void appendParametersToDeepLinkingURL(java.lang.String contains,
                                                      java.util.Map<java.lang.String,java.lang.String> parameters)

Description
Enables app owners using App Links for deep linking (without OneLink) to attribute sessions initiated via a domain associated with their app.

🚧

Appelez cette méthode avant d'appeler start

Vous devez inscrire les paramètres suivants dans le champ parameters Map:

  • pid
  • is_retargeting doit être défini sur true

Arguments d'entrée

TypeNomDescription
Stringcontains Chaîne contenue dans l'URL du deep link
Map<String, String>parametersLes paramètres d'attribution à ajouter aux URL correspondantes

Retours
void

Exemple d'utilisation

HashMap<String, String> urlParameters = new HashMap<>();
urlParameters.put("pid", "exampleDomain"); // Required
urlParameters.put("is_retargeting", "true"); // Required
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com", urlParameters);
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com",
mapOf("pid" to "exampleDomain", "is_retargeting" to "true")) // Required

Dans l'exemple ci-dessus, l'URL d'attribution envoyée aux serveurs AppsFlyer qui en découle est :

example.com?pid=exampleDomain&is_retargeting=true

enableFacebookDeferredApplinks

Signature de la méthode

void enableFacebookDeferredApplinks(boolean isEnabled)

Description
Permet d'activer la collection des liens d'app différés Facebook. Requiert la présence du SDK Facebook et de l'app Facebook sur l'appareil cible/client.

Cette API doit être appelée avant l'initialisation du SDK AppsFlyer afin de fonctionner correctement. Arguments d'entrée

TypeNomDescription
booleanisEnabled Si les liens d'apps différés de Facebook sont traités par le SDK d'AppsFlyer.

Retours
void

enableLocationCollection

A été supprimé de la V6.8.0

Signature de la méthode

AppsFlyerLib enableLocationCollection(boolean flag)

Description
Permet au SDK AppsFlyer de récupérer le dernier emplacement connu. Requiert ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION Permissions du manifeste.

Arguments d'entrée

TypeNomDescription
booleanflag

Retours
void

enableTCFDataCollection

Signature de la méthode

AppsFlyerLib enableTCFDataCollection (boolean flag)

Description

Enables the collection of Transparency and Consent Framework (TCF) data from SharedPreferences. The data was placed in SharedPreferences by the device TCF v2.2 compatible Consent Management Platform (CMP).

Arguments d'entrée

TypeNomDescription
booleanflagA boolean value to enable (true) or disable (false) the collection of TCF data. The SDK collects TCF data when the flag is set to true.

Retours
void

getAppsFlyerUID

Signature de la méthode

java.lang.String getAppsFlyerUID(Context context)

Description
Pour obtenir l'ID d'appareil unique AppsFlyer. Le SDK génère un ID d'appareil unique AppsFlyer lorsque l'application est installée. Lorsque le SDK se lance, cet ID est enregistré comme étant l'ID de la première installation

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité

Retours
ID d'appareil unique d'AppsFlyer.

Exemple d'utilisation

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

getAttributionId

Signature de la méthode

java.lang.String getAttributionId(Context context)

Description
Produit l'identifiant d'attribution Facebook, s'il existe.

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'app/activité

Retours
void

Exemple d'utilisation

String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)

getHostName

Signature de la méthode

java.lang.String getHostName()

Description
Obtenir le nom d'hôte.
La valeur par défaut est appsflyer.com

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours

TypeDescription
StringNom d'hôte actuellement défini.

Exemple d'utilisation

getHostPrefix

Signature de la méthode

java.lang.String getHostPrefix()

Description
Obtenez le préfixe d'hôte personnalisé.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours
Préfixe d'hôte.

getInstance

Signature de la méthode

AppsFlyerLib getInstance()

Description
Renvoie l'instance du SDK, via laquelle vous pouvez accéder aux méthodes décrites dans ce document.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours
Instance singleton AppsFlyerLib.

getOutOfStore

Signature de la méthode

java.lang.String getOutOfStore(Context context)

Description
Obtenez la valeur de référent de l'app store tiers.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité

Retours
AF_Store valeur.

getSdkVersion

Signature de la méthode

java.lang.String getSdkVersion()

Description
Obtenez la version du SDK AppsFlyer utilisée dans l'app.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours
Version du SDK d'AppsFlyer.

init

Signature de la méthode

AppsFlyerLib init(java.lang.String key,
                                  AppsFlyerConversionListener conversionDataListener,
                                  Context context)

Description
Utilisez cette méthode pour initialiser le SDK AppsFlyer. Cette API doit être appelée à l'intérieur de l'application onCreate .

Arguments d'entrée

TypeNomDescription
StringkeyClé dev AppsFlyer
AppsFlyerConversionDataListenerconversionDataListener(Facultatif) implémentez AppsFlyerConversionDataListener pour accéder aux données de conversion d'AppsFlyer. Peut être nul.
ContextcontextContexte de l'app.

Retours
void

Exemple d'utilisation
Voir Initialisation du SDK.

isPreInstalledApp

Signature de la méthode

boolean isPreInstalledApp(Context context)

Description
Indicateur booléen à pré-installer par le fabricant.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité

Retours
boolean.

Exemple d'utilisation

isStopped

Signature de la méthode

boolean isStopped()

Description
Vérifiez si le SDK a été arrêté.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours

TypeDescription
boolean true si stoppé, false dans un autre cas.

Exemple d'utilisation

logAdRevenue

Added in v6.15.0
Signature de la méthode


public abstract void logAdRevenue(
            @NonNull AFAdRevenueData adRevenueData, 
            @Nullable Map<String, Object> additionalParameters
    );

Description

The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.

Paramètres entrants

NomTypeDescription
adRevenueDataAFAdRevenueDataAn object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method.
additionalParametersMap<String, Object>An optional dictionary containing additional parameters to log with the adRevenue event.

Retours

void.

AFAdRevenueData

An object that encapsulates all mandatory adRevenue data received from the mediation network.

Definition

data class AFAdRevenueData(
    val monetizationNetwork: String,
    val mediationNetwork: MediationNetwork,
    val currencyIso4217Code: String,
    val revenue: Double
)

AFAdRevenueData parameters

NomTypeDescription
monetizationNetworkChaîneThe monetization network name.
mediationNetworkMediationNetworkThe mediation network enum.
currencyIso4217CodeChaîneThe ad revenue event currency is a String validated against currencyIso4217Code
revenueDoubleThe ad revenue event amount.

MediationNetwork

NomTypeComments
ironsourceChaîne
applovinmaxChaîne
googleadmobChaîne
fyberChaîne
appodealChaîne
admostChaîne
toponChaîne
tradplusChaîne
yandexChaîne
chartboostChaîne
unityChaîne
customMediationChaîneLa solution de médiation ne figure pas dans la liste des partenaires de médiation pris en charge.
directMonetizationNetworkChaîneL'application s'intègre directement aux réseaux de monétisation sans aucune médiation.

logEvent

Signature de la méthode

void logEvent(Context context,
                              java.lang.String eventName,
                              java.util.Map<java.lang.String,java.lang.Object> eventValues)

Description
Enregistrer un événement in-app.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité
StringeventName Nom de l'événement
MapeventValues Valeurs de l'événement

Retours
void

Exemple d'utilisation

logEvent

Signature de la méthode

void logEvent(Context context,
                              java.lang.String eventName,
                              java.util.Map<java.lang.String,java.lang.Object> eventValues,
                              AppsFlyerRequestListener listener)

Description
Identique à logEvent, avec AppsFlyerRequestListener. HttpURLConnection.HTTP_OK du serveur
invoquera la méthode AppsFlyerRequestListener#onSuccess()
. AppsFlyerRequestListener#onError(int, String) renverra
l'erreur si elle se produit

Arguments d'entrée
Cette fonction ne prend aucun paramètre.
Renvoie
void

Exemple d'utilisation

logLocation

Signature de la méthode

void logLocation(Context context,
                                 double latitude,
                                 double longitude)

Description
Enregistrement manuel de l'emplacement de l'utilisateur.

Cette méthode crée un événement in-app af_location_coordinates avec af_lat and af_long comme paramètres d'événement.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité
doublelatitude LATITUDE
doublelongitude LONGITUDE

Retours
void

Exemple d'utilisation

logSession

Signature de la méthode

void logSession(Context ctx)

Description
Si votre app est une app utilitaire en arrière-plan, vous pouvez utiliser cette API dans l'élément onCreate() de votre activité pour enregistrer et envoyer manuellement une session.

Arguments d'entrée

TypeNomDescription
ContextctxContexte de l'app/activité

Exemple d'utilisation

public void logSession(Context context);
public void logSession(Context context)

Retours
void

onPause

Signature de la méthode

void onPause(Context context)

Description
Pour la plateforme Cocos2dx uniquement
Cocos2dx a son propre évènement applicationDidEnterBackground.
Par conséquent, onPause sera appelé depuis le C++ par JNI.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité

Retours
void

Exemple d'utilisation

performOnAppAttribution

Obsolète depuis la V6.3.2
Signature de la méthode

void performOnAppAttribution(Context context,
                                             java.net.URI link)

Description
Permet de corriger manuellement le deep linking.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité
java.net.URIlink Lien à corriger

Retours
void

Exemple d'utilisation

AppsFlyerLib.getInstance().performOnAppAttribution(context, uri);
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri)

performOnDeepLinking

Ajouté dans la V6.3.1+.

Signature de la méthode

 public void performOnDeepLinking(@NonNull Intent intent, @NonNull Context context);

Description
Active le déclenchement manuel pour la résolution des deep links. Cette méthode permet aux apps qui retardent l'appel de démarrage de résoudre les deep links avant le démarrage du SDK.

  • Si un DeepLinkListener est enregistré, il prend en charge le deep linking direct et différé
  • Si un AppsFlyerConversionListener est enregistré, il prend uniquement en charge le deep linking direct

Nous vous recommandons d'appeler cette fonction depuis Activityde onResumepour les activités qui peuvent être lancées via deep linking.
Remarque  : les deep links directs traités par cette API ne sont pas transmis au serveur.

Exemple d'utilisation

@Override
protected void onResume() {
  super.onResume();

  AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
  appsflyer.performOnDeepLinking(getIntent(),this);
}

Arguments d'entrée

TypeNomDescription
Intentintent
Contextcontext Contexte de l'app/activité

Retours
void

registerConversionListener

Signature de la méthode

void registerConversionListener(Context context,
                                                AppsFlyerConversionListener conversionDataListener)

Description
Pour enregistrer un port d'écoute des données de conversion. Vous pouvez également utiliser init pour enregistrer le port d'écoute.

Arguments d'entrée

TypeNomDescription
Contextcontext Contexte de l'app/activité
AppsFlyerConversionListenerconversionDataListenerThe AppsFlyerConversionListener à enregistrer.

Retours
void

Exemple d'utilisation

// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener);
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener)

Voici un exemple d'implémentation de AppsFlyerConversionListener.

registerValidatorListener (LEGACY)

Signature de la méthode

void registerValidatorListener(Context context,
                                               AppsFlyerInAppPurchaseValidatorListener validationListener)

Description
Permet d'enregistrer un port d'écoute de validation pour l'API validateAndLogInAppPurchase .

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'app/activité
AppsFlyerInAppPurchaseValidatorListenervalidationListenerThe AppsFlyerInAppPurchaseValidatorListener à enregistrer.

Retours
void

Exemple d'utilisation

sendAdRevenue (LEGACY)

Deprecated in v6.15.0

(Supported until SDK v6.14.2 For versions including and above v6.15.0 use logAdRevenue)

Signature de la méthode

void sendAdRevenue(Context context,
                                   java.util.Map<java.lang.String,java.lang.Object> eventValues)

Description

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'app/activité
Map<String, Object>validationListener

Retours
void

sendPushNotificationData

Signature de la méthode

void sendPushNotificationData(Activity activity)

Description
Permet de mesurer et obtenir les données des campagnes de notifications push. Appelez cette méthode dans la méthode onCreate des Activityqui sont lancés depuis les notifications push.

Arguments d'entrée

TypeNomDescription
ActivityactivityThe Activity qui est lancé par la notification.

Retours
void.

Exemple d'utilisation

setAdditionalData

📘

Calling setAddiotionalData before first launch will have the additional data included in installs, sessions, as well as in-app events.

Signature de la méthode

void setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> customData)

Description
Pour ajouter des données personnalisées à la charge utile des événements. S'affichera dans les rapports de données brutes. Arguments d'entrée

TypeNomDescription
HashMapcustomData

Retours
void.

setAndroidIdData

Signature de la méthode

void setAndroidIdData(java.lang.String aAndroidId)

Description
Par défaut, le numéro IMEI et l'ID Android ne sont pas collectés par le SDK si la version Android est supérieure à la version KitKat (4.4) et si l'appareil comprend Google Play Services. Utilisez cette API pour envoyer explicitement l'ID Android à AppsFlyer.

Arguments d'entrée

TypeNomDescription
StringaAndroidIdID d'appareil Android.

Retours
void

setAppId

Signature de la méthode

void setAppId(java.lang.String id)

Description

Arguments d'entrée

TypeNomDescription
StringidID de l'app Android.

Retours
void

setAppInviteOneLink

Signature de la méthode

void setAppInviteOneLink(java.lang.String oneLinkId)

Description
Définissez l'ID OneLink qui doit être utilisé pour attribuer une invitation utilisateur. Le lien généré pour l'invitation de l'utilisateur utilisera ce OneLink comme lien de base. Consultez Configurer OneLink pour l'attribution des invitations utilisateur.

Arguments d'entrée

TypeNomDescription
StringoneLinkIdID OneLink obtenu à partir du tableau de bord AppsFlyer.

Retours
void.

setCollectAndroidID

Signature de la méthode

void setCollectAndroidID(boolean isCollect)

Description
Active la collecte des ID Android. Force le SDK à collecter l'ID Android.

Arguments d'entrée

TypeNomDescription
booleanisCollectRéglez sur true pour accepter.

Retours
void.

setCollectIMEI

Signature de la méthode

void setCollectIMEI(boolean isCollect)

Description
Active la collecte des IMEI. Force le SDK à collecter l'IMEI.

Arguments d'entrée

TypeNomDescription
booleanisCollectRéglez sur true pour accepter.

Retours
void.

setCollectOaid

Signature de la méthode

void setCollectOaid(boolean isCollect)

Description
Accepter/refuser la collecte OAID. Par défaut, le SDK tente de collecter l'OAID.

Arguments d'entrée

TypeNomDescription
booleanisCollectLa valeur par défaut est true. Réglez sur false pour refuser.

Retours
void.

setConsentData

Signature de la méthode

AppsFlyerLib.getInstance().setConsentData(AppsFlyerConsent afConsent)

Description

Transfers consent data to the SDK.

Arguments d'entrée

TypeNomDescription
AppsFlyerConsentafConsentAn object containing user consent data

setCurrencyCode

Signature de la méthode

void setCurrencyCode(java.lang.String currencyCode)

Description
Définir le code de la devise locale de l'utilisateur pour les achats in-app. Le code de devise doit être un code ISO 4217 à 3 caractères.

Arguments d'entrée

TypeNomDescription
StringcurrencyCode3 character ISO 4217 code. Defaults to "USD".

Retours
void.

setCustomerIdAndLogSession

⚠️

Before calling this method, the method waitForCustomerUserId must be called

Signature de la méthode

void setCustomerIdAndLogSession(java.lang.String id,
                                                Context context)

Description
Permet de définir l'identifiant du client et de lancer le SDK.

Arguments d'entrée

TypeNomDescription
StringidID client.
StringcontextContexte de l'app/activité

Retours
void

setCustomerUserId

Signature de la méthode

void setCustomerUserId(java.lang.String id)

Description
Définir votre propre ID client vous permet de croiser votre propre ID unique avec l'ID unique d'AppsFlyer et les ID des autres appareils.
Cet ID est disponible dans les rapports de données brutes d'AppsFlyer et les API de postback, vous permettant de les croiser avec vos ID internes.

Arguments d'entrée

TypeNomDescription
StringidID client.

Retours
void.

setDebugLog

Signature de la méthode

void setDebugLog(boolean shouldEnable)

Description
Active les journaux de débogage pour le SDK AppsFlyer. Doit uniquement être défini sur true dans les environnements de développement.

Arguments d'entrée

TypeNomDescription
booleanshouldEnableLa valeur par défaut est false.

Retours
void.

Exemple d'utilisation

setDisableAdvertisingIdentifiers

Ajouté dans la V6.3.2
Signature de la méthode

void setDisableAdvertisingIdentifiers(boolean disable);

Description
Désactive la collecte du SDK pour divers ID publicitaires. Notamment le Google Advertising ID (GAID), l'OAID et de l'Amazon Advertising ID (AAID).

Arguments d'entrée

TypeNomDescription
booleandisableLa valeur par défaut est false.

Retours
void.

setDisableNetworkData

Ajout à la version V6.7.0
Signature de la méthode

void setDisableNetworkData(boolean disable);

Description
Permet de refuser la collecte depuis l'appreil du nom de l'opérateur réseau (opérateur) et du nom de l'opérateur sim.

Arguments d'entrée

TypeNomDescription
booleandisableLa valeur par défaut est false.

Retours
void.

setExtension

Signature de la méthode

void setExtension(java.lang.String extension)

Description
Les plug-ins et les extensions du SDK définiront ce champ.

Arguments d'entrée

TypeNomDescription
StringextensionNom de l'extension.

Retours
void.

setHost

Signature de la méthode

void setHost(java.lang.String hostPrefixName,
                             java.lang.String hostName)

DescriptionPour définir un hôte personnalisé. Remarque : à partir du SDK V6.10, si l'hôte est envoyé avec une valeur vide ou nulle, l'appel d'API est ignoré.

Arguments d'entrée

TypeNomDescription
StringhostPrefixNamePréfixe d'hôte.
StringhostNameNom de l'hôte.

Retours
void.

setImeiData

Signature de la méthode

void setImeiData(java.lang.String aImei)

Description
Par défaut, le numéro IMEI et l'ID Android ne sont pas collectés par le SDK si la version du système d'exploitation est supérieure à la version KitKat (4.4) et si l'appareil comprend Google Play Services.

Arguments d'entrée

TypeNomDescription
StringaImeiIMEI de l'appareil.

Retours
void.

setIsUpdate

Signature de la méthode

void setIsUpdate(boolean isUpdate)

Description
Permet de définir manuellement que l'app a été mise à jour.

Arguments d'entrée

TypeNomDescription
booleanisUpdate

Retours
void.

setLogLevel

Signature de la méthode

void setLogLevel(AFLogger.LogLevel logLevel)

Description
Définir le niveau de journal du SDK.

Arguments d'entrée

TypeNomDescription
StringlogLevelNiveau du journal.

Retours
void.

setMinTimeBetweenSessions

Signature de la méthode

void setMinTimeBetweenSessions(int seconds)

Description
Définissez une valeur personnalisée pour fixer la durée minimum entre chaque sessions.

Arguments d'entrée

TypeNomDescription
intsecondsDéfinit le laps de temps qui s'écoule au minimum entre deux lancements de l'app pour que les sessions soient considérées comme distinctes. S’il n’est pas défini, le temps minimum par défaut entre les sessions est de 5 secondes.

Retours
void.

setOaidData

Signature de la méthode

void setOaidData(java.lang.String oaid)

Description
Par défaut, l'OAID n'est pas collecté par le SDK. Utilisez cette API pour envoyer explicitement l'ID Android à AppsFlyer.

Arguments d'entrée

TypeNomDescription
StringoaidOAID de l'appareil.

Retours
void.

setOneLinkCustomDomain

Signature de la méthode

void setOneLinkCustomDomain(java.lang.String... domains)

Description
Afin que le SDK AppsFlyer puisse résoudre les paramètres d'attribution masqués (décodés en ID de lien court), tout domaine configuré en tant que domaine de marque dans le tableau de bord AppsFlyer doit être indiqué dans cette méthode.

Arguments d'entrée

TypeNomDescription
String...domainsTableau des domaines que le SDK doit traiter comme des domaines de marque (le SDK essaiera de les résoudre comme des OneLinks).

Retours
void.

setOutOfStore

Signature de la méthode

void setOutOfStore(java.lang.String sourceName)

Description
Spécifier l'app store alternative depuis laquelle l'app a été téléchargée.

Arguments d'entrée

TypeNomDescription
StringsourceNameNom de l'app store tiers.

Retours
void.

Exemple d'utilisation

AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")

setPartnerData

Signature de la méthode

void setPartnerData(@NonNull String partnerId, Map<String, Object> data);

Description
Permet d'envoyer des données personnalisées pour l'intégration des partenaires.

Arguments d'entrée

TypeNomDescription
StringpartnerIdID du partenaire (généralement avec le suffixe « _int »).
MapdataLes données client dépendent de la configuration de l'intégration avec le partenaire concerné.

Retours
void.

Exemple d'utilisation

Map<String, Object> partnerData = new HashMap();
partnerData.put("puid", "123456789");
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData);
val partnerData = mapOf("puid" to "123456789")
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData)

setPhoneNumber

Signature de la méthode

void setPhoneNumber(java.lang.String phoneNumber)

Description
Sera envoyé sous la forme d'une chaîne cryptée SHA-256.

Arguments d'entrée

TypeNomDescription
StringphoneNumber

Retours
void.

setPreinstallAttribution

Signature de la méthode

void setPreinstallAttribution(java.lang.String mediaSource,
                                              java.lang.String campaign,
                                              java.lang.String siteId)

Description
Indiquer le nom du fabricant ou de la source média à qui la pré-installation est attribuée.
Arguments d'entrée

TypeNomDescription
StringmediaSourceNom du fabricant ou de la source média pour l'attribution de pré-installations.
StringcampaignNom de la campagne pour l'attribution pré-installation.
StringsiteIdID du site pour l'attribution pré-installation.

Retours
void.

setResolveDeepLinkURLs

Signature de la méthode

void setResolveDeepLinkURLs(java.lang.String... urls)

Description
Les annonceurs peuvent encapsuler un OneLink AppsFlyer dans un autre lien universel. Ce lien universel appellera l'app, mais les données de deep linking ne se propageront pas à AppsFlyer.

setResolveDeepLinkURLs vous permet de configurer le SDK pour corriger les URL OneLink encapsulées, afin que le deep linking puisse se produire correctement.

Arguments d'entrée

TypeNomDescription
String...urlsVeillez à fournir des URL explicites.

Retours
void

Exemple d'utilisation

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

setSharingFilterForPartners

Ajouté dans la V6.4
Signature de la méthode

void setSharingFilterForPartners(java.lang.String... partners)

This function replaces the deprecated setSharingFilter and setSharingFilterForAllPartners

Description
Vous permet de configurer les partenaires que le SDK doit exclure du partage de données.

Arguments d'entrée

TypeNomDescription
String...partnersUn ou plusieurs identifiants partenaires que vous souhaitez exclure. Doit comprendre uniquement des lettres/chiffres et des tirets bas. Nombre max. de caractères pour l'ID du partenaire : 45

Remarque :
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:

  1. Run the Get active integrations API for a list of all active integrations
  2. Utiliser la méthode media_source_name values from the API response as input values to the method partners array.

Exceptions:

  • For Twitter, use twitter (and not twitter_int)

Exemple d'utilisation

AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int"); // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int"); // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all"); // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners(); // Reset list (default)
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int") // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int") // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all") // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("") // Reset list (default)

setSharingFilter

Obsolète pour la V6.4
Signature de la méthode

void setSharingFilter(java.lang.String... partners)

This function is deprecated and has been replaced by setSharingFilterForPartners

Description
Stops events from propagating to the specified AppsFlyer partners.
(Deprecated and replaced by setSharingFilterForPartners)
Input arguments

TypeNomDescription
String...partnersUn ou plusieurs identifiants de partenaire. Doit comprendre uniquement des lettres/chiffres et des tirets bas. Longueur maximale : 45

Retours
void

setSharingFilterForAllPartners

Obsolète pour la V6.4
Signature de la méthode

void setSharingFilterForAllPartners()

This function is deprecated and has been replaced by setSharingFilterForPartners

Description
Empêche les événements de se propager à tous les partenaires AppsFlyer. Écrase setSharingFilter.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours
void

setUserEmails

Signature de la méthode

void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
                                   java.lang.String... emails)

Description
Définissez les e-mails des utilisateurs et chiffrez-les.

Arguments d'entrée

TypeNomDescription
AppsFlyerProperties.EmailsCryptTypecryptMethodMéthodes de cryptage :
  • AppsFlyerProperties.EmailsCryptType.NONE
  • AppsFlyerProperties.EmailsCryptType.SHA256
String...emailsUn ou plusieurs courriels d'utilisateurs.

Retours
void.

start

Signature de la méthode

void start(Context context,
                           java.lang.String key,
                           AppsFlyerRequestListener listener)

Description
Démarre le SDK.

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'application si l'appel est lancé dans la méthode onCreate de l'app, contexte de l'activité si l'appel est lancé dans l'activité après la méthode onResume .
StringkeyVotre clé dev AppsFlyer
AppsFlyerRequestListenerlistener(Facultatif) Port d'écoute pour obtenir l'état de la demande.

Retours
void.

Exemple d'utilisation
Voir Intégration du SDK pour un exemple d'implémentation.

stop

Signature de la méthode

void stop(boolean shouldStop,
                          Context context)

DescriptionUne fois cette API appelée, notre SDK ne communiquera plus avec nos serveurs et cessera de fonctionner. Utile lors de l'application de l'acceptation/du refus de l'utilisateur.

📘

SDK restart

Après stop(true) was called, you need to call stop(false) and only then call start()

Arguments d'entrée

TypeNomDescription
booleanshouldStopsi le logging doit être interrompu.
ContextcontextContexte de l'app/activité

Retours
void.

subscribeForDeepLink

Signature de la méthode

void subscribeForDeepLink(DeepLinkListener deepLinkListener,
                                          long timeout)

Description

Arguments d'entrée

TypeNomDescription
DeepLinkListenerdeepLinkListener
longtimeoutFacultatif.
Unités en millisecondes

Retours
void

unregisterConversionListener

Signature de la méthode

void unregisterConversionListener()

Description
Permet d'annuler l'enregistrement d'un AppsFlyerConversionListener.

Arguments d'entrée
Cette fonction ne prend aucun paramètre.

Retours
void

updateServerUninstallToken

Signature de la méthode

void updateServerUninstallToken(Context context,
                                                java.lang.String token)

Description
Pour les développeurs qui utilisent Firebase à des fins autres que la mesure des désinstallations. Pour plus d'informations, consultez la section Mesure des désinstallations.

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'app/activité
StringtokenJeton d'appareil Firebase.

Retours
void

Exemple d'utilisation

AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);

validateAndLogInAppPurchase

Added in v6.14.0

Signature de la méthode

public abstract void validateAndLogInAppPurchase(@NonNull AFPurchaseDetails purchaseDetails,
                                                 @Nullable Map<String, String> additionalParameters,
                                                 @Nullable AppsFlyerInAppPurchaseValidationCallback validationCallback);

Description
The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase event to AppsFlyer.

See detailed instructions in Validate and log in-app purchase.

Arguments d'entrée

NomTypeDescription
purchaseDetails *AFPurchaseDetailsAn object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.
additionalParametersMap<String, String>Additional parameters to log with the purchase.
validationCallback *AppsFlyerInAppPurchaseValidationCallback`A callback for delivering validation results.

Retours
void

AFPurchaseDetails

An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.

data class AFPurchaseDetails(
    val purchaseType: AFPurchaseType,
    val purchaseToken: String,
    val productId: String,
    val price: String,
    val currency: String
)

AFPurchaseDetails parameters

NomTypeDescription
purchaseTypeAFPurchaseTypeField to distinguish between one-time purchases and subscriptions. The field can accept either subscription or one-time-purchase.
purchaseTokenChaîneToken that uniquely identifies a purchase for a given item and user pair. Part of the Billing Library's Purchase class. To retrieve the token call the getPurchaseToken API
productIdChaîneID of the product item that has been purchased. Also part of the Billing Library's Purchase class.
priceChaîneThe full price of the one-time purchase or the subscription. Also part of the Billing Library's Purchase class.
currencyChaîneCurrency used to make the purchase.

validateAndLogInAppPurchase (LEGACY)

Deprecated in v6.4

Signature de la méthode

void validateAndLogInAppPurchase(Context context,
                                                 java.lang.String publicKey,
                                                 java.lang.String signature,
                                                 java.lang.String purchaseData,
                                                 java.lang.String price,
                                                 java.lang.String currency,
                                                 java.util.Map<java.lang.String,java.lang.String> additionalParameters)

Description
Une API pour la vérification par le serveur des achats intégrés. Un événement af_purchase avec les bonnes valeurs sera automatiquement envoyé si la vérification est un succès.

Consultez les instructions détaillées dans la section Validation des achats.

Arguments d'entrée

TypeNomDescription
ContextcontextContexte de l'app/activité
StringpublicKeyClé de licence obtenue via la Google Play Console.
Stringsignaturedata.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data)
StringpurchaseDatadata.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data)
StringpricePrix d'achat, doit être dérivé de skuDetails.getStringArrayList("DETAILS_LIST")
StringcurrencyDevise d'achat, doit être dérivée de skuDetails.getStringArrayList("DETAILS_LIST")
Map<String, String>additionalParametersParamètres Freehand à enregistrer avec l'achat (si validé).

Retours
void.

waitForCustomerUserId

Signature de la méthode

void waitForCustomerUserId(boolean wait)

Description
Cette méthode met en attente l'initialisation du SDK jusqu'à ce que customerUserID soit fourni.
Tous les événements in-app et tous les autres appels à l'API SDK sont rejetés jusqu'à ce que customerUserID soit fourni et enregistré.

Arguments d'entrée

TypeNomDescription
booleanwait

Retours
void.

Exemple d'utilisation

AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);