Implementing Branded Links

Setting up a Branded Links consists of associating a full domain set in your DNS with a OneLink subdomain in AppsFlyer as depicted in the following figure. 

Branded Link pointing to AppsFlyer servers

Before you begin:

• Choose a full domain name, for example, click.abcdef.com where abcdef.com is your brand.
  • The subdomain, for example click, can also be customized.
• Request that the DNS admin create the full domain (aka host). 

To map your full domain to a OneLink subdomain:

1. Go to Engagement & Deep Linking > Branded Links.
2. Click Add Branded Link.
3. In the Brand Domain field, enter your full domain as set in your DNS. For example, click.abcdef.com
   Do not place a period after the domain. 
4. Select the OneLink subdomain from the list that displays. 
5. Click Verify.
   The DNS settings status displays.

   

6. If the domain doesn't exist message displays:
   1. Ensure that you have entered the full domain correctly and correct it if necessary.
   2. Click Reverify.

      

   3. If the domain doesn't exist message persists:
      1. Contact your DNS admin and ask them to investigate.
      2. Wait for the DNS admin to confirm that the domain is registered. 
      3. Click Reverify. If the message Domain exists displays, continue with this procedure.
7. If the AppsFlyer CNAME not found message displays:
   1. Copy the URL that displays. Tip! Use the copy icon. 
   2. Click Add. 
      The window closes. 
   3. Request that the DNS admin set a CNAME record such that the full domain (Brand domain) points to the specified URL (aka AppsFlyer host). This is depicted in the figure Branded Link pointing to AppsFlyer servers in this section. 
   4. Wait for the DNS admin to confirm that the CNAME is active.
      
      

To verify that a Branded Link is operational: 

1. Go to Engagement & Deep Linking > Branded Links.
2. Select the branded link.
   The Edit Branded link window opens.
3. Click Verify.
   The DNS settings status display. Both should have a green checkmark to confirm that they are correctly set in the DNS. If either has a red checkmark, contact your DNS admin.
   Note: Your DNS records MUST enable letsencrypt.org to create a certificate for your domain (CAA). 

• Use the following SDK versions:
  
  • Android V4.10.1 and later
  • iOS V4.10.1 and later
  • User invite referral (invite a friend) requires SDK version V5.2.0 and later for both iOS and Android 

Branded Links SDK implementation considerations

• When deep linking takes place using Branded Links, the AppsFlyer SDK can't get conversion data for installs and deep linking.
• To overcome this, the developer uses the setOneLinkCustomDomain SDK API.
• This API queries the branded link, gets the OneLink to which it is mapped, and finally queries the OneLink to get conversion data. Example setting. 

public class AFApplication extends Application {

    @Override
    public void onCreate() {
    super.onCreate();

      AppsFlyerConversionListener conversionListener = new AppsFlyerConversionListener() {

        // implement AppsFlyerConversionListener callbacks 
        // see https://support.appsflyer.com/hc/en-us/articles/207032126#integration-32-initializing-the-sdk

      }
      
      // set branded link domain
      AppsFlyerLib.getInstance().setOneLinkCustomDomain("promotion.greatapp.com");
      AppsFlyerLib.getInstance().init(AF_DEV_KEY, conversionListener, this);
      AppsFlyerLib.getInstance().start(this, AF_DEV_KEY);

    }
}

AppsFlyerLib.getInstance().setOneLinkCustomDomain("promotion.greatapp.com", 
                                                        "click.greatapp.com", 
                                                        "deals.greatapp.com");

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    /** APPSFLYER INIT **/
    [AppsFlyerLib shared].appsFlyerDevKey = @"SED_DEV_KEY";
    [AppsFlyerLib shared].appleAppID = @"123456789";
    [AppsFlyerLib shared].oneLinkCustomDomains = @[@"promotion.greatapp.com"];
    //...
    //...
  }

[AppsFlyerLib shared].oneLinkCustomDomains = @[@"promotion.greatapp.com", @"click.greatapp.com"];

   func application(_ application: UIApplication, didFinishLaunchingWithOptions 
        launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
          AppsFlyerLib.shared().appsFlyerDevKey = "6CQi4Be6Zs9oNLsCusPbUL"
          AppsFlyerLib.shared().appleAppID = "340954504"
          AppsFlyerLib.shared().oneLinkCustomDomains = ["example.com"]
          //...
          //...
   }

AppsFlyerLib.shared().oneLinkCustomDomains = ["promotion.greatapp.com", "click.greatapp.com"]

Prerequisites:

Before using and testing, Branded Links complete the steps in the Branded Links workflow. 

To create and test branded links:

1. Create a custom attribution link using the OneLink template mapped to the branded link.
2. Copy the custom attribution link to a text editor.
3. The custom attribution link is made up of a OneLink subdomain, OneLink ID, and custom Link ID. Replace the OneLink subdomain with the Branded Link full domain. Example:
   

   Custom attribution link	Branded link
   abcdef.onelink.me/A1bc/dc1234ef	click.abcdef.com/A1bc/dc1234ef

4. Use the branded link to test installs and deep linking.
5. If you use raw data reports as part of the testing, the Original URL field is populated by the branded links. 

Editing enables you to change the mapping of an existing full domain to a different OneLink subdomain. There is no need to set a CNAME. 

To edit a branded link mapping:

1.  Go to Engaging & Deep Linking > Branded Links.
2. Select the Action command.
3. Select Edit.

To delete a branded link mapping: 

• Reach out to your CSM you can't do it yourself or contact hello@appsflyer.com