Add Deep Links to Your App Ad

A deep link is a link that goes not only to your app, but to a specific piece of content within your app. With deep linking, you send people directly to information they are interested in when they open your app for the first time.

By using deep linking in your app ads, you are removing extra steps between clicking the ad and getting to the content that made someone want to open your app. This provides a more seamless customer experience. Without deep links, people will have to search through your app for the content they are looking for, and you risk them losing interest.

How a Deep Link Works

1. Your ad shows personalized content. For example, an offer for a vacation to San Francisco.
2. People click to download your app.
3. Because the download link is a deep link, the app opens at the point of inspiration: the vacation to San Francisco.

Because the first landing point in your app is related to the attractive idea that motivated a person to tap the ad, they are more likely to engage with the content of your app.

Step-by-Step Guide

Before You Start

• You must have implemented the Facebook SDK.
• Enabled Install Tracking.

For Android apps, read the official tutorial Create Deep Links to App Content for setup instructions.

1. Add Deep Linking Settings

In the App Dashboard add deep linking information for your app.

Android Settings

• ClassName: Find the ClassName of the launch activity in the file AndroidManifest.xml. The class name should take the form com.example.androidapp.MainActivity.

Android - Navigate to Dashboard > Settings > Android

iOS Settings

• URL Scheme Suffix: Add your URL scheme without ://. For example, if your URL scheme is mytravelapp://, enter mytravelapp.
• App Store ID: You can get your App Store ID from your App Store URL: https://itunes.apple.com/us/app/my-app/APP_STORE_ID.

iOS - Navigate to Dashboard > Settings > iOS

2. Deferred Deep Linking (optional)

Deferred deep linking allows you to send people to a custom view after they install your app through the app store.

When do You Need Deferred Deep Linking?

You must use deferred deep linking if you target people who did not install your app yet. If you are only targeting people who already installed your app, you do not need to add deferred deep linking.

Deferred Deep Linking with App Links

The Facebook SDK for iOS and Android includes the product App Links, which will enable you to support deferred deep linking in your app. In addition to your deep link implementation, just add the following code to your app to handle deferred deep links:

AppLinkData.fetchDeferredAppLinkData(this, 
  new AppLinkData.CompletionHandler() {
     @Override
     public void onDeferredAppLinkDataFetched(AppLinkData appLinkData) {
         // Process app link data
     }
 }
);

# Objective-C

#import <FBSDKCoreKit/FBSDKCoreKit.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  if (launchOptions[UIApplicationLaunchOptionsURLKey] == nil) {
    [FBSDKAppLinkUtility fetchDeferredAppLink:^(NSURL *url, NSError *error) {
      if (error) {
        NSLog(@"Received error while fetching deferred app link %@", error);
      }
      if (url) {
        [[UIApplication sharedApplication] openURL:url];
      }
    }];
  }
  return YES;
}

# Swift
import FacebookCore

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        AppLinkUtility.fetchDeferredAppLink { (url, error) in
            if let error = error {
                print("Received error while fetching deferred app link %@", error)
            }
            if let url = url {
                if #available(iOS 10, *) {
                    UIApplication.shared.open(url, options: [:], completionHandler: nil)
                } else {
                    UIApplication.shared.openURL(url)
                }
            }
        }
        return true;
}

Starting from v5.0.0, we introduce a flag for disabling automatic SDK initialization. If you follow the GDPR compliance in GDPR Compliance in FB SDK Best Practices for GDPR Compliance re-enable automatic initialization first after an end User provides consent before fetching deferred link:

// Get user consent
FacebookSdk.setAutoInitEnabled(true);
FacebookSdk.fullyInitialize();
AppLinkData.fetchDeferredAppLinkData(this, 
  new AppLinkData.CompletionHandler() {
     @Override
     public void onDeferredAppLinkDataFetched(AppLinkData appLinkData) {
         // Process app link data
     }
 }
);

# Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  if (launchOptions[UIApplicationLaunchOptionsURLKey] == nil) {
    // Get user consent
    [FBSDKSettings setAutoInitEnabled:YES];
    [FBSDKApplicationDelegate initializeSDK:nil];
    [FBSDKAppLinkUtility fetchDeferredAppLink:^(NSURL *url, NSError *error) {
      if (error) {
        NSLog(@"Received error while fetching deferred app link %@", error);
      }
      if (url) {
        [[UIApplication sharedApplication] openURL:url];
      }
    }];
  }
  return YES;
}

# Swift
import FacebookCore

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        // Get user consent
        Settings.isAutoInitEnabled = true
        ApplicationDelegate.initializeSDK(nil)
        AppLinkUtility.fetchDeferredAppLink { (url, error) in
            if let error = error {
                print("Received error while fetching deferred app link %@", error)
            }
            if let url = url {
                if #available(iOS 10, *) {
                    UIApplication.shared.open(url, options: [:], completionHandler: nil)
                } else {
                    UIApplication.shared.openURL(url)
                }
            }
        }
        return true;
}

Class Reference: Android > AppLinkData | iOS > FBSDKAppLinkUtility

3. Verify Deep Link Setup

You can verify your Facebook SDK and deep link setup within our App Ads Helper in the tools & support section. We recommend verifying your setup before you start running deep link ads.

4. Add Deep Link to Your Ad

In the Ads Manager, when creating your ad, pay attention to the following settings:

1. Target Platform: In "Who do you want your ads to reach?" use:

   • Android: Android only for the setting platform.
   • iOS: iOS only for the setting platform.

2. Add Deep Link: In "What text and links do you want to use?", add your deep link; for example, mytravelapp://tripId=SF or a URL with Facebook App Links metadata implemented.

If you chose the App Install objective, you can also specify a Deferred Deep Link or a URL with Facebook App Links metadata implemented to take users to a specific location in the app after installing.