在 iOS 上創建動態鏈接

您可以使用 Firebase Dynamic Links Builder API 創建短動態鏈接或長動態鏈接。此 API 接受長動態鏈接或包含動態鏈接參數的對象，並返回如下例所示的 URL：

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

先決條件

在開始之前，請確保將Firebase 添加到您的 iOS 項目中。

設置 Firebase 和動態鏈接 SDK

使用 Swift Package Manager 安裝和管理 Firebase 依賴項。

1. 在 Xcode 中，打開您的應用程序項目，導航至File > Add Packages 。
2. 出現提示時，添加 Firebase Apple 平台 SDK 存儲庫：

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

3. 選擇動態鏈接庫。
4. 為了獲得動態鏈接的最佳體驗，我們建議在您的 Firebase 項目中啟用 Google Analytics ，並將適用於 Google Analytics 的 Firebase SDK 添加到您的應用程序中。您可以選擇沒有 IDFA 集合或有 IDFA 集合的庫。
5. 完成後，Xcode 將自動開始在後台解析和下載您的依賴項。

現在，執行一些配置步驟：

1. 在 Firebase 控制台中，打開動態鏈接部分。

2. 如果您尚未接受服務條款並為您的動態鏈接設置 URI 前綴，請在出現提示時執行此操作。

   如果您已有動態鏈接 URI 前綴，請記下它。當您以編程方式創建動態鏈接時，您需要提供它。

   

3. 推薦：指定深層鏈接和後備鏈接中允許的 URL 模式。這樣做可以防止未經授權的各方創建從您的域重定向到不受您控制的網站的動態鏈接。請參閱允許特定的 URL 模式。

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文件將包含對您應用程序的應用程序 ID 前綴和包 ID 的引用。例如：

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

   如果details屬性為空，請仔細檢查您是否指定了 App ID 前綴。請注意，您的 App ID 前綴可能與您的團隊 ID 不同。

將 Firebase 添加到您的應用

1. 在您的UIApplicationDelegate中導入FirebaseCore模塊，以及您的應用委託使用的任何其他Firebase 模塊。例如，要使用 Cloud Firestore 和身份驗證：

   斯威夫特用戶界面

   import SwiftUI
   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   迅速

   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   目標-C

   @import FirebaseCore;
   @import FirebaseFirestore;
   @import FirebaseAuth;
   // ...
         

2. 在您的應用委託的application(_:didFinishLaunchingWithOptions:)方法中配置一個FirebaseApp共享實例：

   斯威夫特用戶界面

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

   迅速

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

   目標-C

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

3. 如果您使用的是 SwiftUI，則必須創建一個應用程序委託並通過UIApplicationDelegateAdaptor或NSApplicationDelegateAdaptor將其附加到您的App結構。您還必須禁用應用委託調配。有關詳細信息，請參閱SwiftUI 說明。

   斯威夫特用戶界面

   @main
   struct YourApp: App {
     // register app delegate for Firebase setup
     @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
   
     var body: some Scene {
       WindowGroup {
         NavigationView {
           ContentView()
         }
       }
     }
   }
         

使用 Firebase 控制台

如果您想生成單個動態鏈接，無論是出於測試目的，還是為了讓您的營銷團隊輕鬆創建可用於社交媒體帖子等內容的鏈接，最簡單的方法是訪問Firebase 控制台並創建一個按照分步表格手動操作。

使用 iOS 構建器 API

您可以使用 iOS Builder API 從參數構建動態鏈接，或縮短較長的動態鏈接。

從參數創建動態鏈接

要創建動態鏈接，請創建一個新的DynamicLinkComponents對象並通過設置該對象的相應屬性來指定動態鏈接參數。然後，從對象的url屬性獲取長鏈接或通過調用shorten()獲取短鏈接。

以下最小示例創建了一個指向https://www.example.com/my-page長動態鏈接，該鏈接在 iOS 上打開您的 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);
}];
      

默認情況下，生成的短動態鏈接帶有 17 個字符的鏈接後綴，這使得人們極不可能猜出有效的動態鏈接。如果對於您的用例，有人成功猜出短鏈接沒有害處，您可能更願意生成僅在必要時才具有唯一性的後綴，您可以通過設置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);
}];

為動態鏈接指定自定義 URL 方案

默認情況下，動態鏈接使用您應用程序的包標識符作為打開您的應用程序所需的 URL 架構。我們建議保留此默認值以使您的實施簡單。

但是，已經將自定義 URL 方案用於其他目的的開發人員可能希望也將相同的自定義 URL 方案用於他們的動態鏈接。如果您遇到這種情況，您可以按照以下步驟為您的 Firebase 動態鏈接指定不同的 URL 方案：

1. 設置應用程序時，請確保在配置FirebaseApp共享實例之前指定應用程序要使用的默認 URL 架構：

   迅速

   注意：此 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
   }
   

   目標-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. 每當您創建任何動態鏈接時，您都需要指定您的應用使用的自定義 URL 架構。您可以通過 Firebase 控制台、在 Builder API 中設置customScheme 、在您的 URL 中指定ius參數或將iosCustomScheme參數發送到 REST API 來執行此操作

下一步

現在您已經創建了動態鏈接，您需要設置您的應用程序以接收動態鏈接並在用戶打開它們後將用戶發送到您應用程序中的正確位置。

要在您的應用程序中接收動態鏈接，請參閱iOS 、 Android 、 C++和Unity的文檔。