Developer Guide
DeepLink Plan
iOS SDK (v4)

DeepLink Plan - iOS SDK (v4)

Last updated 4 days ago

本指南介绍如何安装 Airbridge iOS SDK 并进行必要的配置。

iOS SDK 安装

您可以通过以下方法安装 Airbridge iOS SDK。安装后，可以测试 iOS SDK 来检查 SDK 是否正确安装。

1. 在 Xcode 中导航至 [File]>[Add Packages...]。

2. 在搜索栏中输入以下地址，并点击 [Add Package]。

https://github.com/ab180/airbridge-ios-sdk-deployment

3. 再次点击 [Add Package]。

4. 在 Xcode 的 [Package Dependencies] 中确认 Airbridge iOS SDK 已成功添加。

注意
在安装 iOS SDK 之前，请导航至 [Xcode]>[YOUR_PROJECT]>[Build Settings]，并确保将 User Script Sandboxing 设置为 “No”。更多信息请参阅 CocoaPods 文档。

1. 使用 brew install cocoapods 安装 CocoaPods。

2. 使用 pod init 创建 Podfile。

3. 使用以下代码将 SDK 添加为 Podfile 的依赖项。

Podfile

1234567
target '[Project Name]' do
    ...
    # choose YOUR_VERSION from https://help.airbridge.io/developers/release-note-ios-sdk
    # example: pod 'airbridge-ios-sdk', '4.X.X'
    pod 'airbridge-ios-sdk', 'YOUR_VERSION'
    ...
end

4. 在输入 pod install --repo-update 时，安装将开始。

5. 运行 YOUR_PROJECT.xcworkspace 以确认 Airbridge iOS SDK 成功安装。

注意
您无法使用 Tuist 的 External Dependencies 安装 Airbridge iOS SDK。请确保按照以下步骤安装。

1. 运行 tuist edit 命令。

2. 将 remote 添加到 project.packages。将 package 添加到 project.targets[...].target.dependencies 中。参见以下代码：

1234567891011121314151617181920212223
import ProjectDescription

let project = Project(
    packages: [
        .remote(
            url: "https://github.com/ab180/airbridge-ios-sdk-deployment",
            // choose YOUR_VERSION from https://help.airbridge.io/developers/release-note-ios-sdk
            // example: requirement: .exact(from: "4.X.X")
            requirement: .exact(from: "YOUR_VERSION")
        ),
        ...
    ],
    targets: [
        .target(
            dependencies: [
                .package(product: "Airbridge", type: .runtime),
                ...
            ]
        ),
        ...
    ],
    ...
)

3. 运行 tuist generate 命令。

4. Airbridge 将添加至 Xcode 的 Package Dependencies 中。

1. 从以下链接下载 Airbridge iOS SDK：

https://sdk-download.airbridge.io/airbridge-ios-sdk/latest/Airbridge.zip

2. 将 Airbridge.xcframework 添加到 Project 中。导航至 [Xcode]>[Project File]>[General]>[Frameworks, Libraries, and Embedded Content]，并点击 “+”。

3. 在 [Add Other...] 下点击 “Add Files...”，并选择 Airbridge.xcframework。

4. 将 Airbridge.xcframework 中的 Embed（嵌入）设置为 Do Not Embed（不嵌入）。

5. 将 SDK 依赖的 Framework 添加到 Project 中。导航至 [Xcode]>[Project File]>[General]>[Frameworks, Libraries, and Embedded Content]，并点击 “+”。

6. 添加所有以下 Framework，并将已添加 Framework 的 Embed（嵌入）设置为 Do Not Embed（不嵌入）。导航至 [Xcode]>[Project File]>[Build Phase]>[Link Binary With Libraries]，将 Status（状态）设置为 “Optional（可选）”。

Framework	说明
AdSupport.framework	用于收集 IDFA
CoreTelephony.framework	用于收集移动通信运营商信息
StoreKit.framework	用于收集 SKAN 信息
AppTrackingTransparency.framework	用于收集 ATT 同意状态信息
AdServices.framework	用于收集 Apple Ads 归因信息（iOS 14.3+）

Restricted SDK

提示
请根据需求选择一般 SDK 或 Restricted SDK, 只能安装其中一个。

根据政策或环境，可能需要对收集设备 ID（例如 GAID 和 IDFA）进行限制。如果安装 Restricted SDK，Airbridge SDK 不会收集设备 ID。

请按照以下说明安装 Restricted SDK：

1. 在 Xcode 中导航至 [File]>[Add Packages...]。

2. 在搜索栏中输入以下地址，并点击 [Add Package]。

https://github.com/ab180/airbridge-ios-sdk-restricted-deployment

3. 再次点击 [Add Package]。

4. 在 Xcode 的 [Package Dependencies] 中确认 Airbridge iOS SDK 已成功添加。

注意
在安装 iOS SDK 之前，请导航至 [Xcode]>[YOUR_PROJECT]>[Build Settings]，并确保将 User Script Sandboxing 设置为 “No”。更多信息请参阅 CocoaPods 文档。

1. 使用 brew install cocoapods 安装 CocoaPods。

2. 使用 pod init 创建 Podfile。

3. 使用以下代码将 SDK 添加为 Podfile 的依赖项。

Podfile

1234567
target '[Project Name]' do
    ...
    # choose YOUR_VERSION from https://help.airbridge.io/developers/release-note-ios-sdk
    # example: pod 'airbridge-ios-sdk-restricted', '4.X.X'
    pod 'airbridge-ios-sdk-restricted', 'YOUR_VERSION'
    ...
end

4. 在输入 pod install --repo-update 时，安装将开始。

5. 运行 YOUR_PROJECT.xcworkspace 以确认 Airbridge iOS SDK 成功安装。

注意
您无法使用 Tuist 的 External Dependencies 安装 Airbridge iOS SDK。请确保按照以下步骤安装。

1. 运行 tuist edit 命令。

2. 将 remote 添加到 project.packages。将 package 添加到 project.targets[...].target.dependencies 中。参见以下代码：

1234567891011121314151617181920212223
import ProjectDescription

let project = Project(
    packages: [
        .remote(
            url: "https://github.com/ab180/airbridge-ios-sdk-restricted-deployment",
            // choose YOUR_VERSION from https://help.airbridge.io/developers/release-note-ios-sdk
            // example: requirement: .exact(from: "4.X.X")
            requirement: .exact(from: "YOUR_VERSION")
        ),
        ...
    ],
    targets: [
        .target(
            dependencies: [
                .package(product: "Airbridge", type: .runtime),
                ...
            ]
        ),
        ...
    ],
    ...
)

3. 运行 tuist generate 命令。

4. Airbridge 将添加至 Xcode 的 Package Dependencies 中。

1. 从以下链接下载 Airbridge iOS SDK。

https://sdk-download.airbridge.io/airbridge-ios-sdk-restricted/latest/Airbridge.zip

2. 将 Airbridge.xcframework 添加到 Project 中。导航至 [Xcode]>[Project File]>[General]>[Frameworks, Libraries, and Embedded Content]，并点击 “+”。

3. 在 [Add Other...] 下点击 “Add Files...”，并选择 Airbridge.xcframework。

4.将 Airbridge.xcframework 中的 Embed（嵌入）设置为 Do Not Embed（不嵌入）。

5. 将 SDK 依赖的 Framework 添加到 Project 中。导航至 [Xcode]>[Project File]>[General]>[Frameworks, Libraries, and Embedded Content]，并点击 “+”。

Framework	说明
CoreTelephony.framework	用于收集移动通信运营商信息
StoreKit.framework	用于收集 SKAN 信息
AdServices.framework	用于收集 Apple Ads 的归因信息（iOS 14.3+）

SDK 初始化

SDK 初始化方法因系统方式而异。SceneDelegate Lifecycle 或 AppDelegate Lifecycle 参考 AppDelegate，SwiftUI Lifecycle 参考 SwiftUI。

YOUR_APP_NAME 和 YOUR_APP_SDK_TOKEN 可在 Airbridge 面板的 [设置]>[Token] 获取。

请在 AppDelegate 的 application(_:didFinishLaunchingWithOptions:) 函数顶部调用 Airbridge.initializeSDK 函数。

123456789101112131415
import UIKit
import Airbridge

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
            .build()
        Airbridge.initializeSDK(option: option)
        return true
    }
}

注意
Airbridge.initializeSDK 函数需在 AppDelegate 的 application(_:didFinishLaunchingWithOptions:) 阶段调用，以确保正常运行。

请在 AppDelegate 的 application:didFinishLaunchingWithOptions: 函数顶部调用 Airbridge.initializeSDK 函数。

123456789101112131415161718
#import "AppDelegate.h"
#import <Airbridge/Airbridge.h>

@interface AppDelegate ()

@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                                   token:@"YOUR_APP_SDK_TOKEN"];
    AirbridgeOption* option = [optionBuilder build];
    [Airbridge initializeSDKWithOption:option];
    return YES;
}

@end

注意
Airbridge.initializeSDK 函数需在 AppDelegate 的 application(_:didFinishLaunchingWithOptions:) 阶段调用，以确保正常运行。

请在 init 的顶部调用 Airbridge.initializeSDK 函数。

1234567891011121314151617
import SwiftUI
import Airbridge

@main
struct ExampleApp: App {
    init() {
        let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
            .build()
        Airbridge.initializeSDK(option: option)
    }
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

注意
Airbridge.initializeSDK 函数需在 App 的 init 阶段调用，以确保正常运行。

注意
SwiftUI Lifecycle 方法不提供 ReferrerURL，因此无法使用 Organic Referrer Attribution。即使使用 UIApplicationDelegateAdaptor，在 SwiftUI Lifecycle 方法中也无法使用 Organic Referrer Attribution。

ATT 弹窗提供

提示
为确保遵守隐私政策所需的功能，应与法律顾问共同审查。

在 iOS 环境中，只有在通过 ATT（App Tracking Transparency，应用跟踪透明度）弹窗征得用户同意后，才能收集 IDFA。

收集安装事件应延迟到用户允许追踪后进行。IDFA 会与安装事件一同收集，因此如果在用户通过 ATT 弹窗允许追踪之前收集安装事件，IDFA 将缺失，影响绩效监测。建议设置足够的延迟时间，以确保 IDFA 被正确收集。

1. 准备好您将在 ATT 弹窗中使用的文本。

2. 在 Info.plist 文件的 NSUserTrackingUsageDescription 值中输入准备好的文本。

请导航至 [Xcode]>[YOUR_PROJECT]>[Info]>[Custom iOS Target Properties]。
请将鼠标悬停在 Key 的项目，点击出现的 “+”，并输入 Privacy - Tracking Usage Description。
请将准备好的 ATT 弹窗文本作为值输入。

1. 请输入 tuist edit 命令。

2. 请在 project.targets[...].infoPlist 的 .extendingDefault 中，作为键输入 NSUserTrackingUsageDescription，作为值输入准备好的 ATT 弹窗文本。

1234567891011121314151617
import ProjectDescription

let project = Project(
    targets: [
        .target(
            infoPlist: .extendingDefault(
                with: [
                    "NSUserTrackingUsageDescription": "YOUR_DESCRIPTION",
                    ...
                ]
            ),
            ...
        ),
        ...
    ]
    ...
)

3. 设置 ATT 弹窗的弹出时间。

请在计划弹出 ATT 弹窗的时间调用 ATTrackingManager.requestTrackingAuthorization 函数。

123
import AppTrackingTransparency
...
ATTrackingManager.requestTrackingAuthorization { _ in }

注意
当调用 ATTrackingManager.requestTrackingAuthorization 函数时，如果 App 不处于 Active 状态，则不会弹出 ATT 弹窗。

App 启用后可立即弹出 ATT 弹窗。

123456789101112131415161718192021
import Airbridge
import AppTrackingTransparency
...
var observer: Any?
...
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
    .build()
Airbridge.initializeSDK(option: option)
...
observer = NotificationCenter.default.addObserver(
    forName: UIApplication.didBecomeActiveNotification,
    object: nil,
    queue: nil
) { [weak self] _ in
    if #available(iOS 14, *) {
        ATTrackingManager.requestTrackingAuthorization { _ in }
    }
    if let observer = self?.observer {
        NotificationCenter.default.removeObserver(observer)
    }
}

1234567891011121314151617181920212223
#import <Airbridge/Airbridge.h>
#import <AppTrackingTransparency/AppTrackingTransparency.h>
...
id observer;
...
AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                               token:@"YOUR_APP_SDK_TOKEN"];
[optionBuilder setAutoDetermineTrackingAuthorizationEnabled:NO];
AirbridgeOption* option = [optionBuilder build];
[Airbridge initializeSDKWithOption:option];
...
__weak typeof(self) weakSelf = self;
observer = [NSNotificationCenter.defaultCenter addObserverForName:UIApplicationDidBecomeActiveNotification
                                                           object:nil
                                                            queue:nil
                                                       usingBlock:^(NSNotification * _Nonnull notification) {
    if (@available(iOS 14, *)) {
        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {}];
    }
    if (weakSelf != nil && weakSelf->observer != nil) {
        [NSNotificationCenter.defaultCenter removeObserver:observer];
    }
}];

1234567891011121314151617181920212223242526272829303132
import SwiftUI
import Airbridge
import AppTrackingTransparency

@main
struct ExampleApp: App {
    var observer: Any?

    init() {
        let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
            .build()
        Airbridge.initializeSDK(option: option)
        observer = NotificationCenter.default.addObserver(
            forName: UIApplication.didBecomeActiveNotification,
            object: nil,
            queue: nil
        ) { [weak self] _ in
            if #available(iOS 14, *) {
                ATTrackingManager.requestTrackingAuthorization { _ in }
            }
            if let observer = self?.observer {
                NotificationCenter.default.removeObserver(observer)
            }
        }
    }
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

4. 如果未收集到安装事件，Airbridge iOS SDK 会在每次 App 启用时延迟 30 秒尝试收集安装事件，直到用户允许追踪为止。如果用户在决定是否允许追踪之前关闭 App，SDK 将不会收集安装事件，并会在下次启用 App 时重试。

安装事件默认收集延迟时间为 30 秒。您可以使用 setAutoDetermineTrackingAuthorizationTimeout 函数修改此值，最长可达 3600 秒（1 小时）。

提示
在 DeepLink Plan 中，建议将 setAutoDetermineTrackingAuthorizationTimeout 函数设为 0 秒。DeepLink Plan 不支持基于标识符的归因。为了使安装 App 的用户能立即通过延迟深度链接跳转至预设目标页面，建议将该函数设为 0 秒。

1234567
import Airbridge
...
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME",
                                    token: "YOUR_APP_SDK_TOKEN")
    .setAutoDetermineTrackingAuthorizationTimeout(second: 30)
    .build()
Airbridge.initializeSDK(option: option)

1234567
#import <Airbridge/Airbridge.h>
...
AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                               token:@"YOUR_APP_SDK_TOKEN"];
[optionBuilder setAutoDetermineTrackingAuthorizationTimeoutWithSecond:30];
AirbridgeOption* option = [optionBuilder build];
[Airbridge initializeSDKWithOption:option];

深度链接 (Deep Link)

Airbridge 在追踪链接打开时，会根据用户环境，将追踪链接中配置的 URI Scheme 深度链接转换为最适合的 Airbridge 深度链接（HTTP 深度链接或 URI Scheme 深度链接）以引导用户进入 App。随后，Airbridge SDK 会将 Airbridge 深度链接重新转换为追踪链接中配置的 URI Scheme 深度链接，并传递至 App。

追踪链接中配置的 URI Scheme 深度链接示例：YOUR_SCHEME://product/12345
Airbridge 深度链接示例：
- HTTP 深度链接格式 1：https://YOUR_APP_NAME.airbridge.io/~~~
- HTTP 深度链接格式 2：https://YOUR_APP_NAME.abr.ge/~~~
- URI Scheme 深度链接格式：YOUR_SCHEME://product/12345?airbridge_referrer=~~~

当 App 已安装时，用户点击追踪链接后，App 将通过 Airbridge 深度链接打开。随后，Airbridge SDK 会将该 Airbridge 深度链接转换为追踪链接中配置的 URI Scheme 深度链接，并将转换后的 URI Scheme 深度链接传递给 App。

当 App 未安装时，用户点击追踪链接后，Airbridge SDK 会保存 Airbridge 深度链接信息。用户被发送至应用商店或网站安装并打开 App 后，Airbridge SDK 会将保存的 Airbridge 深度链接转换为追踪链接中配置的 URI Scheme 深度链接，并将转换后的 URI Scheme 深度链接传递给 App。

深度链接设置

深度链接设置需要在 Airbridge 面板中注册的深度链接信息和用户跳转目的地的 App 内页面地址。

首先，在 Airbridge 面板注册深度链接信息:

在 Airbridge 面板注册深度链接信息后，需要在 App 中设置深度链接。根据 App 的系统方式，查看相应的深度链接设置流程：

请进行设置启用以下功能：

使用 Airbridge 深度链接启用 App
在 App 收集 Airbridge 深度链接事件
使用 Airbridge 深度链接实现用户跳转

使用 Airbridge 深度链接启用 App

当用户点击追踪链接时，App 应通过 Airbridge 深度链接启用。

1. 需要在 App 进行 Airbridge 深度链接的 URI Scheme 深度链接设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Info]>[URL Types]。

2. 请点击 “+”，并在 URL Schemes 中输入已在 Airbridge 面板中注册的 iOS URI Scheme。

注意
必须输入不包括 :// 的 iOS URI Scheme。

3. 需要在 App 进行 Airbridge 深度链接的 Universal Link 设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Signing & Capabilities]。

4. 请点击 “+ Capability” 以添加 Associated Domains。

5. 请将 applinks:YOUR_APP_NAME.airbridge.io 和 applinks:YOUR_APP_NAME.abr.ge 添加到 Associated Domains。YOUR_APP_NAME 是 Airbridge App 名称。

注意
如果您正在使用或计划使用 Password AutoFill 功能，则必须添加 Webcredentials 域名。否则用户可能会看到通过 Password AutoFill 功能保存的密码域名显示为 airbridge.io 或 abr.ge。
更多信息请参阅本指南。

在 App 收集深度链接事件

注意
在 iOS，无法自动收集深度链接事件。必须使用 Airbridge.trackDeeplink 函数将深度链接事件传递给 Airbridge SDK。

为了收集深度链接事件，必须将深度链接事件传递给 Airbridge SDK。当 App 通过深度链接启用时，请在调用的 OS 回调顶部调用 Airbridge.trackDeeplink 函数。

1234
import Airbridge
...
Airbridge.trackDeeplink(url: url)
Airbridge.trackDeeplink(userActivity: userActivity)

请根据 App 状态进行设置：

1. 当已关闭的 App 通过 URI Scheme 深度链接或 Universal Link 重新启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。

12345678910111213141516171819
import Airbridge
...
// when terminated app is opened with scheme deeplink or universal links
func scene(
    _ scene: UIScene,
    willConnectTo session: UISceneSession,
    options connectionOptions: UIScene.ConnectionOptions
) {
    // when app is opened with scheme deeplink
    if let url = connectionOptions.urlContexts.first?.url {
        // track deeplink
        Airbridge.trackDeeplink(url: url)
    }
    // when app is opened with universal links
    else if let userActivity = connectionOptions.userActivities.first {
        // track deeplink
        Airbridge.trackDeeplink(userActivity: userActivity)
    }
}

12345678910111213141516
#import <Airbridge/Airbridge.h>
...
// when terminated app is opened with scheme deeplink or universal links
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
    // when app is opened with scheme deeplink
    NSURL* url = connectionOptions.URLContexts.allObjects.firstObject.URL;
    NSUserActivity* userActivity = connectionOptions.userActivities.allObjects.firstObject;
    if (url != nil) {
        // track deeplink
        [Airbridge trackDeeplinkWithUrl:url];
    }
    else if (userActivity != nil) {
        // track deeplink
        [Airbridge trackDeeplinkWithUserActivity:userActivity];
    }
}

2. 当后台中的 App 通过 URI Scheme 深度链接启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。

123456789101112
import Airbridge
...
// when backgrounded app is opened with scheme deeplink
func scene(
    _ scene: UIScene,
    openURLContexts URLContexts: Set<UIOpenURLContext>
) {
    guard let url = URLContexts.first?.url else { return }

    // track deeplink
    Airbridge.trackDeeplink(url: url)
}

12345678910
#import <Airbridge/Airbridge.h>
...
// when backgrounded app is opened with scheme deeplink
- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    NSURL* url = URLContexts.allObjects.firstObject.URL;
    if (url == nil) { return; }

    // track deeplink
    [Airbridge trackDeeplinkWithUrl:url];
}

3. 当后台中的 App 通过 Universal Link 启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。

12345678910
import Airbridge
...
// when backgrounded app is opened with universal links
func scene(
    _ scene: UIScene,
    continue userActivity: NSUserActivity
) {
    // track deeplink
    Airbridge.trackDeeplink(userActivity: userActivity)
}

12345
// when backgrounded app is opened with universal links
- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {
    // track deeplink
    [Airbridge trackDeeplinkWithUserActivity:userActivity];
}

使用 Airbridge 深度链接实现用户跳转

为确保将用户发送到目标页面，必须使用 Airbridge.handleDeeplink 函数将 Airbridge 深度链接转换为 URI Scheme 深度链接。

123456789101112131415161718192021
import Airbridge
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(url: url) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is

123456789101112131415161718192021
#import <Airbridge/Airbridge.h>
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is

Airbridge.handleDeeplink 函数在输入 Airbridge 深度链接时，会返回 true 并通过回调提供 URI Scheme 深度链接。如果不是 Airbridge 深度链接，则返回 false，且不提供回调。利用此功能，可以分开处理通过 Airbridge 启用的深度链接。

根据系统方式和 App 状态，在通过深度链接启用的 App 调用的 OS 回调中，将 Airbridge.handleDeeplink 函数放置在 Airbridge.trackDeeplink 函数的正下方调用。如有必要，应将现有逻辑一并处理。

1. 请在 SceneDelegate 中实现处理通过 Airbridge 深度链接启用的 App 的函数。

123456
import Foundation
...
// when app is opened with airbridge deeplink
func handleAirbridgeDeeplink(url: URL) {
    // show proper content using url (YOUR_SCHEME://...)
}

2. 当已关闭的 App 通过 URI Scheme 深度链接或 Universal Link 重新启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

1234567891011121314151617181920212223242526272829303132333435363738394041
import Airbridge
...
// when terminated app is opened with scheme deeplink or universal links
func scene(
    _ scene: UIScene,
    willConnectTo session: UISceneSession,
    options connectionOptions: UIScene.ConnectionOptions
) {
    // when app is opened with scheme deeplink
    if let url = connectionOptions.urlContexts.first?.url {
        // track deeplink
        Airbridge.trackDeeplink(url: url)

        // handle deeplink
        var isHandled = Airbridge.handleDeeplink(url: url) { url in
            // when app is opened with airbridge deeplink
            // show proper content using url (YOUR_SCHEME://...)
            handleAirbridgeDeeplink(url: url)
        }
        if isHandled { return }

        // when app is opened with other deeplink
        // use existing logic as it is
    }
    // when app is opened with universal links
    else if let userActivity = connectionOptions.userActivities.first {
        // track deeplink
        Airbridge.trackDeeplink(userActivity: userActivity)

        // handle deeplink
        var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
            // when app is opened with airbridge deeplink
            // show proper content using url (YOUR_SCHEME://...)
            handleAirbridgeDeeplink(url: url)
        }
        if isHandled { return }

        // when app is opened with other deeplink
        // use existing logic as it is
    }
}

1234567891011121314151617181920212223242526272829303132333435363738
#import <Airbridge/Airbridge.h>
...
// when terminated app is opened with scheme deeplink or universal links
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session options:(UISceneConnectionOptions *)connectionOptions {
    // when app is opened with scheme deeplink
    NSURL* url = connectionOptions.URLContexts.allObjects.firstObject.URL;
    NSUserActivity* userActivity = connectionOptions.userActivities.allObjects.firstObject;
    if (url != nil) {
        // track deeplink
        [Airbridge trackDeeplinkWithUrl:url];

        // handle deeplink
        BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
            // when app is opened with airbridge deeplink
            // show proper content using url (YOUR_SCHEME://...)
            [self handleAirbridgeDeeplink:url];
        }];
        if (isHandled) { return; }

        // when app is opened with other deeplink
        // use existing logic as it is
    }
    else if (userActivity != nil) {
        // track deeplink
        [Airbridge trackDeeplinkWithUserActivity:userActivity];

        // handle deeplink
        BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
            // when app is opened with airbridge deeplink
            // show proper content using url (YOUR_SCHEME://...)
            [self handleAirbridgeDeeplink:url];
        }];
        if (isHandled) { return; }

        // when app is opened with other deeplink
        // use existing logic as it is
    }
}

3. 当后台中的 App 通过 URI Scheme 深度链接启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

1234567891011121314151617181920212223
import Airbridge
...
// when backgrounded app is opened with scheme deeplink
func scene(
    _ scene: UIScene,
    openURLContexts URLContexts: Set<UIOpenURLContext>
) {
    guard let url = URLContexts.first?.url else { return }

    // track deeplink
    Airbridge.trackDeeplink(url: url)

    // handle deeplink
    var isHandled = Airbridge.handleDeeplink(url: url) { url in
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        handleAirbridgeDeeplink(url: url)
    }
    if isHandled { return }

    // when app is opened with other deeplink
    // use existing logic as it is
}

123456789101112131415161718192021
#import <Airbridge/Airbridge.h>
...
// when backgrounded app is opened with scheme deeplink
- (void)scene:(UIScene *)scene openURLContexts:(NSSet<UIOpenURLContext *> *)URLContexts {
    NSURL* url = URLContexts.allObjects.firstObject.URL;
    if (url == nil) { return; }

    // track deeplink
    [Airbridge trackDeeplinkWithUrl:url];

    // handle deeplink
    BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        [self handleAirbridgeDeeplink:url];
    }];
    if (isHandled) { return; }

    // when app is opened with other deeplink
    // use existing logic as it is
}

4. 当后台中的 App 通过 Universal Link 启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

123456789101112131415161718192021
import Airbridge
...
// when backgrounded app is opened with universal links
func scene(
    _ scene: UIScene,
    continue userActivity: NSUserActivity
) {
    // track deeplink
    Airbridge.trackDeeplink(userActivity: userActivity)

    // handle deeplink
    var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        handleAirbridgeDeeplink(url: url)
    }
    if isHandled { return }

    // when app is opened with other deeplink
    // use existing logic as it is
}

12345678910111213141516
// when backgrounded app is opened with universal links
- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {
    // track deeplink
    [Airbridge trackDeeplinkWithUserActivity:userActivity];

    // handle deeplink
    BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        [self handleAirbridgeDeeplink:url];
    }];
    if (isHandled) { return; }

    // when app is opened with other deeplink
    // use existing logic as it is
}

请进行设置启用以下功能：

使用 Airbridge 深度链接启用 App
在 App 收集 Airbridge 深度链接事件
使用 Airbridge 深度链接实现用户跳转

使用 Airbridge 深度链接启用 App

当用户点击追踪链接时，App 应通过 Airbridge 深度链接启用。

1. 需要在 App 进行 Airbridge 深度链接的 URI Scheme 深度链接设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Info]>[URL Types]。

2. 请点击 “+”，并在 URL Schemes 中输入已在 Airbridge 面板中注册的 iOS URI Scheme。

注意
必须输入不包括 :// 的 iOS URI Scheme。

3. 需要在 App 进行 Airbridge 深度链接的 Universal Link 设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Signing & Capabilities]。

4. 请点击 “+ Capability” 以添加 Associated Domains。

5. 请将 applinks:YOUR_APP_NAME.airbridge.io 和 applinks:YOUR_APP_NAME.abr.ge 添加到 Associated Domains。YOUR_APP_NAME 是 Airbridge App 名称。

注意
如果您正在使用或计划使用 Password AutoFill 功能，则必须添加 Webcredentials 域名。否则用户可能会看到通过 Password AutoFill 功能保存的密码域名显示为 airbridge.io 或 abr.ge。
更多信息请参阅本指南。

在 App 收集深度链接事件

注意
在 iOS，无法自动收集深度链接事件。必须使用 Airbridge.trackDeeplink 函数将深度链接事件传递给 Airbridge SDK。

为了收集深度链接事件，必须将深度链接事件传递给 Airbridge SDK。当 App 通过深度链接启用时，请在调用的 OS 回调顶部调用 Airbridge.trackDeeplink 函数。

1234
import Airbridge
...
Airbridge.trackDeeplink(url: url)
Airbridge.trackDeeplink(userActivity: userActivity)

当 App 通过 URI Scheme 深度链接或 Universal Link 启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。Airbridge.trackDeeplink 函数将深度链接传递给 Airbridge SDK。

12345678910111213141516
import SwiftUI
import Airbridge

@main
struct ActualApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
                // when app is opened with scheme deeplink or universal links
                .onOpenURL { url in
                    // track deeplink
                    Airbridge.trackDeeplink(url: url)
                }
        }
    }
}

使用 Airbridge 深度链接实现用户跳转

为确保将用户发送到目标页面，必须使用 Airbridge.handleDeeplink 函数将 Airbridge 深度链接转换为 URI Scheme 深度链接。

123456789101112131415161718192021
import Airbridge
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(url: url) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is

123456789101112131415161718192021
#import <Airbridge/Airbridge.h>
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is

在通过深度链接启用的 App 调用的 OS 回调中，将 Airbridge.handleDeeplink 函数放置在 Airbridge.trackDeeplink 函数的正下方调用。如有必要，应将现有逻辑一并处理。

当 App 通过 URI Scheme 深度链接或 Universal Link 启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

1234567891011121314151617181920212223242526
import SwiftUI
import Airbridge

@main
struct ActualApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
                // when app is opened with scheme deeplink or universal links
                .onOpenURL { url in
                    // track deeplink
                    Airbridge.trackDeeplink(url: url)

                    // handle deeplink
                    var isHandled = Airbridge.handleDeeplink(url: url) { url in
                        // when app is opened with airbridge deeplink
                        // show proper content using url (YOUR_SCHEME://...)
                    }
                    if isHandled { return }

                    // when app is opened with other deeplink
                    // use existing logic as it is
                }
        }
    }
}

请进行设置启用以下功能：

使用 Airbridge 深度链接启用 App
在 App 收集 Airbridge 深度链接事件
使用 Airbridge 深度链接实现用户跳转

使用 Airbridge 深度链接启用 App

当用户点击追踪链接时，App 应通过 Airbridge 深度链接启用。

1. 需要在 App 进行 Airbridge 深度链接的 URI Scheme 深度链接设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Info]>[URL Types]。

2. 请点击 “+”，并在 URL Schemes 中输入已在 Airbridge 面板中注册的 iOS URI Scheme。

注意
必须输入不包括 :// 的 iOS URI Scheme。

3. 需要在 App 进行 Airbridge 深度链接的 Universal Link 设置。请在 Xcode 中导航至 [YOUR_PROJECT]>[Signing & Capabilities]。

4. 请点击 “+ Capability” 以添加 Associated Domains。

5. 请将 applinks:YOUR_APP_NAME.airbridge.io 和 applinks:YOUR_APP_NAME.abr.ge 添加到 Associated Domains。YOUR_APP_NAME 是 Airbridge App 名称。

注意
如果您正在使用或计划使用 Password AutoFill 功能，则必须添加 Webcredentials 域名。否则用户可能会看到通过 Password AutoFill 功能保存的密码域名显示为 airbridge.io 或 abr.ge。
更多信息请参阅本指南。

在 App 收集深度链接事件

注意
在 iOS，无法自动收集深度链接事件。必须使用 Airbridge.trackDeeplink 函数将深度链接事件传递给 Airbridge SDK。

为了收集深度链接事件，必须将深度链接事件传递给 Airbridge SDK。当 App 通过深度链接启用时，请在调用的 OS 回调顶部调用 Airbridge.trackDeeplink 函数。

1234
import Airbridge
...
Airbridge.trackDeeplink(url: url)
Airbridge.trackDeeplink(userActivity: userActivity)

具体设置方法因 Airbridge 深度链接类型而异。

1. 当 App 通过 URI Scheme 深度链接启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。

12345678910111213
import Airbridge
...
// when app is opened with scheme deeplink
func application(
    _ app: UIApplication,
    open url: URL,
    options: [UIApplication.OpenURLOptionsKey : Any] = [:]
) -> Bool {
    // track deeplink
    Airbridge.trackDeeplink(url: url)

    return true
}

123456789
#import <Airbridge/Airbridge.h>
...
// when app is opened with scheme deeplink
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    // track deeplink
    [Airbridge trackDeeplinkWithUrl:url];

    return YES;
}

2. 当 App 通过 Universal Link 启用时，请在调用的函数中调用 Airbridge.trackDeeplink 函数。

1234567891011
// when app is opened with universal links
func application(
    _ application: UIApplication,
    continue userActivity: NSUserActivity,
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
) -> Bool {
    // track deeplink
    Airbridge.trackDeeplink(userActivity: userActivity)

    return true
}

123456789
#import <Airbridge/Airbridge.h>
...
// when app is opened with universal links
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
    // track deeplink
    [Airbridge trackDeeplinkWithUserActivity:userActivity];

    return YES;
}

使用 Airbridge 深度链接实现用户跳转

为确保将用户发送到目标页面，必须使用 Airbridge.handleDeeplink 函数将 Airbridge 深度链接转换为 URI Scheme 深度链接。

123456789101112131415161718192021
import Airbridge
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(url: url) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}
if isHandled { return }

// when app is opened with other deeplink
// use existing logic as it is

123456789101112131415161718192021
#import <Airbridge/Airbridge.h>
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is
...
// handle deeplink
BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
    // when app is opened with airbridge deeplink
    // show proper content using url (YOUR_SCHEME://...)
}];
if (isHandled) { return; }

// when app is opened with other deeplink
// use existing logic as it is

1. 请在 AppDelegate 中实现用于处理通过 Airbridge 深度链接启用的 App 的函数。

123456
import Foundation
...
// when app is opened with airbridge deeplink
func handleAirbridgeDeeplink(url: URL) {
    // show proper content using url (YOUR_SCHEME://...)
}

2. 当 App 通过 URI Scheme 深度链接启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

123456789101112131415161718192021222324
import Airbridge
...
// when app is opened with scheme deeplink
func application(
    _ app: UIApplication,
    open url: URL,
    options: [UIApplication.OpenURLOptionsKey : Any] = [:]
) -> Bool {
    // track deeplink
    Airbridge.trackDeeplink(url: url)

    // handle deeplink
    var isHandled = Airbridge.handleDeeplink(url: url) { url in
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        handleAirbridgeDeeplink(url: url)
    }
    if isHandled { return }

    // when app is opened with other deeplink
    // use existing logic as it is

    return isHandled
}

1234567891011121314151617181920
#import <Airbridge/Airbridge.h>
...
// when app is opened with scheme deeplink
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    // track deeplink
    [Airbridge trackDeeplinkWithUrl:url];

    // handle deeplink
    BOOL isHandled = [Airbridge handleDeeplinkWithUrl:url onSuccess:^(NSURL* url) {
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        [self handleAirbridgeDeeplink:url];
    }];
    if (isHandled) { return; }

    // when app is opened with other deeplink
    // use existing logic as it is

    return isHandled;
}

3. 当 App 通过 Universal Link 启用时，请在调用的函数中调用 Airbridge.handleDeeplink 函数。转换后的 URI Scheme 深度链接将用户发送到预设的目标页面。

12345678910111213141516171819202122
// when app is opened with universal links
func application(
    _ application: UIApplication,
    continue userActivity: NSUserActivity,
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
) -> Bool {
    // track deeplink
    Airbridge.trackDeeplink(userActivity: userActivity)

    // handle deeplink
    var isHandled = Airbridge.handleDeeplink(userActivity: userActivity) { url in
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        handleAirbridgeDeeplink(url: url)
    }
    if isHandled { return }

    // when app is opened with other deeplink
    // use existing logic as it is

    return isHandled
}

1234567891011121314151617181920
#import <Airbridge/Airbridge.h>
...
// when app is opened with universal links
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
    // track deeplink
    [Airbridge trackDeeplinkWithUserActivity:userActivity];

    // handle deeplink
    BOOL isHandled = [Airbridge handleDeeplinkWithUserActivity:userActivity onSuccess:^(NSURL* url) {
        // when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
        [self handleAirbridgeDeeplink:url];
    }];
    if (isHandled) { return; }

    // when app is opened with other deeplink
    // use existing logic as it is

    return isHandled;
}

延迟深度链接（Deferred Deep Link）设置

当 App 未安装时，如果用户点击了设置了延迟深度链接的追踪链接，Airbridge 深度链接信息将被保存。Airbridge SDK 会通过以下方法来获取保存的深度链接：

Airbridge.handleDeferredDeeplink 函数在获取已保存的 Airbridge 深度链接后，会将 Airbridge 深度链接转换为 URI Scheme 深度链接，并将转换后的 URI Scheme 深度链接传递给 App。转换后的 URI Scheme 深度链接将用户发送至设置的目的页面。

1234567891011
import Airbridge
...
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
    .build()
Airbridge.initializeSDK(option: option)
...
let isHandled = Airbridge.handleDeferredDeeplink() { url in
    if let url {
        // show proper content using url (YOUR_SCHEME://...)
    }
}

123456789101112
#import <Airbridge/Airbridge.h>
...
AirbridgeOptionBuilder* optionBuilder = [[AirbridgeOptionBuilder alloc] initWithName:@"YOUR_APP_NAME"
                                                                               token:@"YOUR_APP_SDK_TOKEN"];
AirbridgeOption* option = [optionBuilder build];
[Airbridge initializeSDKWithOption:option];
...
BOOL isHandled = [Airbridge handleDeferredDeeplinkOnSuccess:^(NSURL* url) {
    if (url != nil) {
        // show proper content using url (YOUR_SCHEME://...)
    }
}];

Airbridge.handleDeferredDeeplink 函数在 App 安装后首次被调用时会返回 true，并等待获取 Airbridge 深度链接，将其转换为 URI Scheme 深度链接后传递给 onSuccess。您可以使用该 URI Scheme 深度链接将用户发送至预设目标页面。

如果没有保存的 Airbridge 深度链接，则会向 onSuccess 传递 nil。如果 SDK 尚未初始化，或 Airbridge.handleDeferredDeeplink 函数并非首次被调用，则会返回 false。

传递的 URI Scheme 深度链接通常是 YOUR_SCHEME://... 格式的 URL。如果使用 Meta Deferred App Link 等服务，则可能会传递其他格式的 URL。

测试

可通过 SDK 运行测试和深度链接测试，验证 Airbridge SDK 和深度链接是否正常运行。

SDK 运行测试

App 安装事件会自动被 iOS SDK 收集，无需额外设置。

检查 App 安装事件的收集

1. 准备未安装您 App 的测试设备，或在测试前删除该 App。

2. 将 SDK 日志级别设置为 LOG_ALL。

123
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
    .build()
Airbridge.initializeSDK(option: option)

3. 在测试设备上安装 App。安装后需要启用 App，才能收集到 App 安装事件。请启用 App。

Airbridge 将首次收集的打开（Open）事件记录为安装（Install）事件。因此，如果收集到安装（Install）事件，打开（Open）事件可能不会被记录。

4. 在 [Xcode]>[Console] 检查测试设备的 IDFA 事件日志。在 Console Filter 输入 Library:Airbridge。若 App 安装事件被正常收集，可在日志中查看如下信息：

Send event packets to Airbridge: categories=9161
Send event packets to Airbridge: categories=9163

5. 如果经过足够时间后 Xcode 的 Console 仍无日志，请检查 SDK 是否已初始化、配置是否正确、以及网络状态。

如果反复无法查到 App 安装事件，请通过 [帮助] 提交请求，并附上 SDK 日志。

深度链接测试

提前准备

`#{"width":"120px"}`	`#{"width":"240px"}` 说明	`#{"width":"140px"}` 相关指南
HTTP 深度链接（App link）设置	- 必需设置。	- 面板设置 - 深度链接设置
URI Scheme 深度链接设置	- 必需设置。	- 面板设置 - 深度链接设置
延迟深度链接设置	- 自动设置，无需额外设置。	- 延迟深度链接设置
品牌域名设置	- 可选设置。	- 面板设置
App 安装	- 如果不测试延迟深度链接，请提前在测试设备上安装 App。 - 如果测试延迟深度链接，测试设备上不应安装 App。如果已安装，请提前卸载。

通过深度链接测试网站进行测试

1. 在测试设备上访问深度链接测试网站。您可以扫描下方 QR 码访问。

2. 在 App Name 栏输入在 Airbridge 面板注册的 App 名称。App 名称可在 Airbridge 面板的 [设置]>[Token] 获取。

若要测试特定深度链接地址，在 Deeplink URL 栏中输入 URI Scheme 深度链接，格式应为 {YOUR_SCHEME}://...。

如果要测试品牌域名，在 Custom Domain 栏输入品牌域名。

3. 根据所需测试的深度链接类型，点击相应的按钮。

请注意，延迟深度链接只能在测试设备未安装 App 的情况下进行测试。

`#{"width":"120px"}` 按钮	`#{"width":"240px"}` 说明	`#{"width":"140px"}` 示例
Test HTTP Deeplink Type-1	- 可以测试 `https://{your_app-name}.abr.ge` 格式的 HTTP 深度链接。	`https://{your_app-name}.abr.ge/@{your_app-name}/test_sdk?...`
Test HTTP Deeplink Type-2	- 可以测试 `https://abr.ge` 格式的 HTTP 深度链接。与 Test HTTP Deeplink Type-1 的地址格式不同。	`https://abr.ge/@{your_app-name}/test_sdk?...`
Test Scheme Deeplink	- 可以测试 URI Scheme 深度链接。	`https://abr.ge/@{your_app-name}/test_sdk?...`
Test Deferred Deeplink	- 可以测试延迟深度链接。	`https://abr.ge/@{your_app-name}/test_sdk?...`
Test Custom Domain Deeplink	- 仅在输入品牌域名时可用。 - 可以测试品牌域名。	`https://{your_custom_domain}/@{your_app-name}/test_sdk?...`

4. 在 [Xcode]>[Console] 检查测试设备的 IDFA 事件日志。在 Console Filter 输入 [Airbridge][Debug]。若深度链接事件被正常收集，可在日志中查看如下信息：

[Airbridge] [Debug] - success network to url: https://core.airbridge.io/api/v4/apps/{app_name}/events/mobile-app/9162
[Airbridge] [Debug] - success network to url : https://core.airbridge.io/api/v4/apps/{app_name}/events/mobile-app/9163
[Airbridge] [Debug] - success network to url : https://core.airbridge.io/api/v4/apps/{app_name}/events/mobile-app/9168

如果在 Airbridge SDK 初始化过程中将日志级别设置为 DEBUG，则可查看通过网络传输的数据。

5. 通过 Client request: method={...} 消息发送 header 和 body 值。根据您点击的按钮，进一步检查以下项目。如果深度链接正常运行，所有项目都应符合。

问题排查

问题	解决方法
点击深度链接后，App 未启用，或 SDK 日志显示的内容与设置不符。	请参考深度链接设置，检查深度链接设置是否正确。
点击深度链接后，App 已启用，但未跳转至设定的 App 页面。	您需要手动实现，使用户能够根据传递给 `onSuccess` 函数的深度链接路径进行跳转。请参考深度链接设置。

Was this page helpful?

Have any questions or suggestions?

DeepLink Plan - iOS SDK (v4)self.__wrap_n!=1&&self.__wrap_b(":R29jtt7ppjtsba:",0.5)

iOS SDK 安装

注意

注意

Restricted SDK

提示

注意

注意

SDK 初始化

注意

注意

注意

注意

ATT 弹窗提供

提示

在指定时间弹出 ATT 弹窗

注意

启用 App 时弹出 ATT 弹窗

提示

深度链接 (Deep Link)

深度链接设置

在 Airbridge 面板注册深度链接信息

注意

在 App 中设置深度链接 - SceneDelegate Lifecycle

使用 Airbridge 深度链接启用 App

注意

注意

在 App 收集深度链接事件

注意

使用 Airbridge 深度链接实现用户跳转

在 App 中设置深度链接 - SwiftUI Lifecycle

使用 Airbridge 深度链接启用 App

注意

注意

在 App 收集深度链接事件

注意

使用 Airbridge 深度链接实现用户跳转

在 App 中设置深度链接 - AppDelegate Lifecycle

使用 Airbridge 深度链接启用 App

注意

注意

在 App 收集深度链接事件

注意

使用 Airbridge 深度链接实现用户跳转

延迟深度链接（Deferred Deep Link）设置

Airbridge SDK 获取延迟深度链接的方法

测试

SDK 运行测试

检查 App 安装事件的收集

Xcode Console 消息的含义

深度链接测试

提前准备

通过深度链接测试网站进行测试

Test HTTP Deeplink

Test Scheme Deeplink

Test Deferred Deeplink

Test Custom Domain Deeplink

问题排查

DeepLink Plan - iOS SDK (v4)