tvOS SDK integration for developers

Current Version: 4.7.11

AppsFlyer's tvOS SDK provides app installation and event recording functionality. We have developed an SDK that is highly robust (8+ billion SDK installations to date), secure, lightweight and very simple to embed.


You can record installs, updates and sessions (by following the mandatory steps below), and also record additional in-app events beyond app installs (including in-app purchases, game levels, etc.) to evaluate ROI and user engagement levels.

The mandatory steps are explained below, followed by additional optional features.

The tvOS SDK is compatible with tvOS 9+.


  • AppsFlyer's SDKs are fully compliant with Apple's IPv6 DNS64/NAT64 Networks. For more information, click here.
  • AppsFlyer's SDKs make use of NSUserDefaults class. Clearing values from NSUserDefaults may cause attribution issues.

The following sections are covered in this guide:

SDK_download.png tvOS SDK Download

  • To download the tvOS SDK as a framework click here.

1. What's New in This Version?

  • Updated to Native SDK Version 4.7.11
  • Supports Uninstall Measurement

2. Embedding the SDK into your application (mandatory)

AppsFlyer SDK is available as a framework.

2.1 AppsFlyer TVos SDK Framework

The simplest way to integrate the framework is using cocoapods:

  • Add the following line to your pod file:
    pod ‘AppsFlyerTvOsLib'

If you do not use cocoapods, follow the steps below:

  • In Xcode, go to Build Phases >> Link Binary with Libraries >> Click + to add a new library


  • Click Add Other and add the AppsFlyerLib.framework


  • Include the following header:
    #import <AppsFlyerLib/AppsFlyerTracker.h>

3. SDK initialization & installation event (minimum requirement for attributing)

NOTE: This is the minimum requirement to start attributing your app installs.

You must initialize the SDK on the first launch of the app. Make sure that the SDK is initialized before sending the event below.

3.1 Initializing the SDK

To initialize the SDK, add the following to your “didFinishLaunchingWithOptions” function:

[AppsFlyerTracker sharedTracker].appsFlyerDevKey = @"[Dev_Key]";
[AppsFlyerTracker sharedTracker].appleAppID = @"REPLACE THIS WITH YOUR App_ID";

NOTEYou should enter the number only and not the "ID" prefix. For example, if your App ID is id123456789 the above should appear as:

[AppsFlyerTracker sharedTracker].appleAppID = @"123456789";

Replace [Dev_Key] with your own Dev_Key (accessible from your account, see Settings >> Integrate the SDK into... in the AppsFlyer dashboard). For example: a4kGpVyxm8iGgzvzT8NPaV

3.2 Adding Code

Add the following code to your AppDelegate.m source file at “applicationDidBecomeActive” function:

#import "AppsFlyerTracker.h"
-(void)applicationDidBecomeActive:(UIApplication *)application
   // Record Installs, updates & sessions(app opens) 
   //(You must include this API to enable attribution and event recording)
   [[AppsFlyerTracker sharedTracker] trackAppLaunch];


  • If your app supports deep linking, implement the procedure as explained in section 5.7 to enable you to measure sessions and other in-app activities following a successful deep link.

4. In-App Events Recording API (Optional)

This API enables AppsFlyer to record post install events. These events are defined by the advertiser and include an event name in addition to optional event values.

Recording in-app events helps you measure and analyze how loyal users discover your app, and attribute them to specific campaigns/media sources. It is recommended to take the time and define the events you would like to measure to allow you to measure ROI (Return on Investment) and LTV (Lifetime Value).


- (void) trackEvent:(NSString *)eventName withValues:(NSDictionary*)values

eventName is any string to define the event name.

values is a dictionary of event parameters that comprise a rich event.

Counting revenue as part of a rich in-app event: Use the ‘af_revenue” (constant)


event parameter to count revenue as part of an in-app event. You can populate it with any numeric value, positive or negative.

NOTE: “af_price”


is not counted as revenue and is a descriptive parameter which does not affect revenue and LTV measurements.

Example 1: Level Achieved In-App Event

[[AppsFlyerTracker sharedTracker] trackEvent: AFEventLevelAchieved withValues:@{    
  AFEventParamLevel: @9,
  AFEventParamScore : @100 }];

This generates an event of type “af_level_achieved” with the following event values:

{af_level: 9 , af_score: 100}

Example 2: Purchase Event

[[AppsFlyerTracker sharedTracker] trackEvent:AFEventPurchase withValues: @{
  AFEventParamContentType : @"category_a",
  AFEventParamRevenue: @200,

This generates an event of type “af_purchase” with the following event values:

{af_content_id: “1234567” , af_content_type: “category_a”, af_revenue: 200, af_currency: “USD”}

The purchase event above contains a $200 revenue, appearing as revenue in the dashboard.

NOTE: An In-app event name must be no longer than 45 characters. Events names with more than 45 characters do not appear in the dashboard, but only in the raw Data, Pull and Push APIs.

For details of the AppsFlyer Rich In-App Events for iOS, click here.

5. Advanced integration

The APIs below are optional and are part of the advanced integration with AppsFlyer SDK.

5.1 Set currency code (optional)

You can set a global currency code using the API below, in addition to specific currency codes that can be used as part of each in-app event that is sent to AppsFlyer. The global currency code is used when “af_currency” (AFEventParamCurrency) is not sent as part of an in-app event.

USD is the default value. Find acceptable ISO currency codes here.

Use the following API in order to set the currency code:

[[AppsFlyerTracker sharedTracker].currencyCode = @"GBP"];

5.2 Get AppsFlyer unique ID (optional)

An AppsFlyer proprietary unique ID is created for every new install of an app. AppsFlyer’s unique ID is the main ID used by AppsFlyer in the Reports and APIs.

Use the following API In order to get AppsFlyer’s unique ID:

(NSString *) [AppsFlyerTracker sharedTracker] getAppsFlyerUID

5.3 Set customer user ID (optional)

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with postbacks APIs for cross-referencing with your internal IDs.

To set your customer user ID:

[[AppsFlyerTracker sharedTracker].customerUserID = @"YOUR_CUSTOMER_USER_ID"];


  • The set customer ID, must be called before the trackAppLaunch.
  • It is recommended to set your Customer User ID as soon as possible as it is only associated to events reported after setting this attribute.
  • You must set the Customer User ID using this API in order to use AppsFlyer’s integrations with Analytics platforms such as Mixpanel and Swrve.

For more information about the Customer User ID, click here.

5.4 Get conversion data (optional)

AppsFlyer allows you to access the user attribution data in real time directly at the SDK level. It enables you to customize the landing page a user sees on the very first app open after a fresh app install.

For more information regarding this advanced functionality, read here.

5.5 Enabling App Extension Support

The app extension requires permissions to use the Internet:

  1. Go to your app extension's info.plist file
  2. In the NSExtension / NSExtensionAttributes set the RequestsOpenAccess flag to YES.

On the App Extension ViewController ViewDidLoad initialize AppsFlyerLib:

[AppsFlyerTracker sharedTracker].appsFlyerDevKey = @"YOUR_DEV_KEY_HERE";
[AppsFlyerTracker sharedTracker].appleAppID = @"APP_ID_HERE"; 
[AppsFlyerTracker sharedTracker].delegate = self;
[[AppsFlyerTracker sharedTracker] trackAppLaunch];

To receive Conversion Data:

  1. Go to the App Extension ViewController.h
  2. Import AppsFlyer header file
#import "AppsFlyerTracker.h"
  1. Add <AppsFlyerTrackerDelegate> on the interface declaration

On the Extension ViewController.m add the following methods:

-(void)onConversionDataSuccess:(NSDictionary*) installData {
  id status = [installData objectForKey:@"af_status"];
  if([status isEqualToString:@"Non-organic"]) {   
   id sourceID = [installData objectForKey:@"media_source"];   
   id campaign = [installData objectForKey:@"campaign"];   
   NSLog(@"This is a none organic install. Media source: %@ Campaign: %@",sourceID,campaign);   
 } else if([status isEqualToString:@"Organic"]) {   
   NSLog(@"This is an organic install.");   
-(void)onConversionDataFail:(NSError *) error { 
- (void) onAppOpenAttribution:(NSDictionary*) attributionData { 
 NSLog(@"attribution data: %@", attributionData);
- (void) onAppOpenAttributionFailure:(NSError *)error {

5.7 Reporting deep links for retargeting attribution (optional)

AppsFlyer enables you to report launches initiated through deep links and Universal Links and to analyze the performance of your retargeting attribution campaigns.

To report such launches, add the following code to the app delegate:

// Reports app open from a Universal Link for iOS 9
- (BOOL) application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *_Nullable))restorationHandler
[[AppsFlyerTracker sharedTracker] continueUserActivity:userActivity restorationHandler:restorationHandler];
return YES;
// Reports app open from deeplink for iOS 8 or below
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url
   sourceApplication:(NSString*)sourceApplication annotation:(id)annotation

[[AppsFlyerTracker sharedTracker] handleOpenURL:url sourceApplication:sourceApplication withAnnotation:annotation];
return YES;

For more information see, OneLink Set-Up Guide.

5.8 In-app purchase receipt validation (optional)

NOTE: This function is supported for iOS7 and above.

AppsFlyer’s SDK can provide in‐app purchase server verification. To set receipt validation you need to call the validateAndTrackInAppPurchase method inside the SKStoreKit’s completeTransaction: callback. This call automatically generates an “af_purchase” in‐app event.

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

This call has two callback blocks, one for ‘success’ and one for ‘failure’ (for any reason, including validation fail). On success, a dictionary is returned with the receipt validation data provided by Apple’s servers.

IMPORTANT: For testing purposes, we recommend to set the useReceiptValidationSandbox flag to YES, as this redirects the requests to Apple sandbox servers.

[AppsFlyerTracker sharedTracker].useReceiptValidationSandbox = YES;


[[AppsFlyerTracker sharedTracker] validateAndTrackInAppPurchase:product.productIdentifier price:product.price.stringValue
additionalParameters:@{@"test": @"val" , @"test1" : @"val 1"}
success:^(NSDictionary *result){
        NSLog(@"Purcahse succeeded And verified!!! response: %@", result[@"receipt"]);
} failure:^(NSError *error, id response) {
        NSLog(@"response = %@", response);

5.9 End user opt-out (optional)

AppsFlyer provides you a method to opt‐out specific users from AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is NO, meaning attribution and event recording are enabled by default. Use this API during the SDK initialization in Section 4 to explicitly opt-out:

[AppsFlyerTracker sharedTracker].deviceTrackingDisabled = YES;

5.10 Explicit Opt-out from ID for Advertisers – IDFA/IFA (Optional)

The AppsFlyer SDK collects IDFA only if AdSupport.framework library is included in your project. There is no need to explicitly opt‐in or opt‐out. However, if you want to explicitly opt‐out IDFA, use the following API during the SDK initialization in Section 4:

[AppsFlyerTracker sharedTracker].disableAppleAdSupportTracking = YES;

The IDFA is NOT collected to the AppsFlyer servers when the disableAppleAdSupportracking is set to YES.

5.11 Uninstall measurement (optional)

AppsFlyer enables you to measure app uninstalls rates. For implementation details about this feature please see section 5.11 in the SDK integration guide - click here.

5.12 Implementing deep linking with OneLink (optional)

OneLink triggers an app to open at the deep link location by mentioning the scheme under the af_dp parameter, or the Universal Links for iOS9.

You can implement the callback onAppOpenAttribution called by the AppsFlyer SDK. It returns the Onelink parameters used to trigger the app open. Then, you can parse the values and apply the logic to trigger the relevant app page.

(void) onAppOpenAttribution:(NSDictionary*) attributionData; ///iOS

For more information, click here.

6. Testing the SDK Integration

To learn how to test the SDK integration before submitting to the App Store, click here and after submitting to the App Store click here.

Was this article helpful?
0 out of 0 found this helpful