Branded links (beta)

This feature is currently in beta. If you want to be added as a beta user, contact your CSM or send an email to hello@appsflyer.com.

This article discusses the benefits of branded links and how to set them up. It also discusses limitations and troubleshooting.

What are branded links?

As the name suggests, branded links are links that bear your brand. For example, if your brand is Great App, a branded link can be promotions.greatapp.com.

Why use branded links?

• Allow deep linking with your own brand - currently, if you want to use OneLink for re-attribution or re-engagement, you can only set a OneLink subdomain. Branded links perform just like OneLinks but they bear your brand and promote brand awareness.
• Trusted links - branded links are trusted by users, browsers, and email validation systems. With branded links, users are more likely to click the link, for example when you post the link in social media. In addition, email validation systems are more likely to view emails containing branded links as valid promotion emails.
• Promote brand awareness - On top of these, one of the biggest benefits of branded links is that your brand marks your campaigns, rather than a generic link.

Setting up branded links

See the following steps to set up branded links.

1. Prerequisites

Branded links require a OneLink domain to be mapped to. Make sure you have a Onelink configuration ready for use. Otherwise, go ahead and create one.

2. Setting a CNAME record

A CNAME is DNS record that maps one subdomain to another. To learn more, read here. You can set a CNAME with the help of one of the following:

• An IT person in your organization.
• Your domain hosting customer support.

In your domain hosting, set a CNAME that points from your branded link to ONELINK_SUBDOMAIN.customlinks.appsflyer.com.

The OneLink subdomain is set when you create a OneLink configuration.

Example

If your OneLink subdomain is greatapp, map your click domain to the following AppsFlyer server endpoint:

See the following to learn how to set a CNAME in some popular domain hosting services:

• Adding CNAME in AWS Route53
• Adding a CNAME in GoDaddy
• Adding a CNAME in HostGator
• Adding a CNAME in Bluehost
• Adding a CNAME in SiteGround

3. Checking that the CNAME is set correctly

1. Go to whatsmydns.
2. Paste your branded link.
3. Choose CNAME in the dropdown menu.
4. Click search.

If the CNAME is set correctly, you should see something similar to the following:

If you get a series of red Xs, it could mean one of two:

• The CNAME needs some time to take effect. Wait a few minutes and try again.
• The CNAME is not set properly. Consult an IT person in your organization or your domain host technical support.

4. Mapping a branded link to OneLink

1. In AppsFlyer, on the navigation menu, click Branded Links.
2. In the branded links page, click Add branded link.
3. Under Brand domain, enter your branded link.
4. Under OneLink domain, select the OneLink subdomain.
   

   

5. Click Add.

Editing or deleting branded links

To delete a mapped branded link, contact your CSM or send an email to hello@appsflyer.com.

To edit a branded link, click the three dots on the right-hand side of the branded link and click Edit.

Editing only allows mapping the branded link to a different OneLink configuration. If you map a branded link to a different OneLink configuration, you don't need to set a new CNAME. The existing CNAME is enough.

Setting up deep linking using branded links

This part is intended for app developers.

Setting deep linking using branded links is supported from the following SDK versions:

• Android 4.10.1 and above
• iOS 4.10.1 and above

When deep linking takes place using branded links, the AppsFlyer SDK doesn't have a way to get conversion data for installs and deep linking. To address this, the app developer should add deep linking support for branded links. Adding deep linking support for branded links allows the developer to get conversion data and deep link users into the app.

The developer should use the setOneLinkCustomDomain SDK API. This API queries the branded link to get the OneLink to which it is mapped. The SDK then queries the OneLink to get conversion data.

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().startTracking(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 **/
    [AppsFlyerTracker sharedTracker].appsFlyerDevKey = @"SED_DEV_KEY";
    [AppsFlyerTracker sharedTracker].appleAppID = @"123456789";
    [AppsFlyerTracker sharedTracker].oneLinkCustomDomains = @[@"promotion.greatapp.com"];
    //...
    //...
  }

[AppsFlyerTracker sharedTracker].oneLinkCustomDomains = @[@"promotion.greatapp.com", @"click.greatapp.com"];

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

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

Associating domains for iOS Universal Links

For iOS, you also have to set up the branded link as an associated domain in Xcode. See here for instructions.

Using and testing branded links

See the following to learn how to create and test branded links. The instructions assume that:

• You already have a branded link mapped to a OneLink configuration.
• The branded link has a CNAME set for it.
• The app developer set up the app to support branded link.

1. Create a custom attribution link from the OneLink configuration that is 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 subdomain. See the following example:
   
   

   Custom attribution link	Branded link
   greatapp.onelink.me/A1bc/dc1234ef	promotion.greatapp.com/A1bc/dc1234ef

4. Use the branded link to test installs and deep linking.

Troubleshooting branded links

Below we list common issues with branded links and how to address them.

Branded links SSL/HTTP

Branded links get their SSL certificate from Let's Encrypt. AppsFlyer takes care of managing, renewing and assigning SSL certificates to branded links.

Limits on adding branded links

Let's encrypt has a rate limit of 50 new certificates per week per domain. This means that you can create 50 branded link per week. However, we don't recommend creating more than a few branded links.