创建动态链接 (iOS)

您可以使用 Firebase Dynamic Links Builder API 创建短动态链接或长动态链接。此 API 接受一个长动态链接或一个包含动态链接参数的对象，并返回如下所示的网址：

https://example.com/link/WXYZ
https://example.page.link/WXYZ

前提条件

在开始之前，请务必将 Firebase 添加到您的 iOS 项目中。

设置 Firebase 和 Dynamic Links SDK

使用 Swift Package Manager 安装和管理 Firebase 依赖项。

1. 在 Xcode 中打开您的应用项目，依次转到 File（文件）> Swift Packages（Swift 软件包）> Add Package Dependency（添加软件包依赖项）。
2. 出现提示时，添加 Firebase Apple 平台 SDK 代码库：

  https://github.com/firebase/firebase-ios-sdk
  

3. 选择 Dynamic Links 库。
4. 为了获得最佳的 Dynamic Links 使用体验，我们建议您在 Firebase 项目中启用 Google Analytics（分析），并将适用于 Google Analytics（分析）的 Firebase SDK 添加到您的应用中。您可以选择不收集 IDFA 的库，也可以选择收集 IDFA 的库。
5. 完成之后，Xcode 将会自动开始在后台解析和下载您的依赖项。

现在，执行一些配置步骤：

1. 在 Firebase 控制台中，打开 Dynamic Links 部分。

2. 如果您尚未接受服务条款并为动态链接设置 URI 前缀，请在收到提示时执行相关操作。

   如果您已有动态链接 URI 前缀，请记下它。在以编程方式创建动态链接时，您需要提供该动态链接 URI 前缀。

   

3. 推荐：指定可以在您的深层链接和后备链接中使用的网址格式。这样做可以防止未经授权者创建动态链接，从您的网域重定向至您无法控制的网站。 请参阅允许特定网址格式。

4. 确保已在您的应用的设置中指定应用的 App Store ID 和应用 ID 前缀。要查看和修改应用的设置，请转到 Firebase 项目的“设置”页面，然后选择您的 iOS 应用。

   打开托管在动态链接网域上的 apple-app-site-association 文件，确认您的 Firebase 项目已正确配置为在 iOS 应用中使用动态链接。Firebase 会从网域的根目录以及 .well-known 子目录中提供 apple-app-site-association 文件。例如：

       https://example.com/apple-app-site-association
       https://example.com/.well-known/apple-app-site-association
       

   如果您的应用已关联，则 apple-app-site-association 文件中包含对应用的 App ID 前缀和软件包 ID 的引用。例如：

   {"applinks":{"apps":[],"details":[{"appID":"1234567890.com.example.ios","paths":["/*"]}]}}

   如果 details 属性为空，请仔细检查您是否指定了应用 ID 前缀。请注意，应用 ID 前缀可能与团队 ID 不同。

将 Firebase 添加至您的应用

1. 在 UIApplicationDelegate 中导入 Firebase 模块：

   Swift

   import Firebase

   Objective-C

   @import Firebase;

2. 配置一个 FirebaseApp 共享实例（通常在应用的 application:didFinishLaunchingWithOptions: 方法中配置）：

   Swift

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Objective-C

   // Use Firebase library to configure APIs
   [FIRApp configure];

使用 Firebase 控制台

如果您想生成一个动态链接（无论是出于测试目的，还是为了让您的营销团队轻松创建可以在社交媒体帖子等地方使用的链接），最简单的方法就是访问 Firebase 控制台并按照分步说明手动创建一个。

使用 iOS Builder API

您可以使用 iOS Builder API 利用参数构建动态链接，也可以将长动态链接缩短。

利用参数创建动态链接

要创建动态链接，请创建一个新的 DynamicLinkComponents 对象，并通过设置该对象的相应属性来指定动态链接参数。然后，从该对象的 url 属性中获取长链接或通过调用 shorten() 获取短链接。

下面这个极为简单的示例创建了一个指向 https://www.example.com/my-page 的长动态链接，此链接会在您的 iOS 应用和 Android 应用 com.example.android 中打开：

guard let link = URL(string: "https://www.example.com/my-page") else { return }
let dynamicLinksDomainURIPrefix = "https://example.com/link"
let linkBuilder = DynamicLinkComponents(link: link, domainURIPrefix: dynamicLinksDomainURIPRefix)
linkBuilder.iOSParameters = DynamicLinkIOSParameters(bundleID: "com.example.ios")
linkBuilder.androidParameters = DynamicLinkAndroidParameters(packageName: "com.example.android")

guard let longDynamicLink = linkBuilder.url else { return }
print("The long URL is: \(longDynamicLink)")

NSURL *link = [[NSURL alloc] initWithString:@"https://www.example.com/my-page"];
NSString *dynamicLinksDomainURIPrefix = @"https://example.com/link";
FIRDynamicLinkComponents *linkBuilder = [[FIRDynamicLinkComponents alloc]
                                         initWithLink:link
                                               domainURIPrefix:dynamicLinksDomainURIPrefix];
linkBuilder.iOSParameters = [[FIRDynamicLinkIOSParameters alloc]
                             initWithBundleID:@"com.example.ios"];
linkBuilder.androidParameters = [[FIRDynamicLinkAndroidParameters alloc]
                                 initWithPackageName:@"com.example.android"];

NSLog(@"The long URL is: %@", linkBuilder.url);

如需创建一个短动态链接，请按照上面的相同方式构建一个 DynamicLinkComponents，然后调用 shorten()。

构建短链接需要发出网络调用，因此，shorten() 会接受完成处理程序（在请求完成时调用），而不是直接返回链接。例如：

linkBuilder.shorten() { url, warnings, error in
  guard let url = url, error != nil else { return }
  print("The short URL is: \(url)")
}

[linkBuilder shortenWithCompletion:^(NSURL * _Nullable shortURL,
                                     NSArray<NSString *> * _Nullable warnings,
                                     NSError * _Nullable error) {
  if (error || shortURL == nil) { return; }
  NSLog(@"The short URL is: %@", shortURL);
}];
      

默认情况下，生成的短 Dynamic Links 动态链接有 17 个字符的链接后缀，让他人极难猜测出有效的 Dynamic Links 动态链接。在您的用例中，如果短链接即使被人成功猜出也不会造成任何危害，您可以仅生成长度足以确保唯一性的后缀。设置 dynamicLinkComponentsOptions 属性即可实现此目的：

linkBuilder.options = DynamicLinkComponentsOptions()
linkBuilder.options.pathLength = .short
linkBuilder.shorten() { url, warnings, error in
  guard let url = url, error != nil else { return }
  print("The short URL is: \(url)")
}

linkBuilder.dynamicLinkComponentsOptions = [[FIRDynamicLinkComponentsOptions alloc] init];
linkBuilder.dynamicLinkComponentsOptions.pathLength = FIRShortDynamicLinkPathLengthShort;
[linkBuilder shortenWithCompletion:^(NSURL * _Nullable shortURL,
                                     NSArray<NSString *> * _Nullable warnings,
                                     NSError * _Nullable error) {
  if (error || shortURL == nil) { return; }
  NSLog(@"The short URL is: %@", shortURL);
}];
      

动态链接参数

您可以使用 Dynamic Link Builder API 创建带有任何受支持参数的动态链接。如需了解详细信息，请参阅 API 参考文档。

以下示例创建了一个带有几个常见参数的动态链接：

guard let link = URL(string: "https://www.example.com/my-page") else { return }
let dynamicLinksDomainURIPrefix = "https://example.com/link"
let linkBuilder = DynamicLinkComponents(link: link, domainURIPRefix: dynamicLinksDomainURIPrefix)

linkBuilder.iOSParameters = DynamicLinkIOSParameters(bundleID: "com.example.ios")
linkBuilder.iOSParameters.appStoreID = "123456789"
linkBuilder.iOSParameters.minimumAppVersion = "1.2.3"

linkBuilder.androidParameters = DynamicLinkAndroidParameters(packageName: "com.example.android")
linkBuilder.androidParameters.minimumVersion = 123

linkBuilder.analyticsParameters = DynamicLinkGoogleAnalyticsParameters(source: "orkut",
                                                                       medium: "social",
                                                                       campaign: "example-promo")

linkBuilder.iTunesConnectParameters = DynamicLinkItunesConnectAnalyticsParameters()
linkBuilder.iTunesConnectParameters.providerToken = "123456"
linkBuilder.iTunesConnectParameters.campaignToken = "example-promo"

linkBuilder.socialMetaTagParameters = DynamicLinkSocialMetaTagParameters()
linkBuilder.socialMetaTagParameters.title = "Example of a Dynamic Link"
linkBuilder.socialMetaTagParameters.descriptionText = "This link works whether the app is installed or not!"
linkBuilder.socialMetaTagParameters.imageURL = "https://www.example.com/my-image.jpg"

guard let longDynamicLink = linkBuilder.url else { return }
print("The long URL is: \(longDynamicLink)")

NSURL *link = [[NSURL alloc] initWithString:@"https://www.example.com/my-page"];
NSString *dynamicLinksDomainURIPrefix = @"https://example.com/link";
FIRDynamicLinkComponents *linkBuilder = [[FIRDynamicLinkComponents alloc]
                                         initWithLink:link
                                         domainURIPrefix:dynamicLinksDomainURIPrefix];

linkBuilder.iOSParameters = [[FIRDynamicLinkIOSParameters alloc]
                             initWithBundleID:@"com.example.ios"];
linkBuilder.iOSParameters.appStoreID = @"123456789";
linkBuilder.iOSParameters.minimumAppVersion = @"1.2.3";

linkBuilder.androidParameters = [[FIRDynamicLinkAndroidParameters alloc]
                                 initWithPackageName:@"com.example.android"];
linkBuilder.androidParameters.minimumVersion = 123;

linkBuilder.analyticsParameters = [[FIRDynamicLinkGoogleAnalyticsParameters alloc]
                                   initWithSource:@"orkut"
                                           medium:@"social"
                                         campaign:@"example-promo"];

linkBuilder.iTunesConnectParameters = [[FIRDynamicLinkItunesConnectAnalyticsParameters alloc] init];
linkBuilder.iTunesConnectParameters.providerToken = @"123456";
linkBuilder.iTunesConnectParameters.campaignToken = @"example-promo";

linkBuilder.socialMetaTagParameters = [[FIRDynamicLinkSocialMetaTagParameters alloc] init];
linkBuilder.socialMetaTagParameters.title = @"Example of a Dynamic Link";
linkBuilder.socialMetaTagParameters.descriptionText = @"This link works whether the app is installed or not!";
linkBuilder.socialMetaTagParameters.imageURL = @"https://www.example.com/my-image.jpg";

NSLog(@"The long URL is: %@", linkBuilder.url);

您可以使用以下对象和属性设置动态链接参数：

https://example.com/link
https://example.page.link

缩短长动态链接

要缩短长动态链接，请将长动态链接与 DynamicLinkComponentsOptions 对象一起传递给 shortenURL(url:options:)（如果您想生成具有短后缀的链接）：

DynamicLinkComponents.shortenURL(url: longLinkUrl, options: nil) { url, warnings, error in
  guard let url = url, error != nil else { return }
  print("The short URL is: \(url)")
}

[FIRDynamicLinkComponents shortenURL:longLinkUrl
                             options:nil
                          completion:^(NSURL * _Nullable shortURL,
                                       NSArray<NSString *> * _Nullable warnings,
                                       NSError * _Nullable error) {
  if (error || shortURL == nil) { return; }
  NSLog(@"The short URL is: %@", shortURL);
}];

为动态链接指定自定义网址架构

默认情况下，动态链接使用您的应用的软件包标识符作为打开该应用所需的网址架构。我们建议您保留此默认值，以确保实现方式简单明了。

但是，如果开发者已出于其他原因使用自定义网址架构，则可能希望为其动态链接使用相同的自定义网址架构。如果您属于这种情况，则可以按照以下步骤为您的 Firebase 动态链接指定不同的网址架构：

1. 设置您的应用时，请确保在配置 FirebaseApp 共享实例之前指定该应用将使用的默认网址架构：

   Swift

   注意：此 Firebase 产品不适用于 macOS、Mac Catalyst、tvOS 或 watchOS 目标。

   func application(_ application: UIApplication,
                    didFinishLaunchingWithOptions launchOptions: [UIApplication
                      .LaunchOptionsKey: Any]?) -> Bool {
     // Set deepLinkURLScheme to the custom URL scheme you defined in your
     // Xcode project.
     FirebaseOptions.defaultOptions()?.deepLinkURLScheme = customURLScheme
     FirebaseApp.configure()
   
     return true
   }
   

   Objective-C

   注意：此 Firebase 产品不适用于 macOS、Mac Catalyst、tvOS 或 watchOS 目标。

   - (BOOL)application:(UIApplication *)application
       didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     // Set deepLinkURLScheme to the custom URL scheme you defined in your
     // Xcode project.
     [FIROptions defaultOptions].deepLinkURLScheme = CUSTOM_URL_SCHEME;
     [FIRApp configure];
   
     return YES;
   }

2. 每当创建动态链接时，您都需要指定您的应用使用的自定义网址架构。您可以通过如下方式执行此操作：通过 Firebase 控制台、在 Builder API 中设置 customScheme、在网址中指定 ius 参数或者将 iosCustomScheme 参数发送到 REST API。

后续步骤

现在您已创建动态链接，此时您需要设置您的应用以接收动态链接，并在用户打开动态链接时将用户引导至您的应用中的相应位置。

要在您的应用中接收动态链接，请参阅适用于 iOS、Android、C++ 和 Unity 的文档。