サーバー間 (S2S) イベントAPI for モバイル

• ペイロードパラメータは、1 つ以上のデバイス識別子で構成されます（オペレーティングシステムによって異なります）。
• デバイス識別子を送信できない場合はどうしますか？
  • ユーザーが広告トラッキングの制限をオンにしている (LAT端末) の場合や、iOS 14を使用しており ATT に同意していないの場合など、特定の理由により広告IDを送信できないことがあります。IDFAがある場合は、送信してください。
  • 広告ID／デバイス識別子を送信しないと次のような問題が起こる場合があります。
    • ポストバックの問題：メディアソースはデバイス識別子なしでポストバックを受信するため、メディアソース側でユーザーと成果を紐づけることができません。
    • オーディエンスセブメントとルールの失敗：オーディエンスのルールセットは識別子が必要です。
      S2Sイベントごとに、ルールセットで使用する IDタイプに従ってデバイスID またはカスタマーユーザーID を送信することが常にベストプラクティスです。
      ただし、AppsFlyer識別子が他の手段（SDKまたは過去のS2Sイベント）で送信された場合、イベントで識別子が送信されていなくても、新しいアプリ内イベントは正しいユーザーにマッチングされます。

"custom_data" : {"key_group" : { 
"key_a1" : "value a1", 
"key_a2" : "value a2" 
},
"key_b" : "value b"
}

curl --location --request POST 'https://api2.appsflyer.com/inappevent/<app_id_placeholder>'\
--header 'authentication: <dev_key_placeholder>
' \
--header 'Content-Type: application/json' \
--data-raw '{
  "appsflyer_id": "9999999999999-9999999999999999999",
	"advertising_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
	"customer_user_id" : "example_customer_id_123",
	"ip": "199.0.2.1",
	"app_version_name" : "example_version_name",
	"eventTime" : "2020-02-25 12:00.000",
	"eventName": "af_purchase",
	"eventCurrency": "ZAR",
        "os" : "14.6",
"att" : 3,
	"eventValue": 
	"{
		\"af_revenue\": \"1006\",
		\"af_content_type\": \"wallets\",
		\"af_content_id\": \"15854\",
		\"af_quantity\" :\"1\"
   }"
}
'

特記事項：

• テストには、非オーガニックインストールのAppsFlyer IDを使用してください。そうすればイベント計測はリアルタイムで行われますが、オーガニックユーザーのイベント計測の場合、最長数時間の遅延を伴います。
• 一部のイベントフィールドは、ユーザーのインストールアトリビューションイベントを使用して入力されます。たとえば、時間とメディアソースをインストールします。 

テスト端末を非オーガニックインストールとして紐付けるには：

1. S2Sメッセージをテストするために、カスタム計測リンクを用意してください。リンク上のメディアソースパラメーターを s2s_test と設定し、計測リンクの例に示すように、リンク上に広告ID（GAID、IDFA等）を設定します。
2. テストデバイスの登録
3. テスト端末からアプリをアンインストールしてください。
4. テスト端末にリンクを送信してください。
5. リンクをクリックしてください。
6. アプリをインストールして起動してください。
7. 管理画面のオーバービュー上で、インストールが計測されているか確認してください。
8. S2Sメッセージ送信で使用するAppsFlyer IDを取得してください。

S2Sメッセージをテスト送信するには ：

1. 先程の工程で取得したAppsFlyer IDを使用して、S2Sメッセージを準備してください。コード例については、以下を参照してください。
2. S2Sメッセージを送信してください。
3. 次のいずれかを実行して、S2SメッセージがどのようにAppsFlyerに記録されたかを確認してください。
   • アプリ内イベントのローデータレポートをダウンロードしてください。送信したデータがローデータレポートに反映されるのに、イベントを送信後15分ほど掛かることがあります。 
   • Push API （ Postman および Webhookサイトなどのツール利用をおすすめします。）
4. 以下を確認してください。
   • S2Sメッセージで送信された値が、レポートに正しく入力されているか特に、イベントの日付、イベントの通貨、イベントの収益、イベントの値に注意してください。
   • アトリビューションソースとインストールタイムはAppsFlyerによって入力されます。
   • SDKバージョンなどのSDK自体によって提供される値は入力されません。

Android

https://app.appsflyer.com/<app_id>?pid=s2s_test&c=test&advertising_id=<GAID>

iOS

https://app.appsflyer.com/<app_id>?pid=s2s_test&c=test&idfa=<IDFA>

• 広告ID / デバイス識別子は、FacebookやGoogle AdsなどのSRNへポスバックをするために必須です。IDを送信できない場合は、ポストバックを送信できないということを考慮してください。
• AppsFlyer IDのみを送信する場合、アプリ内イベントは記録され正常に成果が紐づきます。

AppsFlyerがS2Sのアプリ内イベントを処理するとき、アトリビューションフィールドはAppsFlyer IDを使用して入力され、アプリ内イベントよりも前に発生していた関連するインストールイベントを識別します。

つまり、AppsFlyerが非オーガニックサーバー間アプリ内イベントに関連付けるデータは、オーガニックサーバー間アプリ内イベントに紐付けられないということです。

パラメーターに入力する特定の値を取得するには、バックエンドロジックが必要です。以下では、AppsFlyer IDの取得方法について説明しています。

• AppsFlyer IDは必須であり、イベントの紐付けに使用されます。
• このIDはユーザーが最初にアプリをインストールしたときに発行されます。
• CUIDをAppsFlyer IDにマップできるようにするには、アプリでCUIDを設定する必要があります。

どのユーザーがどのイベントを実行したかを簡単に把握できるようにするには、以下のフローを実装してください。

• ユーザーがアプリをインストールしたときにカスタマーユーザーID を付与（設定）してください。
• AppsFlyerのローデータレポートにCUIDとAppsFlyer IDが記録されるので、AppsFlyerのPush APIなどのデータ提供機能を利用して取得してください。 
• ローデータレポートを使って、CUIDとAppsFlyer IDを照合させてください。 
• AppsFlyer IDは、実装したSDKからも取得することが可能です。(Android/iOS)
• お客様自身のデータベース上でも、AppsFlyer IDをカスタマーユーザーIDにマッピングしてください。（将来的な使用においても重要です）。

AppsFlyer IDをお客様側のカスタマーユーザーIDにマッピングすると、どのユーザーがどのイベントを実行したかを簡単に知ることができます。その後、他の値（イベント値、イベント通貨、イベント時間など）を取得してサーバー間アプリ内イベントを送信できます。 

{
  "appsflyer_id": "1415211453000-6513894",
	"advertising_id": "38412345-8cf0-aa78-b23e-10b96e40000d",
	"eventName": "af_purchase",
	"eventValue": 
	"{
		\"af_revenue\": \"6\",
                \"af_currency\" \"USD"\",
		\"af_content_type\": \"wallets\",
		\"af_content_id\": \"15854\",
		\"af_quantity\" :\"1\"
   }",
	"eventCurrency": "USD",
	"ip": "1.2.3.4",
	"eventTime": "2014-05-15 12:17:00.000"
}

appsflyer_id はサーバー間イベントメッセージの必須パラメータです。AppsFlyerでは、このパラメーターを使用して、オリジナルの端末とメディアソースにイベントを紐付けます。 次のいずれかの方法でIDを取得できます。

• AppsFlyer SDKのAPIを呼んでモバイル端末から取得する場合：Android / iOS
• 次のいずれかを使用してAppsFlyerプラットフォームから： Pull API / Push API / インストールのローデータエクスポート

購入がキャンセルされた場合などには、マイナスの収益の値を持つイベントも送信可能です。 af_revenue のパラメータには、マイナスの値も使用することができます。 

af_quantity のパラメータも使用している場合には、利用されているシステム側のロジックによっては、マイナスの値を設定したいケースもあるかと思います。AppsFlyerでは af_quantity を収益の集計などには使用しませんのでご安心ください。

マイナスの収益を送る例

{{
	"eventName": "cancel_purchase",
	"eventValue": 
	"{
		\"af_revenue\": \"-6\",
		\"af_content_type\": \"wallets\",
		\"af_content_id\": \"15854\",
		\"af_quantity\" :\"1\"
   }",
	"eventCurrency": "USD",
	
}}

• エンドポイント：使用されているエンドポイントが正しいことを確認してください。
• ペイロードに必須のパラメータが含まれていることを確認してください。詳細はこちらです。
• イベント計測に使用しているAppsFlyerIDが、（このガイドで提示しているサンプルのIDでなく）そのアプリがインストールされている実際のappsflyer_idであることを確認してください。詳細はこちらです。
• S2Sイベントは、イベントの一括送信をサポートしていません。各S2Sイベントは個別に送信する必要があります。 
  • 非同期メソッドを使用してイベントを送信して、応答時間を短縮できます。
• オーバービューの画面で指定する日付は、イベントの発生日ではなく、アプリのインストール日（LTV）になります。
  • 正しい日付範囲を選択していることを確認してください。
  • 管理画面でイベントを確認するには、管理画面で選択した日付が、イベントの発生日ではなく、端末（appsflyer_id）のインストール日と一致していることを確認してください。
    
    
• イベントローデータレポート：日付範囲は、インストール日ではなくイベントの発火日が関係します。 

S2Sイベントを送信しても、その収益が記録されない場合には、送信したJSONが文字列化されているかどうかを確認してください。最も重要な部分は、JSONのイベント値パラメーターです。次の例に示すように、文字列化する必要があります。

"{\"af_revenue\":\"6\" ,\"af_content_type\":\"wallets\"}"

文字列（String）化されていない場合、イベント値は正しく処理されず、収益は記録されません。

収益の値は書式化しないでください。小数点のコンマを含むことができます。通貨記号や通貨コード、, のような値の区切り文字も含めないでください。収益の値の冒頭には - (マイナス)を付与することも可能です。

• 有効な値の例: 123, -123.45, 123.456 
• 無効な値の例: 1,234.56, 1,234

ローデータの項目は、S2Sのコールで送信された値と、インストールイベントのデータを使用して入力されます。AppsFlyerのSDKを使って計測するアプリ内イベントと似たような挙動になりますが、まったく同一ではなくいくつかの違いがあります。具体的には、次の項目はS2Sイベントでは入力されません。

• WIFI
• Operator
• Language
• Device Type
• Device Category
• アプリバージョン： app_version_name を使用して設定します。
• App Name