Unity SDK 連携ガイド

Adjust Unity SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをUnityアプリで記録できます。Adjust SDKをアプリに実装するには、以下の手順に従ってください。

事前準備

事前準備として、以下の内容をご確認ください。

Adjust SDKは、iOS 12以降またはAndroid APIレベル21（Lollipop）以降に対応しています。
Adjust SDKはUnity Editor 2018.2以降に対応しています。

1. Adjust SDKを取得する

Adjust SDKをインストールするには、次のいずれかのメソッドを選択します。

Unityのパッケージをインストールする

UnityアプリでAdjust SDKを使うには、プロジェクトに追加する必要があります。GitHubのリリースページから最新バージョンをダウンロードできます。

以下の手順に従って、Adjust SDKをUnityプロジェクトにインポートしてください。

Unityエディター（Unity Editor）を開きます。
Assets —> Import Package —> Custom Package を選択します。
ダウンロードしたSDKパッケージを選択します。

UnityのPackage Managerを使用する

Unity Package Managerを使用してAdjust SDKをインストールするには、以下の手順に従ってください。

Unity editorで、 Package Manager ウィンドウを選択します。
Add package from git URLを 選択します。
次のURLを入力します：https://github.com/adjust/unity_sdk.git?path=Assets/Adjust。

2. iOSとAndroid SDKをインストールする

v5.0.4で変更

SDK v5は、iOSとAndroid SDKをバイナリ依存として使用しなくなりました。基盤となるiOSおよびAndroid SDKをインストールするには、External Dependency Manager for Unity (EDM4U)を使用して、CocoaPodsとMavenからパッケージをインストールする必要があります。

3. SDKを実装する

Adjust SDKには、ゲームオブジェクトのテンプレートとAdjustスクリプトを含むUnityプレハブ（Prefab）が格納されています。このスクリプトを使用してSDKを設定できます。Unityエディターでプレハブを開くには、以下の手順に従ってください。

Assets/Adjust/Adjust.prefabのプレハブを1番目のシーンに追加します。
プレハブのInspector Menuを開きます。
プレハブのメニューには、Adjust SDKの動作を制御する編集可能なフィールドが含まれています。

Unity エディター内での Adjust SDK プレハブ設定スクリプトのスクリーンショット

以下の情報を入力して、Adjust SDKを設定します。

アプリトークン 。アプリトークンの確認方法については、アプリ設定をご覧ください。
環境：
- アプリをテスト中で、テストデータを送信する必要がある場合は、 サンドボックス を選択します。テストデータを表示するには、ダッシュボードでサンドボックスモードを有効にする必要があります。
- テストが完了し、アプリを公開する準備が整ったら、 本番用 を選択します。
ログレベル 。ログレベルは、受け取るログの内容を制御します。詳しくは、ログレベルの設定をご覧ください。

Adjust SDKは、アプリのAwakeイベントが発生したときにデフォルトで開始します。この動作をオーバーライドするには、 START SDK MANUALLY オプションをONにしてください。これにより、configインスタンスを引数としてAdjust.InitSdkを呼び出すことで、Adjust SDKを初期化できます。

1
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox);
2
Adjust.InitSdk(adjustConfig);

4. Androidデバイスを設定する

Google Play 開発者サービスを追加する

Google Playストアを対象とするアプリは、gps_adid（Google広告ID）を使用してデバイスを識別する必要があります。gps_adidにアクセスするには、play-services-ads-identifier AARをプロジェクトに追加する必要があります。

EDM4U
手動インストール

External Dependency Managerプラグインを使用している場合は、Dependencies.xmlファイルに以下を追加します。

1
<androidpackages>
2
   <androidpackage spec="com.google.android.gms:play-services-ads-identifier:18.0.1" />
3
</androidPackages>

ARRAndroid Archiveを手動でインストールするには、Mavenからダウンロードして Assets/Plugins/Android ディレクトリに追加してください。

アプリセットIDを収集する

アプリセットID は、ユーザーがデバイスにインストールしたアプリの情報を計測するための一意の識別子です。同じ開発者のアプリは全て同じアプリセットIDを共有しているため、全てのアプリのユーザーから有意義なインサイトを収集できます。

EDM4U
手動インストール

デバイスのApp Set IDを記録するには、以下のdependencyをDependencies.xmlファイルに追加する必要があります。

1
<androidpackages>
2
   <androidpackage spec="com.google.android.gms:play-services-appset:16.0.2" />
3
</androidPackages>

ARRAndroid Archiveを手動でインストールするには、Mavenからダウンロードして Assets/Plugins/Android ディレクトリに追加してください。

インストールリファラーを設定する

インストールリファラーは、アプリインストールをソースにアトリビュートするために使用できる一意の識別子です。Adjust SDKは、アトリビューションを実行するためにこの情報を必要とします。そこで、 Google Play Referrer APIを使用してこの情報を収集します。

Google Play Referrer APIをサポートするには、以下の2つの方法があります。

EDM4U
手動インストール

インストールリファラーライブラリをdependencyとしてカスタムbuild.gradleファイルに追加します。

1
dependencies {
2
   implementation 'com.android.installreferrer:installreferrer:2.2'
3
}

Mavenからインストールリファラーライブラリをダウンロードし、ARR（Android Archive）ファイルをPlugins/Androidフォルダーに入れてください。

Metaとのリファラー連携

Adjust SDKは、Adjust Metaインストールリファラープラグインを使用してMetaインストールリファラーをサポートしています。連携の詳細については、Metaインストールリファラープラグインをご覧ください。

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

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

6. アプリをビルドする

アプリのビルドプロセスを完了し、アプリ内でAdjust SDKが動作することを確実にするため、Adjust Unityのパッケージはポストビルドを実行します。このプロセスは、AdjustEditor.csのOnPostprocessBuildメソッドによって実行されます。

ポストビルドオプションを設定して、アプリのビルドをカスタマイズできます。

UnityエディターのAdjust SDK ポストビルド構成スクリプト

iOS

iOSのポストビルドプロセスは、生成したXcodeプロジェクトを次のように変更します。

Objective-C exceptionsを有効にします。

フレームワーク

iOS機能にアクセスするために、以下のフレームワークを有効にすることができます。

AdServices.framework: Apple Search Adsの計測に必要。
AdSupport.framework: デバイスのIDFAの読み取りに必要。
AppTrackingTransparency.framework: ユーザーに計測への同意を求め、その同意ステータスを取得するために必要。
StoreKit.framework: SKAdNetworkフレームワークとの通信に必要。

AppTrackingTransparencyの同意ダイアログ

ATT（App Tracking Transparency）ラッパーを使用している場合は、 User Tracking Description メッセージを入力します。このメッセージは、ATT同意ダイアログをユーザーに示す場合に表示されます。

ディープリンク

ディープリンクを有効化するには、次の情報を追加します。

iOSユニバーサルリンクドメイン ：ユニバーサルリンクに使用されるAssociated Domain。
iOS URL Identifier ：アプリのバンドルID。
iOS URLスキーム ：アプリに関連するURLスキーム。

Android

Androidのポストビルドプロセスは、 Assets/Plugins/Android/内の AndroidManifest.xml ファイルを確認します。このファイルが存在しない場合、AdjustAndroidManifest.xmlからコピーを作成します。

アクセス権限

Android機能にアクセスするには、以下のパーミッションを有効にしてください。

android.permission.INTERNET: インターネットに接続するために必要。
android.permission.ACCESS_NETWORK_STATE: デバイスが接続されているネットワークタイプの読み取りに必要。
com.android.finsky.permission.BIND_GET_INSTALL_REFERRER_SERVICE （廃止済み） ：Google Play Storeインテント経由でインストールリファラー情報を取得するのに必要。
com.google.android.gms.permission.AD_ID: 詳細は、GoogleのAdvertisingIdClient.infoドキュメントを参照してください。

ディープリンク

ディープリンクを有効化するには、次の情報を追加します。

Android URIスキーム ：ディープリンクの遷移先。

プロセスの出力は、Unity IDEコンソールウィンドウに表示されます。

7. 連携をテストする

Adjust SDKは、実装をテストとトラブルシューティングのためのツールを提供します。以下の手順に従って、実装をテストしてください。

環境をAdjustEnvironment.Sandboxに設定します。
Adjustダッシュボードにサンドボックスフィルターを追加します。
ログレベルをAdjustLogLevel.Verboseに設定します。

Google Play 開発者サービスの連携をテストする

Adjust SDKがデバイスのGoogle広告IDを受信できるかどうかテストするには、ログレベルをAdjustLogLevel.Verboseに、環境をAdjustEnvironment.Sandboxに設定します。アプリを起動してsessionまたはイベントを計測します。SDKが広告IDを読み取った場合、SDKはgps_adid（Google Play 開発者サービス広告ID)パラメーターをログに記録します。

Google広告IDを取得する際に問題が発生した場合は、Githubリポジトリで質問を投稿するか、support@adjust.comまでお問い合わせください。