Intégration SDK iOS pour les développeurs

Le DeviceID unique d'AppsFlyer est créé pour chaque nouvelle installation d’une application. Vous pouvez l’obtenir en utilisant le code suivant :

let appsflyerId = AppsFlyerTracker.shared().getAppsFlyerUID()

NSString *appsflyerId = [AppsFlyerTracker sharedTracker].getAppsFlyerUID;

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.

Pour définir votre ID Utilisateur-Client :

AppsFlyerTracker.shared().customerUserID = "my user id"

[AppsFlyerTracker sharedTracker].customerUserID = @"my user id";

Obtenir l'ID Utilisateur-Client :

Pour obtenir l'ID utilisateur-client, récupérez-le à partir de sharedTracker.

[AppsFlyerTracker sharedTracker].customerUserID

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

AppsFlyer recueille automatiquement l’IDFA (ID pour les annonceurs) et IDFV (ID pour les vendeurs) si AdSupport.framework est inclus dans l’application.

Pour la mesure de désinstallation, activez la notification push distante sur votre application. Consultez le Remote Notification Programming Guide d'Apple pour plus de détails.

Suivez les instructions d’intégration du SDK iOS pour terminer la configuration de la fonctionnalité de mesure de désinstallation.

Pour activer le suivi des lancements d'application par les notifications push, ajoutez le code suivant à votre app delegate :

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any]) {
	AppsFlyerTracker.shared().handlePushNotification(userInfo)
}

-(void) application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
	[[AppsFlyerTracker sharedTracker] handlePushNotification:userInfo];
  }

Le message push doit avoir un paramètre af avec les paramètres d'attribution AppsFlyer.

Exemple de message :

{
  "aps":{
   "alert":"Push text",
   "sound":"default",
   "category":"REMINDER_CATEGORY"
  },
  "_p":123456,
  "payloadKey":"payloadValue",
  "af":{
   "pid":"swrve_int",
   "is_retargeting":"true",
   "c":"test_campaign"
  }
}

AppsFlyer vous permet d'enregistrer et d'attribuer les installations provenant d'une promotion croisée de l'une de vos applications au sein de l'application actuelle dont dispose l'utilisateur. Les applications de promotion croisée peuvent être un facteur de croissance important en entrainant des installations supplémentaires pour vos applications.

Pour plus d'informations, reportez-vous à l'article concernant l'attribution de promotion croisée, ici.

Le SDK AppsFlyer peut fournir une vérification serveur des achat in-app. Pour configurer le suivi de validation de reçu, vous devez appeler la méthode validateAndTrackInAppPurchase dans le callback Transaction finalisée du SKStoreKit. Cet appel génère automatiquement un évènement in-app af_purchase.

- (void) validateAndTrackInAppPurchase:(NSString *) productIdentifier
price:(NSString *) price
currency:(NSString *) currency
transactionId:(NSString *) tranactionId
additionalParameters:(NSDictionary *) params
success:(void (^)(NSDictionary *response)) successBlock
failure:(void (^)(NSError *error, id reponse)) failedBlock;

Cet appel contient deux blocs de callback, l'un pour la « réussite » et l'autre pour « l'échec » (quelle qu'en soit la raison, y compris l'échec de validation). En cas de réussite, un dictionnaire est retourné avec les données de validation de reçu fournies par les serveurs d’Apple. 

#ifdef DEBUG
  [AppsFlyerTracker sharedTracker].useReceiptValidationSandbox = YES;
#endif

[[AppsFlyerTracker sharedTracker] validateAndTrackInAppPurchase:@"ProductIdentifier" price:@"price"
    currency:@"USD"
    transactionId:@"transactionID"
    additionalParameters:@{@"test": @"val" , @"test1" : @"val 1"}
    success:^(NSDictionary *result){
      NSLog(@"Purchase succeeded And verified!!! response: %@", result[@"receipt"]);
    } failure:^(NSError *error, id response) {
      NSLog(@"response = %@", response);
      if([response isKindOfClass:[NSDictionary class]]) {
        if([response[@"status"] isEqualToString:@"in_app_arr_empty"]){
          // retry with 'SKReceiptRefreshRequest' because
          // Apple has returned an empty response
          // <YOUR CODE HERE>
        }

      } else {
        //handle other errors
        return;
      }
  }];

AppsFlyerTracker
      .shared()?
      .validateAndTrack(inAppPurchase: "productIdentifier",
                   price: "price",
                  currency: "currency",
               transactionId: "transactionId",
            additionalParameters: [:],
                  success: {
      guard let dictionary = $0 as? [String:Any] else { return }
      dump(dictionary)
    }, failure: { error, result in
      guard let emptyInApp = result as? [String:Any],
           let status = emptyInApp["status"] as? String,
             status == "in_app_arr_empty" else {
                // Try to handle other errors
                 return
               }
         
      // retry with 'SKReceiptRefreshRequest' because
      // Apple has returned an empty response
      // <YOUR CODE HERE>
    })

Pour obtenir la liste des valeurs possibles de retour pour la validation des reçus, veuillez vous reporter à la documentation d’Apple ici.

AppsFlyer vous fournit une méthode permettant d'anonymiser des identifiants utilisateur spécifiques dans les analyses AppsFlyer. Cette méthode est conforme aux dernières exigences de confidentialité ainsi qu'aux politiques de confidentialité des données de Facebook. La valeur par défaut est NON, ce qui signifie qu'aucune anonymisation n'est effectuée par défaut.

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

AppsFlyerTracker.shared().deviceTrackingDisabled = true

[AppsFlyerTracker sharedTracker].deviceTrackingDisabled = YES;

Il est possible de reprendre le suivi en appelant de nouveau deviceTrackingDisabled, défini sur false.

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

Toutefois, vous pouvez utiliser l'API suivante pour définir votre valeur personnalisée de durée minimale requise entre les sessions :

AppsFlyerTracker.shared().minTimeBetweenSessions = <votre_temps_personnalisé_en_secondes>

[AppsFlyerTracker sharedTracker].minTimeBetweenSessions = <votre_temps_personnalisé_en_secondes>;

L’extension de l’application requiert des autorisations pour utiliser internet :

1. Allez au fichier info.plist de l’extension de votre application
2. Dans NSExtension / NSExtensionAttributes définissez l'indicateur RequestsOpenAccess sur YES.

Ajoutez le code suivant au UIViewController de l’extension de l’application viewDidLoad :

override func viewDidLoad() {  
    super.viewDidLoad()
    AppsFlyerTracker.shared().appsFlyerDevKey = "MY_APPSFLYER_KEY"

    // MY_APP_ID below stands for you app ID on iTunes Connect. Should be 9 or 10 digits.
    AppsFlyerTracker.shared().appleAppID = "MY_APP_ID"
        
    AppsFlyerTracker.sharedTracker().trackAppLaunch()
  }

- (void)viewDidLoad {
    [super viewDidLoad];
    // Replace MY_APPSFLYER_KEY below by your AppsFlyer dev key
    [AppsFlyerTracker sharedTracker].appsFlyerDevKey = @"MY_APPSFLYER_KEY";

    // MY_APP_ID below stands for you app ID on iTunes Connect. Should be 9 or 10 digits.
    [AppsFlyerTracker sharedTracker].appleAppID = @"MY_APP_ID";
        
    [[AppsFlyerTracker sharedTracker] trackAppLaunch];
  }

Dans certains cas extrêmes, vous pouvez vouloir arrêter toute fonction du SDK en raison de la conformité aux exigences légales et à la vie privée. L'API isStopTracking le permet. Une fois cette API appelée, notre SDK ne communiquera plus avec nos serveurs et cessera de fonctionner.

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

AppsFlyerTracker.shared().isStopTracking = true

[AppsFlyerTracker sharedTracker].isStopTracking = true;

Il est possible d'attendre que le customerUserID soit défini pour lancer l'initialisation du SDK. Cette fonctionnalité permet de s'assurer que le SDK ne commence pas avant d'avoir obtenu le customerUserID. Lorsque vous retardez l'initialisation du SDK, tous les évènements in-app ainsi que tous les appels à une API SDK sont ignorés, jusqu'à ce que le customerUserID soit fourni et enregistré.

Vous pouvez ajouter une logique à l'API iOS applicationDidBecomeActive pour retarder l'initialisation du SDK jusqu'à ce que l'ID utilisateur du client soit défini. Consultez les exemples ci-dessous :

- (void)applicationDidBecomeActive:(UIApplication *)application {
    NSString *customUserId = [[NSUserDefaults standardUserDefaults] stringForKey:@"customerUserId"]; // Your custom logic of retrieving CUID
    if (customUserId != nil && ![customUserId  isEqual: @""]) {
        [AppsFlyerTracker sharedTracker].customerUserID = customUserId; // Set CUID in AppsFlyer SDK for this session
        [[AppsFlyerTracker sharedTracker] trackAppLaunch]; // Track App Launch
    }
}

func applicationDidBecomeActive(_ application: UIApplication) {
        let customUserId = UserDefaults.standard.string(forKey: "customUserId")  //  your logic to retrieve CUID
        if(customUserId != nil && customUserId != ""){
            AppsFlyerTracker.shared().customerUserID = customUserId // Set CUID in AppsFlyer SDK for this session
            AppsFlyerTracker.shared().trackAppLaunch() // Track App Launch
        }
    }

Le SDK AppsFlyer vous permet de collecter le nom de l'appareil pour votre analyse interne. Cette fonctionnalité est désactivée par défaut. Pour l'activer, utilisez l'API suivante :

AppsFlyerTracker.shared().shouldCollectDeviceName = false

[AppsFlyerTracker sharedTracker].shouldCollectDeviceName = NO;

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.
Le code qui suit illustre l'implémentation de setAdditionalData sur iOS pour Objective-C ou Swift

NSDictionary* CustomDataMap = [[NSDictionary alloc] initWithObjectsAndKeys:@"value_of_param_1", @"custom_param_1", nil];
  
[[AppsFlyerTracker sharedTracker] setAdditionalData:CustomDataMap];

let CustomDataMap: [AnyHashable: Any] = [
  "custom_param_1" : "value_of_param_1"
]
    
AppsFlyerTracker.shared().customData = CustomDataMap

Si vous utilisez les liens OneLink (qui prennent en charge les liens universels) et les encapsulez avec un lien universel tiers, vous pouvez utiliser l'API setResolveDeepLinkURLs pour indiquer au SDK AppsFlyer quels sont les domaines de clic appelant l'application qui doivent être résolus par le SDK et en extraire le lien OneLink sous-jacent. Cela vous permettra de maintenir le deep linking et l'attribution tout en encapsulant le lien OneLink avec un lien universel tiers. Assurez-vous d'appeler cette API avant d'initialiser le SDK.

[AppsFlyerTracker sharedTracker].resolveDeepLinkURLs = @[@"example.com",@"click.example.com"];

AppsFlyerTracker.shared().resolveDeepLinkURLs = ["example.com", "click.example.com]