インストール後イベント (PIE) データ

はじめに

広告主はこのエンドポイントを使用して、ユーザー レベルのイベントが発生するたびに、そのイベントに関する Vungle データを送信できます。イベント データ API により、広告主は自分にとって価値のあるユーザーを Vungle に特定させることができます。アプリケーション内でイベント情報を Vungle に送信すると、Vungle によってキャンペーンが最適化され、価値をもたらす重要なユーザーを獲得することが可能となります。

コンテンツ

HTTP リクエスト

http://ingest.vungle.com/eventData

POST

POST リクエストは以下のボディ コンテンツ タイプを使用してサポートされます。

  • application/x-www-form-urlencoded  
  • application/json  

注意: POST メソッドは JSON ボディとともに使用することをお勧めします。

curl -H "Content-Type: application/json" -d '{"data": "myData"}' "http://ingest.vungle.com/eventData"

GET

GET リクエストもクエリー パラメータを使用してサポートされます。

curl "http://ingest.vungle.com/eventData?data=myData"

必須パラメータ

Vungle に送信するどのイベント データにも、必須パラメータとオプション パラメータの両方があります。必要なパラメータが含まれていないリクエストはすべて Vundle によって却下され、どのパラメータが欠如しているかが通知されます。詳細については、エラー セクションを参照してください。

デバイス識別子

イベントごとに必要なデバイス識別子は少なくとも 1 つです。すべての識別子を渡す必要はありません。

パラメータ 説明
device_idfa Apple IDFA または Google Play Services 広告 ID
device_mac 正規形式の Mac アドレス (ハイフン区切りまたはコロン区切り)
device_other_id その他の一意の識別子 (Android ID、ハッシュ化された識別子など)

注意: 可能な場合は必ず device_idfa を使用してください。

その他の必須パラメータ

Vungle によってイベントが承認されるようにするには、残りの必須パラメータをすべて渡す必要があります。

パラメータ 説明
vungle_app_id Vungle ダッシュボードで指定されているアプリケーション ID
trk 着信イベントのソース。サーバー間の直接統合の場合は、自己識別を行う必要があります。それ以外の場合は、「tune」、「kochava」、「adjust」、「appsflyer」などのトラッキング プロバイダーを識別する必要があります。
event_trk_id  イベントに対して一意の識別子でなければなりません。重複排除に使用されます。
event_id Vungle イベント識別子。Vungle キャンペーンによってアプリケーションを開かされたユーザーがこのイベントを実行した場合、このイベント識別子は閲覧またはクリック トラッカーで渡されています。
event_name ユーザー間で一致している文字列のイベント識別子を指定する必要があります (「tutorial-complete」、「level-3」、「purchase」など)。

POST ボディの例:

{
  "device_idfa"   : "236A005B-700F-4889-B9CE-99",
  "vungle_app_id" : "myVungleApp",
  "trk"           : "tune",
  "event_trk_id"  : "uniqueID1234",
  "event_name"    : "tutorial-complete"
}

GET リクエストの例:

curl "http://ingest.vungle.com/eventData?device_idfa=236A005B-700F-4889-B9CE-999EAB2B605D&vungle_app_id=myVungleApp&trk=tune&event_trk_id=uniqueID1234&event_name=tutorial-complete"

上記のペイロードは、Vungle に送信できる最小リクエストの例であり、「200 OK」応答を返します。

オプション パラメータ

これらのパラメータはオプションですが、どのユーザーが価値をもたらすかを Vungle が特定するうえで重要であるため、可能な限り多くを指定する必要があります。

パラメータ デフォルト 説明
event_value なし イベントに関連付けられた数値。Vungle に送信する他のイベントと関連している必要があります。たとえば、$4.99 IAP は 4.99. にする必要があります。
event_currency 'usd'  event_value が明示的な貨幣価値の場合は、ここで通貨を定義します。
event_iap_event false イベントがアプリ内購入であったかどうかを示すフラグをここで設定します。
device_limit_track false デバイスに「追跡型広告を制限」が設定されているかどうかを表すブール値。
event_datetime イベント受信のタイムスタンプ イベント発生のタイムスタンプ。タイムゾーンが指定されていない場合、タイムゾーンは UTC であるとみなされます。タイムスタンプは ISO 8601 形式にする必要があります。
device_ip なし デバイスの IP アドレス。
device_make なし デバイスのメーカー。
device_model なし デバイスのモデル。
device_carrier なし デバイスの携帯電話会社。
device_language なし デバイスの ISO 639-1 言語コード (2 桁)。
device_country なし ソース IP の ISO 3166 国コード (2 桁)。
device_user_agent  なし デバイスのブラウザ ユーザー エージェント。
device_os なし オペレーティング システムのバージョン番号。

注意: event_value パラメータに着目して、各イベントの値を考慮してください。Vungle は実際に使用される値に依存しませんが、イベントの値は相互に関連している必要があります。Vungle は、広告主に送る各ユーザー タイプの全般的な価値を最大化するよう試みます。

オプション パラメータの例

{
  "event_currency"      : "usd",
  "event_iap_event"     : true,
  "device_limit_track"  : false,
  "event_datetime"      : "2015-03-15T13:27:36Z",
  "device_ip"           : "201.15.25.11",
  "device_make"         : "samsung",
  "device_model"        : "sm-g900v",
  "device_carrier"      : "verizon",
  "device_language"     : "es",
  "device_country"      : "us",
  "device_user_agent"   : "Mozilla/5.0 (Linux; U; Android 2.2.1; fr-fr; HTC_DesireZ_A7272 Build/FRG83D) AppleWebKit/533.1 (KHTML, like Gecko), Version/4.0 Mobile Safari/533.1",
  "device_os"           : "4.3.2",
  "event_value"         : 1.99
} 

エラー コード

Vungle から以下のコードが返されます。

エラー コード 意味
200  OK – ありがとうございます!
400 無効なリクエスト – リクエストに問題があります。必須パラメータのいずれかが省略されていることが考えられます。レスポンス ボディを確認してください。
500 内部サーバー エラー – 内部サーバーで問題が発生しました。後でもう一度試してください。
503 サービス使用不可 – メンテナンスのため一時的にオフラインになっています。後でもう一度試してください。

「400 BAD REQUEST」というレスポンスが返された場合は、レスポンス ボディを確認してください。Vungle は問題を診断するための最善の努力を払います。1 つまたは 2 つのフィールドが欠如していることが問題であると考えられます。以下に例を示します。

curl "http://ingest.vungle.com/eventData?trk=tune&event_trk_id=uniqueID1234"

この場合、次のようなレスポンスが返されます。

{
  "missing_fields":
  [
    "vungle_app_id",
    "trk",
    "event_trk_id",
    "event_name",
    "device_idfa | device_mac | device_other_id"
  ]
}

 

 

他にご質問がございましたら、リクエストを送信してください

コメント