ダイレクトディープリンクの設定

アプリがインストールされているユーザーがAdjustリンクをクリックすると、ダイレクトディープリンク機能により、アプリ内の特定のコンテンツへ直接遷移させることができます。

設定

iOSでは、アプリの実装に応じてダイレクトディープリンクを受け取るための方法が複数提供されています。

これらのメソッド内で、次のいずれかのメソッドを使用して、ディープリンクをAdjust SDKにパスします。

ディープリンクの処理と解析（推奨）

processDeeplink(_:completionHandler:)メソッドを使用すると、以下の処理が実行されます。

ディープリンククリックによるアトリビューションを記録する
短いブランドリンクを長いブランドリンクに解析する
その他のリンクをそのまま渡す

その後、アプリは解決済みのリンクを解析し、適切な画面へ遷移させることができます。このメソッドは、Adjustの長いブランドリンクを含む全てのディープリンク（ユニバーサルリンク、アプリスキームディープリンクなど）に使用できます。

+ (void)processDeeplink:(nonnull NSURL *)deeplink
      completionHandler:(void (^_Nonnull)(NSString * _Nonnull resolvedLink))completionHandler;

ディープリンクの処理（レガシー版）

Adjust SDKにはappWillOpen(_:)メソッドがあり、ショートブランドリンクを使用していない場合でも、ディープリンククリックからのアトリビューションを記録することができます。

+ (void)appWillOpenUrl:(nonnull NSURL *)url;

ただし、processDeeplink(_:completionHandler:)メソッドはこのレガシー版メソッドの機能を置き換えるものであるため、新しいこちらのメソッドを使用することを推奨します。

実装に関する重要な注意事項

ディープリンクの効果的な活用方法は、以下の通りです。

リンク処理の要件
- アプリは、Adjustのブランドリンク (brandname.go.link) とユニバーサルリンク (example.com) を同一に処理する必要があります。アプリでドメインの許可リストを使用している場合は、Adjustブランドドメインが含まれていることを確認してください。たとえば、次の両方が同じ画面に移動するはずです。
  - Adjustブランドリンク： https://brandname.go.link/summer-clothes?promo=beach
  - ユニバーサルリンク： https://example.com/summer-clothes?promo=beach
- アプリは、Adjustのブランドリンクとアプリスキームのディープリンクを同じように処理する必要があります。iOSでユニバーサルリンクがサポートされていない場合、Adjustはそれらを同等のアプリスキーム形式に変換します。たとえば、以下の2つのリンクは、どちらも同じ画面に遷移する必要があります。
  - Adjustブランドリンク： https://brandname.go.link/summer-clothes?promo=beach
  - アプリスキームのディープリンク： example://summer-clothes?promo=beach
アプリステータスに関する考慮事項
- アプリが「未起動」、「バックグラウンド」、または必要に応じて「フォアグラウンド」）のいずれの状態から起動された場合でも、リンクを正しく処理できるよう確認してください。
- ユーザーが認証されていない場合など、すぐに処理できない場合はディープリンクを保存し、アプリで移動する準備ができてから処理することを検討してください。
アプリ内ナビゲーション
- アプリが UIApplication.open(_:options:completionHandler:) またはSwiftUIの openURL を呼び出してユニバーサルリンクを開こうとすると、iOSはそれらのリンクをアプリ内ではなくSafariで開いてしまいます。これらのメソッドをアプリ内ナビゲーションに使用する場合は、アプリスキームのディープリンクのみを渡す必要があります。または、アプリ内にユニバーサルリンクを配置し、独自のディープリンク処理ロジックでリンクを解析し、適切な画面へ遷移させることも可能です。

実装

アプリの構造と一致する実装方法を使用してください。

AppDelegateライフサイクルを使用するUIKitアプリ
SceneDelegateライフサイクルを使用するUIKitアプリ
AppDelegateライフサイクルを使用するSwiftUIアプリ
SceneDelegateライフサイクルを使用するSwiftUIアプリ

AppDelegateライフサイクルを使用するUIKitアプリ

AppDelegateを更新して、iOSダイレクトディープリンクメソッドを実装します。

Swift
Objective-C

1
// Receive universal link when app is installed
2
// and link opens app from "not running"
3
// or background state.
4
func application(
5
  _ application: UIApplication,
6
  continue userActivity: NSUserActivity,
7
  restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
8
) -> Bool {
9
  guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
10
    let incomingLink = userActivity.webpageURL
11
  else { return true }
12

13
  // Send deep link to Adjust's servers for attribution.
14
  // If short branded link, receive long link.
15
  // Otherwise, receive original link.
16
  Adjust.processDeeplink(incomingLink) { resolvedLink in
17
    // TO DO: Handle resolvedLink by parsing its components
18
    // (example: path, query parameters) and
19
    // navigating to the appropriate screen.
20
  }
21

22
  return true
23
}
24

25
// Receive app scheme deep link when app is installed
26
// and link opens app from "not running",
27
// background, or foreground state.
28
func application(
29
  _ application: UIApplication,
30
  open incomingLink: URL,
31
  options: [UIApplication.OpenURLOptionsKey: Any] = [:]
32
) -> Bool {
33
  // Send deep link to Adjust's servers for attribution.
34
  // If short branded link, receive long link.
35
  // Otherwise, receive original link.
36
  Adjust.processDeeplink(incomingLink) { resolvedLink in
37
    // TO DO: Handle resolvedLink by parsing its components
38
    // (example: path, query parameters) and
39
    // navigating to the appropriate screen.
40
  }
41
  return true
42
}

1
// Receive universal link when app is installed
2
// and link opens app from "not running"
3
// or background state.
4
- (BOOL)application:(UIApplication *)application
5
    continueUserActivity:(NSUserActivity *)userActivity
6
      restorationHandler:
7
          (void (^)(NSArray<id<uiuseractivityrestoring>> *_Nullable))
8
              restorationHandler {
9
  // Check if it's a web browsing activity
10
  if (![userActivity.activityType
11
          isEqualToString:NSUserActivityTypeBrowsingWeb])
12
    return YES;
13

14
  // Check if there's a valid URL
15
  NSURL *incomingLink = userActivity.webpageURL;
16
  if (!incomingLink) return YES;
17

18
  // Send deep link to Adjust's servers for attribution.
19
  // If short branded link, receive long link.
20
  // Otherwise, receive original link.
21
  [Adjust processDeeplink:incomingLink
22
        completionHandler:^(NSString *resolvedLink){
23
            // TO DO: Handle resolvedLink by parsing its components
24
            // (example: path, query parameters) and
25
            // navigating to the appropriate screen.
26
        }];
27

28
  return YES;
29
}
30

31
// Receive app scheme deep link when app is installed
32
// and link opens app from "not running",
33
// background, or foreground state.
34
- (BOOL)application:(UIApplication *)application
35
            openURL:(NSURL *)incomingLink
36
            options:
37
                (NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
38
  // Send deep link to Adjust's servers for attribution.
39
  // If short branded link, receive long link.
40
  // Otherwise, receive original link.
41
  [Adjust processDeeplink:incomingLink
42
        completionHandler:^(NSString *resolvedLink){
43
            // TO DO: Handle resolvedLink by parsing its components
44
            // (example: path, query parameters) and
45
            // navigating to the appropriate screen.
46
        }];
47
  return YES;
48
}

SceneDelegateライフサイクルを使用するUIKitアプリ

SceneDelegateを更新して、iOSダイレクトディープリンクメソッドを実装します。

Swift
Objective-C

1
// Receive universal link or app scheme deep link when app is installed
2
// and link opens app from "not running" state.
3
func scene(
4
  _ scene: UIScene,
5
  willConnectTo session: UISceneSession,
6
  options connectionOptions: UIScene.ConnectionOptions
7
) {
8
  // Receive incoming universal link
9
  if let userActivity = connectionOptions.userActivities.first,
10
    userActivity.activityType == NSUserActivityTypeBrowsingWeb,
11
    let incomingLink = userActivity.webpageURL
12
  {
13
    // Send deep link to Adjust's servers for attribution.
14
    // If short branded link, receive long link.
15
    // Otherwise, receive original link.
16
    Adjust.processDeeplink(incomingLink) { resolvedLink in
17
      // TO DO: Handle resolvedLink by parsing its components
18
      // (example: path, query parameters) and
19
      // navigating to the appropriate screen.
20
    }
21
    return
22
  }
23

24
  // Receive incoming app scheme deep link
25
  guard let incomingLink = connectionOptions.urlContexts.first?.url else { return }
26

27
  // Send deep link to Adjust's servers for attribution.
28
  // If short branded link, receive long link.
29
  // Otherwise, receive original link.
30
  Adjust.processDeeplink(incomingLink) { resolvedLink in
31
    // TO DO: Handle resolvedLink by parsing its components
32
    // (example: path, query parameters) and
33
    // navigating to the appropriate screen.
34
  }
35
}
36

37
// Receive universal link when app is installed
38
// and link opens app from background state.
39
func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
40
  guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
41
    let incomingLink = userActivity.webpageURL
42
  else { return }
43

44
  // Send deep link to Adjust's servers for attribution.
45
  // If short branded link, receive long link.
46
  // Otherwise, receive original link.
47
  Adjust.processDeeplink(incomingLink) { resolvedLink in
48
    // TO DO: Handle resolvedLink by parsing its components
49
    // (example: path, query parameters) and
50
    // navigating to the appropriate screen.
51
  }
52
}
53

54
// Receive app scheme deep link when app is installed
55
// and link opens app from background
56
// or foreground state.
57
func scene(
58
  _ scene: UIScene,
59
  openURLContexts URLContexts: Set<uiopenurlcontext>
60
) {
61
  guard let incomingLink = URLContexts.first?.url else { return }
62

63
  // Send deep link to Adjust's servers for attribution.
64
  // If short branded link, receive long link.
65
  // Otherwise, receive original link.
66
  Adjust.processDeeplink(incomingLink) { resolvedLink in
67
    // TO DO: Handle resolvedLink by parsing its components
68
    // (example: path, query parameters) and
69
    // navigating to the appropriate screen.
70
  }
71
}

1
// Receive universal link or app scheme deep link when app is installed
2
// and link opens app from "not running" state.
3
- (void)scene:(UIScene *)scene
4
    willConnectToSession:(UISceneSession *)session
5
                 options:(UISceneConnectionOptions *)connectionOptions {
6
  // Receive universal link
7
  if (connectionOptions.userActivities.count > 0) {
8
    NSUserActivity *userActivity =
9
        connectionOptions.userActivities.allObjects.firstObject;
10
    if ([userActivity.activityType
11
            isEqualToString:NSUserActivityTypeBrowsingWeb] &&
12
        userActivity.webpageURL) {
13
      NSURL *incomingLink = userActivity.webpageURL;
14
      // Send deep link to Adjust's servers for attribution.
15
      // If short branded link, receive long link.
16
      // Otherwise, receive original link.
17
      [Adjust processDeeplink:incomingLink
18
            completionHandler:^(NSString *resolvedLink){
19
                // TO DO: Handle resolvedLink by parsing its components
20
                // (example: path, query parameters) and
21
                // navigating to the appropriate screen.
22
            }];
23
      return;
24
    }
25
  }
26

27
  // Receive app scheme deep link
28
  if (connectionOptions.URLContexts.count == 0) return;
29

30
  UIOpenURLContext *urlContext =
31
      connectionOptions.URLContexts.allObjects.firstObject;
32
  NSURL *incomingLink = urlContext.URL;
33

34
  // Send deep link to Adjust's servers for attribution.
35
  // If short branded link, receive long link.
36
  // Otherwise, receive original link.
37
  [Adjust processDeeplink:incomingLink
38
        completionHandler:^(NSString *resolvedLink){
39
            // TO DO: Handle resolvedLink by parsing its components
40
            // (example: path, query parameters) and
41
            // navigating to the appropriate screen.
42
        }];
43
}
44

45
// Receive universal link when app is installed
46
// and link opens app from background state.
47
- (void)scene:(UIScene *)scene
48
    continueUserActivity:(NSUserActivity *)userActivity {
49
  // Check if it's a web browsing activity
50
  if (![userActivity.activityType
51
          isEqualToString:NSUserActivityTypeBrowsingWeb])
52
    return;
53

54
  // Check if there's a valid URL
55
  NSURL *incomingLink = userActivity.webpageURL;
56
  if (!incomingLink) return;
57

58
  // Send deep link to Adjust's servers for attribution.
59
  // If short branded link, receive long link.
60
  // Otherwise, receive original link.
61
  [Adjust processDeeplink:incomingLink
62
        completionHandler:^(NSString *resolvedLink){
63
            // TO DO: Handle resolvedLink by parsing its components
64
            // (example: path, query parameters) and
65
            // navigating to the appropriate screen.
66
        }];
67
}
68

69
// Receive app scheme deep link when app is installed
70
// and link opens app from background
71
// or foreground state.
72
- (void)scene:(UIScene *)scene
73
    openURLContexts:(NSSet<uiopenurlcontext *> *)URLContexts {
74
  // Check if we have any URL contexts
75
  UIOpenURLContext *urlContext = URLContexts.allObjects.firstObject;
76
  if (!urlContext) return;
77

78
  // Check if the URL is valid
79
  NSURL *incomingLink = urlContext.URL;
80
  if (!incomingLink) return;
81

82
  // Send deep link to Adjust's servers for attribution.
83
  // If short branded link, receive long link.
84
  // Otherwise, receive original link.
85
  [Adjust processDeeplink:incomingLink
86
        completionHandler:^(NSString *resolvedLink){
87
            // TO DO: Handle resolvedLink by parsing its components
88
            // (example: path, query parameters) and
89
            // navigating to the appropriate screen.
90
        }];
91
}

AppDelegateライフサイクルを使用するSwiftUIアプリ

まだ作成していない場合は、プロジェクトのメインディレクトリに AppDelegate.swift ファイルを作成し、以下の App.swift ファイルの例のように、アプリケーションのメインファイルで参照してください。これは、アプリのライフサイクルイベントとAdjust SDKの実装を処理するために必要です。また、アプリがインストールされている状態でユニバーサルリンクやアプリスキームディープリンクを受け取れるように、onOpenURL SwiftUIモディファイアも実装してください。

Swift

1
import Adjust
2
import SwiftUI
3

4
@main
5
struct MyApp: App {
6
  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
7

8
  var body: some Scene {
9
    WindowGroup {
10
      ContentView()
11
        // Receive universal link or app scheme deep link when app is installed
12
        // and link opens app from "not running",
13
        // background, or foreground state.
14
        .onOpenURL { incomingLink in
15
          // Send deep link to Adjust's servers for attribution.
16
          // If short branded link, receive long link.
17
          // Otherwise, receive original link.
18
          Adjust.processDeeplink(incomingLink) { resolvedLink in
19
            // TO DO: Handle resolvedLink by parsing its components
20
            // (example: path, query parameters) and
21
            // navigating to the appropriate screen.
22
          }
23
        }
24
    }
25
  }
26
}

ScreenDelegateライフサイクルを使用するSwiftUIアプリ

AppDelegateライフサイクルを使用するSwiftUIアプリの手順に従ってください。onOpenURL SwiftUIモデリングは、アプリがインストールされ、リンクがバックグラウンドまたはフォアグラウンドの状態からアプリを開くと、ユニバーサルリンクとアプリスキームのディープリンクを受信します。

さらに、SceneDelegateライフサイクルの手順に従って、UIKitアプリからscene(_:willConnectTo:options:)メソッドを実装してください。このメソッドは、アプリがインストールされ、アプリが「未起動」の状態でリンクが開かれると、ユニバーサルリンクとアプリスキームのディープリンクを受け取ります。