Accéder à la console

Set up a custom domain for Dynamic Links

You can have greater control over your Dynamic Links' branding by using your own domain instead of a page.link subdomain. With custom domains, you can create Dynamic Links like the following examples:

https://example.com/link-suffix
https://example.com/links/promos/link-suffix
https://links.example.com/link-suffix
https://ex.amp.le/link-suffix

The part of the URL before link-suffix is called the URL prefix, and contains both your custom Dynamic Link domain and a path prefix. You will need to provide a URL prefix when you create Dynamic Links.

Setting up a custom domain requires Editor or Owner permission on your Firebase project.

Using your web domain for Dynamic Links

You can use the same domain for your Dynamic Links and your web pages, Universal Links, and App Links, but if you do, you must take care that your Dynamic Link URLs don't conflict with your web URLs. When you configure Dynamic Links to use a particular URL prefix, all URLs that begin with that prefix are treated as Dynamic Links, so you can't use URLs with that prefix to point to ordinary hosted content.

For example, if you want to create a Dynamic Link to the resource https://example.com/my-resource (a web page, Universal Link, or App Link), you can't use https://example.com/ as the Dynamic Links URL prefix, because doing so would cause https://example.com/my-resource to be treated as a Dynamic Link. Instead, you must use a URL prefix with either a different domain or a different path prefix.

So, the following long-form Dynamic Links (and equivalent short links) won't work as intended because the URLs specified by the link parameter start with the Dynamic Link URL prefix, https://example.com/:

 https://example.com/?link=https://example.com/my-resource
 https://example.com/?link=https://example.com/resources/my-resource

But the following long-form Dynamic Links (and equivalent short links) can work, because the URL prefixes don't conflict with the link URLs:

 https://link.example.com/?link=https://example.com/my-resource
 https://example.com/links/?link=https://example.com/my-resource
 https://ex.amp.le/?link=https://example.com/my-resource

Set up a custom domain in the Firebase console

You can usually set up a custom domain completely in the Firebase console. To do so:

  1. If you haven't set up Firebase Hosting for your project, open the Hosting page of the Firebase console, click Get Started, and click through the setup instructions. You don't have to complete the indicated steps at this time.

  2. Open the Dynamic Links page of the Firebase console.

  3. If you haven't used Dynamic Links before, click Get Started. Otherwise, click Add URL prefix from the drop-down menu.

    Then, complete the setup wizard, specifying the domain and path prefix you want to use when prompted.

  4. iOS only: In your Xcode project's Info.plist file, create a key called FirebaseDynamicLinksCustomDomains and set it to your app's Dynamic Links URL prefixes. For example:

    <key>FirebaseDynamicLinksCustomDomains</key>
    <array>
      <string>https://example.com/link</string>
      <string>https://example.com/promos</string>
    </array>
    

Set up a custom domain manually

In some situations, such as when you already have a custom domain set up for Dynamic Links and want to add another domain, or when you are adding a domain already connected to a Hosting site, you have to set up your custom domain manually.

To do so:

  1. Connect your domain to Firebase Hosting if you haven't already done so.

    Setting up your domain with Firebase Hosting includes creating the configuration file firebase.json in your local project directory.

  2. Make sure that you have version 6.5.0 or later of the Firebase CLI installed:

    npm install -g firebase-tools

  3. Configure your Hosting site for Dynamic Links in your project's firebase.json file. If your project has multiple sites, be sure to configure the site connected to the domain you want to use.

    • Set appAssociation to AUTO. With this setting, Hosting dynamically generates assetlinks.json and apple-app-site-association files when they are requested.

    • Specify the path prefixes you want to use for Dynamic Links by setting rewrite rules with dynamicLinks set to true. Requests to these paths get proxied to Dynamic Links.

      Unlike rules that rewrite paths to URLs, Dynamic Link rewrite rules can't contain regular expressions.

      If you have multiple rewrite rules for your site, be aware that Hosting executes the first rewrite rule that matches the request.

    For example:

    "hosting": {
      // ...
      "appAssociation": "AUTO",
      "rewrites": [
        {
          "source": "/promos/**",
          "dynamicLinks": true
        },
        {
          "source": "/links/share/**",
          "dynamicLinks": true
        }
      ]
    }
    

    With the above configuration, you can create Dynamic Links with URL prefixes like the following examples:

    https://your-domain/promos/link-suffix
    https://your-domain/links/share/link-suffix
    

    If you use this domain only for Dynamic Links, you can use a source path of /** to create Dynamic Links with no path prefix:

    {
      "source": "/**",
      "dynamicLinks": true
    }
    

    With the above rule, you can create Dynamic Links like the following example:

    https://your-domain/link-suffix

  4. Deploy your Hosting configuration changes:

    firebase deploy --only hosting

    (optional) You can check the deployed firebase.json content using the Hosting REST API.

  5. iOS only: In your Xcode project's Info.plist file, create a key called FirebaseDynamicLinksCustomDomains and set it to your app's Dynamic Links URL prefixes. For example:

    <key>FirebaseDynamicLinksCustomDomains</key>
    <array>
      <string>https://example.com/promos</string>
      <string>https://example.com/links/share</string>
    </array>
    

Priority order for Dynamic Links and Hosting

For Dynamic Links, be particularly aware of hosting priority order.

  • Ensure that your Dynamic Links URL prefix doesn't conflict with higher priority hosting configurations (for example, hosted static content always has priority over rewrites).
  • Within the rewrites attribute, the Hosting response will obey the rule specified by the first source glob that captures the requested path.

For example, if you set up a Dynamic Link for your-domain/source-path/link-suffix but you also have static content at your-domain/source-path/index.html, the static content takes precedence. An end-user will see index.html rather than the Dynamic Link. Similarly, if you have static content at your-domain/source-path/link-suffix, the end-user will see the static content rather than the Dynamic Link.

If you want to use the same branding for both Dynamic Links and Hosting, consider one of the following options for your Dynamic Links URL prefix:

  • Set your source attribute to match a path prefix. For example, if you have a custom domain of example.com, your rewrite rule could be:

    // Domain is example.com
    "rewrites": [ {
      "source": "/links/**",  // Dynamic Links start with "https://example.com/links/"
      "dynamicLinks": true
    } ]
    
  • Set up a subdomain to use for Dynamic Links, then set your source attribute to match that subdomain. For example, if you have a subdomain of links.example.com, your rewrite rule could be:

    // Domain is links.example.com
    "rewrites": [ {
      "source": "/**",  // Dynamic Links start with "https://links.example.com/"
      "dynamicLinks": true
    } ]