AppsFlyerLib

Vue d'ensemble

AppsFlyerLib est la classe principale du SDK iOS AppsFlyer, elle encapsule la majorité des méthodes.

Pour importer AppsFlyerLib:

// AppDelegate.h
#import <AppsFlyerLib/AppsFlyerLib.h>

@interface AppDelegate : UIResponder <UIApplicationDelegate, AppsFlyerLibDelegate>

@end

import AppsFlyerLib

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

Propriétés

advertisingIdentifier (read-only)

Déclaration de propriété

@property(nonatomic, strong, readonly) NSString *advertisingIdentifier

Description
Le SDK AppsFlyer collecte l'élément advertisingIdentifier if the AdSupport.framework est inclus dans le SDK.
d'Apple inclus dans le SDK. Vous pouvez désactiver ce comportement en réglant disableAdvertisingIdentifier to true.

anonymizeUser

Déclaration de propriété

@property(atomic) BOOL anonymizeUser;

Description
Permet de désactiver l'enregistrement pour un utilisateur précis

appInviteOneLinkID

Déclaration de propriété

@property(nonatomic, strong, nullable, setter = setAppInviteOneLink:) NSString * appInviteOneLinkID

Description
Permet de définir votre ID OneLink depuis la configuration OneLink. Est utilisé dans les invitations d'utilisateur pour générer un OneLink.

appleAppID

Déclaration de propriété

@property(nonatomic, strong) NSString * appleAppID

Description
Cette propriété permet de définir l'ID Apple de votre app (récupéré sur la page de l'app dans iTunes Connect)

appsFlyerDevKey

Déclaration de propriété

@property(nonatomic, strong) NSString * appsFlyerDevKey

Description
Cette propriété permet de définir votre clé dev AppsFlyer.

currencyCode

Déclaration de propriété

@property(nonatomic, strong, nullable) NSString *currencyCode

Description
Dans le cadre d'événements d'achat in-app, vous pouvez définir le code de devise utilisé par votre acheteur.
Le code de devise est un code à 3 lettres aux normes ISO.

Exemple d'utilisation

[[AppsFlyerLib shared] setCurrencyCode:@"USD"];

AppsFlyerLib.shared().currencyCode = "USD"

customData

📘

Réglage customData before first launch will have the additional data included in installs, sessions, as well as in-app events.

Déclaration de propriété

@property(nonatomic, strong, nullable, setter = setAdditionalData:) NSDictionary * customData

Description
Pour ajouter des données personnalisées à la charge utile des événements. Vous le recevrez dans les rapports de données brutes.

customerUserID

Déclaration de propriété

@property(nonatomic, strong, nullable) NSString * customerUserID

Description
Dans le cas où vous utilisez votre propre ID utilisateur au sein de votre app, vous pouvez utiliser ce même ID pour définir la propriété.
Vous pouvez ainsi croiser votre propre ID unique avec l'ID unique d'AppsFlyer et les ID des autres appareils.

deepLinkDelegate

Déclaration de propriété

@property(weak, nonatomic) id<AppsFlyerDeepLinkDelegate> deepLinkDelegate

Description
Permet de déléguer la propriété d'un objet conforme au protocole DeepLinkDelegate, et qui implémente ses méthodes.

Exemple d'utilisation

AppsFlyerLib.shared().deepLinkDelegate = self

deepLinkTimeout

DescriptionTemps de réponse expiré pour le deeplinking différé.

Unités en millisecondes.

Déclaration de propriété

@property(nonatomic) NSUInteger deepLinkTimeout

delegate

Description
Délégué AppsFlyer. Cf AppsFlyerLibDelegate.
Déclaration de propriété

@property (nonatomic, weak) id<AppsFlyerLibDelegate> delegate;

disableAdvertisingIdentifier

Déclaration de propriété

@property (nonatomic) int disableAdvertisingIdentifier;

Description
dans le cas où AdSupport.framework n'est pas désactivé, le SDK collecte le advertisingIdentifierd'Apple. Vous pouvez désactiver ce comportement en donnant à la propriété suivante la valeur YES.

disableAppleAdsAttribution

Déclaration de propriété

@property(nonatomic) BOOL disableAppleAdsAttribution

Description
Disables AdServices framework-based attribution for Apple Search Ads.

disableCollectASA

Déclaration de propriété

@property(atomic) BOOL disableCollectASA;

Description
Disables the collection of data from the iAd Framework. This API has no effect in v6.12.3 and above, where the iAd Framework is no longer in use.

disableIDFVCollection

Déclaration de propriété

@property(nonatomic) BOOL disableIDFVCollection;

Description
Pour désactiver la collecte de l'identifiant du fournisseur de l'app (IDFV), réglez disableIDFVCollection to YES.

disableSKAdNetwork

Déclaration de propriété

@property(nonatomic) BOOL disableSKAdNetwork

Description

facebookDeferredAppLink

Déclaration de propriété

@property (nonatomic, nullable) int *facebookDeferredAppLink;

Description
Permet de définir manuellement le lien d'app différé Facebook.

host (read-only)

Déclaration de propriété

@property(nonatomic, strong, readonly) NSString *host

Description
Cette propriété accepte une valeur de chaîne qui représente le nom d'hôte pour l'ensemble des points de terminaison. Pour définir l’hôte, utilisez setHost.

Pour utiliser le point de terminaison du SDK par défaut, réglez la valeur sur nil.

hostPrefix (read-only)

Déclaration de propriété

@property(nonatomic, strong, readonly) NSString *hostPrefix

DescriptionCette propriété accepte une valeur de chaîne qui représente le préfixe du nom d'hôte pour l'ensemble des points de terminaison.
Pour définir l’hôte, utilisez setHost.

isDebug

Déclaration de propriété

@property(nonatomic) BOOL isDebug;

Description
Permet d'inscrire les messages du SDK dans le log de console. Doit être désactivé pour les builds de production.

isStopped

Déclaration de propriété

@property(atomic) BOOL isStopped;

📘

SDK Restart

Définis isStopped = true and then set isStopped = false

No need to call start()

Description
API to shut down all SDK activities. This will disable all requests from the SDK except for those related to fetching SKAd Network data from the server.

minTimeBetweenSessions

Déclaration de propriété

@property(atomic) NSUInteger minTimeBetweenSessions;

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

Arguments d'entrée

oneLinkCustomDomains

Déclaration de propriété

@property(nonatomic, nullable) NSArray<NSString *> *oneLinkCustomDomains;

Description
Permet aux annonceurs d'utiliser des OneLinks personnalisés.

phoneNumber

Déclaration de propriété

@property(nonatomic, nullable) NSString *phoneNumber

Description

resolveDeepLinkURLs

Déclaration de propriété

@property(nonatomic, nullable) NSArray<NSString *> *resolveDeepLinkURLs;

Description

Exemple d'utilisation
Certains services tiers tels que les fournisseurs de services de messagerie (FSM) encapsulent des liens dans des e-mails 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 éviter ce problème, utilisez setResolveDeepLinkURLs pour obtenir le OneLink des domaines de clic qui lancent l'app. Assurez-vous d'appeler cette API avant d'initialiser le SDK.

Admettons que vous avez trois domaines de clic qui redirigent vers votre OneLink : https://mysubdomain.onelink.me/abCD. Vous utilisez cette API pour obtenir le OneLink vers lequel vos domaines de clic pointent. Cette méthode d'API reçoit une liste de domaines que le SDK vient conclure.

[AppsFlyerLib shared].resolveDeepLinkURLs = @[@"example.com",@"click.example.com"];

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

Cela vous permet d'utiliser votre domaine de clic tout en conservant les fonctionnalités 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 utilisateur.

sharingFilter

Déclaration de propriété

@property(nonatomic, nullable) NSArray<NSString *> *sharingFilter;

Description

shouldCollectDeviceName

Déclaration de propriété

@property(nonatomic) BOOL shouldCollectDeviceName;

Description
Quand ce drapeau est réglé sur YES, permet de collecter le nom du périphérique actuel (ex : « Mon iPhone »).

useReceiptValidationSandbox

Déclaration de propriété

@property (nonatomic) BOOL useReceiptValidationSandbox;

Description
Permet de valider la réception des achats in-app sous environnement Apple (production ou sandbox).

useUninstallSandbox

Déclaration de propriété

@property (nonatomic) BOOL useUninstallSandbox;

Description
Ce drapeau permet de tester la désinstallation sous environnement Apple (production ou sandbox).

Méthodes

addPushNotificationDeepLinkPath

Signature de la méthode

- (void)addPushNotificationDeepLinkPath:(NSArray<NSString *> *)deepLinkPath;

addPushNotificationDeepLinkPath(deepLinkPath: [String])

Description
Permet d'ajouter un ensemble de clés, lesquelles composeront le chemin clé visant à conclure le deeplink de charge utile des notifications push.

Arguments d'entrée

Retours
void.

Exemple d'utilisation
Configuration de base :

[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"af_push_link"]]

AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["af_push_link"])

Configuration avancée :

[AppsFlyerLib shared] addPushNotificationDeepLinkPath:@[@"deeply", @"nested", @"deep_link"]]

AppsFlyerLib.shared().addPushNotificationDeepLinkPath(["deeply", "nested", "deep_link"])

Cet appel correspond à la structure de charge utile suivante :

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

appendParametersToDeepLinkingURL

Signature de la méthode

(void)appendParametersToDeepLinkingURLWithString:(NSString *)containsString parameters:(NSDictionary<NSString *, NSString*> *)parameters;

appendParametersToDeeplinkURL(contains: String, parameters: [String : String])

Description
Fait correspondre les URL qui contiennent contains en tant que sous-chaîne, et leur ajoute des paramètres de requête. Si l'URL ne correspond pas, les paramètres ne lui sont pas ajoutés.

🚧

Appelez cette méthode avant d'appeler start

Arguments d'entrée

Retours
void.

continue

Signature de la méthode

- (id)continueUserActivity:(id)userActivity
restorationHandler:
(void (^_Nullable)(int *_Nullable))restorationHandler;

AppsFlyerLib.shared().continue(userActivity: NSUserActivity?, restorationHandler: (([Any]?) -> Void)?)

Description
Permet à AppsFlyer de gérer la restauration depuis NSUserActivity. Cette méthode permet de gérer les liens universels.

Arguments d'entrée

Retours
void.

enableFacebookDeferderedApplinks

Signature de la méthode

- (void)enableFacebookDeferredApplinksWithClass:(Class _Nullable)facebookAppLinkUtilityClass;

enableFacebookDeferredApplinks(with:AnyClass?)

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.
• Pour fonctionner correctement, cette API doit être appelée avant d'initialiser le SDK AppsFlyer.

Arguments d'entrée

Retours
void.

enableTCFDataCollection

Signature de la méthode

- (void)enableTCFDataCollection:(BOOL)flag;

func enableTCFDataCollection(_ flag: Bool)

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

Arguments d'entrée

Retours
void.

getAppsFlyerUID

Signature de la méthode

- (NSString *)getAppsFlyerUID;

getAppsFlyerUID()

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
Cette méthode ne prend pas d'arguments d'entrée.

Retours

getSDKVersion

Signature de la méthode

- (NSString *)getSDKVersion;

getSDKVersion()

Description
Permet d'obtenir une version du SDK.

Arguments d'entrée
Cette méthode ne prend pas d'arguments d'entrée.

Retours

handleOpen

Signature de la méthode

- (void)handleOpenUrl:(id)url options:(id)options;

AppsFlyerLib.shared().handleOpen(url: URL?, options: [AnyHashable : Any]?)

Description
Appelez cette méthode depuis votre méthode AppDelegate openURL method.
This method handles URI-scheme for iOS 9 and above.

Arguments d'entrée

Retours
void.

handlePushNotification

Signature de la méthode

- (void)handlePushNotification:(NSDictionary * _Nullable)pushPayload;

AppsFlyerLib.shared().handlePushNotification(pushPayload: [AnyHashable : Any]?)

Description
Permet à AppsFlyer de gérer une notification push.

Arguments d'entrée

Retours
void.

logAdRevenue

Added in v6.15.0

Signature de la méthode

-(void)logAdRevenue:(AFAdRevenueData *)adRevenueData additionalParameters:(NSDictionary * **_Nullable**)additionalParameters;

Description

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

Paramètres entrants

Retours

void.

AFAdRevenueData

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

Definition

AFAdRevenueData {
	(NSString * **_Nonnull**)monetizationNetwork
	(AppsFlyerAdRevenueMediationNetworkType)mediationNetwork
	(NSString * **_Nonnull**)currencyIso4217Code
	(NSNumber * **_Nonnull**)eventRevenue
}

AFAdRevenueData parameters

AppsFlyerAdRevenueMediationNetworkType

logEvent

Signature de la méthode

- (void)logEvent:(NSString *)eventName withValues:(NSDictionary * _Nullable)values;

logEvent(eventName: String, withValues: [AnyHashable : Any]?)

Description
Cette méthode permet d'enregistrer un événement avec des paramètres d'événement.

Arguments d'entrée

Retours
void.

logEvent

Signature de la méthode

- (void)logEventWithEventName:(NSString *)eventName
  eventValues:(NSDictionary<NSString * , id> * _Nullable)eventValues
  completionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;

logEvent(eventName: String, withValues: [AnyHashable : Any]?, completionHandler:(([String : Any]?, Error?) -> Void)?)

Description
Cette méthode permet d'enregistrer un événement avec des paramètres d'événement, et de transmettre un gestionnaire d'achèvement qui prendra en charge les soumissions d'événements (avec succès ou en échec).

Arguments d'entrée

Retours
void.

logLocation

Signature de la méthode

- (void)logLocation:(double)longitude latitude:(double)latitude;

logLocation(longitude: Double, latitude: Double)

Description
Permet d'enregistrer la géolocalisation. Agit comme le code ci-dessous.

Arguments d'entrée

Retours
void.

performOnAppAttribution

Signature de la méthode

- (void)performOnAppAttributionWithURL:(NSURL * _Nullable)URL;

performOnAppAttribution(with:URL?)

Description
Utilisé pour déclencher manuellement onAppOpenAttribution delegate.

Arguments d'entrée

Retours
void.

registerUninstall

Signature de la méthode

- (void)registerUninstall:(NSData * _Nullable)deviceToken;

registerUninstall(deviceToken: Data?)

Description
Enregistrement des désinstallations : vous devez vous inscrire pour la notification distante, et fournir à AppsFlyer le jeton de l'appareil push.

Arguments d'entrée

Retours
void.

setConsentData

Signature de la méthode

.setConsentData(afConsent: AppsFlyerConsent)

- (void)setConsentData:(AppsFlyerConsent) afConsent

Description

Transfers consent data to the SDK.

Arguments d'entrée

setCurrentDeviceLanguage

Signature de la méthode

- (void)setCurrentDeviceLanguage:(NSString *)currentDeviceLanguage

Description
Utilisez cette méthode pour définir la langue du dispositif dans le SDK et la transmettre à AppsFlyer.

Arguments d'entrée

Exemple d'utilisation

NSString *language = [[NSLocale preferredLanguages] objectAtIndex:0]
    [[AppsFlyerLib shared] setCurrentDeviceLanguage: @language];

let language = NSLocale.current.languageCode
AppsFlyerLib.shared().currentDeviceLanguage = language

setHost

Signature de la méthode

(void)setHost:(NSString *)host withHostPrefix:(NSString *)hostPrefix;

setHost(host: String, withHostPrefix: String)

Description
Cette fonction définit le nom d'hôte et le préfixe du nom d'hôte pour tous les points de terminaison.

Note: Starting with SDK V6.11, if the host value is empty or null, the API call will be ignored.

Arguments d'entrée

Retours
void.

Exemple d'utilisation

[[AppsFlyerLib shared] setHost:@"example.com" withHostPrefix:@"my_host_prefix"];

AppsFlyerLib.shared().setHost("example.com", withHostPrefix: "my_host_prefix")

setPartnerData

Signature de la méthode

- (void)setPartnerDataWithPartnerId:(NSString * _Nullable)partnerId partnerInfo:(NSDictionary<NSString *, id> * _Nullable)partnerInfo;

setPartnerData(partnerId: String?, partnerInfo: [String : Any]?)

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

Arguments d'entrée

Retours
void.

Exemple d'utilisation

NSDictionary *partnerInfo = @{
 @"puid": @"123456789",
};

[[AppsFlyerLib shared] setPartnerDataWithPartnerId: @"test_int" partnerInfo:partnerInfo];

let partnerInfo = [
  "puid":"123456789",
]

AppsFlyerLib.shared().setPartnerData(partnerId:"test_int", partnerInfo:partnerInfo)

setSharingFilterForPartners

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

- (void)setSharingFilterForPartners:(NSArray<NSString *> * _Nullable)sharingFilter;

This function replaces the deprecated setSharingFilterForAllPartners

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

Arguments d'entrée

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 Apple Search Ads use Apple Search Ads (and not iossearchads_int).
• For Twitter, use twitter (and not twitter_int)

Exemple d'utilisation

[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int"]]; // 1 partner
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"examplePartner1_int", @"examplePartner2_int"]]; // multiple partners
[[AppsFlyerLib shared] setSharingFilterForPartners:@[@"all"]]; // All partners
[[AppsFlyerLib shared] setSharingFilterForPartners:nil]; // Reset list (default)

AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner1_int"]) // 1 partner
AppsFlyerLib.shared().setSharingFilterForPartners(["examplePartner2_int", "examplePartner1_int"]) // multiple partners
AppsFlyerLib.shared().setSharingFilterForPartners(["all"]) // All partners
AppsFlyerLib.shared().setSharingFilterForPartners(nil) // Reset list (default)

setSharingFilterForAllPartners

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

- (void)setSharingFilterForAllPartners;

setSharingFilterForAllPartners()

This function is deprecated and has been replaced by setSharingFilterForPartners

Description
Block an event from being shared with integrated partners.

Arguments d'entrée
Cette méthode ne prend pas d'arguments d'entrée.

Retours
void

setUserEmails

Signature de la méthode

- (void)setUserEmails:(NSArray<NSString *> * _Nullable)userEmails withCryptType:(EmailCryptType)type;

setUserEmails(userEmails: [String]?, with: EmailCryptType)

Description
Use this to set the user email(s).
Note: MD-5 and SHA-1 encryption types are deprecated starting with SDK V6.9.0. Currently, only SHA-256 and NONE are supported.

Arguments d'entrée

Retours
void.

shared

Signature de la méthode

(AppsFlyerLib *)shared;

Description
Accédez à l'instance SDK singleton de la classe AppsFlyerLib , en la créant si nécessaire.

Exemple d'utilisation

AppsFlyerLib.shared()

start

Signature de la méthode

- (void)start;

(void) start()

Description
Démarre le SDK.

Arguments d'entrée
Cette méthode ne prend pas d'arguments d'entrée.

Retours
void.

start

Signature de la méthode

- (void)startWithCompletionHandler:(void (^ _Nullable)(NSDictionary<NSString *, id> * _Nullable dictionary, NSError * _Nullable error))completionHandler;

start(completionHandler: (([String : Any]?, Error?) -> Void)?)

Description
Permet de démarrer le SDK avec un gestionnaire d'achèvement.

Arguments d'entrée

Retours
void.

validateAndLogInAppPurchase

(Supported from SDK v.6.14.1)

Signature de la méthode

typedef void (^AFSDKValidateAndLogCompletion)(AFSDKValidateAndLogResult * _Nullable result);
- (void)validateAndLogInAppPurchase:(AFSDKPurchaseDetails *)details
                   extraEventValues:(NSDictionary * _Nullable)extraEventValues
                  completionHandler:(AFSDKValidateAndLogCompletion)completionHandler NS_AVAILABLE(10_7, 7_0);

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.

Paramètres entrants

Retours
void.

AFSDKPurchaseDetails

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

AFSDKPurchaseDetails parameters

validateAndLogInAppPurchase (LEGACY)

(Supported until SDK v.6.14.0)

Signature de la méthode

- (void)validateAndLogInAppPurchase:(id)productIdentifier
price:(id)price
 currency:(id)currency
transactionId:(id)transactionId
additionalParameters:(id)params
success:(void (^_Nullable)(int *))successBlock
failure:
(void (^_Nullable)(int *_Nullable,
 id _Nullable))failedBlock;

validateAndLog(inAppPurchase: String?, price: String?, currency: String?, transactionId: String?, additionalParameters: [AnyHashable : Any]?, success: ([AnyHashable : Any]) -> Void)?, failure: ((Error?, Any?) -> Void)?)

Description
Permet d'enregistrer et valider les achats in-app en appelant cette méthode depuis la méthodecompleteTransaction[ dans votre SKPaymentTransactionObserver.

Arguments d'entrée

Retours
void.

waitForATTUserAuthorization

Signature de la méthode

- (void)waitForATTUserAuthorizationWithTimeoutInterval:(id)timeoutInterval;

waitForATTUserAuthorization(timeoutInterval:)

Description
Permet d'attendre la demande d'autorisation de l'utilisateur pour accéder aux données propres à l'app.

Arguments d'entrée

Exemple d'utilisation

if (@available(iOS 14, *)) {
        [[AppsFlyerLib shared] waitForATTUserAuthorizationWithTimeoutInterval:60];
        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status){
        }];
    }

if #available(iOS 14, *) {
            AppsFlyerLib.shared().waitForATTUserAuthorization(withTimeoutInterval: 60)
            ATTrackingManager.requestTrackingAuthorization { (status) in
            }
        }

Retours
void.