Интеграция AppsFlyer SDK — iOS. Информация для разработчиков

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

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

NSString *appsflyerId = [AppsFlyerTracker sharedTracker].getAppsFlyerUID;

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

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

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

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

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

Идентификатор пользователя-клиента можно получить из объекта sharedTracker.

[AppsFlyerTracker sharedTracker].customerUserID

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

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

Для измерения количества удалений нужно включить в приложении push-уведомления. Подробные сведения см. в документе Apple Руководство по программированию удаленных уведомлений.

См. указания по настройке отслеживания удалений в инструкции по интеграции SDK для iOS .

Чтобы включить отслеживание запуска приложений из 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 позволяет атрибутировать и регистрировать установки, источником которых является перекрестная реклама одного из ваших приложений в другом приложении, которое уже есть у пользователя. Перекрестная реклама позволяет значительно увеличить количество установок ваших приложений.

Подробные сведения см. в статье Атрибуция в кампаниях перекрестной рекламы.

При покупках из приложения 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:@"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>
    })

Список возможных возвращаемых значений при валидации чеков см. в документации 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];
  }

В исключительных случаях может потребоваться полное отключение всех функций SDK для соблюдения норм законодательства и правил конфиденциальности. Для этого можно использовать API isStopTracking. После вызова этого API пакет SDK завершит обмен данными с нашими серверами и перестанет функционировать.

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

AppsFlyerTracker.shared().isStopTracking = true

[AppsFlyerTracker sharedTracker].isStopTracking = true;

Можно отложить инициализацию SDK до настройки идентификатора клиента customerUserID. Это позволит гарантировать, что SDK не начнет функционировать до предоставления идентификатора customerUserID. Если инициализация SDK отложена, все внутренние события приложения и вызовы всех других API SDK игнорируются до тех пор, пока не будет предоставлен и зарегистрирован идентификатор customerUserID.

Чтобы отсрочить инициализацию SDK до регистрации идентификатора customerUserID, можно в API для iOS добавить логические операторы в метод applicationDidBecomeActive. См. приведенные ниже примеры.

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

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

Если используются ссылки OneLink, которые поддерживают ссылки для приложений Android, и при этом упаковываются в сторонние универсальные ссылки, то для уведомления SDK AppsFlyer о том, какие домены CLICK, вызывающие приложение, нужно разрешить и использовать для извлечения базовой ссылки OneLink, можно применять API setResolveDeepLinkURLs. Это позволит поддерживать диплинкинг и атрибуцию при упаковке ссылки OneLink в стороннюю универсальную ссылку. Этот API нужно обязательно вызвать перед инициализацией SDK.

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

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