diff --git a/src/content/docs/ja/sdk/ios/v5/index.mdoc b/src/content/docs/ja/sdk/ios/v5/index.mdoc index f21dca318..8b2fb4eee 100644 --- a/src/content/docs/ja/sdk/ios/v5/index.mdoc +++ b/src/content/docs/ja/sdk/ios/v5/index.mdoc @@ -1,39 +1,41 @@ --- -title: iOS SDK連携ガイド -description: iOS SDKを使用して、iOSアプリでAdjustの機能にアクセスしましょう。 -category-title: iOS SDK -slug: ja/sdk/ios +title: "iOS SDK連携ガイド" +description: "iOS SDKを使用して、iOSアプリでAdjustの機能にアクセスしましょう。" +category-title: "iOS SDK" +slug: "en/sdk/ios" sidebar-position: 2 -versions: -- label: v5 - value: v5 - default: true -- label: v4 - value: v4 -redirects: - v4: /ja/sdk/ios/v4 +versions: + - + label: "v5" + value: "v5" + default: true + - + label: "v4" + value: "v4" +redirects: + v4: "/en/sdk/ios/v4" --- - Adjust iOS SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをWebアプリで記録できます。このガイドでは、Adjust SDKをアプリに実装する方法を紹介します。 -{% callout type="important" %} +\{% callout type="important" %\} Adjust SDKはiOS 12以降のバージョンに対応しています。 -{% /callout %} +\{% /callout %\} -## 1. プロジェクトにSDKを追加する {% #add-the-sdk-to-your-project %} +1\. プロジェクトにSDKを追加する \{% \#add\-the\-sdk\-to\-your\-project %\} +----------------------------------------------------------------------- iOSアプリでAdjust SDKを使うには、Xcodeプロジェクトに追加する必要があります。 Swift Package Managerを使ってSDKを追加するには、以下の手順に従ってください。 -1. **File --> Swift Packages --> Add Package Dependency** を選択します。 -1. 表示されたボックスに、SDKのGitHubのアドレスを入力します。 `https://github.com/adjust/ios_sdk` -1. **Version** ドロップダウンで、使用したいAdjust SDKのバージョンを選択します。最新のパージョンは[リリースページ](https://github.com/adjust/ios_sdk/releases)からご確認ください。 +1. **File \-\-> Swift Packages \-\-> Add Package Dependency** を選択します。 +2. 表示されたボックスに、SDKのGitHubのアドレスを入力します。 `https://github.com/adjust/ios_sdk` +3. **Version** ドロップダウンで、使用したいAdjust SDKのバージョンを選択します。最新のパージョンは[リリースページ](https://github.com/adjust/ios_sdk/releases)からご確認ください。 -### その他のインストール方法 {% #alternative-installation-methods %} +### その他のインストール方法 \{% \#alternative\-installation\-methods %\} -{% tabs %} -{% tab title="Cocoapods" sync="cocoapods" %} +\{% tabs %\} +\{% tab title="Cocoapods" sync="cocoapods" %\} Cocoapodsを使ってSDKを追加するには、`Podfile`で使用したいバージョンを指定します。 ```rb @@ -46,71 +48,77 @@ pod 'Adjust', '~> {% $versions.ios.v5 %}' ```rb pod 'Adjust/AdjustWebBridge', '~> {% $versions.ios.v5 %}' ``` -{% /tab %} -{% tab title="Carthage" sync="carthage" %} +\{% /tab %\} + +\{% tab title="Carthage" sync="carthage" %\} Carthageを使ってSDKを追加するには、以下を`Cartfile`に追加します。 ```text github "adjust/ios_sdk" ``` -{% /tab %} -{% /tabs %} -## 2. Adjust SDKを実装する {% #integrate-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +2\. Adjust SDKを実装する \{% \#integrate\-the\-adjust\-sdk %\} +---------------------------------------------------------------- Adjust SDKを`Xcode`プロジェクトに追加したら、それをアプリで実装する必要があります。 プロジェクトファイルに関連するimport statement（インポートステートメント）を追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\} +\{% tab title="Swift" sync="swift" %\} Adjust SDKをインポートするには、以下をbridging headerファイルに追加します。 ```swift import AdjustSdk ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} Adjust SDKをインポートするには、以下を`AppDelegate.h`ファイルに追加します。 ```objc #import ``` -{% /tab %} -{% /tabs %} -## 3. iOS frameworksを追加する {% #add-ios-frameworks %} +\{% /tab %\}\{% /tabs %\} + +3\. iOS frameworksを追加する \{% \#add\-ios\-frameworks %\} +------------------------------------------------------------ Adjust SDKは、特定のデバイス情報にアクセスするためにフレームワークに依存しています。この情報を読み取れるようにするには、フレームワークを追加してそれらを **オプション** として表示します。 -| Framework | 説明 | 注意 | -| ----------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------- | +| 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シグネチャーを設定する {% #set-up-sdk-signature %} +4\. SDKシグネチャーを設定する \{% \#set\-up\-sdk\-signature %\} +----------------------------------------------------------- -Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/ja/article/sdk-signature)の手順に従ってください。 +Adjust SDKとAdjustのサーバー間の通信を保護するためにSDKシグネチャーライブラリを使用する場合は、[AdjustヘルプセンターのSDKシグネチャーガイド](https://help.adjust.com/en/article/sdk-signature)の手順に従ってください。 -## 5.（オプション）Adjust Web Bridgeを設定する {% #set-up-web-bridge %} +5\.（オプション）Adjust Web Bridgeを設定する \{% \#set\-up\-web\-bridge %\} +---------------------------------------------------------------------- アプリがWeb viewを使用している場合、Adjust Web Bridgeを設定してWeb view内のアクティビティを記録する必要があります。 -### `AdjustBridge`をアプリに実装する {% #integrate-adjustbridge-into-your-app %} +### `AdjustBridge`をアプリに実装する \{% \#integrate\-adjustbridge\-into\-your\-app %\} プロジェクトナビゲータにて： 1. View Controllerのソースファイルを開きます。 -1. ファイルの最上部に`import`ステートメントを追加します。 -1. Web View Delegateの`viewDidLoad`または`viewWillAppear`メソッドの`AdjustBridge`に以下のコールを追加します。 +2. ファイルの最上部に`import`ステートメントを追加します。 +3. Web View Delegateの`viewDidLoad`または`viewWillAppear`メソッドの`AdjustBridge`に以下のコールを追加します。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -121,9 +129,11 @@ func viewWillAppear(_ animated: Bool) { adjustBridge.loadWKWebViewBridge(webView) } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -136,39 +146,40 @@ func viewWillAppear(_ animated: Bool) { // Your code here ``` -{% /tab %} -{% /tabs %} -#### `AdjustBridge`をWeb viewに実装する {% #integrate-adjustbridge-into-your-web-view %} +\{% /tab %\}\{% /tabs %\} + +#### `AdjustBridge`をWeb viewに実装する \{% \#integrate\-adjustbridge\-into\-your\-web\-view %\} Web viewでJavascriptを使用するには、bridgeを設定する必要があります。Adjust iOSのWeb bridgeを初期化するには、以下のJavascriptコードを追加してください。 -{% tabs %} -{% tab title="Javascript" sync="js" %} +\{% tabs %\}\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -## 6. Adjust SDKを初期化する {% #initialize-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} + +6\. Adjust SDKを初期化する \{% \#initialize\-the\-adjust\-sdk %\} +------------------------------------------------------------------ Adjust SDKを初期化するには、configオブジェクトを作成する必要があります。このオブジェクトには、Adjust SDKの動作をコントロールする設定オプションが含まれています。最小限の設定を行うために、以下の引数をパスします。 -* `appToken`: [アプリトークン](https://help.adjust.com/ja/article/app-settings#view-your-app-token)。 +* `appToken`: [アプリトークン](https://help.adjust.com/en/article/app-settings#view-your-app-token)。 * `environment`: SDKを実行したい環境。`ADJEnvironmentSandbox`に設定します。 ConfigオブジェクトでAdjust SDKを初期化： 1. アプリデリゲートの`didFinishLaunching`または`didFinishLaunchingWithOptions`メソッド内のconfigオブジェクトを宣言します。 -1. Configオブジェクトの`logLevel`プロパティを`ADJLogLevelVerbose`（verbose）に設定します。デバイス情報を取得するには、verboseロギングを有効化する必要があります。 -1. Configオブジェクトを引数として`initSdk`メソッドにパスします。 +2. Configオブジェクトの`logLevel`プロパティを`ADJLogLevelVerbose`（verbose）に設定します。デバイス情報を取得するには、verboseロギングを有効化する必要があります。 +3. Configオブジェクトを引数として`initSdk`メソッドにパスします。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -184,9 +195,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -201,37 +214,38 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% tab title="Javascript" sync="js" %} +\{% /tab %\} + +\{% tab title="Javascript" sync="js" %\} + ```js var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); Adjust.initSdk(adjustConfig); ``` -{% /tab %} -{% /tabs %} -### iMessageアプリを設定する {% #set-up-your-imessage-app %} +\{% /tab %\}\{% /tabs %\} + +### iMessageアプリを設定する \{% \#set\-up\-your\-imessage\-app %\} -{% callout type="important" %} -iMessageの拡張機能は、アプリとは異なるバンドル識別子を持ち、別のメモリースペースで実行されます。同じトークンで両方を設定した場合、SDKはミックスデータを返します。AdjustダッシュボードでiMessageアプリ用に別のアプリを作成し、Adjust SDKを初期化する際にそのトークンを使用する必要があります。 -{% /callout %} +\{% callout type="important" %\} +iMessageの拡張機能は、アプリとは異なるバンドル識別子を持ち、別のメモリースペースで実行されます。同じトークンで両方を設定した場合、SDKはミックスデータを返します。AdjustダッシュボードでiMessageアプリ用に別のアプリを作成し、Adjust SDKを初期化する際にそのトークンを使用する必要があります。\{% /callout %\} アプリがiMessageをターゲティングしている場合、いくつか追加の設定を行う必要があります。 * ソースからAdjust SDKを追加した場合、`ADJUST_IM=1`プリプロセッサマクロをiMessageプロジェクトの設定に追加してください。 * Adjust SDKをフレームワークとして追加した場合、 **ビルドフェーズ** プロジェクト設定で **新規コピーファイルフェーズ（New Copy Files Phases）** を追加します。`AdjustSdkIm.framework`をフレームワークフォルダーにコピーするように設定してください。 -#### セッションを記録する {% #record-sessions %} +#### セッションを記録する \{% \#record\-sessions %\} Adjust SDKはiMessageアプリのiOSシステム通知を受け取りません。アプリがフォアグラウンドに入った、またはフォアグラウンドから離れたことをAdjust SDKに通知するには、`trackSubsessionStart`と`trackSubsessionEnd`メソッドを呼び出す必要があります。 `didBecomeActiveWithConversation:`メソッド内で`trackSubsessionStart`へのコールを追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func didBecomeActive(with conversation: MSConversation) { // Called when the extension is about to move from the inactive to active state. @@ -241,9 +255,11 @@ func didBecomeActive(with conversation: MSConversation) { Adjust.trackSubsessionStart() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)didBecomeActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the inactive to active state. @@ -253,13 +269,13 @@ func didBecomeActive(with conversation: MSConversation) { [Adjust trackSubsessionStart]; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} `willResignActiveWithConversation:`メソッド内で`trackSubsessionEnd`へのコールを追加します。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func willResignActive(with conversation: MSConversation) { // Called when the extension is about to move from the active to inactive state. @@ -273,9 +289,11 @@ func willResignActive(with conversation: MSConversation) { Adjust.trackSubsessionEnd() } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc -(void)willResignActiveWithConversation:(MSConversation *)conversation { // Called when the extension is about to move from the active to inactive state. @@ -289,30 +307,33 @@ func willResignActive(with conversation: MSConversation) { [Adjust trackSubsessionEnd]; } ``` -{% /tab %} -{% /tabs %} -## 7. Adjust SDKを設定する {% #configure-the-adjust-sdk %} +\{% /tab %\}\{% /tabs %\} -Configオブジェクトと初期化ロジックを追加したら、Adjust SDKを設定してアプリの様々な部分に関する情報を記録することができます。[設定ガイド](/ja/sdk/ios/configuration)と[機能ガイド](/ja/sdk/ios/features)を参照し、記録したいデータを正確に設定してください。 +7\. Adjust SDKを設定する \{% \#configure\-the\-adjust\-sdk %\} +---------------------------------------------------------------- -## 8. Adjust SDKをテストする {% #test-the-adjust-sdk %} +Configオブジェクトと初期化ロジックを追加したら、Adjust SDKを設定してアプリの様々な部分に関する情報を記録することができます。[設定ガイド](/en/sdk/ios/configuration)と[機能ガイド](/en/sdk/ios/features)を参照し、記録したいデータを正確に設定してください。 -アプリの情報を記録するようにAdjust SDKを設定したら、次はテストを行います。Adjustは、アプリのテストに役立つ[テストコンソール](https://help.adjust.com/ja/article/testing-console)と[デバイスAPI](https://help.adjust.com/ja/article/device-api)を提供しています。 +8\. Adjust SDKをテストする \{% \#test\-the\-adjust\-sdk %\} +------------------------------------------------------------ -[テストガイド](https://help.adjust.com/ja/article/test-the-adjust-sdk)に従って、Adjustがアプリから想定どおりの値を受け取ることを確認してください。 +アプリの情報を記録するようにAdjust SDKを設定したら、次はテストを行います。Adjustは、アプリのテストに役立つ[テストコンソール](https://help.adjust.com/en/article/testing-console)と[デバイスAPI](https://help.adjust.com/en/article/device-api)を提供しています。 -## 9. 本番用にアプリをビルドする {% #build-your-app-for-production %} +[テストガイド](https://help.adjust.com/en/article/test-the-adjust-sdk)に従って、Adjustがアプリから想定どおりの値を受け取ることを確認してください。 + +9\. 本番用にアプリをビルドする \{% \#build\-your\-app\-for\-production %\} +--------------------------------------------------------------------- テストが終わったら、本番用にアプリをビルドできます。そのためには、configオブジェクトを更新する必要があります。 以下の値を更新します。 * `environment`: `ADJEnvironmentProduction`に設定します。 -* `logLevel`: [ログレベル](/ja/sdk/ios/configuration#set-your-logging-level)を選択するか、configプロジェクトに`allowSuppressLogLevel`引数をパスしてログを完全に無効化します。 +* `logLevel`: [ログレベル](/en/sdk/ios/configuration#set-your-logging-level)を選択するか、configプロジェクトに`allowSuppressLogLevel`引数をパスしてログを完全に無効化します。 + +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} -{% tabs %} -{% tab title="Swift" sync="swift" %} ```swift import AdjustSdk @@ -331,9 +352,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -350,13 +373,13 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} `Xcode`のビルドフラグを使用して、debug buildと本番ビルドのどちらを作成するかに応じて、動的に設定を更新することができます。 -{% tabs %} -{% tab title="Swift" sync="swift" %} +\{% tabs %\}\{% tab title="Swift" sync="swift" %\} + ```swift func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // Override point for customization after application launch. @@ -382,9 +405,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return true } ``` -{% /tab %} -{% tab title="Objective-C" sync="objc" %} +\{% /tab %\} + +\{% tab title="Objective\-C" sync="objc" %\} + ```objc #import @@ -409,5 +434,6 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau return YES; } ``` -{% /tab %} -{% /tabs %} + +\{% /tab %\}\{% /tabs %\} +