iOS SDK連携ガイド

Adjust iOS SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをWebアプリで記録できます。このガイドでは、Adjust SDKをアプリに実装する方法を紹介します。

1. プロジェクトにSDKを追加する

iOSアプリでAdjust SDKを使うには、Xcodeプロジェクトに追加する必要があります。

Swift Package Managerを使ってSDKを追加するには、以下の手順に従ってください。

File --> Swift Packages --> Add Package Dependency を選択します。
表示されたボックスに、SDKのGitHubのアドレスを入力します。 https://github.com/adjust/ios_sdk
Version ドロップダウンで、使用したいAdjust SDKのバージョンを選択します。最新のパージョンはリリースページからご確認ください。

Cocoapodsを使ってSDKを追加するには、Podfileで使用したいバージョンを指定します。

1
# Get pod from repository
2
pod 'Adjust', '~> 5.1.0'

アプリでWeb viewを使用している場合は、以下のようにAdjust Web Bridgeを追加します。

1
pod 'Adjust/AdjustWebBridge', '~> 5.1.0'

Carthageを使ってSDKを追加するには、以下をCartfileに追加します。

1
github "adjust/ios_sdk"

2. Adjust SDKを実装する

Adjust SDKをXcodeプロジェクトに追加したら、それをアプリで実装する必要があります。

プロジェクトファイルに関連するimport statement（インポートステートメント）を追加します。

Swift
Objective-C

Adjust SDKをインポートするには、以下をbridging headerファイルに追加します。

1
import AdjustSdk

Adjust SDKをインポートするには、以下をAppDelegate.hファイルに追加します。

1
#import <AdjustSdk/AdjustSdk.h>

3. iOS frameworksを追加する

Adjust SDKは、特定のデバイス情報にアクセスするためにフレームワークに依存しています。この情報を読み取れるようにするには、フレームワークを追加してそれらを オプション として表示します。

Framework	説明	注意
`AdSupport.framework`	デバイスのIDFAにアクセスできるようにします。また、iOS 14以前のデバイスでLAT情報にアクセスできるようになります。	アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。
`AdServices.framework`	ASAアトリビューションを処理します。
`StoreKit.framework`	SKAdNetworkフレームワークにアクセスできるようにします。	iOS14以降のデバイスでAdjust SDKがSKAdNetworkとの通信を処理するために必要です。
`AppTrackingTransparency.framework`	Adjust SDKがユーザーのATT同意ダイアログをラップし、iOS 14以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。	アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。
`WebKit.framework`	アプリでWeb viewを使用できるようにします。	アプリがWeb viewを使用している場合にのみ必要です。

4. SDKシグネチャーを設定する

Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、AdjustヘルプセンターのSDKシグネチャーガイドの手順に従ってください。

5.（オプション）Adjust Web Bridgeを設定する

アプリがWeb viewを使用している場合、Adjust Web Bridgeを設定してWeb view内のアクティビティを記録する必要があります。

`AdjustBridge`をアプリに実装する

プロジェクトナビゲータにて：

View Controllerのソースファイルを開きます。
ファイルの最上部にimportステートメントを追加します。
Web View DelegateのviewDidLoadまたはviewWillAppearメソッドのAdjustBridgeに以下のコールを追加します。

Swift
Objective-C

1
import AdjustSdk
2

3
func viewWillAppear(_ animated: Bool) {
4
    let webView = WKWebView(frame: view.bounds)
5

6
    // add var adjustBridge: AdjustBridge? on your interface
7
    adjustBridge.loadWKWebViewBridge(webView)
8
}

1
#import <AdjustSdk/AdjustSdk.h>
2

3
- (void)viewWillAppear:(BOOL)animated {
4
    WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds];
5

6
    // add @property (nonatomic, strong) AdjustBridge *adjustBridge; on your interface
7
    [self.adjustBridge loadWKWebViewBridge:webView];
8
}
9

10
// Your code here

`AdjustBridge`をWeb viewに実装する

Web viewでJavascriptを使用するには、bridgeを設定する必要があります。Adjust iOSのWeb bridgeを初期化するには、以下のJavascriptコードを追加してください。

Javascript

1
var yourAppToken = yourAppToken;
2
var environment = AdjustConfig.EnvironmentSandbox;
3
var adjustConfig = new AdjustConfig(yourAppToken, environment);
4
Adjust.initSdk(adjustConfig);

6. Adjust SDKを初期化する

Adjust SDKを初期化するには、configオブジェクトを作成する必要があります。このオブジェクトには、Adjust SDKの動作をコントロールする設定オプションが含まれています。最小限の設定を行うために、以下の引数をパスします。

appToken: アプリトークン。
environment: SDKを実行したい環境。ADJEnvironmentSandboxに設定します。

ConfigオブジェクトでAdjust SDKを初期化：

アプリデリゲートのdidFinishLaunchingまたはdidFinishLaunchingWithOptionsメソッド内のconfigオブジェクトを宣言します。
ConfigオブジェクトのlogLevelプロパティをADJLogLevelVerbose（verbose）に設定します。デバイス情報を取得するには、verboseロギングを有効化する必要があります。
Configオブジェクトを引数としてinitSdkメソッドにパスします。

1
import AdjustSdk
2

3
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
4
        // Override point for customization after application launch.
5
        let yourAppToken = "{YourAppToken}"
6
        let environment = ADJEnvironmentSandbox
7
        let adjustConfig = ADJConfig(appToken: yourAppToken,
8
                                     environment: environment)
9

10
        Adjust.initSdk(adjustConfig)
11
       //...
12
        return true
13
 }

1
#import <AdjustSdk/AdjustSdk.h>
2

3
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
4
   NSString *yourAppToken = @"{YourAppToken}";
5
   NSString *environment = ADJEnvironmentSandbox;
6
   ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
7
                                                environment:environment];
8
   // Your code here
9
   [Adjust initSdk:myAdjustConfig];
10
   // Your code here
11
   return YES;
12
}

1
var yourAppToken = yourAppToken;
2
var environment = AdjustConfig.EnvironmentSandbox;
3
var adjustConfig = new AdjustConfig(yourAppToken, environment);
4
Adjust.initSdk(adjustConfig);

iMessageアプリを設定する

アプリがiMessageをターゲティングしている場合、いくつか追加の設定を行う必要があります。

ソースからAdjust SDKを追加した場合、ADJUST_IM=1プリプロセッサマクロをiMessageプロジェクトの設定に追加してください。
Adjust SDKをフレームワークとして追加した場合、 ビルドフェーズ プロジェクト設定で 新規コピーファイルフェーズ（New Copy Files Phases） を追加します。AdjustSdkIm.frameworkをフレームワークフォルダーにコピーするように設定してください。

セッションを記録する

Adjust SDKはiMessageアプリのiOSシステム通知を受け取りません。アプリがフォアグラウンドに入った、またはフォアグラウンドから離れたことをAdjust SDKに通知するには、trackSubsessionStartとtrackSubsessionEndメソッドを呼び出す必要があります。

didBecomeActiveWithConversation:メソッド内でtrackSubsessionStartへのコールを追加します。

Swift
Objective-C

1
func didBecomeActive(with conversation: MSConversation) {
2
    // Called when the extension is about to move from the inactive to active state.
3
    // This will happen when the extension is about to present UI.
4
    // Use this method to configure the extension and restore previously stored state.
5

6
    Adjust.trackSubsessionStart()
7
}

1
-(void)didBecomeActiveWithConversation:(MSConversation *)conversation {
2
    // Called when the extension is about to move from the inactive to active state.
3
    // This will happen when the extension is about to present UI.
4
    // Use this method to configure the extension and restore previously stored state.
5

6
    [Adjust trackSubsessionStart];
7
}

willResignActiveWithConversation:メソッド内でtrackSubsessionEndへのコールを追加します。

Swift
Objective-C

1
func willResignActive(with conversation: MSConversation) {
2
    // Called when the extension is about to move from the active to inactive state.
3
    // This will happen when the user dismisses the extension, changes to a different
4
    // conversation or quits Messages.
5

6
    // Use this method to release shared resources, save user data, invalidate timers,
7
    // and store enough state information to restore your extension to its current state
8
    // in case it is terminated later.
9

10
    Adjust.trackSubsessionEnd()
11
}

1
-(void)willResignActiveWithConversation:(MSConversation *)conversation {
2
    // Called when the extension is about to move from the active to inactive state.
3
    // This will happen when the user dismisses the extension, changes to a different
4
    // conversation or quits Messages.
5

6
    // Use this method to release shared resources, save user data, invalidate timers,
7
    // and store enough state information to restore your extension to its current state
8
    // in case it is terminated later.
9

10
    [Adjust trackSubsessionEnd];
11
}

7. Adjust SDKを設定する

Configオブジェクトと初期化ロジックを追加したら、Adjust SDKを設定してアプリの様々な部分に関する情報を記録することができます。設定ガイドと機能ガイドを参照し、記録したいデータを正確に設定してください。

8. Adjust SDKをテストする

アプリの情報を記録するようにAdjust SDKを設定したら、次はテストを行います。Adjustは、アプリのテストに役立つテストコンソールとデバイスAPIを提供しています。

テストガイドに従って、Adjustがアプリから想定どおりの値を受け取ることを確認してください。

9. 本番用にアプリをビルドする

テストが終わったら、本番用にアプリをビルドできます。そのためには、configオブジェクトを更新する必要があります。

以下の値を更新します。

environment: ADJEnvironmentProductionに設定します。
logLevel: ログレベルを選択するか、configプロジェクトにallowSuppressLogLevel引数をパスしてログを完全に無効化します。

Swift
Objective-C

1
import AdjustSdk
2

3
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
4
        // Override point for customization after application launch.
5
        let yourAppToken = "{YourAppToken}"
6
        let environment = ADJEnvironmentProduction
7
        let adjustConfig = ADJConfig(
8
            appToken: yourAppToken,
9
            environment: environment,
10
            suppressLogLevel: true)
11
        adjustConfig?.logLevel = ADJLogLevel.verbose
12
        //...
13
        Adjust.initSdk(adjustConfig)
14
       //...
15
        return true
16
}

1
#import <AdjustSdk/AdjustSdk.h>
2

3
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
4
   NSString *yourAppToken = @"{YourAppToken}";
5
   NSString *environment = ADJEnvironmentSandbox;
6
   ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
7
                                                environment:environment
8
                                                suppressLogLevel:YES];
9
   [adjustConfig setLogLevel:ADJLogLevelVerbose];
10
   //...
11
   [Adjust initSdk:adjustConfig];
12
   //...
13
   return YES;
14
}

Xcodeのビルドフラグを使用して、debug buildと本番ビルドのどちらを作成するかに応じて、動的に設定を更新することができます。

Swift
Objective-C

1
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
2
        // Override point for customization after application launch.
3
        let yourAppToken = "{YourAppToken}"
4

5
        #if DEBUG
6
        let environment = ADJEnvironmentSandbox
7
        let adjustConfig = ADJConfig(
8
            appToken: yourAppToken,
9
            environment: environment)
10
        adjustConfig?.logLevel = ADJLogLevel.verbose
11

12
        #else
13
        let environment = ADJEnvironmentProduction
14
        let adjustConfig = ADJConfig(
15
            appToken: yourAppToken,
16
            environment: environment)
17
        adjustConfig?.logLevel = ADJLogLevel.suppress
18
        #endif
19
        //...
20
        Adjust.initSdk(adjustConfig)
21
        //...
22
        return true
23
}

1
#import <AdjustSdk/AdjustSdk.h>
2

3
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
4
   NSString *yourAppToken = @"{YourAppToken}";
5

6
   #if DEBUG
7
   NSString *environment = ADJEnvironmentSandbox;
8
   ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
9
                                                environment:environment];
10
   [adjustConfig setLogLevel:ADJLogLevelVerbose];
11

12
   #else
13
   NSString *environment = ADJEnvironmentProduction;
14
   ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
15
                                                environment:environment];
16
   [adjustConfig setLogLevel:ADJLogLevelSuppress];
17
   #endif
18
   //...
19
   [Adjust initSdk:adjustConfig];
20
   //...
21
   return YES;
22
}