概要:Webサーバー間(Web-S2S)イベントAPIを使用して、Web SDKで送信されないイベントやコンバージョンをPBAに送信します。
PBA向けWebサーバー間イベントAPI
People-Based AttributionのWeb-S2S APIは、Web SDKを補完するものです。Webサイトに関連して発生するイベントのうち、Web SDKでは取得できないイベントを送信できます。たとえば、Webサイトの訪問者(Webユーザー)がオンライン決済イベントを発生させ、バックエンドシステムが処理する場合などです。バックエンドは、処理後にS2S APIを使用してAppsFlyerにイベントを送信します。
S2S APIで送信したイベントは、以下のように扱われます。
- Web SDKから送信されたイベントと同様に記録されます。
- コンバージョンイベントに設定されている場合、PBAダッシュボードに含まれます。
- PBAローデータでは、event_sourceフィールドにweb S2Sが設定されます。
APIの使用方法
以下の説明に従って、API呼び出しを作成してください。
| 番号 | 項目 | 補足 |
|---|---|---|
| 1 | 一意のユーザーID | |
| 2 | タイムスタンプ |
|
| 3 | 収益と通貨 | eventValueに収益と通貨を含める場合も、eventRevenueCurrencyとeventRevenueを設定する必要があります。ダッシュボードでは、これらのパラメータを使用するためです。 |
APIの基本情報
APIの実装には、ダッシュボードで確認できる以下の認証情報が必要です。
- バンドルID(ブランドバンドルID)
- Web Devキー
認証情報を取得するには:
- AppsFlyerの上部メニューで、マイアプリ > [ブランドバンドルを表示]を選択します。
バンドルの一覧が表示されます。 - 対象バンドルの以下の値をコピーして控えます。
- ブランドバンドルID
- Web Devキー
Web S2S APIの基本情報
| パス |
|
| HTTPメソッド | POST |
| 対応するコンテンツタイプ |
application/json |
| JSONペイロードの制限 |
JSONペイロードのサイズ:最大1KB |
| レート制限 |
POSTリクエストの上限:1分あたり60,000件。上限の引き上げについては、担当CSMにお問い合わせください。 |
| TLS |
|
setCuIdメソッド
| メソッド名 |
setCuId |
| 用途 |
Webサイト訪問者にCUIDを関連付ける際に使用します。たとえば、Webの |
| メソッドのパス |
|
| ペイロード |
JSONペイロードは、以下のパラメータで構成されます。すべてのパラメータが必須です。 |
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"}
eventメソッド
| メソッド名 |
event |
| 用途 | 送信 |
| メソッドのパス |
|
| 詳細情報 | 本記事のeventメソッドの詳細セクションには、ペイロードの詳細、curlサンプル、Pythonサンプル、テスト方法が記載されています。 |
eventメソッドの詳細
ペイロードのパラメータ
ペイロードのパラメータは、ユーザー識別子とイベントパラメータに分かれます。
- ユーザーID:ユーザーIDのパラメータを少なくとも1つ送信する必要があります。
- イベント:必須パラメータに加え、必要に応じて任意のパラメータを送信します。
ユーザー識別子のパラメータ(少なくとも1つ送信)
| ユーザーIDのパラメータ | 説明 |
|---|---|
|
customerUserId |
カスタマーユーザーID(CUID)は、ユーザー側で設定する一意の識別子です。
|
|
afUserId |
Webサイトを訪問する各ユーザーに、Web SDKが割り当てる一意のユーザーIDです。 Cookieの値をバックエンドサーバーに渡す必要があります。
|
イベントパラメータ
| パラメータ名 | 必須 | 説明 |
|---|---|---|
|
webDevKey |
はい |
ダッシュボードで確認できるWeb Devキーを設定します。
|
| eventType | はい |
AppsFlyerが内部で使用するイベント属性の識別子です。常にEVENTを設定します。
|
| eventName | はい |
|
| timestamp | いいえ |
イベントの発生時刻(ミリ秒単位)です。 13桁のUnixタイムスタンプとして送信します。
|
| eventValue | いいえ |
イベントの内容を表すパラメータのマップです。商品のSKUや明細ごとの価格など、詳細なアプリ内イベントの情報を送信するために使用します。
|
| eventRevenueCurrency | いいえ |
収益イベントの通貨コードです。ISO 4217に準拠した3文字の通貨コードを使用します。
|
| eventRevenue | いいえ |
イベントに関連付ける収益(金額)です。 注意: eventValueで収益を送信する場合は、eventRevenueでも送信し、eventRevenueCurrencyを設定してください。
|
| いいえ | このパラメータは非推奨で、将来システムから削除される予定です。代わりにeventValueを使用してください。 | |
| いいえ |
このパラメータは非推奨で、将来システムから削除される予定です。代わりにeventValueを使用してください。 |
|
| referrer | いいえ |
HTTPリファラ
|
| userAgent | いいえ |
ブラウザからサーバーに送信されるUser-Agentリクエストヘッダーです。
|
| ip | いいえ |
ユーザーのIPアドレス
|
curlサンプル
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"
}
}
}'
Pythonサンプル
''' 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'))
テスト
テストのために、以下の手順でイベントを数件送信してください。
- イベントを送信します。
- 戻りコードが200 OKであることを確認します。それ以外の場合は、戻りコードとエラーメッセージを参照して修正してください。
- 送信したイベントがPBAローデータに反映されるまで、UTC午前0時から数時間お待ちください。 PBAデータは1日に1回処理されるため、待機する必要があります。
補足情報
Web SDKのafUserIDの取得
-
afUserIdは、ユーザーがWebサイトを初めて訪問したときに、Web SDKが設定する一意の識別子です。 afUserIdが必要な場合は、以下のいずれかの方法で取得してください。
HTTP CookieヘッダーからのafUserIdの取得
-
afUserIdは、Webサイトへのリクエスト時に、訪問者のブラウザから送信されます。 - 必要に応じて、HTTP Cookieヘッダーから取得してください。
訪問者のブラウザでのafUserIdの確認
-
afUserIdは、トラブルシューティングやデバッグのために、訪問者のブラウザで確認できます。 - 確認するには、訪問者がWeb SDKを実装したページに、少なくとも1回アクセスしている必要があります。
-
afUserIdを保持するCookieは、自社ドメインのファーストパーティCookieです。 - 以下の手順は、Chrome 81を使用して作成されています。ブラウザやOSによって、操作が異なる場合があります。
訪問者のブラウザからafUserIdを取得するには:
レスポンスコード
| レスポンスコード | メッセージ | 対応方法 |
|---|---|---|
| 200 | OK | |
| 404 | Not found |
|
| 400 | Bad request |
|
トラブルシューティング
- 症状:HTTP戻りコードが返されない。
解決方法:AppsFlyerサーバーを許可リストに追加してください。
リリースノート
| 日付 | エンドポイントのバージョン* | 補足 |
|---|---|---|
| 2020-05-12 | 1 | 初回リリース |
| 2020-05-24 | 1 | |
* バージョン番号は、エンドポイントのバージョン番号を示します。 https://webs2s.appsflyer.com/v1/method
|
||