AppsFlyer SDK実装ガイド - Android

AppsFlyerの一意のデバイスIDは、アプリが新しくインストールされるたびに作成されます。AppsFlyerの一意のIDを取得するには、次のAPIを使用します。

public String getAppsFlyerUID(Context context);

使用例：

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

顧客ユーザーIDを設定するには：

public void setCustomerUserId(String id);

使用例：

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

顧客ユーザーIDの取得

最初の起動後に顧客ユーザーIDの値を再度設定することのないように、以下を使用して値が空かどうかを確認できます。 

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

顧客ユーザーIDの詳細については、こちらをクリックしてくだい。

利用可能な暗号化方法：Sha1、MD5、SHA256、プレーン

例：

public void setUserEmails(String... emails);

使用例：

AppsFlyerLib.getInstance().setUserEmails(AppsFlyerProperties.EmailsCryptType.MD5, "email1@domain.com","email2@domain.com", ….);

SDKバージョン4.8.0以降、AppsFlyerはgoogle_advertising_idを自動的に収集します。Google Advertising IDを収集する要件は、バージョン4.7以前のSDKにのみ関連します。

デフォルトでは、OSバージョンがKitKat（4.4）より新しく、デバイスにGoogle Play Servicesが含まれている場合（SDKのバージョンが4.8.8以前でGoogle Play Servicesが必要な特定のアプリ）、IMEIとAndroid IDはSDKによって収集されません。 

これらのIDをAppsFlyerに明示的に送信するには、開発者は以下のAPIを使用できます。コードはstartTrackingの前に追加します。

AppsFlyerLib.getInstance().setImeiData("IMEI_DATA_HERE");
AppsFlyerLib.getInstance().setAndroidIdData("ANDROID_ID_DATA_HERE");

アプリにGoogle Play Servicesが含まれていない場合、IMEIとAndroid IDはSDKによって収集されます。ただし、 Google Play Servicesを使用したアプリの場合、IMEIの収集がGoogle Playのポリシーに違反するため、収集を行わないようにしてください。

開発者は、これらのAPIを使用することで、IMEIとAndroid IDの収集をオプトアウトすることができます。

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

このプロセスを完全かつ正確に完了させるには、こちらをお読みください。

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

この機能を有効にするには、通知をクリックすると起動されるあらゆるアクティビティのonCreateメソッド内で次のメソッドを呼び出します。

AppsFlyerLib.getInstance().sendPushNotificationData(this);

データペイロードには、関連するキー/値文字列と共にオブジェクト：afが含まれている必要があります。

例：

{  
   "data":{  
      "score":"5x1",
      "time":"15:10",
      "af":{  
         "c":"test_campaign",
         "is_retargeting":"true",
         "pid":"push_provider_int"
      }
   }
}
{

{  
   "data":{  
      "score":"5x1",
      "time":"15:10",
      "click_action":"com.example.someAction",
      "af":{  
         "c":"test_campaign",
         "is_retargeting":"true",
         "pid":"push_provider_int"
      }
   }
}

AFInAppEventParameterName.CURRENCY

がアプリ内イベントの一部として送信されない場合に使用されます。

USD（米国ドル）がデフォルト値です。使用可能なISO通貨コードは、こちらで確認することができます。

通貨コードを設定するには、以下のAPIを使用します。

public void setCurrencyCode(String currencyCode);

使用例：

AppsFlyerLib.getInstance().setCurrencyCode("GBP");

AppsFlyerのSDKは、アプリ内購入のサーバー検証を提供します。購入検証トラッキングを設定するには、onActivityResult関数内でvalidateAndTrackInAppPurchaseメソッドを呼び出します。

この呼び出しにより、「af_purchase」アプリ内イベントが自動的に生成されます。

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

この呼び出しには、「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);
          }
});

使用例：

protected void onActivityResult(int requestCode, int resultCode, Intent data) {
   if (requestCode == 1001) {
       String purchaseData = data.getStringExtra("INAPP_PURCHASE_DATA");
       String dataSignature = data.getStringExtra("INAPP_DATA_SIGNATURE");
       if (resultCode == RESULT_OK) {
           HashMap<String,String> event = new HashMap<>();
           event.put(AFInAppEventParameterName.PRICE,"9");
           AppsFlyerLib.getInstance().validateAndTrackInAppPurchase(getApplicationContext(),publicKey, dataSignature, purchaseData, "3.00", "ILS", event);
       }
   }
} 

ユーザーのインストール、イベント、セッションのトラッキングを明示的に匿名化するには、SDKの初期化中にこのAPIを使用します。

public void setDeviceTrackingDisabled(boolean isDisabled);

使用例：

AppsFlyerLib.getInstance().setDeviceTrackingDisabled(true);

トラッキングを再開するには、deviceTrackingDisabled（falseに設定されている）を再度呼び出します。

AppsFlyerLib.setMinTimeBetweenSessions(int seconds);

アプリがバックグラウンドで実行されるユーティリティアプリの場合、このAPIをアクティビティのonCreate()で使用することができます。

public void reportTrackSession(Context context);

使用例：

AppsFlyerLib.getInstance().reportTrackSession(context);

Google Play以外からのインストールを計測するには、各APKに固有のチャネルやストア名を使用して、アプリのAndroidManifest.xmlでチャネルまたはストアを設定します。CHANNEL値では大文字と小文字を区別します。

例：

<meta-data android:name="CHANNEL" android:value="Amazon" />
<meta-data android:name="CHANNEL" android:value="Standalone"/>
<meta-data android:name="CHANNEL" android:value="Verizon" />

</application>タグの前にmeta-dataタグを配置します。

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

いくつかの極端なケースでは、法律とプライバシーの遵守のため、すべてのSDKトラッキングを停止する必要が出てくることがあります。この場合は、isStopTracking APIを使用できます。このAPIが呼び出されると、SDKはサーバーとの通信と動作を停止します。

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

There are several different scenarios for user opt-out. We highly recommend following the exact instructions for the scenario, that is relevant for your app.

In any event, the SDK can be reactivated by calling the same API, by passing false.

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

customerUserIDが設定されるまで、SDKの初期化を遅らせることができます。この機能を使用すると、customerUserIDが指定されるまで、SDKは動作を開始しません。このAPIを使用する場合、customerUserIDが指定され、トラッキングされるまで、すべてのアプリ内イベントと他のSDK API呼び出しが破棄されます。

To indicate that the SDK should delay initialization for the customer user id call

AppsFlyerLib.getInstance().waitForCustomerUserId(true);

immediately before the init() method. The rest of the SDK initialization should remain unchanged.

Once the customerUserID has been provided, call

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

to provide the SDK with the relevant customer user id and trigger the SDK to begin its normal tracking.

public class AFApplication extends Application {
   private static final String AF_DEV_KEY = ;
   @Override
   public void onCreate() {
       super.onCreate();
AppsFlyerConversionListener conversionDataListener = 
       new AppsFlyerConversionListener() {
           ...
       };
       AppsFlyerLib.getInstance().waitForCustomerUserId(true); 
AppsFlyerLib.getInstance().init(AF_DEV_KEY,getConversionListener(), getApplicationContext());
       AppsFlyerLib.getInstance().startTracking(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().setCustomerIdAndTrack("customer_id",this);
   }
}

setAdditionalData APIを使用するには、Segment、Adobe、Urban Airshipなど、複数の外部パートナーのプラットフォームとSDKレベルで連携する必要があります。このAPIは、プラットフォームの連携の記事に、 setAdditionalData APIが必要であると記載されている場合にのみ使用してください。
次に、AndroidでsetAdditionalDataを実装するコードの例を示します。

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

プリインストール済みアプリのアトリビューションをAndroidで行う場合、さまざまな方法があります。

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

If you want to receive a confirmation that the tracking request was successfully received by the AppsFlyer servers, it is possible to implement the AppsFlyerTrackingRequestListener listener.

The onTrackingRequestSuccess() callback method is invoked for every 200 response to an attribution request made by the SDK.

The onTrackingRequestFailure(String error) callback method is invoked for any other response and returns the response as the error string.

Implementation Example

AppsFlyerLib.getInstance().startTracking(this.getApplication(),"devKey", myListener());
private AppsFlyerTrackingRequestListener myListener() {   
    return new AppsFlyerTrackingRequestListener() {  
        @Override public void onTrackingRequestSuccess() { 
            Log.d("Debug", "Got 200 response from server");    
        }   @Override public void onTrackingRequestFailure(String error) { 
            Log.d("Debug", error); 
            }   
        }; 
    }