ディファードディープリンクの設定

遅延ディープリンクを使用すると、アプリをインストールしていないユーザーがAdjustのリンクをクリックしてアプリストアからアプリをインストールし、アプリを初回起動した際に目的のコンテンツに誘導することができます。

仕組み

以下は、ディファードディープリンクの基本的なフローです。

ユーザーがAdjustディープリンクをクリックします。
Adjustサーバーがユーザーをアプリストアにリダイレクトします。
ユーザーがアプリをインストールまたは再インストールして開きます。
Adjust SDKが、Adjustのサーバーに/attributionリクエストを送信します。
Adjustサーバーは、クリックをインストールまたは再インストールに一致させ、/attributionレスポンスでディファードディープリンクを返します。Adjust SDKは、ディファードディープリンクコールバックを介して、アプリにディファードディープリンクを提供します。
該当する場合、アプリにはオンボーディング画面やユーザーログインなどの初期画面が表示されます。
アプリがディープリンクを処理し、適切な画面に移動します。

ディファードディープリンクのフォーマット

ユーザーがAdjustのブランドリンク（brandname.go.link）をクリックし、そのリンクがディファードリンクである場合、Adjustのサーバーはそれをアプリスキーム形式（example://）に変換し、AdjustダッシュボードのiOSプラットフォーム設定で構成されたアプリスキームを使用して、SDKに渡す前に処理を行います。

設定

ディファードディープリンクのコールバックを設定する

AppDelegateでAdjustDelegateプロトコルに準拠します。アトリビューションコールバックを設定済みの場合は、この手順はスキップして構いません。

Swift
Objective-C

class AppDelegate: UIResponder, UIApplicationDelegate, AdjustDelegate {
}

@interface AppDelegate : UIResponder <UIApplicationDelegate, AdjustDelegate>

SDKを初期化する前に、Adjustの設定でAppDelegateをデリゲートとして指定します。

Swift
Objective-C

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox
3
let adjustConfig = ADJConfig(
4
    appToken: yourAppToken,
5
    environment: environment)
6
adjustConfig?.delegate = self
7

8
// ...
9

10
Adjust.appDidLaunch(adjustConfig)

1
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:@"{YourAppToken}"
2
                                            environment:ADJEnvironmentSandbox];
3
[adjustConfig setDelegate:self];
4

5
// ...
6

7
[Adjust appDidLaunch:adjustConfig];

adjustDeeplinkResponseコールバックメソッドをアプリデリゲートに追加します。Adjust SDKは、ディファードディープリンクを受け取った後にこのメソッドを呼び出します。

Swift
Objective-C

1
func adjustDeeplinkResponse(_ deeplink: URL?) -> Bool {
2
   // deep link format:
3
   //
4
   // example://summer-clothes?promo=beach&adj_t=def456
5
   //
6
   // TODO: Handle the deep link
7
   // (for example, store it or handle it immediately)
8

9
   return false // or true based on your use case (see below)
10
}

1
- (BOOL)adjustDeeplinkResponse:(NSURL *)deeplink {
2
      // deep link format:
3
      //
4
      // example://summer-clothes?promo=beach&adj_t=def456
5
      //
6
      // TODO: Handle the deep link
7
      // (for example, store it or handle it immediately)
8

9
      return NO; // or YES based on your use case (see below)
10
}

戻り値のオプション

adjustDeeplinkResponseの戻り値によって、コールバックコードが実行された後に何が起こるかが決定します。

`false`を返す（最も一般的）

アプリがいつ、どのようにディファードディープリンクを処理するかを完全に制御したい場合は、このアプローチを使用してください。falseを返すと、Adjust SDKはディファードディープリンクを開きません。例えば、アプリがディファードディープリンクを処理する前に初期画面（オンボーディングやログインなど）を表示してから移動する必要がある場合は、このアプローチが適切です。

戻り値 `true`

コールバックコードが実行された直後にAdjust SDKがディファードディープリンクを開くようにしたい場合は、このアプローチを使用してください。例えば、アプリに初期画面がない場合は、このアプローチが適切です。

Adjust SDKがディファードディープリンクを受け取ると、コールバックコードが実行され、Adjust SDKはapplication(_:open:options:)をディファードディープリンクで呼び出します。iOSはアプリ設定に基づいて適切なハンドラーにルーティングします

アプリの実装	ハンドラー
AppDelegateを使用したUIKit	application(_:open:options:)
sceneDelegateを使用したUIKit	scene(_:openURLContexts:)
SwiftUI	.onOpenURL modifier

上記の適切なハンドラーからディープリンクを処理するには、ダイレクトディープリンクをすでに実装していることを確認してください。

完全なコード例

この例では、オンボーディングプロセスを備えたアプリが、ディファードディープリンクをどのように処理するかを示します。アプリの内部フローの概要は以下のとおりです。

ユーザーがアプリを起動すると、ディファードディープリンクが適用されます。
アプリがオンボーディングを開始します。
アプリのコールバックがAdjust SDKからディファードディープリンクを受け取り、オンボーディングが完了したかどうかを確認します。
- オンボーディングが完了すると、ディープリンクはすぐに処理されます。
- オンボーディングが完了していない場合は、ディープリンクが保存されます。
オンボーディングが終了すると、アプリは保存されたディファードディープリンクを確認し、処理します。
アプリがユーザーをディープリンク画面に誘導します。

AppDelegate

AppDelegateへのディープリンクの更新は、ハイライト表示されたコードにあります。この例は、UIKitとSwiftUIの両方の例に該当します。

Swift
Objective-C

1
import AdjustSdk
2
import UIKit
3

4
@UIApplicationMain
5
class AppDelegate: UIResponder, UIApplicationDelegate, AdjustDelegate {
6
  func application(
7
    _ application: UIApplication,
8
    didFinishLaunchingWithOptions launchOptions:
9
      [UIApplication.LaunchOptionsKey: Any]?
10
  ) -> Bool {
11
    // Configure Adjust SDK
12
    // Replace {YourAppToken} with your Adjust app token
13
    let appToken = "{YourAppToken}"
14
    var adjustConfig: ADJConfig?
15

16
    // Enable verbose logging for deep link testing
17
    #if DEBUG
18
      let environment = ADJEnvironmentSandbox
19
      adjustConfig = ADJConfig(appToken: appToken, environment: environment)
20
      adjustConfig?.logLevel = ADJLogLevel.verbose
21
    #else
22
      let environment = ADJEnvironmentProduction
23
      adjustConfig = ADJConfig(
24
        appToken: appToken, environment: environment, suppressLogLevel: true)
25
      adjustConfig?.logLevel = ADJLogLevel.suppress
26
    #endif
27

28
    // Create delegate for deferred deep linking
29
    adjustConfig?.delegate = self
30

31
    // Initialize Adjust SDK
32
    Adjust.appDidLaunch(adjustConfig)
33

34
    return true
35
  }
36

37
  // Receive deferred deep link via AdjustDelegate method
38
  func adjustDeeplinkResponse(_ deeplink: URL?) -> Bool {
39
    // Handle failure if deeplink is nil
40
    guard let deeplink = deeplink else { return false }
41

42
    if UserDefaults.standard.bool(forKey: "hasCompletedOnboarding") {
43
      // If onboarding is complete, handle deferred deep link immediately
44

45
      // deep link format:
46
      //
47
      // example://summer-clothes?promo=beach&adj_t=def456
48
      //
49
      // TODO: Handle the deep link and navigate to the appropriate screen.
50
    } else {
51
      // Store deferred deep link to invoke after onboarding screens and login
52
      UserDefaults.standard.set(
53
        deeplink.absoluteString, forKey: "deferredLink")
54
    }
55

56
    // The app controls when and how it handles the deferred deep link, so return false.
57
    return false
58
  }
59
}

1
#import <AdjustSdk/AdjustSdk.h>
2
#import "AppDelegate.h"
3

4
@implementation AppDelegate
5

6
- (BOOL)application:(UIApplication *)application
7
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
8
  // Configure Adjust SDK
9
  // Replace {YourAppToken} with your Adjust app token
10
  NSString *appToken = @"{YourAppToken}";
11
  ADJConfig *adjustConfig;
12

13
// Enable verbose logging for deep linking testing
14
#ifdef DEBUG
15
  adjustConfig = [ADJConfig configWithAppToken:appToken
16
                                   environment:ADJEnvironmentSandbox];
17
  [adjustConfig setLogLevel:ADJLogLevelVerbose];
18
#else
19
  adjustConfig = [ADJConfig configWithAppToken:appToken
20
                                   environment:ADJEnvironmentProduction
21
                         allowSuppressLogLevel:YES];
22
  [adjustConfig setLogLevel:ADJLogLevelSuppress];
23
#endif
24

25
  // Create delegate for deferred deep linking
26
  adjustConfig.delegate = self;
27

28
  // Initialize Adjust SDK
29
  [Adjust appDidLaunch:adjustConfig];
30

31
  return YES;
32
}
33

34
// Receive deferred deep link via AdjustDelegate method
35
- (BOOL)adjustDeeplinkResponse:(nullable NSURL *)deeplink {
36
  // Handle failure if deeplink is nil
37
  if (!deeplink) return NO;
38

39
  if ([[NSUserDefaults standardUserDefaults]
40
          boolForKey:@"hasCompletedOnboarding"]) {
41
    // If onboarding is complete, handle deferred deep link immediately
42

43
    // deep link format:
44
    //
45
    // example://summer-clothes?promo=beach&adj_t=def456
46
    //
47
    // TODO: Handle the deep link and navigate to the appropriate screen.
48
  } else {
49
    // Store deferred deep link to invoke after onboarding screens and login
50
    [[NSUserDefaults standardUserDefaults] setObject:deeplink.absoluteString
51
                                              forKey:@"deferredLink"];
52
  }
53

54
  // The app controls when and how it handles the deferred deep link, so return NO.
55
  return NO;
56
}
57

58
@end
59

60
// AppDelegate.h
61

62
@interface AppDelegate : UIResponder <UIApplicationDelegate, AdjustDelegate>
63
@end

1
import AdjustSdk
2
import UIKit
3

4
class ViewController: UIViewController {
5
  var hasCompletedOnboarding: Bool {
6
    get {
7
      UserDefaults.standard.bool(forKey: "hasCompletedOnboarding")
8
    }
9
    set {
10
      UserDefaults.standard.set(newValue, forKey: "hasCompletedOnboarding")
11
    }
12
  }
13

14
  override func viewDidAppear(_ animated: Bool) {
15
    super.viewDidAppear(animated)
16

17
    // Check if onboarding has been completed
18
    if hasCompletedOnboarding {
19
      // Show main content
20
      return
21
    }
22

23
    // Show onboarding screens and login prompt
24

25
    // After onboarding, set hasCompletedOnboarding to true
26
    hasCompletedOnboarding = true
27

28
    // Show main content
29

30
    // Check for deferredLink received before or during onboarding
31
    if let deferredLink = UserDefaults.standard.string(forKey: "deferredLink") {
32
      // Remove stored deferred deep link to avoid handling again later
33
      UserDefaults.standard.removeObject(forKey: "deferredLink")
34

35
      // deep link format:
36
      //
37
      // example://summer-clothes?promo=beach&adj_t=def456
38
      //
39
      // TODO: Handle the deep link and navigate to the appropriate screen.
40
    }
41
  }
42
}

1
#import <AdjustSdk/AdjustSdk.h>
2
#import "ViewController.h"
3

4
@implementation ViewController
5

6
- (BOOL)hasCompletedOnboarding {
7
  return [[NSUserDefaults standardUserDefaults]
8
      boolForKey:@"hasCompletedOnboarding"];
9
}
10

11
- (void)setHasCompletedOnboarding:(BOOL)hasCompletedOnboarding {
12
  [[NSUserDefaults standardUserDefaults] setBool:hasCompletedOnboarding
13
                                          forKey:@"hasCompletedOnboarding"];
14
}
15

16
- (void)viewDidAppear:(BOOL)animated {
17
  [super viewDidAppear:animated];
18

19
  // Check if onboarding has been completed
20
  if (self.hasCompletedOnboarding) {
21
    // Show main content
22
    return;
23
  }
24

25
  // Show onboarding screens and login prompt
26

27
  // After onboarding, set hasCompletedOnboarding to YES
28
  self.hasCompletedOnboarding = YES;
29

30
  // Show main content
31

32
  // Check for deferred deep link received before or during onboarding
33
  NSString *deferredLink =
34
      [[NSUserDefaults standardUserDefaults] stringForKey:@"deferredLink"];
35
  if (deferredLink) {
36
    // Remove stored deferred deep link to avoid handling again later
37
    [[NSUserDefaults standardUserDefaults] removeObjectForKey:@"deferredLink"];
38

39
    // deep link format:
40
    //
41
    // example://summer-clothes?promo=beach&adj_t=def456
42
    //
43
    // TODO: Handle the deep link and navigate to the appropriate screen.
44
  }
45
}
46

47
@end

SwiftUI

Swift

1
import AdjustSdk
2
import SwiftUI
3

4
struct ContentView: View {
5
  var body: some View {
6
    NavigationStack {
7
      VStack {
8
        // Check if onboarding has been completed
9
        if !UserDefaults.standard.bool(forKey: "hasCompletedOnboarding") {
10
          // Show onboarding screens and login prompt
11

12
          // After onboarding, set hasCompletedOnboarding to true
13
          UserDefaults.standard.set(true, forKey: "hasCompletedOnboarding")
14

15
          // Show main content
16

17
          // Check for deep link received before or during onboarding
18
          if let deferredLink = UserDefaults.standard.string(
19
            forKey: "deferredLink")
20
          {
21
            // Remove stored deferred deep link to avoid handling again later
22
            UserDefaults.standard.removeObject(forKey: "deferredLink")
23

24
            // deep link format:
25
            //
26
            // example://summer-clothes?promo=beach&adj_t=def456
27
            //
28
            // TODO: Handle the deep link and navigate to the appropriate screen.
29
          }
30
        } else {
31
          // Show main content
32
        }
33
      }
34
    }
35
  }
36
}