在 iOS 上接收 Dynamic Links

如要接收 您建立的 Firebase Dynamic Links,您必須在應用程式中加入 Dynamic Links SDK,並在應用程式載入時呼叫 handleUniversalLink:dynamicLinkFromCustomSchemeURL: 方法,以便透過 Dynamic Link 傳遞資料。

先備知識

開始之前,請務必將 Firebase 新增至您的 iOS 專案

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

  1. 在 Xcode 中保持開啟應用程式專案,然後依序點選「File」>「Add Packages」
  2. 在系統提示時,新增 Firebase Apple 平台 SDK 存放區:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. 選擇 Dynamic Links 程式庫。
  5. 在目標建構設定的「Other Linker Flags」部分中新增 -ObjC 標記。
  6. 為了讓動態連結獲得最佳體驗,建議您在 Firebase 專案中啟用 Google Analytics (分析),並將 Google Analytics (分析) 專用 Firebase SDK 加到應用程式。您可以選取不使用 IDFA 收集功能的程式庫,或利用 IDFA 收集功能。
  7. 完成後,Xcode 會自動開始在背景解析並下載依附元件。

現在,請執行一些設定步驟:

  1. Firebase 控制台開啟「Dynamic Links」專區。如果系統提示您接受服務條款,請接受《服務條款》。
  2. 請務必在應用程式的設定中指定應用程式的 App Store ID 和應用程式 ID 前置字串,如要查看及編輯應用程式設定,請前往 Firebase 專案的 設定頁面,並選取 iOS 應用程式。

    開啟下列網址,即可確認 Firebase 專案正確設為在 iOS 應用程式中使用 Dynamic Links:

    https://your_dynamic_links_domain/apple-app-site-association

    如果應用程式已連線,apple-app-site-association 檔案會參照應用程式的應用程式 ID 前置字串和軟體包 ID。例如:

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

    如果 details 欄位空白,請仔細檢查您指定的應用程式 ID 前置字串。請注意,您的應用程式 ID 前置字串可能與團隊 ID 不同。

  3. 選用:禁止 Dynamic Links SDK 使用 iOS 貼上板。

    根據預設,Dynamic Links SDK 會使用貼上板提高安裝後深層連結的可靠性。藉由使用貼上板,Dynamic Links 可以確保當使用者開啟動態連結,但需要先安裝應用程式時,使用者可以在安裝後第一次開啟應用程式時,立即開啟原始連結內容。

    這種做法的缺點是,在 iOS 14 以上版本中使用貼上板會觸發通知。因此,當使用者首次開啟您的應用程式時,如果貼上板含有網址,系統會顯示通知,指出您的應用程式已存取貼上板,而造成混淆。

    如要停用這項行為,請編輯 Xcode 專案的 Info.plist 檔案,並將 FirebaseDeepLinkPasteboardRetrievalEnabled 鍵設為 NO

  1. 在應用程式 Xcode 專案的「Info」分頁中,建立新的要用於 Dynamic Links 的網址類型。將「Identifier」欄位設為專屬的值,並將「網址配置」欄位設為軟體包 ID,這是 Dynamic Links 使用的預設網址配置。
  2. 在應用程式 Xcode 專案的「Capabilities」分頁中,啟用關聯網域,並將下列內容新增至「Associated Domains」清單:
    applinks:your_dynamic_links_domain
  3. 如果您想接收含有完整自訂網域的 Dynamic Links,請在 Xcode 專案的 Info.plist 檔案中建立名為 FirebaseDynamicLinksCustomDomains 的金鑰,並設為應用程式的 Dynamic Links 網址前置字串。例如:
    FirebaseDynamicLinksCustomDomains
    
      https://example.com/promos
      https://example.com/links/share
    
    
  4. FirebaseCore 模組匯入 UIApplicationDelegate,以及應用程式委派使用的任何其他 Firebase 模組。例如,如要使用 Cloud Firestore 和驗證:

    SwiftUI

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

    Swift

    import FirebaseCore
    import FirebaseFirestore
    import FirebaseAuth
    // ...
          

    Objective-C

    @import FirebaseCore;
    @import FirebaseFirestore;
    @import FirebaseAuth;
    // ...
          
  5. 在應用程式委派的 application(_:didFinishLaunchingWithOptions:) 方法中設定 FirebaseApp 共用例項:

    SwiftUI

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

    Swift

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

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];
  6. 如果您使用 SwiftUI,則必須建立應用程式委派,並透過 UIApplicationDelegateAdaptorNSApplicationDelegateAdaptor 將其附加至 App 結構體。您也必須停用應用程式委派功能切換功能。詳情請參閱 SwiftUI 操作說明

    SwiftUI

    @main
    struct YourApp: App {
      // register app delegate for Firebase setup
      @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
    
      var body: some Scene {
        WindowGroup {
          NavigationView {
            ContentView()
          }
        }
      }
    }
          
  7. 接著,在 application:continueUserActivity:restorationHandler: 方法中,處理應用程式安裝後收到的連結為 通用連結

    Swift

    注意:這項產品不適用於 macOS、Mac Catalyst、tvOS 或 watchOS 目標。
    func application(_ application: UIApplication, continue userActivity: NSUserActivity,
                     restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
      let handled = DynamicLinks.dynamicLinks()
        .handleUniversalLink(userActivity.webpageURL!) { dynamiclink, error in
          // ...
        }
    
      return handled
    }
    

    Objective-C

    注意:這項產品不適用於 macOS、Mac Catalyst、tvOS 或 watchOS 目標。
    - (BOOL)application:(UIApplication *)application
    continueUserActivity:(nonnull NSUserActivity *)userActivity
     restorationHandler:
    #if defined(__IPHONE_12_0) && (__IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_12_0)
    (nonnull void (^)(NSArray<id<UIUserActivityRestoring>> *_Nullable))restorationHandler {
    #else
        (nonnull void (^)(NSArray *_Nullable))restorationHandler {
    #endif  // __IPHONE_12_0
      BOOL handled = [[FIRDynamicLinks dynamicLinks] handleUniversalLink:userActivity.webpageURL
                                                              completion:^(FIRDynamicLink * _Nullable dynamicLink,
                                                                           NSError * _Nullable error) {
                                                                // ...
                                                              }];
      return handled;
    }
  8. 最後,在 application:openURL:options: 中,系統會處理透過應用程式自訂網址配置接收的連結。應用程式安裝完成後首次開啟應用程式時,系統就會呼叫此方法。

    如果在應用程式第一次啟動時找不到動態連結,系統會呼叫這個方法,並將 DynamicLinkurl 設為 nil,表示 SDK 找不到相符的待處理動態連結。

    Swift

    注意:這項產品不適用於 macOS、Mac Catalyst、tvOS 或 watchOS 目標。
    @available(iOS 9.0, *)
    func application(_ app: UIApplication, open url: URL,
                     options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {
      return application(app, open: url,
                         sourceApplication: options[UIApplication.OpenURLOptionsKey
                           .sourceApplication] as? String,
                         annotation: "")
    }
    
    func application(_ application: UIApplication, open url: URL, sourceApplication: String?,
                     annotation: Any) -> Bool {
      if let dynamicLink = DynamicLinks.dynamicLinks().dynamicLink(fromCustomSchemeURL: url) {
        // Handle the deep link. For example, show the deep-linked content or
        // apply a promotional offer to the user's account.
        // ...
        return true
      }
      return false
    }
    

    Objective-C

    注意:這項產品不適用於 macOS、Mac Catalyst、tvOS 或 watchOS 目標。
    - (BOOL)application:(UIApplication *)app
                openURL:(NSURL *)url
                options:(NSDictionary<NSString *, id> *)options {
      return [self application:app
                       openURL:url
             sourceApplication:options[UIApplicationOpenURLOptionsSourceApplicationKey]
                    annotation:options[UIApplicationOpenURLOptionsAnnotationKey]];
    }
    
    - (BOOL)application:(UIApplication *)application
                openURL:(NSURL *)url
      sourceApplication:(NSString *)sourceApplication
             annotation:(id)annotation {
      FIRDynamicLink *dynamicLink = [[FIRDynamicLinks dynamicLinks] dynamicLinkFromCustomSchemeURL:url];
    
      if (dynamicLink) {
        if (dynamicLink.url) {
          // Handle the deep link. For example, show the deep-linked content,
          // apply a promotional offer to the user's account or show customized onboarding view.
          // ...
        } else {
          // Dynamic link has empty deep link. This situation will happens if
          // Firebase Dynamic Links iOS SDK tried to retrieve pending dynamic link,
          // but pending link is not available for this device/App combination.
          // At this point you may display default onboarding view.
        }
        return YES;
      }
      return NO;
    }