どのようにお手伝いできますか?

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

  • 更新

概要:Webサーバー間(Web-S2S)イベントAPIを使用して、Web SDKで送信されないイベントやコンバージョンをPBAに送信します。

5107_Infographic_Web_S2S_759x270_option1.jpg

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
  • 利用できる中で、ユーザーを最も確実に識別できる一意のIDを送信してください。ユーザーIDは、データ分析に大きく影響します。
  • customerUserIdを送信することを推奨します。利用できない場合は、Web SDKがWebサイトに設定するCookie IDであるafUserIdを送信してください。
  • カスタマーユーザーID(CUID)とafUserIdを関連付けるたびに、両方のIDを含むsetCuID()メッセージを送信してください。
2 タイムスタンプ
  • AppsFlyerは、受信したイベントのタイムスタンプを厳密に検証します。
    • 遅れて到着するイベント:イベントが、その発生日に対して設けられた24時間の受信猶予内に到着した場合、元のタイムスタンプのまま受け付けます。たとえば、月曜日のタイムスタンプ(2025-08-18 23:59 UTC)を持つイベントは、火曜日の23:59:59 UTCまでに送信されれば、そのタイムスタンプが維持されます。同じイベントを火曜日の23:59:59 UTCより後に送信すると、タイムスタンプはサーバーの受信時刻に上書きされます。
    • 未来のタイムスタンプ:実際の到着時刻より後のタイムスタンプは使用できません。このようなタイムスタンプも、サーバーの受信時刻に上書きされます。
  • タイムスタンプはUTCを基準とします。必要に応じて、パラメータに設定する前に、現地時刻からUTCに変換してください。
3 収益と通貨 eventValueに収益と通貨を含める場合も、eventRevenueCurrencyとeventRevenueを設定する必要があります。ダッシュボードでは、これらのパラメータを使用するためです。

APIの基本情報

APIの実装には、ダッシュボードで確認できる以下の認証情報が必要です。

  • バンドルID(ブランドバンドルID)
  • Web Devキー

認証情報を取得するには: 

  1. AppsFlyerの上部メニューで、マイアプリ > [ブランドバンドルを表示]を選択します。
    バンドルの一覧が表示されます。
  2. 対象バンドルの以下の値をコピーして控えます。
    • ブランドバンドルID
    • Web Devキー

Web S2S APIの基本情報

パス

https://webs2s.appsflyer.com/v1/bundleId/method

  • bundleId:ダッシュボードで確認できるアプリのバンドルIDです。 
  • methodは、以下のいずれかです。
    • event:送信対象のバックエンドイベントが発生した際に送信します。
    • setCuId:afUserIdとCUIDを関連付ける際に送信します。
HTTPメソッド POST
対応するコンテンツタイプ application/json 
JSONペイロードの制限 

JSONペイロードのサイズ:最大1KB

レート制限

POSTリクエストの上限:1分あたり60,000件。上限の引き上げについては、担当CSMにお問い合わせください。

TLS

setCuIdメソッド

メソッド名

setCuId

用途 

Webサイト訪問者にCUIDを関連付ける際に使用します。たとえば、WebのafUserIdとカスタマーユーザーIDを関連付けるたびに使用します。これにより、PBAは複数のソースから得たデータを照合できます。 Webサイト上のsetCustomerUserIdと同様の役割です。

メソッドのパス

https://webs2s.appsflyer.com/v1/bundleId/setcuid

ペイロード

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

用途 送信
メソッドのパス

https://webs2s.appsflyer.com/v1/bundleId/event

 詳細情報 本記事のeventメソッドの詳細セクションには、ペイロードの詳細、curlサンプル、Pythonサンプル、テスト方法が記載されています。

eventメソッドの詳細

ペイロードのパラメータ

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

  • ユーザーID:ユーザーIDのパラメータを少なくとも1つ送信する必要があります。
  • イベント:必須パラメータに加え、必要に応じて任意のパラメータを送信します。

ユーザー識別子のパラメータ(少なくとも1つ送信)

ユーザーIDのパラメータ  説明

customerUserId

カスタマーユーザーID(CUID)は、ユーザー側で設定する一意の識別子です。

  • AppsFlyerにイベントを送信する際は、送信方法にかかわらず、同じ識別子を使用してください。つまり、Web SDK、モバイルSDK、S2S APIで同じ識別子を使用します。
  • Web SDKのカスタマーユーザーID
  • 形式:文字列
  • 例:"customerUserId" : "663274"
  • 対応するローデータフィールド:customer_user_id

afUserId

Webサイトを訪問する各ユーザーに、Web SDKが割り当てる一意のユーザーIDです。 Cookieの値をバックエンドサーバーに渡す必要があります。

  •  Cookieの詳細:
    • 名前:afUserId
    • 値:この値をafUserIdに設定します。
    • ドメイン:website-domain
  • 例:"afUserId" : "unique_cookie_uuid"
  • 対応するローデータフィールド:af_web_id

イベントパラメータ

パラメータ名 必須 説明

webDevKey

はい

ダッシュボードで確認できるWeb Devキーを設定します。

  • 例:"webDevKey" : "ffffffff-ffff-ffff-ffff-ffffffffffff"
eventType はい

AppsFlyerが内部で使用するイベント属性の識別子です。常にEVENTを設定します。

  • 例:"eventType" : "EVENT"
eventName はい
  • PBA設定でマーケターが指定したコンバージョンイベントのリストに基づき、このパラメータでコンバージョンイベントとそれ以外のイベントを区別します。 
  • マーケターのコンバージョンの定義と一致する値を設定してください。
  • 形式:文字列
  • 例:"eventName" : "web_purchase"
  • 対応するローデータフィールド:event_name
timestamp いいえ

イベントの発生時刻(ミリ秒単位)です。 13桁のUnixタイムスタンプとして送信します。

  • タイムスタンプを送信しない場合は、サーバー時刻が設定されます。 
  • 到着が遅れたイベントには、その時点のサーバー時刻がタイムスタンプとして設定されます。 到着が遅れたイベントとは、イベント発生の翌日のUTC午前0時より後に到着したものを指します。たとえば、月曜日に発生したイベントは、火曜日のUTC午前0時より前に処理される必要があります。 
  • 現在のサーバー時刻より未来のタイムスタンプを持つイベントには、サーバー時刻が設定されます。
  • 形式:整数
  • 例:"timestamp" : 1584835200123
  • 対応するローデータフィールド:event_time
eventValue いいえ
イベントの内容を表すパラメータのマップです。商品のSKUや明細ごとの価格など、詳細なアプリ内イベントの情報を送信するために使用します。
  • 収益に関する注意このパラメータには、収益の詳細を設定できます。その場合も、eventRevenueとeventRevenueCurrencyを別途設定する必要があります。
  • 形式:JSON
  • 例:SKUがABC123、色が青、単価が3.99米ドルの商品情報を送信するには、eventValueを以下のように設定します。
    {"Purchase": {"sku" : "ABC123", "color": "blue", "unit_price":3.99,"currency": "USD"}}
  • 上限:1,000文字。超過した部分は切り捨てられるため、上限を超えないようにしてください。 
  • 対応するローデータフィールド:event_value
eventRevenueCurrency いいえ

収益イベントの通貨コードです。ISO 4217に準拠した3文字の通貨コードを使用します。

  • デフォルト:USD
  • 形式:文字列
  • 例: "eventRevenueCurrency" : "EUR"
  • 対応するローデータフィールド:event_revenue_currency
eventRevenue いいえ 

イベントに関連付ける収益(金額)です。

注意: eventValueで収益を送信する場合は、eventRevenueでも送信し、eventRevenueCurrencyを設定してください。 

  • 負の値も使用できます。たとえば、払い戻しに使用できます。
  • 形式:浮動小数点数 
  • 値の例:1 1.2 1234.20 -1234.20
  • 対応するローデータフィールド:event_revenue
eventCategory いいえ  このパラメータは非推奨で、将来システムから削除される予定です。代わりにeventValueを使用してください。
eventLabel いいえ 

このパラメータは非推奨で、将来システムから削除される予定です。代わりにeventValueを使用してください。

referrer いいえ

HTTPリファラ

  • 形式:文字列
  • 例:"referrer" : "https://www.google.com/"
  • 対応するローデータフィールド:http_referrer
userAgent いいえ 

ブラウザからサーバーに送信されるUser-Agentリクエストヘッダーです。

  • デバイスの種類の判定に役立つため、可能な限り送信してください。 
  • 形式:文字列
  • 例:"userAgent" : "Chrome/80.0.3987"
  • 対応するローデータフィールド:user_agent
ip いいえ

ユーザーのIPアドレス

  • 可能な限り、このフィールドの値を送信してください。ユーザーの位置情報の判定に役立ちます。
  • 形式:文字列
  • 例:"ip": "192.0.2.1"
  • 対応するローデータフィールド: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'))

テスト

テストのために、以下の手順でイベントを数件送信してください。

  1. イベントを送信します。
  2. 戻りコードが200 OKであることを確認します。それ以外の場合は、戻りコードとエラーメッセージを参照して修正してください。
  3. 送信したイベントがPBAローデータに反映されるまで、UTC午前0時から数時間お待ちください。 PBAデータは1日に1回処理されるため、待機する必要があります。 

補足情報

Web Devキーの取得

 Web Devキーを取得するには:

  1. AppsFlyerでマイアプリタブを開きます。
  2. [ブランドバンドルを表示]をクリックします。

    GetWebDevKeyPba_us-en.pn

  3. 対象のWeb Devキーをコピーします。 

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を取得するには:

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

    S2S_inspect.jpg

  3. (A)Applicationタブを開きます。
  4. サイドメニューで、(B)Cookiesを展開します。
  5. Webサイトを選択します。表示されない場合は、ブラウザを再読み込みしてください。
  6. (C)filter欄に、afUserIdを入力します。
    afUserIDの値が表示されます。 

レスポンスコード

レスポンスコード メッセージ 対応方法
200 OK  
404 Not found
  • エンドポイントを確認してください。 
  • バンドルIDが正しいことを確認してください。
400 Bad request
  • JSONにエラーがあります。詳細はエラーメッセージを確認してください。 

トラブルシューティング

  • 症状:HTTP戻りコードが返されない。
    解決方法:AppsFlyerサーバーを許可リストに追加してください。

リリースノート


Web SDKのリリースノート
日付  エンドポイントのバージョン* 補足
2020-05-12 1  初回リリース
2020-05-24 1  
* バージョン番号は、エンドポイントのバージョン番号を示します。 https://webs2s.appsflyer.com/v1/method