SDK Stats
Open Source Github Repo: https://github.com/BranchMetrics/ios-branch-deep-linking-attribution
SDK Size: ~220kb (with all Branch features enabled)
Speed: Median 80ms to 250ms
Minimum XCode Version: 15.0+
Minimum OS version: iOS 12+
iOS Demo App
Want to take our technology for a test drive before implementing it?
Download the Branch Monster Factory app to practice creating Branch Links, generating Branch QR Codes, and tracking Branch Events all while leveling up your Branch monster!
Want to dive into the code directly?
View the Branch Monster Factory app in GitHub
Basic Integration
Integrating the Branch iOS SDK is required for the following features:
- Ads
- Journeys
Advanced Features
After completing the basic integration, you can implement the following features:
- Create content reference
- Create deep link
- Share deep link
- Read deep link
- Navigate to content
- Display content
- Track content
- Handle push notifications
- Handle links in your own app
Testing
Test your Branch integration before your app goes live.
Test your Branch iOS SDK integration
Troubleshooting
Running into issues? Browse our troubleshooting section to find a solution.
Search solutions to common Branch iOS SDK issues
Version History
View past versions of the Branch SDK for iOS including changes.
View Branch iOS SDK version history
Full Reference
The information presented here serves as a reference manual for our iOS SDK.
View Branch iOS SDK full reference
FAQ
Why is iOS Redirect not working when I have Universal Links enabled?
Taking into understanding that your app's Branch SDK integration is set up just fine and Universal Links are enabled, this seems to be an issue where the AASA files are not getting downloaded in the device.
There is a known universal bug for Apple where devices for iOS version 11.x+, the AASA files do not get fetched and thus causing the Universal Links to fail.
To troubleshoot, try the following:
Follow the steps outlined in this guide to validate if your AASA file successfully downloaded.
If the issue persists, check on the following:
Uninstall the app from the device
Restart the device
Reinstall app
It may take 2-3 tries for this to work. Normally, the Apple OS looks into retrying to fetch the AASA file at some time interval but the workaround might help for a test condition.
Inside the app, check if the AASA files were downloaded successfully or not. To do this:
- Copy the link into your notes app.
- Long-press the link till a dropdown appears. If the dropdown shows 'Open link', then Universal Links are not working for that device. If the link shows 'Open in app name', the configuration is working fine.
Why are email deep links working on Android but not on iOS?
Branch deep links in emails do not work for iOS, since Branch uses Universal Links property to launch the app. As the Universal Links work on link domains, the mailer links wrap the Branch link into a click tracking domain, and hence the final URL changes. When you click the mailer link, it redirects to Branch link on the web as the Universal Links will not work with the new domain.
For such use cases, we have Branch Email where we have partnered with different Email Service Providers (ESPs) to support direct app open, deep linking, and attribution.
What is the minimum SDK version required to get ATT opt-in and opt-out data?
iOS SDK Version 1.39.1 and above is required.
When is the AASA file fetched once I update the AASA file?
Usually, the apple-app-site-association file is checked when the app is first installed and then rechecked during any later app updates from the App Store. So if you add an additional path to the file, it would be detected when the next update app is released but likely not before. Updating the app will usually re-cache the AASA file.