iOS SDK V6.X integration guide for developers

At a glance: The AppsFlyer iOS SDK V6.X (tested with iOS 14 beta 7), referred to as SDK,  provides app attribution and event reporting functionality for iOS apps while enabling app owners and developers to prepare for the upcoming iOS 14 release. This SDK version incorporates significant method changes compared to previous versions. 

ioios2.png

Release notes (up to V6.0.3)

 Important!

iOS SDK V5.4.4 is fully operational with iOS 14. However, we recommend updating to SDK V6 to ensure compatibility with future iOS releases. for future iOS updates. See Updating to iOS SDK V6.

1. Overview

The SDK provides app installation and event recording functionality. The SDK is robust, secure, lightweight, and simple to embed.

You can record installs, updates, sessions, and in-app events. In-app events support in-app purchases, game levels, etc. to evaluate ROI and user quality. 

iOS version Attribution models supported
iOS 13 and below
  • Probabilistic modeling
  • User-level (IDFA): No consent required. User can opt-out using LAT.

iOS 14 and above

(tested using iOS 14 beta 7)

  • SKAdNetwork Solution*: 
    • Is always available at the iOS and SDK level irrespective of ATT setting. 
    • The advertiser enables SKAdNetwork in the AppsFlyer dashboard.
  • Probabilistic modeling
  • User-level (IDFA): By default, IDFA is collected. Consent dialog is optional.

* iOS SDK V5.4 and earlier:

  • SKAdNetwork Solution is not available as an attribution method
  • SDK V5.4 has been tested with iOS 14 beta 7. Some iOS functions like ATT are not supported.
Attribution models

1.1 SDK integration—what you need to do

Tab Purpose Result

SDK Integration 
[Mandatory]

Shows how to add and configure the SDK.
  • A new organic install in your app dashboard.
  • A new non-organic install in your app dashboard.

Core APIs 
[Recommended]

Shows how to use the SDK core APIs. These APIs allow you to measure in-app events and revenue, perform deep linking and gather conversion data.

In-app events and revenue appear on your dashboard.

You are able to perform deep linking.

Additional APIs

Shows how to implement and use optional APIs such as uninstall measurement, Referrals (user invite attribution), and push notifications.

You are able to measure uninstalls, referrals, user engagements with push notifications, handle user privacy scenarios and more.

API reference

Quick reference of the SDK APIs for developers

 

1.2 SDK compatibility with iOS

  • This SDK is:
    • Compatible with all iOS and tvOS devices (iPhone, iPod, iPad, Apple TV) with iOS version 6 and later and tvOS version 9 and later.
    • Complies with Apple IPv6 DNS64/NAT64 networks.

 Note

Apple iOS 14 App Clips are just around the corner!
Learn all about them in our Definitive App Clips Guide for Developers

Was this article helpful?

Comments

6 comments
  • Hi everyone!

    We want to update you that a new AppsFlyer iOS SDK has been released - version 4.10.3.

    This version supports iOS 13 updates, specifically push token retrieval for Uninstall Measurement.
    The new version also includes bugs fixes and improvements.

    We recommend that you update your app to use version 4.10.3.

    Thank you!

    0
    Comment actions Permalink
  • Hi everyone!

    We want to update you that a new AppsFlyer iOS SDK has been released - version 5.0.0.

    The new version introduces changes to method names and SDK functionality.

    We recommend that you update your app to use version 5.0.0. If you update to version 5.0.0, pay attention to changes in method names and conversion data format.

    For more information, see the following link:
    https://support.appsflyer.com/hc/en-us/articles/360003090618

    0
    Comment actions Permalink
  • Hi everyone!

    We want to update you that a new AppsFlyer iOS SDK has been released - version 5.1.0.

    The new version improves Objective-C - Swift interoperability.

    When our SDK guarantees that a certain value is not null, we return non-optional value. Otherwise, we return an optional so you need to unwrap it manually. If you migrated from older versions of the SDK and used to have unwrapping “?” character in any code that references the SDK, you will get compile-time error now unless you remove “?” as the returned type is no longer optional.

    We recommend that you update your app to use version 5.1.0. If you update to this version, make sure you adapt your code accordingly.

    For more information on optional and unwrapping in swift, see the following link:
    https://docs.swift.org/swift-book/LanguageGuide/OptionalChaining.html

    0
    Comment actions Permalink
  • Hi there!

    AppsFlyer iOS SDK version 5.2.0 has been released.
    Why should you update to it?

    Besides maintenance and bug fixes the new version introduces the following features :
    * Allow setting advanced deferred deep linking for Facebook users
    * Allow generating branded links when using User Invite feature
    * Extended security, logging, and debugging capabilities

    If you use these features or haven't updated the SDK in a while, we recommend doing so.

    0
    Comment actions Permalink
  • Hi everyone!

    AppsFlyer iOS SDK version 5.3.0 has been released! This version includes general bugs fixes and improvements, plus the following additional features:
    * Direct deep linking attribution data can be accessed at any time
    * Additional parameters are available for cross-promotion impressions
    * Main apps and app extensions get the same AppsFlyer ID, so in-app events are grouped similarly

    If you need these features or haven't updated the SDK in a while, we recommend doing so.

    Thanks!

    0
    Comment actions Permalink
  • Hi everyone!

    AppsFlyer iOS SDK version 5.4.1 has been released! This version includes general bug fixes and improvements, plus the following additional features:
    * setSharingFilter API that allows advertisers to control sharing data with integrated partners/networks.
    * onAppOpenAttribution method - aligned the response of iOS Universal Links with the rest of the use cases.

    If you need these features or haven't updated the SDK in a while, this is a great time to do so :)

    -1
    Comment actions Permalink

Please sign in to leave a comment.