Cordova SDK 連携ガイド

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

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

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

Cordovaプラグイン

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

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

Ionic

Ionicを使用してアプリを構築する場合は、次のコマンドを実行してawesome-cordova-pluginsリポジトリからSDKを追加します。

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

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

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

Google Playストアを対象とするアプリは、Google広告ID（gps_adid）を使用してデバイスを識別する必要があります。これを行うには、以下をplugin.xmlファイルに追加してください。

<framework src="com.google.android.gms:play-services-ads-identifier:18.0.1" id="sl-md0000000" />

パーミッションを追加

Adjust SDKには以下のパーミッションが必要です。まだ存在しない場合は、plugin.xmlファイルに追加してください。

<config-file target="AndroidManifest.xml" parent="/manifest/application" id="sl-md0000000">
    <receiver         android:name="com.adjust.sdk.AdjustReferrerReceiver"         android:exported="true" id="sl-md0000000">
        <intent-filter id="sl-md0000000">
            <action android:name="com.android.vending.INSTALL_REFERRER" id="sl-md0000000" />
        </intent-filter>
    </receiver>
</config-file>

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

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

ProGuardを設定する

ProGuardを使用している場合は、以下のルールをカスタムのProGuardファイルに追加してください：

-keep public class com.adjust.sdk.** { *; }
-keep class com.google.android.gms.common.ConnectionResult {
   int SUCCESS;
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
   com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
   java.lang.String getId();
   boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }

Google Play ストアでアプリを公開していない場合は、以下のルールをProGuardファイルに追加してください。

-keep public class com.adjust.sdk.** { *; }

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

インストールリファラーはアプリインストールをソースにアトリビュートするのに使用できる、ユニークな識別子です。Adjust SDKは、アトリビューションにこの情報を必要とします。この情報を収集する方法は3つあります。

Google Play Referrer APIを使用する
Huawei Referrer APIを使用する（Huaweiデバイスのみ）

Google Play Referrer API

Google Play Referrer APIをサポートする：

build.gradleファイルでGoogle Mavenリポジトリを設定します。

allprojects {
   repositories {
      jcenter()
      maven {
            url "https://maven.google.com"
      }
   }
}

以下をplugin.xmlファイルに追加します：

<framework src="com.android.installreferrer:installreferrer:2.2" id="sl-md0000000" />

Proguardを使用している場合は、Proguardファイルに以下の設定が含まれていることを確認してください。
Proguard.pro
```
-keep public class com.android.installreferrer.** { *; }
```

Huawei Referrer API

バージョン4.21.1以降より、Adjust SDKはHuawei App Galleryバージョン10.4以降のHuaweiデバイスへのインストール計測をサポートしています。Huawei Referrer APIの使用を開始するために行う設定変更はありません。

Metaとのリファラー連携

Adjust SDKはv4.37.1以降でMetaインストールリファラーをサポートしています。この機能を有効にする方法：

App DashboardでMetaアプリIDを検索します。詳しくはMetaのアプリダッシュボードのドキュメントをご覧ください。

AdjustConfigインスタンスのfbAppIdプロパティにアプリIDを割り当てます。

var adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
adjustConfig.fbAppId = "<fb_app_id_string id="sl-md0000000">";
Adjust.create(adjustConfig);

3. iOS frameworksを追加する

特定のiOS frameworksをアプリに実装すると、Adjust SDKは追加の情報を取得できます。これらのframeworksによって特定のSDK機能を有効にできますが、SDKが正常に動作するために必須というわけではありません。

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以降のデバイスで同意レスポンスにアクセスできるようにするために必要です。	アプリが「子供向け」カテゴリーをターゲットにしている場合、このフレームワークは追加しないでください。

希望のフレームワークをplugin.xmlファイルに追加して有効化します。

<framework src="AdSupport.framework" weak="true" id="sl-md0000000" />
<framework src="StoreKit.framework" weak="true" id="sl-md0000000" />
<framework src="AdServices.framework" weak="true" id="sl-md0000000" />
<framework src="AppTrackingTransparency.framework" weak="true" id="sl-md0000000" />

4. Adjust SDKを初期化する

Cordovaアプリ内で、即座にAdjust SDKを初期化するようにしてください。これを行うには、次の情報を使ってAdjustConfigオブジェクトをインスタンス化します。

appToken：お客様のAdjustアプリトークン
environment：アプリの実行環境。アプリをローカルでテストするには、これをAdjustConfig.ENVIRONMENT_SANDBOXに設定します。

var adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
Adjust.create(adjustConfig);

5. アプリをビルドする

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

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

6. Adjust SDKシグネチャーを追加する

Adjust SDKシグネチャーを使用して、Adjust SDKによって送信される全ての通信に署名できます。これによりAdjustのサーバーは、シグネチャーがない不正インストールを検出し、拒否することができます。

Adjust SDKシグネチャーの使用を開始するには、担当のテクニカルアカウントマネージャーまたはsupport@adjust.comまでお問い合わせください。

7. 実装をテストする

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

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

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

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

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