PBA向けWebサーバー間イベントAPI (Web-S2S)

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

• バンドルID（ブランドバンドルID）
• Web Dev key

認証情報の取得方法：

1. 上部のメニューバーから、My Appsを選択し、ブランドバンドルを表示をクリックします。バンドルの一覧が表示されます。
2. 適切な内容をコピーして記録します：
   • ブランドバンドルID
   • Web Dev Key

Web S2S API の基本

 Curl の setCuId 例

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

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

• ユーザーID：少なくとも1つのユーザー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. 200 OKのリターンコードが受信できていることを確認します。できない場合は、リターンコードとエラーメッセージをもとに修正を行います。
3. UTCタイムゾーンの午前0時のあと数時間待機し、PBAローデータレポートにイベントが記録されていることを確認してください。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 を表示します。
• これが利用可能になるためには、訪問者は最初に少なくとも一度はWeb SDKを持つページを訪問している必要があります。 
• afUserId を含む cookie は、ドメインに関連するファーストパーティーcookieです。
• 次の手順は、Chrome 81 を使用して作成されました。さまざまなブラウザとオペレーティングシステムにより、手順に多少違いがある可能性があります。

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

1. ブラウザにてウェブサイトに移動します。
2. 右クリックして、 検査する
   ブラウザのインスペクト要素ウィンドウが開きます。

   

3. (A) [Application] タブへ移動します。
4. サイドメニューにて、(B) [Cookie] を展開します。
5. ウェブサイトを選択します。表示されない場合は、ブラウザを更新します。
6. (C) [Filter] 項目にて、afUserIdを入力します。
   afUserID の値が表示されます。 

• 症状：HTTPリターンコードが返されない
  解決策：AppsFlyer サーバーを許可リストに追加します。