简介
此端点使广告商能够在每个用户级别的事件发生时向 Vungle 发送关于这些事件的数据。对于广告商来说,事件数据 API 的目的是帮助 Vungle 了解哪些用户对您有价值。当您发送应用程序内的事件信息时,Vungle 能够优化您的广告活动以帮您获得对您有用的用户。
目录
HTTPS Request
https://ingest.vungle.com/eventData
POST
我们支持具有下述主体内容类型的 POST
请求:
-
application/x-www-form-urlencoded
-
application/json
注:Vungle 推荐使用具有 JSON 主体的 POST
方法。
curl -H "Content-Type: application/json" -d '{"data": "myData"}' "https://ingest.vungle.com/eventData"
GET
我们还支持使用查询参数的 GET
请求。
curl "https://ingest.vungle.com/eventData?data=myData"
必需参数
您发送给我们的每个事件都有必需和可选的参数。我们将会拒绝任何没有含有必要参数的请求,并且我们将会通知您缺少哪些参数。请查阅错误部分以了解更多信息。
设备识别符
我们要求每个事件至少一个设备识别符,因此,您不需要传递全部。
参数 | 说明 |
device_idfa |
Apple IDFA 或 Google Play Services 广告 ID |
device_mac |
标准格式的物理地址,要么由连字号分开,要么由冒号分开 |
device_other_id |
一些其他的唯一标识符,例如 Android ID,散列标识符等等。 |
注:Vungle 建议尽可能地使用 device_idfa!
其他必需的参数
您需要传递所有剩余的必需参数以便我们接受事件。
参数 | 说明 |
vungle_app_id |
仪表板上给出的应用程序 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 "https://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"
以上有效载荷将会返回一个‘200 OK’反应,并且是您能发送给 Vungle 的最低请求的示例。
可选参数
这些参数是可选的,但它们对于 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
}
错误错码
我们返回以下代码:
错误错码 | 意义 |
200 |
好的,谢谢! |
400 |
错误请求——您的请求很差劲。很可能您遗漏了一个必需参数。请检查响应主体来寻找线索。 |
500 |
内部服务器错误——我们的服务器出了问题。请稍后再试。 |
503 |
服务不可用——我们暂时离线维护。请稍后再试。 |
如果我们回复‘400 错误请求’,请检查响应主体。我们将会尽最大努力诊断问题,这些问题最有可能是缺失一或两个字段。例如:
curl "https://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"
]
}