PBA向け Web Server-to-ServerイベントAPI（Web-S2S）

APIの実装には、管理画面から取得できる以下の認証情報が必要です。

• Bundle ID（Brand Bundle ID）
• Web Dev key

認証情報の取得方法：

1. AppsFlyerの上部メニューからマイアプリ > ブランドバンドルを表示を選択します。
   バンドルの一覧が表示されます。
2. 適切な内容をコピーして記録します：
   • Brand bundle ID
   • Web dev key

Web S2S API 基本仕様

 setCuIdの Curl サンプル

curl --location --request POST 'https://webs2s.appsflyer.com/v1/bundleId/setcuid' \
--header 'Accept-Encoding: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"customerUserId": "1234567890abcdef",
	"afUserId":"9999999-f848-4963-a091-568f0bf9a361",
        "webDevKey" : "99999999-9999-9999-9999-999999999999"}

Payload パラメーターは、ユーザー識別子とイベントパラメータに分かれています。 

• User ID：少なくとも1つのユーザーIDパラメータを送信する必要があります。
• Event：必須パラメータと、必要に応じてオプションのパラメータを送信してください。

ユーザーIDパラメータ（少なくとも1つのパラメータを送信）

イベントパラメーター

curl --location --request POST 'https://webs2s.appsflyer.com/v1/bundleId/event' \
--header 'Accept-Encoding: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
	"customerUserId": "1234567890abcdef",
	"afUserId":"9999999-f848-4963-a091-568f0bf9a361",
    "webDevKey" : "99999999-9999-9999-9999-999999999999",
    "ip" : "192.0.2.1",
	"eventType":"EVENT",
	"timestamp" : 1234567890123,
	"eventName":"my_web_event",
	"eventRevenueCurrency" : "EUR",
	"eventRevenue" : 1234.56,
	
		"eventValue": {
		"purchase":{
		 "shoes": "color",
		 "quantity" : "3",
		 "Revenue" : "1234.56",
		 "Currency" : "ZAR"
		}
	}

}'

''' using the requests python package, install using pip install requests  '''
import requests
url = "https://webs2s.appsflyer.com/v1/bundleId/event"
payload = {
    "customerUserId": "1234567890abcdef",
    "afUserId": "9999999-f848-4963-a091-568f0bf9a361",
    "webDevKey": "99999999-9999-9999-9999-999999999999",
    "ip": "192.0.2.1",
    "eventType": "EVENT",
    "timestamp": 1234567890123,
    "eventName": "my_web_event",
    "eventRevenenuCurrency": "EUR",
    "eventRevenue": 1234.56,
    "eventValue":
        {
            "purchase":
            {
                "shoes": "color",
                "quantity": "3",
                "Revenue": "1234.56",
                "Currency": "ZAR"
            }
        }
    }
headers = {
    'Accept-Encoding': 'application/json',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text.encode('utf8'))

テスト時は以下の手順でイベントを送信してください。

1. イベントを送信する
2. HTTPレスポンス 200 OK を確認 / エラーがあればメッセージに従い修正
3. UTCタイムゾーンの午前0時のあと数時間待機し、PBA Raw Dataにイベントが表示されるまで待つ（PBAデータの処理は1日1回のみのため） 

  Web Dev Key の取得方法：

1. AppsFlyerの管理画面内で、[ My Apps ]のタブに移動してください。
2. [ブランドバンドルを表示]をクリックします。

   

3. 必要な Web Dev Key をコピーしてください。 

• afUserIdは、ユーザーが最初にウェブサイトを訪問した際に Web SDK によって割り当てられる一意の識別子です。
• afUserIdが必要な場合は、以下の方法のいずれかを使用してください。

HTTP CookieヘッダーからafUserIdを取得

• afUserIdは、ユーザーがサイトへアクセスする際に訪問者のブラウザから送信されます。
•  必要に応じてHTTP cookie ヘッダーから抽出してください。

訪問者のブラウザでafUserIdを確認

•  トラブルシューティングやデバッグの目的で、訪問者のブラウザ上でafUserIdを確認できます。
• afUserIdを確認するには、訪問者がWeb SDKが実装されたページを少なくとも一度訪問している必要があります。 
• afUserIdを含むCookieは、自社ドメインに対するファーストパーティCookieです。
• 以下の手順はChrome 81を使用して作成されています。ブラウザやOSによって手順が多少異なる場合があります。

訪問者のブラウザから afUserId を取得する方法：

1. ブラウザで自社Webサイトを開きます。
2. 右クリックし、Inspect（検証）を選択します。
   ブラウザの検査ウィンドウが開きます。

   

3. (A) Applicationタブを開きます。
4. サイドメニューにて、(B) [Cookie] を展開します。
5. 自社Webサイトを選択します。表示されない場合は、ブラウザをリフレッシュしてください。
6. (C) filterフィールドに、afUserIdを入力します。
   すると afUserIdの値が表示されます。

• 症状：HTTPのリターンコードが返されない
  ソリューション： AppsFlyerサーバーを許可リストに追加してください