AppsFlyer SDKの実装 - Unity

AFレシーバーとパーミッションのAndroidManifest.xmlへの設定

<!-- receiver should be inside the <application> tag -->
<receiver android:name="com.appsflyer.MultipleInstallBroadcastReceiver" android:exported="true">
        <intent-filter>
                <action android:name="com.android.vending.INSTALL_REFERRER" />
        </intent-filter>
</receiver>
<!-- Mandatory permission: -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

必須パーミッションの設定

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" />

AndroidManifest.xmlのBroadcastReceiverの設定

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

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

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

xCode向けにUnityでプロジェクトを構築後、フレームワークを以前追加しなかった場合は、Security.FrameworkをxCodeのLinked Frameworks and Librariesに追加する必要があります。

iOS Apple Search Ads

以下を追加します。

AdSupport.framework

AppsFlyerは、このフレームワークが含まれている場合に限りIDFAを収集します。このフレームワークを追加しない場合、Facebook、Twitter、その他の大半の広告ネットワークを計測できないことになります。

iAd.framework

Apple Search Adsの計測に必須であるため、このフレームワークをアプリのプロジェクトに追加することを強くお勧めします。

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

public String getAppsFlyerId();

使用例：

string AppsFlyerUID = AppsFlyer.getAppsFlyerId();

アプリで使用される通りにユーザーIDを設定します。

ユーザーIDを設定するには、次のメソッドを呼び出します。

AppsFlyer.setCustomerUserID("someId");

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

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

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

これらのIDをAppsFlyerに明示的に送信するには、開発者は以下のAPIを使用することができます。

AppsFlyer.setAndroidIdData(string)
AppsFlyer.setImeiData(string)

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

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

AppsFlyer.setCollectAndroidID(bool) 
AppsFlyer.setCollectIMEI(bool)

アプリにAdSupport.frameworkが含まれる場合、AppsFlyerではIDFA（広告主用のID）とIDFV（ベンダー用のID）を自動的に収集します。

アンインストールするには、オペレーティングシステムごとの手順に沿って操作します。

using Firebase.Messaging;
using Firebase.Unity;

Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;

public void OnTokenReceived
    (object sender, Firebase.Messaging.TokenReceivedEventArgs token) { 
        AppsFlyer.updateServerUninstallToken (token.Token);
}

<uses-permission android:name="android.permission.WAKE_LOCK" />
<permission android:name="android.appsflyer.sampleapp.permission.C2D_MESSAGE"
    android:protectionLevel="signature" />
<uses-permission android:name="android.appsflyer.sampleapp.permission.C2D_MESSAGE" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />

<receiver
    android:name="com.google.android.gms.gcm.GcmReceiver"
    android:exported="true">
    <intent-filter>
        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
    </intent-filter>
</receiver>

AppsFlyer.setGCMProjectNumber("Your_GCM_Project_Number");

void Start () {
   // register to push notifications
       UnityEngine.iOS.NotificationServices.RegisterForNotifications(UnityEngine.iOS.NotificationType.Alert | UnityEngine.iOS.NotificationType.Badge | UnityEngine.iOS.NotificationType.Sound);
       Screen.orientation = ScreenOrientation.Portrait;
}   void Update () {
       if (!tokenSent) { // tokenSent needs to be defined somewhere (bool tokenSent = false)
           byte[] token = UnityEngine.iOS.NotificationServices.deviceToken;           
           if (token != null) {     
               AppsFlyer.registerUninstall (token);
               tokenSent = true;
           }
       }    
}

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

handlePushNotification(Dictionary<string, string> payload)

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

例：

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

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

AppsFlyer allows you to track and attribute installs originating from a cross promotion of one of your apps from within the current app the user has. Cross promoting apps can be a major growth factor in driving additional installs for your apps.

For details, see the Cross Promotion Tracking article, here.

AppsFlyer allows you to track and attribute installs originating from user invites within your app. Allowing your existing users to invite their friends and contacts as new users to your app can be a key growth factor for your app.

For details, see the User Invite Tracking article, here.

AFInAppEvents.CURRENCY

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

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

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

public void setCurrencyCode(String currencyCode);

使用例：

setCurrencyCode(string currencyCode)

アプリ内購入のレシート検証を行うには、オペレーティングシステムごとの手順に沿って操作します。

//コールバックを取得する
//AppsFlyer.createValidateInAppListener("AppsFlyerTrackerCallbacks", 
"onInAppBillingSuccess", "onInAppBillingFailure");
AppsFlyer.validateReceipt(stringpublicKey, string purchaseData, 
string signature, string price, string currency, Dictionary additionalParametes);

AppsFlyer.createValidateInAppListener("AppsFlyerTrackerCallbacks", "onInAppBillingSuccess", "onInAppBillingFailure");

AppsFlyer.setIsSandbox(true);
AppsFlyer.validateReceipt(stringproductIdentifier, string price, string currency,
string transactionId, Dictionary additionalParametes);

購入検証の応答は、AppsFlyerTrackerCallbacks.csクラスでトリガーされます

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

public void setDeviceTrackingDisabled(boolean isDisabled);

使用例：

AppsFlyer.setDeviceTrackingDisabled(true);

setMinTimeBetweenSessions(int seconds)

使用例：

AppsFlyer.setMinTimeBetweenSessions(10);

Note that setting a high value to the custom time between launches may badly impact APIs relying on sessions data, such as deep linking.

現在、Unityでは使用できません。

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タグを配置します。

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

In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API. Once this API is invoked, our SDK no longer communicates with our servers and stops functioning.

AppsFlyer.stopTracking(true);

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

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.

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

Dictionary<string, string> CustomDataMap = new Dictionary<string, string>();
CustomDataMap.Add("custom_param_1", "value_of_param_1");
AppsFlyer.setAdditionalData(CustomDataMap);

Android Only

You can programatically set a pre-installed media source, from Unity, using the following API:

setPreinstallAttribution(string MediaSource, string Campaign, string Site_Id);

For details on native implementations, click here.