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

ディープリンクは、Adjust管理画面で設定した後にアプリで設定できます。 ダイレクトディープリンク は、ユーザーがアプリをデバイスにインストールしている場合に使用されます。このリンクは、ユーザーをアプリ内の特定のページに誘導します。

ディープリンクを有効化するには、以下を行う必要があります。

AdjustのAppViewで、iOSおよびAndroidアプリに同じブランドドメインを設定すること。
関連ドメイン（Associated Domain）をアプリに対して有効にすること。
Xcodeでディープリンクを設定すること。

Associated Domainsを有効化する

最初に、Apple Developer AccountでAssociated Domainsを有効にする必要があります。これにより、アプリでユニバーサルリンクドメインを設定できるようになります。これを行うには、以下の手順に従ってください。

Apple Developer Accountにログインします。
左側のメニューで 証明書、ID、プロフィール（Certificates, IDs & Profiles） を選択します。
左側のメニューで ID（Identifiers） を選択します。
アプリを探して選択し、編集ページを開きます。
機能（Capabilities） で、 Associated Domains にチェックマークが付いていることを確認します。
保存（Save） を選択して変更内容を保存します。

Xcodeでディープリンクを設定する

次の手順に従って、ディープリンク設定をXcodeプロジェクトに追加します。

Adjustユニバーサルリンクとブランドドメイン

Xcodeでアプリプロジェクトを開きます。
左側のメニューからプロジェクトを選択します。
ターゲット（Targets） でアプリを選択します。
上部のメニューから 署名と機能（Signing & Capabilities） を選択します。
下のサブメニューで 全て（All） が選択されていることを確認します。
追加（Add）オプション（ + ）を選択して、機能を追加します。
Associated Domains を選択します。
プレフィックスapplinksを含むAdjustユニバーサルリンクドメインを入力します： applinks:
- example.adj.stを使用する場合、applinks:example.adj.stのようになります。
Adjustでアプリのブランドドメインを設定する際に設定したブランドリンクドメインを入力します。
- brandedDomain.go.linkを使用する場合、brandedDomain.go.linkのようになります。

すでにxxx.adj.stをユニバーサルリンクのドメインとして使用している場合は、それを削除しないでください。xxx.adj.stとbrandedDomain.go.linkの両方を関連ドメインとして保持してください。

カスタムURLスキーム

Xcodeでアプリプロジェクトを開きます。
左側のメニューからプロジェクトを選択します。
ターゲット（Targets） でアプリを選択します。
上部のメニューから 情報（Info） を選択します。
URLタイプ（URL Types） セクションを展開します。
追加（Add）オプション（ + ）を選択してURLタイプを追加します。
次の情報を入力してURLスキームを作成します。
- 識別子 ： $(PRODUCT_BUNDLE_IDENTIFIER)
- URLスキーム（URL Schemes） ：カスタムURLスキーム。これは一意のものである必要があります。http、https、mailtoなどの保護されたスキームは使用しないでください。
- 権限（Role） ：編集者（Editor）

このスキームは、本番用ビルド および デバッグビルドで機能します。

iOSアプリに変更を加える

さまざまなディープリンクシナリオを設定するために、iOSアプリを更新する必要があります。アプリの更新方法は、アプリでシーンを使用するかどうかによって異なります。

アプリでシーンを使用しない

アプリでシーンを使用しない場合、アプリデリゲートのメソッドを更新する必要があります。

ユニバーサルリンク

Adjust SDKの次のメソッドを呼び出すために、アプリデリゲートのapplication(_:continue:restorationHandler:)メソッドを更新します：

ADJLinkResolution.resolveLink: このメソッドは、マーケティングチームでAdjustのリンク解析ソリューションの使用が必須である場合にのみ呼び出します。resolveUrlSuffixArray内の要素と一致するドメインをディープリンクで使用する場合、メソッドはディープリンクの解析を試み、解析されたリンクを返します。ディープリンクがこの配列内の要素と一致しない場合、メソッドは元のディープリンクをパススルーするため、全てのディープリンクをこのメソッドにパスすることができます。
Adjust.processDeeplink このメソッドを呼び出し、Adjustサーバーにディープリンクを送信して情報を記録します。AdjustのディープリンクとAdjust以外のディープリンクの両方をこのメソッドにパスすることができます。Adjustサーバーは、Adjustパラメーターを持たないディープリンクを計測しません。

ユーザーがユニバーサルリンクをクリックすると、iOSでアプリが開き、ディープリンクがapplication(_:continue:restorationHandler:)に配信されます。これは、ユーザーがアプリを閉じていても、バックグラウンドで実行していても発生します。

Swift
Objective-C

1
func application(
2
    _ application: UIApplication,
3
    continue userActivity: NSUserActivity,
4
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void)
5
    -> Bool {
6

7
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
8
        if let incomingURL = userActivity.webpageURL {
9
            // call the below method to resolve deep link
10
            ADJLinkResolution.resolveLink(
11
                with: incomingURL,
12
                resolveUrlSuffixArray: ["email.example.com", "short.example.com"],
13
                callback: { resolvedURL in
14
                    // add your code below to handle deep link
15
                    // (for example, open deep link content)
16
                    // resolvedURL object contains the deep link
17
                    if let resolvedDeeplink = resolvedURL {
18
                        // call the below method to send deep link to Adjust's servers
19
                        if let deeplink = ADJDeeplink(deeplink: resolvedDeeplink) {
20
                            Adjust.processDeeplink(deeplink)
21
                        }
22
                    }
23
                })
24
        }
25
      } else {
26
          return false
27
      }
28

29
      return true
30
}

1
- (BOOL)application:(UIApplication *)application
2
    continueUserActivity:(NSUserActivity *)userActivity
3
    restorationHandler:
4
    (void (^)(NSArray *restorableObjects))restorationHandler {
5

6
    if ([[userActivity activityType]
7
        isEqualToString:NSUserActivityTypeBrowsingWeb]) {
8
        NSURL *incomingURL = [userActivity webpageURL];
9

10
        // call the below method to resolve deep link
11
        [ADJLinkResolution
12
        resolveLinkWithUrl:incomingURL
13
        resolveUrlSuffixArray:@[
14
        @"email.example.com", @"short.example.com"
15
        ]
16
        callback:^(NSURL* _Nullable resolvedURL) {
17
            // add your code below to handle deep link
18
            // (for example, open deep link content)
19
            // resolvedURL object contains the deep link
20

21

22
            // call the below method to send deep link to Adjust's servers
23
            ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:resolvedURL];
24
            [Adjust processDeeplink:deeplink];
25
        }];
26
    } else {
27
        return NO;
28
    }
29

30
    return YES;
31
}

カスタムURLスキーム

カスタムURLスキームのディープリンクを設定することをマーケティングチームから求められた場合、アプリデリゲートのapplication(_:open:options:)メソッドを更新して、Adjust SDKのAdjust.processDeeplinkメソッドを呼び出します。このメソッドは、ディープリンクをAdjustサーバーに送信し、記録します。AdjustのディープリンクとAdjust以外のディープリンクの両方をこのメソッドにパスすることができます。Adjustサーバーは、Adjustパラメーターを持たないディープリンクを計測しません。

ユーザーがカスタムURLスキームのディープリンクをクリックすると、iOSでアプリが開き、ディープリンクがapplication(_:open:options:)に配信されます。これは、ユーザーがアプリを閉じていても、バックグラウンドで実行していても発生します。

Swift
Objective-C

1
func application(
2
    _ app: UIApplication,
3
    open incomingURL: URL,
4
    options: [UIApplication.OpenURLOptionsKey: Any] = [:]
5
    ) -> Bool {
6

7
    // add your code below to handle deep link
8
    // (for example, open deep link content)
9
    // incomingURL object contains the deep link
10

11

12
    // call the below method to send deep link to Adjust's servers
13
    if let deeplink = ADJDeeplink(deeplink: incomingURL) {
14
        Adjust.processDeeplink(deeplink)
15
    }
16
    return true
17
}

1
- (BOOL)application:(UIApplication *)app
2
    openURL:(NSURL *)incomingURL
3
    options:(NSDictionary *)options {
4

5
    // add your code below to handle deep link
6
    // (for example, open deep link content)
7
    // incomingURL object contains the deep link
8

9

10
    // call the below method to send deep link to Adjust's servers
11
    [Adjust processDeeplink:[[ADJDeeplink alloc] initWithDeeplink:incomingURL]];
12

13
    return YES;
14
}

アプリでシーンを使用

アプリでシーンを使用する場合、シーンデリゲートのメソッドを更新する必要があります。

ユニバーサルリンク

シーンデリゲートのscene(_:willConnectTo:options:)メソッドを更新します。アプリを閉じている状態でユーザーがユニバーサルリンクをクリックすると、iOSでアプリが開き、このメソッドへのディープリンクが配信されます。
シーンデリゲートのscene(_:continue:)メソッドを更新します。バックグラウンドでアプリを実行している状態でユーザーがユニバーサルリンクをクリックすると、iOSでアプリが開き、このメソッドへのディープリンクが配信されます。

上記のメソッドにより、Adjust SDKの次のメソッドが呼び出されます。

ADJLinkResolution.resolveLink: このメソッドは、マーケティングチームでAdjustのリンク解析ソリューションの使用が必須である場合にのみ呼び出します。resolveUrlSuffixArray内の要素と一致するドメインをディープリンクで使用する場合、メソッドはディープリンクの解析を試み、解析されたリンクを返します。ディープリンクがこの配列内の要素と一致しない場合、メソッドは元のディープリンクをパススルーするため、全てのディープリンクをこのメソッドにパスすることができます。
Adjust.processDeeplink - このメソッドを呼び出し、Adjustサーバーにディープリンクを送信してそれらを記録します。AdjustのディープリンクとAdjust以外のディープリンクの両方をこのメソッドにパスすることができます。Adjustサーバーは、Adjustパラメーターを持たないディープリンクを計測しません。

Swift
Objective-C

1
func scene(
2
    _ scene: UIScene,
3
    willConnectTo session: UISceneSession,
4
    options connectionOptions: UIScene.ConnectionOptions
5
    ) {
6

7
    guard let userActivity = connectionOptions.userActivities.first,
8
      userActivity.activityType == NSUserActivityTypeBrowsingWeb,
9
      let incomingURL = userActivity.webpageURL
10
    else { return }
11

12
    // call the below method to resolve deep link
13
    ADJLinkResolution.resolveLink(
14
      withUrl: incomingURL,
15
      resolveUrlSuffixArray: ["email.example.com", "short.example.com"],
16
      callback: { resolvedURL in
17
        // add your code below to handle deep link
18
        // (for example, open deep link content)
19
        // resolvedURL object contains the deep link
20

21

22
        // call the below method to send deep link to Adjust's servers
23
        if let deeplink = ADJDeeplink(deeplink: resolvedURL) {
24
            Adjust.processDeeplink(deeplink)
25
        }
26
      })
27
}
28

29
func scene(
30
    _ scene: UIScene,
31
    continue userActivity: NSUserActivity) {
32

33
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
34
        let incomingURL = userActivity.webpageURL
35

36
        // call the below method to resolve deep link
37
        ADJLinkResolution.resolveLink(
38
        withUrl: incomingURL,
39
        resolveUrlSuffixArray: ["email.example.com", "short.example.com"],
40
        callback: { resolvedURL in
41
            // add your code below to handle deep link
42
            // (for example, open deep link content)
43
            // resolvedURL object contains the deep link
44

45

46
            // call the below method to send deep link to Adjust's servers
47
            if let deeplink = ADJDeeplink(deeplink: resolvedURL) {
48
                Adjust.processDeeplink(deeplink)
49
            }
50
        })
51
    }
52
}

1
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session
2
    options:(UISceneConnectionOptions *)connectionOptions {
3

4
    NSUserActivity* userActivity =
5
    [[[connectionOptions userActivities] allObjects] firstObject];
6

7
    if ([[userActivity activityType]
8
        isEqualToString:NSUserActivityTypeBrowsingWeb]) {
9
        NSURL *incomingURL = [userActivity webpageURL];
10

11
        // call the below method to resolve deep link
12
        [ADJLinkResolution
13
        resolveLinkWithUrl:incomingURL
14
        resolveUrlSuffixArray:@[
15
        @"email.example.com", @"short.example.com"
16
        ]
17
        callback:^(NSURL* _Nullable resolvedURL) {
18
            // add your code below to handle deep link
19
            // (for example, open deep link content)
20
            // resolvedURL object contains the deep link
21

22

23
            // call the below method to send deep link to Adjust's servers
24
            ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:resolvedURL];
25
            [Adjust processDeeplink:deeplink];
26
        }];
27
    }
28
}
29

30
- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity{
31
    if ([[userActivity activityType]
32
        isEqualToString:NSUserActivityTypeBrowsingWeb]) {
33
        NSURL *incomingURL = [userActivity webpageURL];
34

35
        // call the below method to resolve deep link
36
        [ADJLinkResolution
37
        resolveLinkWithUrl:incomingURL
38
        resolveUrlSuffixArray:@[
39
        @"email.example.com", @"short.example.com"
40
        ]
41
        callback:^(NSURL* _Nullable resolvedURL) {
42
            // add your code below to handle deep link
43
            // (for example, open deep link content)
44
            // resolvedURL object contains the deep link
45

46

47
            // call the below method to send deep link to Adjust's servers
48
            ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:resolvedURL];
49
            [Adjust processDeeplink:deeplink];
50
        }];
51
    }
52
}

カスタムURLスキーム

シーンデリゲートのscene(_:willConnectTo:options:)メソッドを更新します。アプリを閉じている状態でユーザーがカスタムURLスキームのディープリンクをクリックすると、iOSでアプリが開き、このメソッドへのディープリンクが配信されます。
シーンデリゲートのscene(_:openURLContexts:)メソッドを更新します。バックグラウンドでアプリを実行している状態でユーザーがカスタムURLスキームのディープリンクをクリックすると、iOSでアプリが開き、このメソッドへのディープリンクが配信されます。

これらのメソッドは、Adjust SDKでAdjust.processDeeplinkメソッドを呼び出します。このメソッドは、ディープリンクをAdjustサーバーに送信し、記録します。AdjustのディープリンクとAdjust以外のディープリンクの両方をこのメソッドにパスすることができます。Adjustサーバーは、Adjustパラメーターを持たないディープリンクを計測しません。

Swift
Objective-C

1
func scene(
2
    _ scene: UIScene,
3
    openURLContexts URLContexts: Set<uiopenurlcontext>
4
    ) {
5

6
    guard let incomingURL = URLContexts.first?.url else {
7
        return
8
    }
9

10
    // add your code below to handle deep link
11
    // (for example, open deep link content)
12
    // incomingURL object contains the deep link
13

14

15
    // call the below method to send deep link to Adjust's servers
16
    if let deeplink = ADJDeeplink(deeplink: incomingURL) {
17
        Adjust.processDeeplink(deeplink)
18
    }
19
}

1
- (void)scene:(UIScene *)scene
2
    openURLContexts:(nonnull NSSet<uiopenurlcontext *> *)URLContexts {
3

4
    NSURL *incomingURL = [[URLContexts allObjects] firstObject].URL;
5

6
    if (incomingURL) {
7
        // add your code below to handle deep link
8
        // (for example, open deep link content)
9
        // incomingURL object contains the deep link
10

11

12
        // call the below method to send deep link to Adjust's servers
13
        ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:incomingURL];
14
        [Adjust processDeeplink:deeplink];
15
    }
16
}

最後に渡されたディープリンクを取得する

+ (void)lastDeeplinkWithCompletionHandler:(nonnull ADJLastDeeplinkGetterBlock)completion;

Adjust.lastDeeplinkWithCompletionHandler: メソッドを呼び出すことで、Adjust.processDeeplinkまたは Adjust.processAndResolveDeeplink メソッドに渡された最後のディープリンクのURLを取得できます。このメソッドは、最後に受け取ったディープリンクを NSURLとして返します。

Swift
Objective-C

1
Adjust.lastDeeplink { lastDeeplink in
2
    if let deeplink = lastDeeplink {
3
        // Handle the deeplink here
4
        print("Last deep link: \(deeplink.absoluteString)")
5
    }
6
}

1
[Adjust lastDeeplinkWithCompletionHandler:^(NSURL * _Nullable lastDeeplink) {
2
    if (lastDeeplink != nil) {
3
        // Handle the deeplink here
4
        NSLog(@"Last deep link: %@", [lastDeeplink absoluteString]);
5
    }
6
}];

リファラーを使用したディープリンクを処理する

オプションのリファラーURLは、ディープリンクやアプリのソースを計測して、より正確なアトリビューションやリアトリビューション、ディープリンクを実現するために使用されます。例えば、SEOやオーガニック検索、Adjustリンクなどのチャネルには直接使用されません。クライアントのルートドメインでユニバーサルリンクが実装されており、それによってアプリが起動する場合、そのチャネルでは、ユーザーのアトリビューションまたはリアトリビューションを行うために、リファラーURLから得られるシグナルに依存する場合があります。

1
func application(_ application: UIApplication,
2
                continue userActivity: NSUserActivity,
3
                restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
4

5
    guard userActivity.activityType == NSUserActivityTypeBrowsingWeb,
6
        let url = userActivity.webpageURL else { return false }
7

8
    if let deeplink = ADJDeeplink(deeplink: url) {
9
        // If referrer URL is available, add it to the deeplink object
10
        if let referrer = URL(string: "https://example.com") {
11
            deeplink.setReferrer(referrer)
12
        }
13
        // Send deeplink and referrer to Adjust's servers
14
        Adjust.processDeeplink(deeplink)
15
        return true
16
    }
17
    return false
18
}

1
- (BOOL)application:(UIApplication *)application
2
            continueUserActivity:(NSUserActivity *)userActivity
3
    restorationHandler:(void (^)(NSArray<id<uiuseractivityrestoring>> *restorableObjects))restorationHandler {
4

5
    if ([userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) {
6
        NSURL *url = userActivity.webpageURL;
7
        if (url) {
8
            ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:url];
9
            if (deeplink) {
10
                NSURL *referrer = [NSURL URLWithString:@"https://example.com"];
11
                // If referrer URL is available, add it to the deeplink object
12
                if (referrer) {
13
                    [deeplink setReferrer:referrer];
14
                }
15
                // Send deeplink and referrer to Adjust's servers
16
                [Adjust processDeeplink:deeplink];
17
            }
18
            return YES;
19
        }
20
    }
21
    return NO;
22
}