You need to retrieve the following data points before you can set up deep links in your app:
- App ID Prefix
- Release Bundle ID
- Debug Bundle ID
- Release Custom URL Scheme
- Debug Custom URL Scheme
- Link resolution domain or domains
Instructions
Follow these instructions to retrieve your data points.
App ID Prefix and Release Bundle ID
Your App ID is found on the Apple Developer portal. It contains two parts:
- The App ID prefix
- The Bundle ID
The ID is formatted as <app_id_prefix>.<bundle_id>
. For example: ABC1234567.com.example.app
To find your App ID Prefix and Bundle ID, follow these steps:
- Log in to the Apple Developer portal.
- Select Certificates, IDs & Profiles from the left-hand menu.
- Select Identifiers from the left-hand menu.
- Find your app and select it to open the edit page.
- Your App ID Prefix and Bundle ID are displayed at the top of the page. Copy the relevant information and store it somewhere for later use.
Debug Bundle ID
If you’re using a different bundle ID for your debug build, you can find its ID in Xcode.
- Open your app project in Xcode.
- Select your project from the left-hand menu.
- Select your app under Targets.
- Select Signing & Capabilities from the top menu.
- Select Debug from the sub menu that appears.
- Your Bundle ID is shown. Copy this information and store it somewhere for later use.
Custom URL schemes
To retrieve your Custom URL Scheme, follow these steps:
- Open your app project in Xcode.
- Select your project from the left-hand menu.
- Select your app under Targets.
- Select Info from the top menu.
- Expand the URL Types section and get the custom URL scheme. If the URL Schemes field contains a build setting (for example:
$(CUSTOM_URL_SCHEME)
), go to the build settings to retrieve the custom URL scheme values:- Select Build Settings from the menu at the top.
- Find the setting named in the URL Schemes field and retrieve both the release and debug values.
If your iOS app doesn’t have a custom URL scheme yet, follow these steps to set a custom URL scheme:
- Open your app project in Xcode.
- Select your project from the left-hand menu.
- Select your app under Targets.
- Select Info from the top menu.
- Expand the URL Types section.
- Select the Add option to add a new URL type.
- Fill in the following information to create a URL scheme:
- Identifier:
$(PRODUCT_BUNDLE_IDENTIFIER)
- URL Schemes: your custom URL scheme. This must be unique. Don’t use protected schemes such as
http
,https
, ormailto
- Role: Editor
- Identifier:
This scheme will work for your production and debug builds.
Link Resolution domains
Your marketing team may already be using a link resolution domain for their email marketing platform. Get this domain from them and store it somewhere for later use.