Интеграция AppsFlyer SDK — iOS

Для каждой новой установки приложения AppsFlyer создает уникальный ID устройства. Его можно запросить с помощью такого кода:

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

NSString *appsflyerId = [AppsFlyerTracker sharedTracker].getAppsFlyerUID;

Установка собственного ID клиента позволяет создавать cross-ссылки между своим уникальным ID и уникальным ID AppsFlyer, а также с ID других устройств. Этот идентификатор можно посмотреть в отчетах AppsFlyer в формате CSV, а также получить с помощью API обратной передачи для cross-ссылок между внутренними идентификаторами.

Для установки собственного Customer User ID используйте такой код:

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

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

Получение Customer User ID:

To get the customer user ID retrieve it from the sharedTracker.

[AppsFlyerTracker sharedTracker].customerUserID

Для получения дополнительных сведений о Customer User ID щелкните здесь.

AppsFlyer позволяет включать в отчеты один или даже несколько адресов электронной почты пользователя, если вы собираете такую информацию в своем приложении. Для шифрования адресов электронной почты можно использовать методы Sha1, MD5 и прямое шифрование.

Пример: сбор пользовательских адресов электронной почты

AppsFlyerTracker.shared().setUserEmails( ["email1@domain.com", "email2@domain.com"], with: EmailCryptTypeSHA1)

[[AppsFlyerTracker sharedTracker] setUserEmails:@[@"email1@domain.com", @"email2@domain.com"] withCryptType:EmailCryptTypeSHA1];

Если в приложение включен файл AdSupport.framework, то AppsFlyer автоматически выполняет сбор данных IDFA (ID для рекламодателей) и IDFV (ID для продавцов).

For Uninstall measurement, enable remote push notification on your app. See Apple's Remote Notification Programming Guide for more details.

Follow the iOS SDK integration instructions to complete the uninstall measurement feature setup.

Чтобы включить отслеживание запуска приложений из push-уведомлений, добавьте в делегат своего приложение такой код:

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

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

Рush-уведомление должно содержать параметр af с параметрами отслеживания AppsFlyer.

Пример сообщения:

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

AppsFlyer позволяет отслеживать и атрибутировать установки, источником которых является cross-promo реклама одного из ваших приложений в другом приложении, которое уже есть у пользователя.  Сross-promo может заметно увеличить количество установок ваших приложений.

Подробные сведения см. в статье об Отслеживании кампаний перекрестной рекламы.

При покупках из приложения SDK AppsFlyer может выполнять проверку сервера. Чтобы запустить валидации чеков, вызовите метод validateAndTrackInAppPurchase из метода completeTransaction с параметром callback, который содержится в структуре SKStoreKit. Этот вызов автоматически создает событие внутри приложения 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;

Этот вызов содержит два блока обратного вызова — один для варианта «успешно», а второй для варианта «ошибочно» (по любой причине, включая сбой проверки). В случае варианта «успешно» словарь получит в ответ подтверждение контрольных данных, предоставляемых серверами Apple.  

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

[[AppsFlyerTracker sharedTracker] validateAndTrackInAppPurchase:product.productIdentifier price:product.price.stringValue
currency:@"USD"
transactionId:trans.transactionIdentifier
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);
}];

AppsFlyerTracker.shared().validateAndTrack(inAppPurchase:  product.productIdentifier, price: "\(product.price)", currency: product.priceLocale.currencyCode, transactionId: trans.transactionIdentifier, additionalParameters: nil,success:{(result) in
   print("Purchase succeeded And verified!!! response \(result)")
   },failure:{(error,message) in
   print("response = \(message)")
   })

Список возможных возвращаемых значений при валидации чеков см. в документации Apple по этой ссылке.

В AppsFlyer предусмотрен метод анонимизации идентификаторов определенных пользователей в аналитике AppsFlyer. Этот метод соответствует последним требованиям по защите личной информации и политикам Facebook в отношении обработки данных и конфиденциальности. Значение по умолчанию — NO (НЕТ), то есть по умолчанию анонимизация не выполняется.

Для реализации явной анонимизации установок, событий и сеансов пользователя используйте этот API во время инициализации SDK:

AppsFlyerTracker.shared().deviceTrackingDisabled = true

[AppsFlyerTracker sharedTracker].deviceTrackingDisabled = YES;

Чтобы снова запустить отслеживание, еще раз вызовите метод deviceTrackingDisabled со значением "false" (ложь).

По умолчанию 2 сеанса учитываются как отдельные, если интервал между двумя запусками приложения составляет не меньше 5 секунд (см. дополнительные сведения об учете сеансов). 
Однако если необходимо установить свой вариант минимального интервала между сеансами, можно использовать этот API:

AppsFlyerTracker.shared().minTimeBetweenSessions = <ваш_временной_интервал_в_секундах>

[AppsFlyerTracker sharedTracker].minTimeBetweenSessions = <ваш_временной_интервал_в_секундах>;

Расширение приложения требует разрешения на доступ к интернету:

1. Откройте файл info.plist для своего приложения, которое содержит расширение.
2. В группе NSExtension / NSExtensionAttributes установите для флага RequestsOpenAccess значение YES.

Добавьте в подкласс UIViewController расширения приложения приведенный ниже код для метода 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];
    }

In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API. Once this API is invoked, our SDK no longer communicates with our servers and stops functioning.

Есть несколько различных сценариев, которые пользователь.может применить для отказа. Настоятельно рекомендуется строго следовать инструкциям сценария, применимого для вашего приложения.

AppsFlyerTracker.shared().isStopTracking = true

[AppsFlyerTracker sharedTracker].isStopTracking = true;

SDK AppsFlyer позволяет собирать информацию об имени устройства для внутреннего анализа. По умолчанию данная функция отключена. Чтобы включить ее, используйте следующий API:

>AppsFlyerTracker.shared().shouldCollectDeviceName = false`

[AppsFlyerTracker sharedTracker].shouldCollectDeviceName = NO;

API setAdditionalData необходим для интеграции на уровне SDK с несколькими внешними партнерским платформами, включая Segment, Adobe и Urban Airship. Используйте данный API, только если в статье об интеграции платформы специально указано необходимость использования API  setAdditionalData.
Ниже приведен примеры кода для использования setAdditionalData в приложениях для iOS на Objective-C и 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