OneLink Branded Domains

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

Branded Domain pointing to AppsFlyer servers

Before you begin:

• Choose a full domain name, for example, app.abcdef.com where
  abcdef.com is your brand. The subdomain, for example, app, can also be customized.
• Request that the DNS admin create the full domain (aka host).
• 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 Domain pointing to AppsFlyer servers (above).

To map your full domain to a OneLink subdomain:

1. Go to Experiences & Deep Linking > Branded Domains.
2. Click + New Branded Domain.
3. In the Brand Domain field, enter your full domain as set in your DNS. For example, click.abcdef.com Note: Do not place a period after the domain.
4. Select the OneLink subdomain from the list that displays. If no list
   displays, you need to create a OneLink template, which will provide a
   default subdomain.
5. Click Next.
6. Set a CNAME record:
   • If your domain is properly pointed to the AppsFlyer CNAME
     destination, "AppsFlyer CNAME was found" displays.
   • If a CNAME is not found, copy the AppsFlyer CNAME destination, send it to your DNS admin, and ask them to make sure your full domain is mapped to the CNAME destination. The DNS admin must map your full domain to an AppsFlyer CNAME destination. Otherwise, the branded domain is created but doesn't work.

      Note

     The CNAME record must be mapped within a time span of 7 days, starting from the branded domain creation date and ending on the date specified in the confirmation dialog.
     If the CNAME record is not mapped by the specified date, you must
     renew the 7-day period.

   • If you’re using your branded domain for ESPs, before copying the CNAME destination, select Use branded domain for an ESP configuration.
7. Click Done. You can now create new links based on the OneLink template with your branded domain.

    Note

   • If you already created links based on your OneLink template without the branded domain, they still work.
   • It can take up to 24 hours for a new branded domain to start working.

Renew the 7-day period for mapping the CNAME record

The new branded domain does not work if the CNAME record of your full domain isn’t mapped to AppsFlyer within 7 days of your branded domain creation.

To renew the 7-day period:

1. In AppsFlyer, from the side menu, select Engage > Branded Domains.
2. Go to the branded domain that is not yet mapped to AppsFlyer, indicated by the warning icon ().
3. Click the refresh icon () to renew the 7-day period.

• 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 Domains SDK implementation considerations

• When deep linking takes place using Branded Domains, the AppsFlyer SDK can't get conversion data for installs and deep linking.
• To overcome this, the developer uses the setOneLinkCustomDomain and oneLinkCustomDomains SDK API for Android and iOS respectively.
• This API queries the branded domain, gets the OneLink domain to which it is mapped, and completes the OneLink.

public class AFApplication extends Application {

    @Override
    public void onCreate() {
    super.onCreate();
      
      // Set branded link domain. Don't include https:// as part of the 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 Domains complete the steps in the Branded Domains workflow. 

To create and test branded domains:

1. Create a OneLink link using the OneLink template mapped to the branded domain.
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 Domain full domain. Example:
   

   Custom attribution link	Branded Domain
   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. 

Edit a branded domain mapping

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

1. In AppsFlyer, from the side menu, select Engage > Branded Domains.
2. Go to the branded domain you want to edit.
3. Click the Edit icon ().
4. Select the new OneLink subdomain.
5. Click Next. There is no need to set a CNAME.
6. Click Done.

Verify a branded domain mapping

After changing the OneLink subdomain mapped to your branded domain verify that the branded domain is mapped properly:

1. In AppsFlyer, from the side menu, select Engage > Branded Domains.
2. Go to the branded domain you want to verify.
3. Click the Verify icon ().

Delete a branded domain mapping

To delete a branded domain contact your AppsFlyer CSM or hello@appsflyer.com.