Android SDK 実装ガイド

アプリに SDK を追加するには、次のいずれかの方法を使用してください。

• [推奨] Gradleを使用する
• マニュアルでSDKを追加する

Android Install Referrerはアトリビューションの精度を改善し、不正から守ります。APIはAppsFlyerのAndroid SDKバージョン4.8.6以降よりサポートされています。

アプリにInstall referrerを追加するには、2つの方法があります。

• Gradleを使用する（推奨）
• Install referrerを手動で追加する

パーミッションの追加は確率論的モデリングの精度向上に貢献し、SDKがWifiやキャリアネットワークなどのデータを送信できるようにします。このデータはローデータレポートにも反映され、キャンペーンの分析や最適化に使用できます。

必須パーミッションの追加

1. 次の権限をAndroidManifest.xmlに追加てください：
   

   <uses-permission android:name="android.permission.INTERNET" />
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
   <!-- Optional : -->
   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
   

BroadcastReceiverはAppsFlyerが計測に使用するGoogle Playよりデータを受診します。BroadcastReceiverを使用するとアトリビューションの精度が高くなります。

インストールリファラーブロードキャストレシーバの実装には、次の2つのオプションがあります。

<application>


	<receiver android:name="com.appsflyer.SingleInstallBroadcastReceiver" android:exported="true">
		<intent-filter>
			 <action android:name="com.android.vending.INSTALL_REFERRER" />
		 </intent-filter>
	</receiver>


</application>

<application>


	<receiver android:name="com.appsflyer.MultipleInstallBroadcastReceiver" android:exported="true">
		<intent-filter>
			<action android:name="com.android.vending.INSTALL_REFERRER" />
		</intent-filter>
	</receiver>


</application>

AppsFlyerではdev keyを使用して個々のアカウントを識別します。SDKがAppsFlyerアカウントに関するデータを安全に送受信できるようにするためにdev keyは必須です。

注意：間違ったdev keyを使用すると、SDKから送信されるデータに影響を与え、アトリビューションやレポーティングが正しく行えません。

Dev Keyの取得

1. アプリの管理画面にログインしてください。
2. 管理画面左メニューの 設定 下にあるアプリ設定 をクリックしてください。
3. dev keyをコピーしてください。
   

   

アプリのグローバルアプリケーションクラス内でSDKを初期化することをお勧めします。これにより、ディープリンクを含むすべてのシナリオでSDKを初期化できます。

アプリのグローバルアプリケーションクラス内でのステップは次となります。

1. アプリのグローバルアプリケーションクラス内にて次のライブラリをインポートしてください。
   

   import android.app.Application;
   import android.util.Log;
   import com.appsflyer.AppsFlyerLib;
   import com.appsflyer.AppsFlyerConversionListener;
   import java.util.Map;

2. グローバルクラス内でdev keyを変数に設定します。AF_DEV_KEYが好ましいです。 
   
   重要：SDKを初期化する際に必ず正しいdev keyを使用してください。一致しないdev keyを使用するとSDKから送信されるデータに影響を与え、アトリビューションやレポーティングに問題が発生します。
   Java Kotlin

   public class AFApplication extends Application {
       private static final String AF_DEV_KEY = "qrdZGj123456789";
       
       //...
       
   }
   

   class AFApplication : Application() {
       private val devKey = "qrdZGj123456789";
   
       
       //...
       
   }
   

3. グローバルクラス内で、super.onCreate()をコールした後、AppsFlyerConversionListenerを実装してください。ステップ４のコードを参照してください。
4. グローバルクラス内で、ConversionListener の後に、init()のメソッドを使用してSDKを初期化してください。 
   
   Java Kotlin

   public class AFApplication extends Application {
       private static final String AF_DEV_KEY = "qrdZGj123456789";
       
       @Override
       public void onCreate() {
           super.onCreate();
           AppsFlyerConversionListener conversionListener = new AppsFlyerConversionListener() {
   
   
               @Override
               public void onConversionDataSuccess(Map<String, Object> conversionData) {
               
                       for (String attrName : conversionData.keySet()) {
                       Log.d("LOG_TAG", "attribute: " + attrName + " = " + conversionData.get(attrName));
                   }
               }
   
               @Override
               public void onConversionDataFail(String errorMessage) {
   		   Log.d("LOG_TAG", "error getting conversion data: " + errorMessage);
               }
   
               @Override
               public void onAppOpenAttribution(Map<String, String> attributionData) {
               
                   for (String attrName : attributionData.keySet()) {
                       Log.d("LOG_TAG", "attribute: " + attrName + " = " + attributionData.get(attrName));
                   }
   
               }
   
               @Override
               public void onAttributionFailure(String errorMessage) {
                   Log.d("LOG_TAG", "error onAttributionFailure : " + errorMessage);
               }
           };
           
           AppsFlyerLib.getInstance().init(AF_DEV_KEY, conversionListener, this);
   
       }
   }
                 

   class AFApplication : Application() {
       private val devKey = "qrdZGj123456789";
   
       override fun onCreate() {
           super.onCreate()
           val conversionDataListener  = object : AppsFlyerConversionListener{
               override fun onConversionDataSuccess(data: MutableMap<String, Any>?) {
                   data?.let { cvData ->
                       cvData.map {
                           Log.i(LOG_TAG, "conversion_attribute:  ${it.key} = ${it.value}")
                       }
                   }
               }
   
               override fun onConversionDataFail(error: String?) {
                   Log.e(LOG_TAG, "error onAttributionFailure :  $error")
               }
   
               override fun onAppOpenAttribution(data: MutableMap<String, String>?) {
                   data?.map {
                       Log.d(LOG_TAG, "onAppOpen_attribute: ${it.key} = ${it.value}")
                   }
               }
   
               override fun onAttributionFailure(error: String?) {
                   Log.e(LOG_TAG, "error onAttributionFailure :  $error")
               }
           }
   
           AppsFlyerLib.getInstance().init(devKey, conversionDataListener, this)
       }
   }
   

5. アプリのグローバルクラス内でstart()をコールしてください。
   
   Java Kotlin

   AppsFlyerLib.getInstance().start(this);
   

   AppsFlyerLib.getInstance().start(this)

AndroidManifest.xmlファイルのapplication タグ内に、次の行を追加してください。

android:name="APP.PACKAGE.NAME.AFApplication"

• APP.PACAKGE.NAME - 該当するアプリパッケージ名に置き換えてください。
• AFApplication - アプリのグローバルクラスに設定した名前に置き換えてください。

manifest.xml内のこの行は、何がグローバルアプリケーションであるかをアプリケーションに伝えます。前述のように、そうすることでAppsFlyer SDKがアプリ全体にアクセス可能になります。

SDKの初期化を遅らせるには、Activityクラスから start をコールすることが可能です。

このオプションは、例えば、GDPR や CCPA の要件などにより、ユーザーの同意が得られるまで start を遅延する必要がある場合に使用できます。

Activity クラスで start を呼び出すとき：

• Activityのインスタンスをアプリケーションではなく引数としてパスしてください。
• ディープリンクの機能を使用する場合には、start を持っておらず、かつディープリンクできるすべてのアクティビティに start()のAPI を追加してください。

インストールのテストを開始する前に、使用するテスト端末をホワイトリスト登録 してください。

オーガニックインストールは通常、アプリストアからの直接インストールであり何も紐付けがされないインストールです。

オーガニックインストールをシミュレートするには：

1. コンピュータにテスト端末が接続されていることを確認してください。
2. Android StudioでLogcatを開いてください。
3. Android Studioから、テスト端末またはシミュレーターにアプリをインストールしてください。
4. アプリが起動するのを待ってください。
5. Logcatで、アプリのパッケージ名を探してください。

次が表示されるはずです。

スクリーンショットのハイライト箇所はSDKがオーガニックインストールをレポートしていることを表します。本データはAFApplicationクラス内onConversionDataSuccessメソッドから取得されます。コンバージョンデータの取得については本ガイド後半で説明します。

注： SDK ver5以降、 onConversionDataSuccess がコンバージョンデータを取得するメソッドの名称です。5.0.0より前のSDKバージョンを使用している場合、メソッドの名前は onInstallConversionDataLoaded です。SDK ver5.0.0にアップグレードすることをお勧めします。詳細についてはこちらをクリックしてください。

オーガニックインストールが、 管理画面オーバービュー ページに表示されるはずです 。

管理画面にインストールが表示されない場合は、 SDKトラブルシューティングガイドを参照してください。

非オーガニックインストールは、通常は広告エンゲージメントに紐付けられたインストールです。計測URLを使用して、非オーガニックインストールをシミュレートできます。

非オーガニックインストールをシミュレートするには：

1. マニフェストで、アプリのパッケージ名を確認します。 com.company.app
   • 次のURLにて、<app_id>を、あなたのアプリのパッケージ名に書き換えてください。
     

     https://app.appsflyer.com/<app_id>?pid=Test&c=Test

     例：

     https://app.appsflyer.com/id0123456789?pid=Test&c=Test

   •  c パラメータには、キャンペーンの名前を指定します。
   •  pid パラメータには、インストールが紐づくメディアソースの名前を指定します。
   • コンピュータからクリックをテストする場合には、Advertising ID(GAID)を追加する必要があります（手順1で、計測リンクの末尾に&advertising_id=<GAID> を追加してください）。
2. デバイスに計測リンクを送信します。たとえば、メールやWhatsAppに送信できます。
3. 端末上で、URLをクリックしてください。
   • アプリがアプリストアに掲載されている場合、アプリストアにリダイレクトされます。アプリストアからはアプリをダウンロードしないでください。ステップ5に進んでください。
   • アプリがアプリストアに掲載されておらず、まだ開発中の場合、画面にはアプリがアプリストアでは見つからないというメッセージが表示されます。そのままステップ5に進んでください。
4. Android StudioでLogcatを開いてください。
5. USBケーブルを使用して端末をコンピューターに接続してください。
6. Android Studioから、テスト端末にアプリをインストールしてください。
7. Logcatで、アプリのパッケージ名を探してください。

次が表示されるはずです。

非オーガニックインストールが、 管理画面オーバービュー ページに表示されるはずです 。

SDKには、アプリ内イベントに関連する2つのインターフェイスがあります。

• AFInAppEventType - 定数：アプリ内イベントのイベント名
• AFInAppEventParameterName - 定数：アプリ内イベントのイベントパラメータ名

2つのインターフェイスを次の理由から推奨します。

• これらの共通となるアプリ内イベント名ではAppsFlyerからFacebook、Google、TwitterやSnapchatなどに自動的にマッピングします。
• 後方互換性 - もしAppsFlyerがイベント名やパラメータを変更した場合、後方互換性があります。

これらの2つのインターフェイスを使用するにはインポートします。

import com.appsflyer.AFInAppEventParameterName;
import com.appsflyer.AFInAppEventType;

推奨するアプリ内イベント名とパラメータのリスト をご確認ください。

収益はどのアプリ内イベントでも送信できます。af_revenueのイベントパラメータを使って（AFInAppEventParameterName.REVENUE）、収益をアプリ内イベントの一部として計測します。正負を問わず、あらゆる数値を入力できます。

af_revenueは、AppsFlyerのローデータと管理画面で収益としてカウントされる唯一のイベントパラメータです。詳細については、こちらをクリックしてください。

収益をアプリ内イベントで送る際に次の点をご注意ください。

• 通貨コード（次参照）を設定する際は、ISO 4217コードの３文字を使用してください。（デフォルトはUSDです）。
• 次のメソッドを呼び出すことにより、すべてのイベントの通貨コードを設定できます。： AppsFlyer.setCurrencyCode（ " ZZZ " ） 通貨単位の設定、管理画面上での表示、通貨換算については、収益通貨に関するガイドをご覧ください。
• コンマの値区切り、通貨記号、テキストなどは収益の値に含めないでください。たとえば、収益の値は「1234.56」のように設定してください。

例）収益を伴うアプリ内イベント

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.REVENUE,1234.56);
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"Shirt");
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"1234567");
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD");
AppsFlyerLib.getInstance().logEvent(getApplicationContext(), AFInAppEventType.PURCHASE , eventValue);

val eventValue = HashMap<String, Any>() 
eventValue.put(AFInAppEventParameterName.REVENUE,1234.56)
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"Shirt")
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"1234567")
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD")
AppsFlyerLib.getInstance().logEvent(getApplicationContext(), AFInAppEventType.PURCHASE , eventValue)

上記の購入イベントには$1234.56の収益が関連付けられており、管理画面に収益として表示されます。

マイナス収益の計測

稀に、マイナスの収益を計測したいケースがあるかと思います。

例えば、ユーザーが購入した靴の返金を受け取ったとします。

Map<String, Object> eventValue = new HashMap<String, Object>();
eventValue.put(AFInAppEventParameterName.REVENUE,-200);
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE,"shoes");
eventValue.put(AFInAppEventParameterName.CONTENT_ID,"4875");
eventValue.put(AFInAppEventParameterName.CURRENCY,"USD");
AppsFlyerLib.getInstance().logEvent(getApplicationContext(), "cancel_purchase" , eventValue);

val eventValue = HashMap<String, Any>()
eventValue.put(AFInAppEventParameterName.REVENUE, -200)
eventValue.put(AFInAppEventParameterName.CONTENT_TYPE, "category_a")
eventValue.put(AFInAppEventParameterName.CONTENT_ID, "1234567")
eventValue.put(AFInAppEventParameterName.CURRENCY, "USD")
AppsFlyerLib.getInstance().logEvent(applicationContext,"cancel_purchase", eventValue)

AppsFlyerのSDKでは、アプリ内購入をサーバーにて検証できる機能を複数提供しています。アプリ内購入を検証したい場合には、 validateAndLogInAppPurchaseを呼び出してください。

アプリ内購入が検証されると、af_purchaseのアプリ内イベントをこのコールで自動的に生成します。

public static void validateAndLogInAppPurchase(Context context, 
String publicKey, String signature, String purchaseData, 
String price, String currency, HashMap<String, String> additionalParameters);

メソッドパラメータ

• String publicKey – Google Developer Consoleで取得したpublic key
• String signature – transaction signature (購入が完了するとGoogle APIから返されます。)
• String purchaseData – JSON形式の購入された製品 (購入が完了するとGoogle APIから返されます。)
• String price – AppsFlyerへレポートされるアプリ内イベントの収益
• String currency – AppsFlyerへレポートされるアプリ内イベントの通貨。
• HashMap<String, String>追加パラメータ –アプリ内イベントローデータレポートののevent_valueフィールドに表示されるアプリ内イベントの追加パラメータ。

購入検証の成功・失敗コールバック

購入の検証が成功したかどうかを知りたい場合は、applicationクラスにregisterValidatorListenerを実装してください。このリスナーには、「Success」と「Failure」（検証失敗など、あらゆる理由によるもの）の2つのコールバックブロックがあります。

AppsFlyerLib.getInstance().registerValidatorListener(this,new
   AppsFlyerInAppPurchaseValidatorListener() {
     public void onValidateInApp() {
       Log.d(TAG, "Purchase validated successfully");
     }
     public void onValidateInAppFailure(String error) {
       Log.d(TAG, "onValidateInAppFailure called: " + error);
     }
});

AppsFlyerLib.getInstance().registerValidatorListener(this, object : AppsFlyerInAppPurchaseValidatorListener {
    override fun onValidateInApp() {
       	Log.d(LOG_TAG, "Purchase validated successfully")
    }

    override fun onValidateInAppFailure(error: String) {
        Log.d(LOG_TAG, "onValidateInAppFailure called: $error")
   }
})

アプリ内購入の検証サンプル

// Purchase object is returned by Google API in onPurchasesUpdated() callback
private void handlePurchase(Purchase purchase) {
    Log.d(LOG_TAG, "Purchase successful!");
    Map<String, String> additional_event_values = new HashMap<>();
    additional_event_values.put("some_parameter", "some_value");
    String price= "10";
    String currency = "USD";
    AppsFlyerLib.getInstance().validateAndLogInAppPurchase(getApplicationContext(), PUBLIC_KEY, purchase.getSignature(), purchase.getOriginalJson(), revenue, currency, additional_event_values);
}

// Purchase object is returned by Google API in onPurchasesUpdated() callback
private fun handlePurchase(Purchase purchase) {
   Log.d(LOG_TAG, "Purchase successful!");
   val additional_event_values = HashMap<String, String>()
   additional_event_values.put("some_parameter", "some_value");
   val price= "10";
   val currency = "USD";
   AppsFlyerLib.getInstance().validateAndLogInAppPurchase(this, PUBLIC_KEY, purchase.getSignature(), purchase.getOriginalJson(), revenue, currency, additional_event_values);
}

アプリ内購入を検証するとアプリ内イベントが自動的にAppsFlyerに送信されます。event_valueのパラメータが渡されている、次のサンプルデータをご確認ください。

{
   "some_parameter":"some_value", // from additional_event_values
   "af_currency":"USD", // from currency
   "af_content_id":"test_id", // from purchase
   "af_revenue":"10", // from revenue
   "af_quantity":"1", // from purchase
   "af_validated":true // flag that AF verified the purchase
}

• イベント名：最大45文字まで(半角)
• イベント値(Event Value)：半角1000文字を超えないでください。 - 超えた場合には切り捨てる可能性があります。
• 価格(price)と収益(revenue)：5または5.2など、数字と小数点のみを使用してください。
• 価格(price)と収益(revenue)の値は、小数点の後に最大5桁(=小数点第5位)まで設定できます。たとえば以下の様な形です。5.12345
• v4.8.1以降のSDKであれば、英語以外の文字もアプリ内イベントでサポートされています。

アプリ内イベントの計測は、イベント名とパラメータを使用してlogEventを呼び出すことで実行されます。詳細については、 アプリ内イベントのページを参照してください。

以下は、購入イベントを計測する方法の簡単な例です。業種別の既製のコードスニペットの包括的なリストについては、 業種別のリッチアプリ内イベントのガイドを参照してください

例：アプリ内購入イベント

Map<String,Object> eventValues = new HashMap<>();
eventValues.put(AFInAppEventParameterName.REVENUE, 1200);
eventValues.put(AFInAppEventParameterName.CURRENCY, "JPY");
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, "Shoes");
AppsFlyerLib.getInstance().logEvent(this,AFInAppEventType.PURCHASE, eventValues);

val eventValues = HashMap<String, Any>();
eventValues.put(AFInAppEventParameterName.REVENUE, 1200)
eventValues.put(AFInAppEventParameterName.CURRENCY, "JPY")
eventValues.put(AFInAppEventParameterName.CONTENT_TYPE, "Shoes")
AppsFlyerLib.getInstance().logEvent(this,AFInAppEventType.PURCHASE, eventValues)

インターネット接続が利用できないときにユーザーがイベントを開始した場合でも、Appsflyerはそれを記録できます。裏側の仕組み：

1. SDKはイベントをAppsFlyerのサーバーに送信し、応答を待ちます。
2. SDKが200のサーバーレスポンスを受け取らなかった場合、イベントはキャッシュに保存されます。
3. 次の200サーバーレスポンスが受信されると、保存されたイベントはサーバーに再送信されます。
4. キャッシュに複数のイベントがある場合は、それらはイベントを次々にサーバーに送信されます。

アプリ内イベントの計測時にリスナーを設定できます。このリスナーを使用すると、次の2つのシナリオのロジックを定義できます。

• アプリ内イベントが正常に記録
• アプリ内イベントの記録中にエラーが発生

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),AFInAppEventType.PURCHASE, eventValue, new AppsFlyerRequestListener() {
                    @Override
                    public void onSuccess() {
                        Log.d(LOG_TAG, "Event sent successfully");
                    }
                    @Override
                    public void onError(int i, @NonNull String s) {
                        Log.d(LOG_TAG, "Event failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
                    }
                });

AppsFlyerLib.getInstance().logEvent(getApplicationContext(),AFInAppEventType.PURCHASE, eventValue, object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Event sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Event failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

アプリ内イベントの記録時にエラーが発生した場合には、次の表のようにエラーコードと文字列での説明が提供されます。

OneLinkはクリック時に端末種別を検知し、ユーザーを適切なページ（Google Play、iOS AppStore、それ以外のストア、Webページなど）にリダイレクトします。

OneLinkリダイレクトのガイドでは、マルチプラットフォームの計測リンクの実装について説明しています（SDKのコーディングは不要です）。また、ディープリンクの基盤でもあります。

ディープリンクを使用すると、ユーザーを特定のアクティビティに誘導し、カスタマイズされたコンテンツを提供できます。これは、リターゲティングキャンペーンを実行するときに特に役立ちます。

OneLinkでのディープリンクを設定するには AppsFlyerの管理画面へのアクセス権限を持つマーケティング担当者と、アプリの編集権限を持つ開発者担当者の協力が必須です。

OneLinkでのディープリンク設定 のガイドを参照してください。

ディファードディープリンクを使用すると、新規ユーザーをディープリンクさせ、アプリの初回起動時にカスタマイズされたコンテンツを提供できます。これは、ユーザーの端末に既にアプリがインストールされている必要がある、通常のディープリンクとは異なります。

OneLinkでのディファードディープリンクを設定するには、開発者担当者もAppsFlyerの管理画面へアクセスする必要があります。

ディファードディープリンクの設定は、ディープリンクと同じです。唯一の違いは、ユーザーがアプリをインストールして起動した後に、ユーザーをディープリンクさせてカスタマイズされたコンテンツを提供するために、アプリに追加のロジックを実装する必要がある点です。

詳細については、ディファードディープリンクのガイドを参照してください。

SDKは、すべてのインストールまたはディープリンクイベントに伴う、コンバージョンデータまたはエンゲージメントデータを提供します。このデータを使用することで、コンテンツとアプリの動作をプログラムしてカスタマイズできます。

ディープリンクが使用され、アプリが直接開かれたときにディープリンクデータを取得するには、onAppOpenAttributionのメソッドを実装してください。

ディープリンクのリエンゲージメントデータをいつでも手動で取得するには、performAppAttributionのメソッドを実装してください。 これにより、新しいリエンゲージメントを記録せずにリエンゲージメントデータにアクセスできます。

詳細については、ディープリンクデータのガイドを参照してください。

addPushNotificationDeepLinkPathのメソッドを使えば、プッシュ通知のペイロードからディープリンクに必要な情報を取得する方法を、柔軟なインターフェイス上で提供します。

デフォルトの設定では、AppsFlyerのSDK はプッシュ通知のJSON ペイロード内で afキーに紐付くディープリンクの値を検索します。しかし、プッシュ通知機能のプロバイダーの多くはSDK側が追加の設定を行わないと解決できない独自の JSON スキーマを使用しています。

addPushNotificationDeepLinkPathを使用すると、プッシュ通知のペイロードのどのキーをSDKがディープリンクの値に使用するかを設定できるようになります。

AppsFlyer SDK が想定する、デフォルトのプッシュ通知のJSONスキーマを使用しないプッシュ通知プロバイダーとアプリを連携する場合には、このメソッドを使用してください。

addPushNotificationDeepLinkPathを呼び出すと、SDKは以下のことを検証します：

• 必要なキーがペイロード内に存在しているか
• そのキーに有効なOneLink URLが含まれているか

addPushNotificationDeepLinkPathは、start() を呼ぶ前に呼び出さなければなりません。

一般的な実装

addPushNotificationDeepLinkPath の以下の呼び出しと

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");                       

AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

それに紐付くシナリオを確認してください。

シナリオ１

プッシュ通知経由でアプリが起動され、以下のような構造のペイロードが含まれていたとします。

{
    ...
    "deeply": {
        "nested": {
            "deep_link": "https://yourdeeplink2.onelink.me"
        }
    }
    ...
}

この場合、SDKはdeep_linkの値を抽出し、ディープリンクのフローを続行します。

シナリオ２

プッシュ通知経由でアプリが起動され、以下のような構造のペイロードが含まれていたとします。

{
    ...
    "deeply": {
        "nested": {
            "banana": "https://yourdeeplink2.onelink.me"
        }
    },
    ...
}

この場合、呼び出しが実行されても、SDKはペイロード内にdeep_linkのキーを見つけることができず、結果、何も起きません。(＝ディープリンクしない)

シナリオ３

プッシュ通知経由でアプリが起動され、以下のような構造のペイロードが含まれていたとします。

{
    ...
    "deeply": {
        "nested": {
            "deep_link": "Corrupted url or regular string"
        }
    },
    ...
}

この場合、SDKはdeep_linkのキーを検出しますが、そのディープリンクの値は無効です。そのため、上記の呼び出しが実行されても何も起こりません。

高度な設定

複数のペイロード構造を設定するには、addPushNotificationDeepLinkPath を複数回呼び出してください：

• 有効なディープリンクの値を与えた最初のコールが使用されます。
• 他の呼び出しは無視されます。

一致するペイロードの構造がない場合や、有効なOneLink URLがペイロード内に見つからなかった場合には、何も起こりません。

たとえば、以下のペイロードの場合に

{
    ...
    "deeply": {
        "nested": {
            “deep_link”: “https://yourdeeplink2.onelink.me”
        }
    },
    “this”: {
        “is”: {
            "banana": "phone"
        }
    }
    ...
}

addPushNotificationDeepLinkPath を呼び出した場合です。

// this.is.deep_link key isn’t found - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "deep_link");
// this.is.banana key found, but contains invalid OneLink URL - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "banana");
// deeply.nested.deep_link key found and contains valid OneLink URL - proceed deep linking flow
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

// this.is.deep_link key isn’t found - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "deep_link");
// this.is.banana key found, but contains invalid OneLink URL - nothing happens
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("this", "is", "banana");
// deeply.nested.deep_link key found and contains valid OneLink URL - proceed deep linking flow
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");

AppsFlyerを使用することで、GooglePlay以外のアプリストアで発生したインストールも計測できます。これにより、Google Playを利用できないエリアでも多くのオーディエンスにリーチしてアプリを宣伝可能です。

Google Play以外からのAndroidアプリのインストールを計測する方法の詳細については、, こちらを参照してください。

プリインストールキャンペーンでは、アプリの所有者は端末の製造元に、出荷前に端末にアプリをプリインストールするように依頼できます。

AppsFlyerを使用することで、プレインストールされたアプリのインストールも簡単に計測できます。ユーザーがアプリを初回起動したとき、AppsFlyerは端末の製造元をメディアソースとしてそのインストールを紐付けてす。

詳細については、こちらをクリックしてください。

アンインストール測定の実装方法については、 こちらを参照してください。

リクエストがAppsFlyerサーバーで正常に受信されたかどうかを確認したい場合には、AppsFlyerRequestListenerというリスナーを実装してください。

SDKによる個々のアトリビューションリクエストに対して、200のレスポンス毎にonRequestSuccess()のコールバックメソッドが実行されます。

それ以外のレスポンスについては onRequestFailure(String error)のコールバックメソッドが実行され、レスポンスをエラーストリングとして返します。

実装例

AppsFlyerLib.getInstance().start(getApplicationContext(),"devKey", new AppsFlyerRequestListener() {
            @Override
            public void onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully, got 200 response code from server");
            }
            @Override
            public void onError(int i, @NonNull String s) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                                "Error code: " + i + "\n"
                                + "Error description: " + s);
            }
        });

AppsFlyerLib.getInstance().start(this,"devKey", object : AppsFlyerRequestListener {
            override fun onSuccess() {
                Log.d(LOG_TAG, "Launch sent successfully")
            }
            override fun onError(errorCode: Int, errorDesc: String) {
                Log.d(LOG_TAG, "Launch failed to be sent:\n" +
                        "Error code: " + errorCode + "\n"
                        + "Error description: " + errorDesc)
            }
        })

リクエストリスナー中にエラーが発生した場合には、次の表に示すように、エラーコードと文字列での説明が提供されます。

Segment、Adobe、Urban Airshipなどの外部のパートナープラットフォームとSDKレベルで連携する際には、setAdditionalDataのAPIが必要です。このAPIは、各プラットフォームの連携のサポートページに、setAdditionalDataのAPIが必要であると記載されている場合にのみ、使用してください。

setAdditionalData コード例：

HashMap<String,Object> CustomDataMap = new HashMap<>();
CustomDataMap.put("custom_param_1","value_of_param_1");
AppsFlyerLib.getInstance().setAdditionalData(CustomDataMap);

val customDataMap = HashMap<String, Any>()
customDataMap.put("custom_param_1","value_of_param_1")
AppsFlyerLib.getInstance().setAdditionalData(customDataMap)

(OneLink以外で)ディープリンクのためにApp Linksを使用し、アプリに関連付けられたドメインを持っている広告主は、appendParametersToDeepLinkingURLのメソッドを使用することで、それらのドメインを介して開始された起動を計測できます。

たとえば、ユーザーがGoogleで検索し御社のドメイン：www.example.comをクリックしたとします。

• ユーザーがアプリをインストールしていない場合には、そのままWebサイト(www.example.com)に遷移します。
• ユーザーが既にアプリを端末にインストールしている場合には、www.example.comに関連付けられたアプリがディープリンク起動されます。この起動イベントをappendParametersToDeepLinkingURL内で指定されたメディアソース (pidパラメータ)に紐づけて計測することができます。

詳細については、Android SDKのAPIリファレンスを参照してください。

Point： スマートバナーは、Webサイトに訪問したユーザーをアプリユーザーに変換するのにとても役立ちます。

デフォルトでは、それぞれ別のセッションとしてカウントされるには、２つのアプリ起動の間隔が少なくとも5秒以上あいている必要があります（詳細は 「セッション数のカウント」を参照してください）。

セッション間の最小時間を設定したい場合には、次のAPIを使用してください：

AppsFlyerLib.setMinTimeBetweenSessions(int seconds);

セッション間のカスタム時間に大きい値を設定すると、ディープリンクなどのセッションデータに依存するAPI へ悪影響を与える可能性があるので注意してください。

このSDKメソッドを使用することで、ユーザーの新しいセッションを報告できます。たとえば、これはバックグラウンドで実行されるユーティリティアプリなどの場合に便利です。

このAPIを、アクティビティのonCreate(): で使用してください。

public void logSession(Context context);

使用例：

AppsFlyerLib.getInstance().logSession(context);

メールサービスプロバイダー(ESP)などの一部のサードパーティサービスは、独自のクリック計測用ドメインでメール内の計測リンクを変換してしまいます。一方で元々のクリック計測URLを設定できるものもあります。もしもOneLinkがクリック計測用に変換された場合、OneLinkの機能が制限される可能性があります。

この問題を解決するには、 setResolveDeepLinkURLs のAPIを使用してください。このAPIを使用することで、アプリを起動するクリックドメインからOneLinkを取得することが可能です。このAPIはSDK初期化よりも前に必ず呼び出してください。

たとえば、あなたのOneLink（https://mysubdomain.onelink.me/abCD）にリダイレクトする3つのクリックドメインがあったときにも、このAPIを使用することで、そのクリックドメインたちがリダイレクトするOneLinkを取得可能です。このAPIメソッドはSDKが分析するクリックドメインのリストを受け取ります。SDK初期化の前に以下のコードを追加してください。

AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");

上記のコードを使用すると、OneLinkの機能を維持しながらクリックドメインを使用できます。そのクリックドメインは、アプリの起動を担います。このAPIは、順番に、これらのクリックドメインからOneLinkを取得し、そのデータを使ってカスタマイズされたユーザーコンテンツへのディープリンクを可能にします。

AppsFlyerでは、リターゲティングキャンペーンの一部として、プッシュ通知を計測できます。

この機能を有効にするには、通知をクリックした後に起動されるすべてのアクティビティの onCreate メソッド内で sendPushNotificationData メソッドを呼び出してください。

AppsFlyerLib.getInstance().sendPushNotificationData(this);

プッシュ通知の計測に関する詳細は、こちらを参照してください。

アプリの既存ユーザーがアプリに友人を招待できるようにすることが、アプリインストール増加のきっかけとなる場合があります。AppsFlyerを使用することで、アプリ内のユーザー招待から発生したインストールの計測を行うことが可能です。

詳細は、ユーザー招待の計測のガイドを参照してください。

AppsFlyer IDは、アプリのインストール毎に都度発行されます。AppsFlyer IDはさまざまな目的で使用できます。

• サーバー間(S2S)イベントを送信するとき
• 広告主側で持っているシステム上のユーザー情報と一致させるとき
• Pull APIとPush APIのデータをマージするときに、各データを突合させるとき

次のAPIを使用してAppsFlyer IDを取得してください。

public String getAppsFlyerUID(Context context);

使用例：

String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);

カスタマーユーザーIDを設定するには：

public void setCustomerUserId(String id);

使用例：

AppsFlyerLib.getInstance().setCustomerUserId("myId");

設定された後に計測されたイベントにしかカスタマーユーザーIDを紐付けられないので、AppsFlyerでは、 アプリ利用の一連の流れの中で、できる限り早いタイミングでカスタマーユーザーIDを設定することをお勧めしています。

• startを呼び出す前に setCustomerUserId が呼び出された場合には、インストールおよびイベントのローデータレポートにカスタマーユーザーIDが表示されます。
• trackAppLaunchよりも後に設定された場合には、カスタマーユーザーIDはその設定後に計測されたイベントへのみ紐付けられます。

カスタマーユーザーIDの取得

最初の起動後にカスタマーユーザーIDの値を再度設定したり、IDを取得する通信をあなたのサーバーに必要以上にしないように、以下のコードを使用してIDの値が空かどうかを確認できます。 

AppsFlyerProperties.getInstance().getString(AppsFlyerProperties.APP_USER_ID)

カスタマーユーザーIDの詳細については、こちらをクリックしてください。

customerUserIDのためのSDK初期化の遅延

customerUserIDが設定されるまで、SDKの初期化を遅らせることも可能です。

customerUserIDの呼び出しのためにSDKの初期化を遅らせる必要があることを示すには：

AppsFlyerLib.getInstance().waitForCustomerUserId(true);

を呼び出します。SDK初期化の残りの部分は変更しません。

customerUserIDが指定されたら、

AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id",this);

関連するCustomer User IDをSDKに提供してSDKでの計測を開始します。

コードは次のようになります。

public class AFApplication extends Application {
  private static final String AF_DEV_KEY = "qrdZGj123456789";
  @Override
  public void onCreate() {
    super.onCreate();
AppsFlyerConversionListener conversionDataListener = 
    new AppsFlyerConversionListener() {
      ...
    };
    AppsFlyerLib.getInstance().waitForCustomerUserId(true);
//WARNING!Removing above line doesn't cancel its effect.
// Replace with this to stop waiting for CUID:
    // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
AppsFlyerLib.getInstance().init(AF_DEV_KEY,getConversionListener(), getApplicationContext());
    AppsFlyerLib.getInstance().start(this);
// Do your magic to get the customerUserID
    // ...
    // any AppsFlyer SDK code invoked here will be discarded
   //Call the following API once the customerUserID is available:
 AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id",this);
  }
}

class AFApplication: Application() {
 private val afDevKey = ""

 override fun onCreate() {
  super.onCreate()
val conversionDataListener = object: AppsFlyerConversionListener {
   ...
  }
  AppsFlyerLib.getInstance().waitForCustomerUserId(true);
//WARNING!Removing above line doesn't cancel its effect.
// Replace with this to stop waiting for CUID:
  // AppsFlyerLib.getInstance().waitForCustomerUserId(false);
AppsFlyerLib.getInstance().init(afDevKey,conversionDataListener, this)
  AppsFlyerLib.getInstance().start(this)
// Do your magic to get the customerUserID
  // ...
  // any AppsFlyer SDK code invoked here will be discarded
  // Call the following API once the customerUserID is available:
  AppsFlyerLib.getInstance().setCustomerIdAndLogSession("customer_id",this)
 }
}

カスタマーユーザーIDが利用可能になるまでSDKの初期化を遅らせる方法の詳細については、こちらを参照してください。

SDKバージョン4.8.0以降、AppsFlyerはgoogle_advertising_idを自動的に収集します。

Google Advertising IDを収集する要件は、バージョン4.7.X以前のSDKにのみ関連します。

計測を有効にするには、少なくとも1つのユニークな端末識別子を収集する必要があり、以下の識別子が使用可能です。：GAID / Android ID / IMEI / OAID

GAID - Google Advertising ID

Google Play 開発者サービスを含んでいるアプリからは自動的に収集されます。 GAIDが利用可能な場合には、Google Playポリシーを違反しないために、IMEIおよびAndroid IDはアプリで収集しないでください 。

IMEIとAndroid ID

デフォルトでは無効になっています。 Google Play 開発者サービスを含まないアプリについてのみ収集できます。
注： 2019年後半にリリースされた Android 10（APIレベル29） から、IMEIパラメーターへのアクセスが制限されています。

これらのIDをAppsFlyerに送信するには：

1. アプリを開いて、端末のIMEIやAndroid IDを収集します。
2. start のメソッドを呼び出す前に、次のAPIを呼び出してください。
   

   AppsFlyerLib.getInstance().setImeiData("IMEI_HERE");
   AppsFlyerLib.getInstance().setAndroidIdData("ANDROID_ID_HERE");

OAID - Open Advertiser Identifier

OAIDの実装ガイド

端末ID収集のオプトアウト

開発者は、次のAPIを使用してIMEI、Android ID、OAIDの収集をオプトアウトすることも可能です。

AppsFlyerLib.getInstance().setCollectIMEI(false);
AppsFlyerLib.getInstance().setCollectAndroidID(false);
AppsFlyerLib.getInstance().setCollectOaid(false);

稀ではあっても場合によっては、法律やプライバシー遵守のために、すべてのSDKにおける計測を停止しなければならないケースがあるかと思います。その場合、isStoppedのAPIを利用可能です。このAPIが呼び出されると、AppsFlyerのSDKは動作を停止し、AppsFlyerサーバーとの通信は何も発生しなくなります。

AppsFlyerLib.getInstance().isStopped(true,context);

ユーザーのオプトアウトには、さまざまなシナリオがあります。AppsFlyerでは、アプリに適したシナリオにあわせて正しい手順を守り、実装するよう推奨します。

なお、同じAPIにてfalseを渡して呼び出すことにより、SDKを再アクティブ化することができます。

AppsFlyerLib.getInstance().start(getApplicationContext(),AF_DEV_KEY);

ユーザーのインストール、イベント、セッションの計測を明示的に匿名化するには、SDKの初期化中にこのAPIを使用してください。

public void anonymizeUser(boolean isDisabled);

使用例：

AppsFlyerLib.getInstance().anonymizeUser(true);

anonymizeUser を false に設定することで、データの計測を再開できます。

場合によっては、アドネットワークやパートナーに対する特定ユーザーのユーザーレベルのデータ共有を停止したい場合があるかと思います。その理由としては：

• CCPAやGDPRのようなプライバシーポリシー
• ユーザーによるオプトアウト
• 一部パートナー（広告ネットワーク/第三者ツール）との競合

AppsFlyerでは、一部またはすべてのパートナーとのデータ共有を停止するための、2つのAPIメソッドを用意しています。

• setSharingFilter： 広告主がデータ取得から 特定の アドネットワークや連携パートナーを 除外する ために使用するものです。
• setSharingFilterForAllPartners: 広告主が すべての アドネットワーク / 連携パートナーに対して、データを共有しないようにするために使用します。

これらのフィルタリングメソッドは、SDK V5.4.1からサポートされています。

このフィルタリングメソッドは、SDK が初期化される毎に呼び出される必要があり、セッション全体に影響を与えます。 このフィルタを設定する必要があるかどうかを判断するのに時間がかかる場合には、SDKの初期化を遅延させてください。

最初のstartの呼び出しよりも前に、このメソッドがアクティブ化された場合 ：

• SRN経由のユーザーはOrganicユーザーと見なされ、そのユーザーのデータは連携パートナーとも共有されません。
• 通常のアドネットワーク(SRN以外)経由のユーザー は、AppsFlyer上で正しく媒体へ紐付けされますが、ポストバック、API、ローデータレポート、またはその他の方法においてアドネットワークへデータは共有されません。

現在、これらのメソッドを使用してアンインストールに関するデータをフィルタリングすることはできませんが、AppsFlyerの 連携設定ページ を使用して、各パートナーへのアンインストールイベントのポストバック送信は停止することができます。