Push APIs – 实时安装&转换数据提醒 - Installation & Conversion Notification APIs

push-api-1-1.svg

介绍

通过使用Push API,你可以将归因数据及市场分析数据同步到自己的内部数据平台。

Push API可以让广告主通过HTTP请求从任意终端接收来自AppsFlyer的原始数据信息。每个成功的自然或非自然安装、应用内事件或访再营销转化发生时,Push API都会发送信息。

信息发送近为实时,即会在操作发生的几秒钟内推送给广告主,最多不超过2分钟。

 默认下,数据通过http POST 或GET方式发送,JSON格式。

了解全部参数信息和示例点击这里.

了解字段描述,请查看这里.

哪些广告主适合使用Push API?

  1. 需要将准确的归因数据近乎实时的传到自己服务器的广告主 
    将广告主的用户信息和AppsFlyer详细的归因数据结合起来,尤其用于分析解析数据方面。[如果你的APP内数据是基于实时归因数据的,例如:APP首次打开5秒内,建议最好改用 AppsFlyer转化数据API ]

  2. 拥有复杂数据库的广告主 
    如果需要将数据分别传给不同的数据库,用以收集安装/应用内事件/自然量/非自然量,Push API可以在短短2分钟内完成相关配置,为你节省宝贵的开发资源。

  3. 与外部数据收集平台合作的广告主
    通过Push API,只需填入外部系统的终端URL,就可以将任何安装或事件数据传给外部系统。

 备注

Push API属于AppsFlyer的高级功能,可以通过购买API权限套餐获得。高级权限的账户可以免费使用该功能。
如需了解详细信息,请咨询您的客户成功经理或联系AppsFlyer Support团队。

配置Push API

请按照以下步骤配置Push API偏好:

1. 在控制面板的左侧目录栏,在Integration下面选择 API Access

API_Access_new.png

2. 在页面底部找到Push API 部分,点击Add Postback

3. 选择要发送的数据 
可以给自然、非自然的安装量和应用内事件选择配置1到4条不同的回传URL。如果有再营销的流量,也可以配置回传URL,最多可以配置6条。 

 注意

Push API仅支持port 80和443。

4.输入终端URL接收回传数据。

5. 点击 保存

保存设置后,发生的每个转化都会以文档中设置的格式发送到终端URL。

 注意

JSON的结构中可能随时会添加其他字段。请关注本篇文章,当有任何API变化时,可以收到相关通知。

目前API key 参数不能作为push API的一部分。

 警告

如果客户没能正确接收推送的信息,信息不支持重发。任何由于故障引起的推送信息缺失,可以通过pull API弥补信息。

IP白名单

我们建议将AppsFlyer IP加入您内部网络/平台的白名单中以确保成功收取AppsFlyer的Push API。

可通过这个 链接 获取AppsFlyer最新的IPs。

TLS 支持

AppsFlyer的Push API支持以下TLS版本:
  • 1.0
  • 1.1
  • TLS v1.0 
如果目标终端 支持 TLS v1.2,回传对接将会失败。(请确认您的终端同时也支持较早的版本)

Push API 结构

Push API除了支持发送安装数据,同样也支持发送应用内事件数据,包含自然量和非自然量的。还可以发送再营销数据,显示重新归因数据和再互动的数据。

支持的字段

以下表格显示针对自然和非自然量,通过Push API支持的所有字段。

Y - 有该字段,显示数值或显示“null"

N - 没有该字段或显示”null" 

字段 非自然安装 FB 安装 TW 安装 自然安装 非自然应用内事件 FB 应用内事件 TW 应用内事件 自然量应用内事件
attributed_touch_type Y Y Y N Y Y Y N
attributed_touch_time Y Y Y N Y Y Y N
event_type Y Y Y Y Y Y Y Y
attribution_type
(Organic or Regular)
Y Y Y Y Y Y Y Y
click_time Y Y Y Y Y Y Y Y
download_time Y Y Y Y Y Y Y Y
install_time Y Y Y Y Y Y Y Y
media_source Y Y Y Y Y Y Y Y
agency Y Y Y Y Y Y Y Y
af_channel Y Y Y N Y Y Y N
af_keywords Y Y Y  iOS: Y
And: N
Y Y Y N
campaign Y Y Y Y Y Y Y Y
af_c_id Y Y Y N Y Y Y N
af_adset Y Y Y N Y Y Y N
af_adset_id Y Y Y N Y Y Y N
af_ad Y Y Y N Y Y Y N
af_ad_id Y Y Y N Y Y Y N
fb_campaign_name Y Y Y Y Y Y Y Y
fb_campaign_id Y Y Y Y Y Y Y Y
fb_adset_name Y Y Y Y Y Y Y Y
fb_adset_id Y Y Y Y Y Y Y Y
fb_adgroup_name Y Y Y Y Y Y Y Y
fb_adgroup_id Y Y Y Y Y Y Y Y
af_ad_type Y Y Y N Y Y Y N
af_siteid Y Y Y Y Y Y Y Y
af_sub1 Y Y Y Y Y Y Y Y
af_sub2 Y Y Y Y Y Y Y Y
af_sub3 Y Y Y Y Y Y Y Y
af_sub4 Y Y Y Y Y Y Y Y
af_sub5 Y Y Y Y Y Y Y Y
http_referrer Y Y Y Y Y Y Y Y
click_url Y Y Y Y Y Y Y Y
af_cost_model Y N N N Y Y Y N
af_cost_value Y N N N Y Y Y N
af_cost_currency Y N N N Y Y Y N
cost_per_install Y N N Y Y Y Y Y
is_retargeting Y Y Y Y Y Y Y Y
re_targeting_conversion_type Y Y Y Y Y Y Y Y
country_code Y Y Y Y Y Y Y Y
city Y Y Y Y Y Y Y Y
ip Y Y Y Y Y Y Y Y
wifi Y Y Y Y Y Y Y Y
mac Y Y Y Y Y Y Y Y
operator Y Y Y Y Y Y Y Y
carrier Y Y Y Y Y Y Y Y
language Y Y Y Y Y Y Y Y
appsflyer_device_id Y Y Y Y Y Y Y Y
advertising_id Y Y Y Y Y Y Y Y
android_id Y Y Y Y Y Y Y Y
customer_user_id Y Y Y Y Y Y Y Y
imei Y Y Y Y Y Y Y Y
idfa Y Y Y Y Y Y Y Y
platform Y Y Y Y Y Y Y Y
device_brand Y Y Y Y Y Y Y Y
device_model Y Y Y Y Y Y Y Y
os_version Y Y Y Y Y Y Y Y
app_version Y Y Y Y Y Y Y Y
sdk_version Y Y Y Y Y Y Y Y
app_id Y Y Y Y Y Y Y Y
app_name Y Y Y Y Y Y Y Y
bundle_id Y Y Y Y Y Y Y Y
event_time Y Y Y Y Y Y Y Y
event_name Y Y Y Y Y Y Y Y
event_value Y Y Y Y Y Y Y Y
currency Y Y Y Y Y Y Y Y
download_time_selected_timezone Y Y Y Y Y Y Y Y
click_time_selected_timezone Y Y Y Y Y Y Y Y
install_time_selected_timezone Y Y Y Y Y Y Y Y
event_time_selected_timezone Y Y Y Y Y Y Y Y
selected_currency Y Y Y Y Y Y Y Y
revenue_in_selected_currency N N N N Y Y Y Y
cost_in_selected_currency Y Y Y Y N N N N

Push API Specific Parameters

Push API中有些参数的名称和 原始报告V5 中显示的不同,还有些参数在Push API中有,但原始数据V5报告中没有。可以查看以下表格。  

Push API 的字段名称 V5 的字段名称 描述
fb_campaign_name N/A Facebook campaign名称*
fb_campaign_id N/A Facebook campaign ID*
fb_adset_name N/A Facebook ad set名称*
fb_adset_id N/A Facebook ad set ID*
fb_adgroup_name N/A Facebook ad group名称*
fb_adgroup_id N/A Facebook ad group ID*
event_type N/A install/in-app-event
attribution_type N/A 自然量或非自然量
click_time attributed_touch_time 触点时间,等同点击时间
download_time N/A 在App商店点击下载的时间,点击时设备上显示的时间(UTC时区)
agency  af_prt 归因代理名称 
cost_per_install af_cost_value 基于系统默认币种显示的花费
re_targeting_conversion_type retargeting_conversion_type Re-engagement / Re-attribution
appsflyer_device_id appsflyer_id 每个设备安装的APP的唯一识别码
currency af_cost_currency USD
selected_currency N/A 在系统中设置的币种
revenue_in_selected_currency event_revenue_currency 基于在系统中设置的币种显示的收入
cost_in_selected_currency af_cost_value 基于在系统中设置的币种显示的花费
download_time_selected_timezone N/A 基于在系统中设置的时区显示的下载时间
click_time_selected_timezone attributed_touch_time 基于在系统中设置的时区显示的广告点击时间
install_time_selected_timezone install_time 基于在系统中设置的时区显示的App首次激活时间
event_time_selected_timezone event_time 基于在系统中设置的时区显示的事件发生时间
device_name N/A 用户填写的设备名称-均显示Null

* 只有当用户的媒体来源是Facebook时,“Facebook"相关的参数,例如:fb_campaign_name, fb_campaign_idfb_adgroup_id 才会显示有数值。

Push API 案例

以下是基于Android和iOS不同需求,通过Push API发送数据的案例,可供参考。

Organic Install

Android iOS
{
   "attributed_touch_type":"",
   "app_version":"5.7.1",
   "event_time":"2017-06-25 12:34:31",
   "media_source":"Organic",
   "fb_campaign_id":"",
   "fb_adset_id":"",
   "currency":"",
   "sdk_version":"4.7.1",
   "event_type":"install",
   "agency":"",
   "download_time_selected_timezone":"2017-06-24 06:34:45.000+0000",
   "imei":"",
   "event_time_selected_timezone":"2017-06-25 12:34:31.267+0000",
   "event_value":"",
   "app_id":"com.greatapp",
   "mac":"",
   "selected_currency":"USD",
   "fb_adgroup_id":"",
   "android_id":"",
   "cost_in_selected_currency":"",
   "install_time":"2017-06-25 12:34:31",
   "fb_adgroup_name":"",
   "fb_adset_name":"",
   "attributed_touch_time":"",
   "is_retargeting":"false",
   "click_time_selected_timezone":"",
   "customer_user_id":"",
   "wifi":"true",
   "device_model":"SM-G930L",
   "language":"???",
   "click_url":"",
   "attribution_type":"organic",
   "cost_per_install":"",
   "country_code":"KR",
   "af_siteid":"",
   "download_time":"2017-06-24 06:34:45",
   "campaign":"",
   "app_name":"great app",
   "city":"Bangeo-Dong",
   "install_time_selected_timezone":"2017-06-25 12:34:31.267+0000",
   "ip":"119.64.85.216",
   "click_time":"",
   "af_sub2":"",
   "af_sub3":"",
   "af_sub1":"",
   "af_sub4":"",
   "af_sub5":"",
   "fb_campaign_name":"",
   "bundle_id":"com.greatapp",
   "event_name":"",
   "re_targeting_conversion_type":"",
   "advertising_id":"1f1cb970-00f7-4672-91db-6b4c********",
   "platform":"android",
   "operator":"LGU+",
   "http_referrer":"",
   "af_keywords":"",
   "device_brand":"samsung",
   "carrier":"LG U+",
   "appsflyer_device_id":"1498286085929-59021898927********",
   "os_version":"7.0"
}

Non-Organic Install

Android iOS
{
   "attributed_touch_type":"",
   "clickapp_version":"5.9.0",
   "event_time":"2017-06-25 12:34:46",
   "af_ad_id":"",
   "media_source":"goodsource_int",
   "fb_campaign_id":"",
   "install_time_selected_timezone":"2017-06-25 12:34:46.529+0000",
   "af_channel":"",
   "currency":"",
   "event_time_selected_timezone":"2017-06-25 12:34:46.529+0000",
   "event_type":"",
   "installagency":"",
   "download_time_selected_timezone":"2017-06-25 12:34:17.000+0000imei",
   "event_value":"",
   "af_ad":"",
   "selected_currency":"USD",
   "fb_adgroup_id":"",
   "android_id":"",
   "af_sub1":"desktop",
   "install_time":"2017-06-25 12:34:46",
   "fb_adgroup_name":"",
   "fb_adset_name":"",
   "attributed_touch_time":"2017-06-25 12:33:33",
   "af_cost_model":"",
   "is_retargeting":"false",
   "sdk_version":"4.7.1",
   "mac":"",
   "af_cost_value":"",
   "app_id":"com.greatapp",
   "wifi":"true",
   "device_model":"SM-T819Y",
   "click_time":"2017-06-25 12:33:33",
   "click_url":"https://app.appsflyer.com/com.greatapp?pid=goodsource_int&c=hotel_page_footer&af_siteid=1456632&site_id=1456632&af_sub1=desktop",
   "attribution_type":"regular",
   "af_ad_type":"",
   "cost_per_install":"",
   "country_code":"SG",
   "af_siteid":"1716632",
   "download_time":"2017-06-25 12:34:17",
   "campaign":"hotel_page_footer",
   "app_name":"great ",
   "appcity":"Singapore",
   "customer_user_id":"84a5111c-8142-45af-bebd-621c********",
   "ip":"175.156.67.152",
   "af_adset_id":"",
   "language":"English",
   "af_sub2":"",
   "af_sub3":"",
   "cost_in_selected_currency":"",
   "af_c_id":"",
   "af_sub4":"",
   "af_sub5":"",
   "fb_campaign_name":"",
   "bundle_id":"com.greatappevent_name",
   "click_time_selected_timezone":"2017-06-25 12:33:33.093+0000",
   "re_targeting_conversion_type":"",
   "advertising_id":"a8a5c84f-53fd-4803-b8e2-ab80********",
   "fb_adset_id":"",
   "af_adset":"",
   "af_cost_currency":"",
   "platform":"android",
   "operator":"",
   "http_referrer":"https://www.greatapp.com/af_keywords",
   "device_brand":"samsung",
   "carrier":"SGP-M1",
   "appsflyer_device_id":"1498394057331-3915165764********",
   "os_version":"6.0.1"
}

Non-Organic In-App Event

Android iOS
{
   "fb_adgroup_name":"",
   "af_cost_model":"",
   "download_time":"2017-06-25 12:23:43",
   "mac":"",
   "device_model":"EVA-L19",
   "agency":"",
   "android_id":"",
   "media_source":"goodsource_int",
   "http_referrer":"",
   "fb_adgroup_id":"",
   "download_time_selected_timezone":"2017-06-25 12:23:43.000+0000",
   "af_ad":"",
   "af_sub2":"EXP-RUN-ID-0",
   "af_sub3":"9eaac647-483c-4c34-b2cd-*******",
   "af_sub1":"EXP-ID-0",
   "click_url":"http://greatapp.onelink.me/1640755593?pid=regoodsource_int&c=PromoOverlay_1764964&af_dp=greatapp%3A%2F%2Fpromocode%2F&target=449037%2C450238%*******&campaign_site_id=1456632&searchdatetype=False&af_siteid=1456632&af_sub1=EXP-ID-0&af_sub2=EXP-RUN-ID-0&af_sub3=9eaac647-483c-4c34-b2cd-********&af_click_lookback=1d",
   "af_sub4":"",
   "af_sub5":"",
   "af_ad_id":"",
   "city":"Lepar Hilir",
   "af_cost_value":"",
   "attributed_touch_time":"2017-06-25 12:22:41",
   "cost_per_install":"",
   "click_time_selected_timezone":"2017-06-25 12:22:41.167+0000",
   "revenue_in_selected_currency":"140.25",
   "attributed_touch_type":"click",
   "install_time":"2017-06-25 12:23:58",
   "attribution_type":"regular",
   "fb_adset_name":"",
   "event_time":"2017-06-25 12:29:17",
   "install_time_selected_timezone":"2017-06-25 12:23:58.455+0000",
   "imei":"",
   "event_value":{
      "af_content_id":"298270",
      "af_date_b":"08-07-2017",
      "af_customer_user_id":"3f834809-5b7e-4eef-acd7-*******",
      "af_revenue":"140.25",
      "af_price":"140.25",
      "af_currency":null
   },
   "app_version":"5.9.0",
   "sdk_version":"4.7.1",
   "re_targeting_conversion_type":"",
   "af_keywords":"",
   "os_version":"7.0",
   "af_adset":"",
   "operator":"",
   "bundle_id":"com.greatapp",
   "event_time_selected_timezone":"2017-06-25 12:29:17.557+0000",
   "ip":"113.210.68.52",
   "language":"English",
   "event_name":"af_initiated_checkout",
   "is_retargeting":"false",
   "appsflyer_device_id":"1498393423958-*************",
   "advertising_id":"f52f9ffc-2c9f-4319-94be-*************",
   "customer_user_id":"3f834809-5b7e-4eef-acd7-*************",
   "af_ad_type":"",
   "af_cost_currency":"",
   "carrier":"MY MAXIS",
   "wifi":"false",
   "af_channel":"",
   "campaign":"PromoOverlay_1764964",
   "af_siteid":"1731669",
   "click_time":"2017-06-25 12:22:41",
   "fb_campaign_name":"",
   "platform":"android",
   "country_code":"MY",
   "fb_adset_id":"",
   "af_c_id":"",
   "app_name":"great app",
   "af_adset_id":"",
   "app_id":"com.greatapp",
   "selected_currency":"USD",
   "device_brand":"HUAWEI",
   "currency":"",
   "event_type":"in-app-event"
}
{
   "mac":"null",
   "idfv":"8D36BBF0-E12B-*****-*****-**********",
   "af_sub1":"null",
   "customer_user_id":"null",
   "bundle_id":"com.appsflyer.support.two",
   "af_cost_value":"null",
   "app_version":"1.0",
   "city":"Herzliyya",
   "fb_campaign_id":"null",
   "af_cost_model":"null",
   "af_c_id":"null",
   "selected_currency":"USD",
   "app_name":"id34******",
   "install_time_selected_timezone":"2018-08-19 13:03:37.422+0000",
   "wifi":"true",
   "install_time":"2018-08-19 13:03:37",
   "fb_adgroup_id":"null",
   "currency":"USD",
   "attributed_touch_type":"click",
   "af_adset_id":"null",
   "re_targeting_conversion_type":"null",
   "device_name":"null",
   "attributed_touch_time":"2018-08-19 13:03:13",
   "click_time_selected_timezone":"2018-08-19 13:03:13.851+0000",
   "revenue_in_selected_currency":"200",
   "is_retargeting":"false",
   "country_code":"IL",
   "event_type":"in-app-event",
   "appsflyer_device_id":"1534694606690-******",
   "http_referrer":"",
   "af_sub5":"null",
   "fb_campaign_name":"null",
   "click_url":"https://app.appsflyer.com/id3******?pid=Social%20Twitter&c=test",
   "media_source":"Social Twitter",
   "campaign":"test",
   "af_keywords":"null",
   "event_value":{
      "af_revenue":"200",
      "af_price":"250"
   },
   "ip":"31.168.174.142",
   "event_time":"2018-08-19 13:04:08",
   "click_time":"2018-08-19 13:03:13",
   "af_sub4":"null",
   "fb_adgroup_name":"null",
   "af_sub2":"null",
   "attribution_type":"regular",
   "af_adset":"null",
   "fb_adset_id":"null",
   "af_ad":"null",
   "agency":"null",
   "fb_adset_name":"null",
   "device_type":"x86_64",
   "idfa":"C25C4EE5-F3B8-46B6-*****-*********",
   "cost_per_install":"null",
   "af_channel":"null",
   "af_cost_currency":"null",
   "download_time":"2018-08-19 13:03:26",
   "af_siteid":"null",
   "language":"en",
   "app_id":"id340954503",
   "af_ad_type":"null",
   "event_name":"af_purchase",
   "os_version":"11.3",
   "platform":"ios",
   "af_sub3":"null",
   "download_time_selected_timezone":"2018-08-19 13:03:26.000+0000",
   "af_ad_id":"null",
   "sdk_version":"v4.8.3",
   "event_time_selected_timezone":"2018-08-19 13:04:08.838+0000"
}

Retargeting In-App Event - Facebook Re-Engagement

Android iOS

{
   "fb_adgroup_name":"|Auto 'Feed'|T:DAT-iOS|O:All|L:TH-TH|A:Hotel|R:2-4 'Day'|",
   "download_time":"2017-05-20 11:48:33",
   "mac":"",
   "device_model":"CPH1607",
   "agency":"",
   "platform":"android",
   "media_source":"Facebook Ads",
   "fb_adgroup_id":"6066880147218",
   "download_time_selected_timezone":"2017-05-20 11:48:33.000+0000",
   "af_ad":"",
   "app_name":"great app",
   "af_sub3":"",
   "af_sub1":"",
   "click_url":"",
   "click_time_selected_timezone":"",
   "install_time_selected_timezone":"2017-06-04 11:47:54.623+0000",
   "af_sub5":"",
   "af_ad_id":"",
   "af_cost_value":"",
   "attributed_touch_time":"2017-05-27 22:17:10",
   "cost_per_install":"",
   "click_time":"2017-05-27 22:17:10",
   "language":"???",
   "attributed_touch_type":"click",
   "install_time":"2017-06-04 11:47:54",
   "attribution_type":"regular",
   "fb_adset_name":"|Auto 'Feed'|T:DAT-iOS|O:All|L:TH-TH|A:Hotel|R:2-4 'Day'|",
   "android_id":"",
   "event_time":"2017-06-25 12:29:14",
   "af_sub4":"",
   "operator":"",
   "appsflyer_device_id":"1495280913891-*************",
   "af_cost_currency":"",
   "app_version":"5.9.0",
   "sdk_version":"4.7.1",
   "fb_adset_id":"6066880141618",
   "af_keywords":"",
   "fb_campaign_name":"|Auto 'Feed'|T:DAT|L:TH-TH|",
   "af_adset":"",
   "re_targeting_conversion_type":"re-engagement",
   "bundle_id":"com.greatapp",
   "event_time_selected_timezone":"2017-06-25 12:29:14.358+0000",
   "ip":"175.136.225.45",
   "revenue_in_selected_currency":"",
   "event_name":"af_search",
   "is_retargeting":"true",
   "imei":"",
   "advertising_id":"b31bd790-209f-41d0-946f-*************",
   "customer_user_id":"8ce24e82-8530-40cb-88f9-*************",
   "af_ad_type":"",
   "event_value":{
      "af_room_no":"1",
      "af_content_id":"27758",
      "af_date_a":"27-06-2017",
      "af_currency":null,
      "af_date_b":"28-06-2017",
      "af_language_id":"22"
   },
   "af_sub2":"",
   "carrier":"MY MAXIS",
   "wifi":"true",
   "campaign":"|Auto 'Feed'|T:DAT|L:TH-TH|",
   "af_siteid":"",
   "af_cost_model":"",
   "os_version":"6.0.1",
   "af_channel":"Facebook",
   "country_code":"MY",
   "city":"Kampung Kurnia Jaya",
   "af_c_id":"",
   "af_adset_id":"",
   "app_id":"com.greatapp",
   "selected_currency":"USD",
   "device_brand":"OPPO",
   "currency":"",
   "event_type":"in-app-event"
}
 

如何统计再互动次数?

如果勾选了“re-attributions - installs" 的选项框,Push API 可以实时自动发送再归因事件。勾选"re-attributions - in-app events" 的选项框,可以收到在再互动间隔期内的所有应用内事件。

但是, 再互动的初始行为, 即现有用户在点击链接后打开App, 是不自动上报的

当现有用户点击深度链接时,会调起onAppOpenAttribution 方式。因此,如果你需要知道再互动发生的时间, 可以通过onAppOpenAttribution 方式发送事件, 代表一次深度链接的再互动事件。

点击这里 查看关于再互动事件的推荐结构。

如何保障API的安全性?

所有Push API信息均通过安全加密的https链接发送。

更多信息,可点击这里

回传的Facebook的数据在哪里?

默认下,Facebook不提供用户层级的原始数据,除非接受Facebook的Terms of Service.
通过接受该条款,可以通过Push API接收来自Facebook用户层级的数据。

这篇文章有帮助吗?
12 人中有 7 人觉得有帮助