AppsFlyerLib

Обзор

AppsFlyerLib  — это основной класс SDK AppsFlyer для iOS, который содержит большинство его методов.

Чтобы импортировать AppsFlyerLib:

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

@interface AppDelegate : UIResponder <UIApplicationDelegate, AppsFlyerLibDelegate>

@end

import AppsFlyerLib

Вернуться к Указателю справочника по SDK.

Свойства

advertisingIdentifier (read-only)

Объявление свойства

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

Описание
SDK AppsFlyer собирает от Apple advertisingIdentifier if the AdSupport.framework включен в SDK.
Вы можете отключить эту функцию, задав для свойства disableAdvertisingIdentifier to true.

anonymizeUser

Объявление свойства

@property(atomic) BOOL anonymizeUser;

Описание
Отключает регистрацию данных по конкретному пользователю

appInviteOneLinkID

Объявление свойства

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

Описание
Позволяет указать ваш идентификатор OneLink из конфигурации OneLink. Используется в приглашениях пользователей для создания ссылки OneLink.

appleAppID

Объявление свойства

@property(nonatomic, strong) NSString * appleAppID

Описание
Используйте это свойство, чтобы указать Apple ID своего приложения (взятый со страницы приложения в iTunes Connect)

appsFlyerDevKey

Объявление свойства

@property(nonatomic, strong) NSString * appsFlyerDevKey

Описание
Используйте это свойство, чтобы указать свой ключ разработчика AppsFlyer.

currencyCode

Объявление свойства

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

Описание
Для событий покупки в приложении можно указывать код валюты, в которой пользователь совершил оплату.
Код валюты — это трехбуквенный код по стандарту ISO.

Пример использования

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

AppsFlyerLib.shared().currencyCode = "USD"

customData

📘

Параметр customData before first launch will have the additional data included in installs, sessions, as well as in-app events.

Объявление свойства

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

Описание
Используется для добавления настраиваемых данных в рабочую нагрузку событий. Вы будете получать их в отчетах с сырыми данными.

customerUserID

Объявление свойства

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

Описание
Если вы используете свой идентификатор пользователя в приложении, его можно указать в качестве значения этого свойства.
В результате вы сможете сопоставить свой уникальный идентификатор с уникальным идентификатором AppsFlyer и идентификаторами других устройств.

deepLinkDelegate

Объявление свойства

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

Описание
Свойство delegate объекта, которое соответствует протоколу DeepLinkDelegate и реализует его методы.

Пример использования

AppsFlyerLib.shared().deepLinkDelegate = self

deepLinkTimeout

Описание
Истекло время ожидания запроса отложенного диплинкинга.

Единицы измерения в миллисекундах.

Объявление свойства

@property(nonatomic) NSUInteger deepLinkTimeout

delegate

Описание
Делегат AppsFlyer. См. AppsFlyerLibDelegate.
Объявление свойства

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

disableAdvertisingIdentifier

Объявление свойства

@property (nonatomic) int disableAdvertisingIdentifier;

Описание
исходящей ссылки, если параметр AdSupport.framework не отключен, SDK собирает от Apple advertisingIdentifier.
Вы можете отключить эту функцию, задав для следующего свойства значение YES.

disableAppleAdsAttribution

Объявление свойства

@property(nonatomic) BOOL disableAppleAdsAttribution

Описание
Disables AdServices framework-based attribution for Apple Search Ads.

disableCollectASA

Объявление свойства

@property(atomic) BOOL disableCollectASA;

Описание
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

Объявление свойства

@property(nonatomic) BOOL disableIDFVCollection;

Описание
Чтобы отключить сбор идентификаторов для поставщиков (IDFV), задайте для disableIDFVCollection to YES.

disableSKAdNetwork

Объявление свойства

@property(nonatomic) BOOL disableSKAdNetwork

Описание

facebookDeferredAppLink

Объявление свойства

@property (nonatomic, nullable) int *facebookDeferredAppLink;

Описание
Позволяет вручную указать ссылку App Links Facebook для отложенного диплинкинга.

host (read-only)

Объявление свойства

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

Описание
Это свойство принимает строковое значение, представляющее собой имя хоста для всех конечных точек. Задайте хост с помощью setHost.

Чтобы использовать конечную точку SDK по умолчанию, в качестве значения укажите nil.

hostPrefix (read-only)

Объявление свойства

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

Описание
Это свойство принимает строковое значение, представляющее собой префикс имени хоста для всех конечных точек. Задайте хост с помощью setHost.

isDebug

Объявление свойства

@property(nonatomic) BOOL isDebug;

Описание
Печатает сообщения SDK в журнале консоли. В рабочих сборках должно быть отключено.

isStopped

Объявление свойства

@property(atomic) BOOL isStopped;

📘

Перезапуск SDK

Установлено isStopped = true , а затем настройте isStopped = false

Не нужно вызывать start()

Описание
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

Объявление свойства

@property(atomic) NSUInteger minTimeBetweenSessions;

Описание
Задает желаемый минимальный интервал между сессиями.

Входные аргументы

oneLinkCustomDomains

Объявление свойства

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

Описание
Для рекламодателей, использующих ссылки OneLink с vanity URL.

phoneNumber

Объявление свойства

@property(nonatomic, nullable) NSString *phoneNumber

Описание

resolveDeepLinkURLs

Объявление свойства

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

Описание

Пример использования
Некоторые сторонние службы, например, почтовые сервисы (ESP), упаковывают ссылки в электронных письмах в собственные домены регистрации кликов. Некоторые даже разрешают вам задавать свои домены регистрации кликов. Упаковка ссылки OneLink в такие домены может привести к ограничению ее функциональных возможностей.

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

Например, у вас есть три домена регистрации кликов, которые выполняют перенаправление на вашу ссылку OneLink по адресу https://mysubdomain.onelink.me/abCD. Используйте этот API для получения ссылки OneLink, на которую перенаправляют домены регистрации кликов. Этот метод API получает список доменов, разрешение которых выполняет SDK.

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

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

Это позволяет использовать домен регистрации кликов, сохраняя при этом функциональные возможности OneLink. Домены регистрации кликов выполняют запуск приложения. API, в свою очередь, получает от этих доменов ссылку OneLink, после чего ее данные можно использовать для диплинкинга и персонализации контента для пользователей.

sharingFilter

Объявление свойства

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

Описание

shouldCollectDeviceName

Объявление свойства

@property(nonatomic) BOOL shouldCollectDeviceName;

Описание
Установите этот флажок в значение YES, чтобы собирать текущее имя устройства (например, «Мой iPhone»).

useReceiptValidationSandbox

Объявление свойства

@property (nonatomic) BOOL useReceiptValidationSandbox;

Описание
Проверка чека для покупок в приложении в среде Apple (рабочей среде или песочнице).

useUninstallSandbox

Объявление свойства

@property (nonatomic) BOOL useUninstallSandbox;

Описание
Установите этот флажок, чтобы протестировать удаления приложения в среде Apple (рабочей среде или песочнице).

Методы

addPushNotificationDeepLinkPath

Сигнатура метода

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

addPushNotificationDeepLinkPath(deepLinkPath: [String])

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

Входные аргументы

Возвращаемые значения
void.

Пример использования
Базовая конфигурация:

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

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

Расширенная конфигурация:

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

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

Этому вызову соответствует следующая структура полезной нагрузки:

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

appendParametersToDeepLinkingURL

Сигнатура метода

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

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

Описание
Сопоставляет URL-адреса, которые содержат contains в качестве подстроки и добавляет к ним параметры запроса. Если URL-адрес не совпадает, параметры к нему не добавляются.

🚧

Вызовите этот метод до вызова start

Входные аргументы

Возвращаемые значения
void.

continue

Сигнатура метода

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

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

Описание

Разрешает AppsFlyer обрабатывать восстановление данных из NSUserActivity. Используйте этот метод для обработки универсальных ссылок.

Входные аргументы

Возвращаемые значения
void.

enableFacebookDeferderedApplinks

Сигнатура метода

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

enableFacebookDeferredApplinks(with:AnyClass?)

Описание
Включает сбор данных App Links Facebook для отложенного диплинкинга.

• Требует, чтобы на целевом/клиентском устройстве были установлены SDK Facebook и приложение Facebook.
• Для корректной работы этот API необходимо вызывать до инициализации SDK AppsFlyer.

Входные аргументы

Возвращаемые значения
void.

enableTCFDataCollection

Сигнатура метода

- (void)enableTCFDataCollection:(BOOL)flag;

func enableTCFDataCollection(_ flag: Bool)

Описание
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).

Входные аргументы

Возвращаемые значения
void.

getAppsFlyerUID

Сигнатура метода

- (NSString *)getAppsFlyerUID;

getAppsFlyerUID()

Описание
Получение от AppsFlyer уникального идентификатора устройства. SDK генерирует уникальный идентификатор устройства AppsFlyer при установке приложения. При запуске SDK этот идентификатор записывается как идентификатор первой установки приложения.

Входные аргументы
Этот метод не принимает входные аргументы.

Возвращаемые значения

getSDKVersion

Сигнатура метода

- (NSString *)getSDKVersion;

getSDKVersion()

Описание
Получает версию SDK.

Входные аргументы
Этот метод не принимает входные аргументы.

Возвращаемые значения

handleOpen

Сигнатура метода

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

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

Описание
Вызывайте этот метод из класса AppDelegate, метода openURL method.
This method handles URI-scheme for iOS 9 and above.

Входные аргументы

Возвращаемые значения
void.

handlePushNotification

Сигнатура метода

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

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

Описание
Включает в AppsFlyer обработку push-уведомлений.

Входные аргументы

Возвращаемые значения
void.

logAdRevenue

Added in v6.15.0

Сигнатура метода

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

Описание

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

Входные параметры

Возвращаемые значения

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

Сигнатура метода

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

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

Описание
Используйте этот метод для регистрации события с параметрами события.

Входные аргументы

Возвращаемые значения
void.

logEvent

Сигнатура метода

- (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)?)

Описание
Используйте этот метод для регистрации события с параметрами события и передачи обработчика завершения для обработки успешной/неуспешной отправки события.

Входные аргументы

Возвращаемые значения
void.

logLocation

Сигнатура метода

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

logLocation(longitude: Double, latitude: Double)

Описание
Регистрирует местоположение для определения геозон. Делает то же, что и приведенный ниже код.

Входные аргументы

Возвращаемые значения
void.

performOnAppAttribution

Сигнатура метода

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

performOnAppAttribution(with:URL?)

Описание
Используется, чтобы вручную запускать делегат onAppOpenAttribution delegate.

Входные аргументы

Возвращаемые значения
void.

registerUninstall

Сигнатура метода

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

registerUninstall(deviceToken: Data?)

Описание
Регистрация удалений. Вам необходимо зарегистрироваться для получения удаленных уведомлений и предоставить AppsFlyer токен устройства для push-уведомлений.

Входные аргументы

Возвращаемые значения
void.

setConsentData

Сигнатура метода

.setConsentData(afConsent: AppsFlyerConsent)

- (void)setConsentData:(AppsFlyerConsent) afConsent

Описание

Transfers consent data to the SDK.

Входные аргументы

setCurrentDeviceLanguage

Сигнатура метода

- (void)setCurrentDeviceLanguage:(NSString *)currentDeviceLanguage

Описание
Используйте этот метод, чтобы задать в SDK язык устройства и передать его в AppsFlyer.

Входные аргументы

Пример использования

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

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

setHost

Сигнатура метода

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

setHost(host: String, withHostPrefix: String)

Описание
Эта функция задает имя хоста и префикс имени хоста для всех конечных точек.

Примечание. Начиная с SDK V6.11, если значение хоста пустое или null, вызов API будет проигнорирован.

Входные аргументы

Возвращаемые значения
void.

Пример использования

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

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

setPartnerData

Сигнатура метода

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

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

Описание
Разрешает отправку настраиваемых данных для интеграции с партнерами.

Входные аргументы

Возвращаемые значения
void.

Пример использования

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

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

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

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

setSharingFilterForPartners

Добавлено в версии 6.4
Сигнатура метода

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

This function replaces the deprecated setSharingFilterForAllPartners

Описание
Позволяет настроить, каких партнеров SDK должен исключать из обмена данными.

Входные аргументы

Внимание:
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. Выполните команду Получить API активных интеграций, чтобы получить список всех активных интеграций
2. Используйте media_source_name из ответа API как входные значения для массива partners метода.

Исключения:

• Для Apple Search Ads используйте Apple Search Ads (а не iossearchads_int).
• For Twitter, use twitter (а не twitter_int)

Пример использования

[[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

Устарело в версии 6.4
Сигнатура метода

- (void)setSharingFilterForAllPartners;

setSharingFilterForAllPartners()

This function is deprecated and has been replaced by setSharingFilterForPartners

Описание
Block an event from being shared with integrated partners.

Входные аргументы
Этот метод не принимает входные аргументы.

Возвращаемые значения
void

setUserEmails

Сигнатура метода

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

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

Описание
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.

Входные аргументы

Возвращаемые значения
void.

shared

Сигнатура метода

(AppsFlyerLib *)shared;

Описание
Получает одноэлементный экземпляр класса AppsFlyerLib , при необходимости создавая его.

Пример использования

AppsFlyerLib.shared()

start

Сигнатура метода

- (void)start;

(void) start()

Описание
Запускает SDK.

Входные аргументы
Этот метод не принимает входные аргументы.

Возвращаемые значения
void.

start

Сигнатура метода

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

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

Описание
Запускает SDK с обработчиком завершения.

Входные аргументы

Возвращаемые значения
void.

validateAndLogInAppPurchase

(Supported from SDK v.6.14.1)

Сигнатура метода

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

Описание

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.

Входные параметры

Возвращаемые значения
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)

Сигнатура метода

- (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)?)

Описание
Чтобы регистрировать и проверять покупки в приложении, вызывайте этот метод из метода [completeTransaction] в SKPaymentTransactionObserver.

Входные аргументы

Возвращаемые значения
void.

waitForATTUserAuthorization

Сигнатура метода

- (void)waitForATTUserAuthorizationWithTimeoutInterval:(id)timeoutInterval;

waitForATTUserAuthorization(timeoutInterval:)

Описание
Ожидает подтверждения запроса пользователем для доступа к данным, связанным с приложением

Входные аргументы

Пример использования

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

Возвращаемые значения
void.