Cordova SDK 連携ガイド

Adjust Cordova SDKを実装することで、アトリビューションやイベントなどのさまざまなデータをCordovaアプリで計測できます。以下の手順に従って、Adjust SDKをアプリに実装してください。また、GitHubのサンプルアプリもご覧ください。

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

Adjust Cordova SDKは、npmのプラグインとして提供されています。これをプロジェクトに追加するには、

Cordova plugin

Adjust Cordova SDKをCordovaプラグインに追加するには、以下のコマンドを実行します。

1
> cordova plugin add com.adjust.sdk
2
Fetching plugin "com.adjust.sdk" via npm
3
Installing "com.adjust.sdk" for android
4
Installing "com.adjust.sdk" for ios

Ionic

Ionicを使用してアプリを開発する場合は、以下のコマンドを実行して、awesome-cordova-pluginsリポジトリからSDKとそのTypeScriptの型定義を追加してください。

1
> npm install @awesome-cordova-plugins/adjust --save
2
> ionic cordova plugin add com.adjust.sdk

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

パーミッションを追加する

Adjust SDKには、デフォルトでcom.google.android.gms.AD_IDとandroid.permission.INTERNETパーミッションが含まれています。アプリをCOPPA準拠にする必要がある場合や、Google Playストアをターゲットにしない場合は、removeディレクティブを追加することでAD_IDパーミッションを削除できます。

1
<config-file target="AndroidManifest.xml" parent="/manifest">
2
  <uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove" />
3
</config-file>

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

Adjust SDKは、Google Play Referrer APIをデフォルトでサポートしています。MetaインストールリファラーはAndroidのプラグインとして利用可能です。連携の詳細については、Cordova Meta インストールリファラープラグインをご覧ください。

3. iOS frameworksを追加する

Adjust SDKは、iOSデバイスで以下のフレームワークを自動的にリンクします。

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

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

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

5. Adjust SDKを初期化する

Cordovaアプリ内で、即座にAdjust SDKを初期化するようにしてください。これを行うには、以下の手順に従ってください。

次の情報を使用してAdjustConfigオブジェクトをインスタンス化します。
- appToken: お客様のAdjustアプリトークン。
- environment: アプリの実行環境。アプリをローカルでテストするには、これをAdjustConfig.EnvironmentSandboxに設定します。
SDKを初期化するには、AdjustConfigインスタンスをAdjust.initSdkメソッドにパスします。

1
var adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
Adjust.initSdk(adjustConfig);

6. アプリをビルドする

これで、Cordovaアプリをビルドして実行できるようになります。ログを有効化して、問題がないか確認してください。また、ログのInstall trackedメッセージもご覧ください。

Adjust SDKを使用してユーザーをアトリビューションできるようになりました。

7. 連携をテストする

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

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

問題が発生した場合は、全ての詳細情報とログを添付し、support@adjust.comまでメールをお送りください。

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

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

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