iOS Adobe Extension v3移行ガイド

Adobe Experience SDKのAdjust Extensionがv3にアップデートされ、Adjust iOS SDK v5のサポートが追加されました。Extensionをv2からv3に移行するには、このガイドの手順に従ってください。

Swift Package Managerを使用して、Adobe ExperienceのAdjust iOS Extension v3をインストールするには、次のURLを入力します。

1
https://github.com/adjust/ios_adobe_extension.git

CocoaPodsを使用している場合は、以下の行をPodfileに追加します。

pod 'AdjustAdobeExtension'

Adobe ExperienceのAdjust iOS Extensionを設定する方法については、連携ガイドを参照してください。

新規API

v3に追加

Extension v3では、以下のAPIが追加されました。

ショートブランドリンクの解析

Adobe Experience SDKのAdjust Extension v3では、ショートブランドリンクの解析に対するサポートが追加されます。ショートリンクを解析するには、以下の引数を使用して Adjust.processAndResolveDeeplink メソッドを呼び出します。

deeplink: NSURL: アプリを起動するディープリンク。
withCompletionHandler: ADJResolvedDeeplinkBlock: 解析されたショートリンクを引数として受け取る完了関数。

Swift
Objective-C

1
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
2
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
3
        if let incomingUrl = userActivity.webpageUrl {
4
        if let deeplink = ADJDeeplink(deeplink: incomingUrl) {
5
            Adjust.processAndResolveDeeplink(deeplink) { resolveDeeplink in
6
                print("[\(resolveDeeplink)]")
7
            }
8
        }
9
        }
10
    }
11
    return true
12
}

1
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<uiuseractivityrestoring>> * _Nullable))restorationHandler {
2
    if ([[userActivity activityType] isEqualToString:NSUserActivityTypeBrowsingWeb]) {
3
        ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:[userActivity webpageURL]];
4
        [Adjust processAndResolveDeeplink:deeplink
5
                withCompletionHandler:^(NSString * _Nullable resolvedLink) {
6
                    NSLog(@"[%@]", resolvedLink);
7
        }];
8
    }
9
    return YES;
10
}

グローバルコールバックパラメーター

Adobe Experience SDKのAdjust Extension v3では、iOS SDK v5によるグローバルコールバックパラメーターAPIのサポートが追加されます。セッションにグローバルコールバックを追加するには、次の引数を指定して Adjust.addGlobalCallbackParameter メソッドを呼び出します。

key: NSString: パラメーターのキー。
value: NSString: パラメーターの値。

Swift
Objective-C

1
Adjust.addGlobalCallbackParameter("value", forKey: "key")
2
Adjust.addGlobalCallbackParameter("855", forKey: "user_id")

1
[Adjust addGlobalCallbackParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalCallbackParameter:@"855" forKey:@"user_id"];

グローバルコールバックの設定方法をご確認ください。

グローバルパートナーパラメーター

Adobe Experience SDKのAdjust Extension v3では、iOS SDK v5によるグローバルパートナーパラメーターAPIのサポートが追加されます。グローバルパートナーパラメーターを追加するには、以下の引数を使用してAdjust.addGlobalPartnerParameterメソッドを呼び出します。

key: String: パラメーターのキー。
value: String: パラメーターの値。

Swift
Objective-C

1
Adjust.addGlobalPartnerParameter("value", forKey: "key")
2
Adjust.addGlobalPartnerParameter("855", forKey: "user_id")

1
[Adjust addGlobalPartnerParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalPartnerParameter:@"855" forKey:@"user_id"];

グローバルパートナーパラメーターの設定方法をご確認ください。

外部デバイスIDを設定する

Adobe Experience SDKのAdjust Extension v3では、外部デバイスID設定のサポートが追加されます。外部デバイスIDを設定するには、以下の引数で AdjustAdobeExtensionConfig の setExternalDeviceId メソッドを呼び出します。

externalDeviceId: NSString: 外部デバイスID。

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
   config.setExternalDeviceId("1a42b171-faa5-46da-b5ae-6f4be6d05167")
3
   AdjustAdobeExtension.setConfiguration(config)
4
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setExternalDeviceId:@"1a42b171-faa5-46da-b5ae-6f4be6d05167"];
3
[AdjustAdobeExtension setConfiguration:config];

外部デバイスIDの設定方法をご確認ください。

プリインストールアプリのデフォルトリンクトークンの設定

Adobe Experience SDKのAdjust Extension v3では、プレインストールされたアプリインストールをデフォルトキャンペーンに記録するため、デフォルトのリンクトークンを設定することができます。デフォルトのリンクトークンを設定するには、以下の引数を使用して AdjustAdobeExtensionConfig インスタンスの setDefaultTracker メソッドを呼び出します。

defaultTracker: NSString: プリインストールキャンペーン用の英数字のリンクトークン。

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
   config.setDefaultTracker("abc123")
3
   AdjustAdobeExtension.setConfiguration(config)
4
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDefaultTracker:@"abc123"];
3
[AdjustAdobeExtension setConfiguration:config];

プリインストールアプリのアクティビティを送信する方法をご確認ください。

変更されたAPI

v3で変更

Extension v3では、以下のAPIが変更されました。

ダイレクトディープリンク

SDK v2では、ディープリンクデータを引数としてAdjustAdobeExtension.applicationメソッドを呼び出すことで、アトリビューションのディープリンクを開くことができます。

Swift
Objective-C

1
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
2
    return AdjustAdobeExtension.application(app, open: url, options: options)
3
}

1
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
2
    return [AdjustAdobeExtension application:app openURL:url options:options];
3
}

SDK v3では、Adjust iOS SDKのprocessDeeplinkメソッドを使用するように更新されました。ダイレクトディープリンクを開くには、以下の手順に従ってください。

ディープリンクURLを使用して新しいADJDeeplinkインスタンスを作成します。
Adjust.processDeeplink メソッドにADJDeeplinkインスタンスを渡します。

Swift
Objective-C

1
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
2
   if let deeplink = ADJDeeplink(deeplink: url) {
3
      Adjust.processDeeplink(deeplink)
4
   }
5
   return true
6
}

1
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
2
   [Adjust processDeeplink: [[ADJDeeplink alloc] initWithDeeplink:url]];
3
   return YES;
4
}

ダイレクトディープリンクでユーザーをリアトリビュートする方法をご確認ください。

ディファードディープリンクのコールバック

SDK v2では、AdjustAdobeExtensionConfigインスタンスのsetDeeplinkResponseBlockメソッドに関数を渡すように設定することで、ディファードディープリンクが開いた時にコールバック関数を起動させることができます。

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
    config.setDeeplinkResponseBlock { deepLink in
3
        // Deep link response received
4
        // Apply your logic to determine whether the Adjust SDK should try to open the deep link
5
        return true;
6
        // or
7
        // return false;
8
    }
9
    AdjustAdobeExtension.setConfiguration(config)
10
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDeeplinkResponseBlock:^BOOL(NSURL * _Nullable deeplink) {
3
    // Deep link response received
4
    // Apply your logic to determine whether the Adjust SDK should try to open the deep link
5
    return YES;
6
    // or
7
    // return NO;
8
}];
9
[AdjustAdobeExtension setConfiguration:config];

SDK v3では、このメソッドの名前がsetDeeplinkResponseBlockからsetDeferredDeeplinkReceivedBlockに変更されました。

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
    config.setDeferredDeeplinkReceivedBlock { (deeplink: URL?) -> Bool in
3
        if let deeplinkString = deeplink?.absoluteString.lowercased(),
4
        deeplinkString.contains("no_open") {
5
            return false
6
        }
7
        return true
8
    }
9
    AdjustAdobeExtension.setConfiguration(config)
10
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDeferredDeeplinkReceivedBlock:^BOOL(NSURL * _Nullable deeplink) {
3
    if (deeplink && [[deeplink.absoluteString lowercaseString] containsString:@"no_open"]) {
4
        return NO;
5
    }
6
    return YES;
7
}];
8
[AdjustAdobeExtension setConfiguration:config];

ディファードディープリンクコールバックとの利用方法をご確認ください。