介绍
AppsFlyer的CSV数据报告可从“导出数据”页面进行手动下载, 也可以通过 Pull API拉取。
Pull API能够使App所有者使用包含查询参数的特定网址接收有关应用的CSV文件。拉取的报告既可以是汇总报告,也可以是原始数据报告。
Pull API链接可以在每个APP的控制面板API访问页面 中获取。
原始数据报告提供安装和应用内事件的所有数据。
API 参数-必要
- api_token
- 是用户对外的API授权密钥:“{使用帐户所有者的API密钥}"
- from
- 报告开始日期的格式为“yyyy-mm-dd”或“yyyy-mm-dd hh:mm”。例如:2010-01-01或2010-01-01%2000%3A15 -(小时参数仅适用于原始数据报告)。
- to
- 报告截止时间。与from格式相同
API筛选参数 - 可选
按媒体源筛选
通过在请求URL中添加Category和Media Source参数,可以筛选报告以列出特定的媒体源:
- category
- 若想获取Facebook数据,那么设置
category=facebook
;对于任何其他特定媒体源,设置category=standard
- media_source
- 提供AppsFlyer控制面板上显示的某个媒体源的名称(
media_source=[SOURCE_NAME]
)
举例
1 Google Adwords报告
https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=standard&media_source=googleadwords_int
2: Facebook 报告
https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=facebook&media_source=facebook
按事件名称筛选
使用event_name
参数筛选应用内事件原始数据报告,使其仅包含特定事件。要筛选多个事件,请使用逗号分隔各个事件。
举例来说:event_name=af_purchase,ftd
重定向相关报告
使用reattr=true
可以得到重定向广告系列的结果
使用Pull API获取自定义报告
- fields
Pull API支持使用可选字段自定义原始数据报告(v5及更高版本)。这使营销人员能够只下载相关信息以满足他们的要求。
要指定请求的字段,请将以下字段字段参数附加到API Call中。
您请求的每个字段都应通过此处列出的API名称添加到fields参数中。Example: fields=country_code,city
&fields=API_Name_A,API_Name_B
示例
拉取安装所对应的城市及国家代码的列表 -https://hq.appsflyer.com/export/id341333333/installs_report/v5?api_token=24b7b9fe-6ddd-4ddd-94c8-xxxxxxxxxxx&from=2017-03-09&to=2017-03-10&fields=country_code,city
完整的字段列表及其API名称可在此处找到。
提示
现阶段使用“字段”选项自定义报表时,暂不支持“筛选”功能。要同时执行两者的话,使用字段自定义构建URL,然后在excel表格上手动过滤结果。
附加字段
通过Pull API,您可以添加一些字段,有时可以得到更加完整的原始安装数据和应用内事件数据。
要添加新字段,请在跟踪链接中添加“&additional_fields=
”,然后用逗号分隔想要添加的其他字段 。请参阅下面的Pull API示例。
通过Pull API拉取的是添加了字段的CSV报告,其中包含相关信息。
字段名称 | 相关信息 |
---|---|
rejected_reason rejected_reason_value |
Validation Rules |
blocked_reason |
Protect360 (Anti-Fraud solution) |
install_app_store | Out-of-store Android markets |
custom_data | Retrieving custom data |
gp_referrer | Google Play field - click here for more info. |
gp_click_time | Google Play field - click here for more info. |
gp_install_begin | Google Play field - click here for more info. |
时区与货币
时区(可选)
您可以更改时区设置,获取相应时区下的Pull API原始数据
1. 在Pull API链接中添加&timezone=[Joda-Time]
以拉取相应时区的报告(请参阅下面的注释)
2. 在Pull API链接中添加&timezone=[Numerical value]
以在指定的时区下接收报告。例如:对于时区UTC + 10:00添加链接&timezone=%2B10:00
3. 否则,将在默认的UTC时区中接收数据。
提示
1. Joda-Time时区格式有进行夏令时计算。
2. Joda-Time值必须与APP设置页面的值相同。例如,如果您希望在法国的时区获取数据,请在App设置页面中查看时区列表,法国时区显示的是“法国 - 巴黎”。 那么Pull API URL中的时区值应为&timezone=France/Paris
币别(可选)
- 用于接收所选币别的收入和成本数据,系统默认的是美元 。这是由帐户管理员进行设置的。
currency=preferred
- 用于接收所选币别的收入和成本数据
备注
通常,Pull API URL不需要进行编码(encode)。但是,如果使用具有非URL兼容值的参数,则需要对它们进行URL编码。例如,小时和时区参数。
API 政策
AppsFlyer的API 政策 通过限制每日请求的数量,防止滥用功能来确保为Pull API用户提供高质量的服务。
每个报告的最大记录数为200K。如果你得到一个有200K行的报告,那么你可能会遗漏一些结果。
提示
如果您的每日报告结果超过200K记录,您可以使用Pull API URL上的from 和 to 参数中的日期/时间格式“yyyy-mm-dd hh:mm”,根据日期和时间拆分数据。
举例来说 - 如果App所有者每天来自于全渠道的新安装量高达300K,那么他可以将每日Pull API调用拆分为2次调用,每次包含12小时的数据。第一个URL调用包括from=yyyy-mm-dd 00:00&to=yyyy-mm-dd 11:59第二次调用from=yyyy-mm-dd 12:00&to=yyyy-mm-dd 23:59 (before encoding)
注意
默认情况下,Pull API绩效报告仅显示营销活动级别的Facebook数据。您需要添加“&category = facebook”以使报告能够显示广告系列和广告级别的Facebook信息。这仅适用于Facebook。
API 安全性
所有Pull API链接都使用安全加密的https连接。
更多细节请查看此处。
Pull API 链接示例
报告类别 | 报告类型 | 链接示例 |
---|---|---|
原始数据报告 | Installs Report | https://hq.appsflyer.com/export/id123456789/安装报告/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd |
In-App Events Report | https://hq.appsflyer.com/export/id123456789/应用内事件报告/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
卸载报告 |
|
|
自然流量安装报告 | https://hq.appsflyer.com/export/id123456789/organic_installs_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
自然流量应用内事件报告 | https://hq.appsflyer.com/export/id123456789/organic_in_app_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
Validation rules报告 | Invalid Installs Report | https://hq.appsflyer.com/export/id123456789/无效的安装报告/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value |
无效的应用内事件报告 | https://hq.appsflyer.com/export/id123456789/invalid_in_app_events_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value |
API Version (V5)
- 维持不变:
-
现有的API(v4)仍可供使用
-
该版本未对文件格式或标题进行任何更改
-
汇总报告提供广告活动成效的详细信息。
API 参数-必要
- api_token
- 是用户对外的API授权密钥:“{使用帐户所有者的API密钥}”
- from
- 报告开始日期的格式为“yyyy-mm-dd”或“yyyy-mm-dd hh:mm”。例如:2010-01-01或2010-01-01%2000%3A15 - (小时参数仅适用于原始数据报告)。
- to
- 报告截止时间。与from格式相同
API筛选参数 - 可选
按媒体源筛选
通过在请求URL中添加Category和Media Source参数,可以筛选报告以列出特定的媒体源
- category
- 若想获取Facebook数据,那么设置
category=facebook
;对于任何其他特定媒体源,设置category=standard
- media_source
- 提供AppsFlyer控制面板上显示的某个媒体源的名称(
media_source=[SOURCE_NAME]
)
举例
1 Google Adwords报告
https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=standard&media_source=googleadwords_int
2 Facebook 报告
https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=facebook&media_source=facebook
重定向相关报告
使用reattr=true
得到归因给重定向行销活动的报告。
时区和货币
时区(可选)
您可以通过Pull API以UTC或App设定的时区来获取汇总数据,该时区在“应用程序设置”页面中设置:
1. 在Pull API链接中添加&timezone=[selected Joda-Time]
以在应用程序的设定时区接收报告(请参阅下面的注释)
2. 如果没有设置的话,将在默认的UTC时区中接收数据。
提示
1Joda-Time时区格式有进行夏令时计算。
2. Joda-Time值必须与APP设置页面中设置的值相同。例如,如果APP设置中的所选时区为“法国 - 巴黎”,则Pull API URL中的时区值应为&timezone=France/Paris
币别(可选)
- 用于接收所选币别的收入和成本数据,系统默认的是美元 。这是由帐户管理员进行设置的。
currency=preferred
- 用于接收所选币别的收入和成本数据
备注:
通常,Pull API URL不需要进行编码(encode)。但是,如果使用具有非URL兼容值的参数,则需要对它们进行URL编码。例如,小时和时区参数
API政策
AppsFlyer的API政策政策通过限制每日请求的数量,防止滥用功能来确保为pull API用户提供高质量的服务。
每个报告的最大记录数为200K。如果你得到一个有200K行的报告,那么你可能会遗漏一些结果。
提示
如果您的每日报告结果超过200K记录,您可以使用Pull API URL上的from 和 to 参数中的日期/时间格式“yyyy-mm-dd hh:mm”,根据日期和时间拆分数据。
举例来说 - 如果App所有者每天来自于全渠道的新安装量高达300K,那么他可以将每日Pull API调用拆分为2次调用,每次包含12小时的数据。第一个URL调用包括from=yyyy-mm-dd 00:00&to=yyyy-mm-dd 11:59 第二次调用 from=yyyy-mm-dd 12:00&to=yyyy-mm-dd 23:59 (编码前)
注意
默认情况下,Pull API绩效报告仅显示营销活动级别的Facebook数据。您需要添加“&category = facebook”以使报告能够显示广告系列和广告级别的Facebook信息。这仅适用于Facebook。
API安全性
所有Pull API链接都使用安全加密的https连接。
更多细节请查看此处。
Pull API 链接示例
报告类别 | 报告类型 | 链接示例 |
---|---|---|
汇总绩效报告 | 分媒体报告 | https://hq.appsflyer.com/export/id123456789/partners_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd |
分媒体每日报告 | https://hq.appsflyer.com/export/id123456789/partners_by_date_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
每日报告 | https://hq.appsflyer.com/export/id123456789/daily_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
分地区报告 | https://hq.appsflyer.com/export/id123456789/geo_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd | |
分地区每日报告 | https://hq.appsflyer.com/export/id123456789/geo_by_date_report/v5?api_token=<API TOKEN HERE>&from=yyyy-mm-dd&to=yyyy-mm-dd |
API Version (V5)
- 变动:
-
V5版本仅显示Facebook广告营销活动层级的数据,而不能显示广告系列和广告层级。
-
导出数据页面的汇总报告使用V5的API 版本
-
- 保持不变:
-
现有的API(v4)仍可供使用
-
该版本未对文件格式或标题进行任何更改
-
注意
要使用V4汇总报告,请将v5更改为v4。
例如,v5(红色字体)应更改为v4。
https://hq.appsflyer.com/export/i{app_
P360汇总数据,在控制面板中是出现在“高级监测”这个版块中的。
API 参数-必要
- api_token
- 是用户对外的API授权密钥:“{使用帐户所有者的API密钥}
- from
- 报告开始日期的格式为“yyyy-mm-dd”或“yyyy-mm-dd hh:mm”。例如:2010-01-01或2010-01-01%2000%3A15 - (小时参数仅适用于原始数据报告)。
- to
- 报告截止时间。与from格式相同
API筛选参数 - 可选
按媒体源筛选
通过在请求URL中添加pid=media source name.
,可以筛选报告以列出特定的媒体源
时区和货币
时区(可选)
您可以通过Pull API以UTC或App设定时区获取汇总数据,该时区在“应用程序设置”页面中设置:
1. 在Pull API链接中添加&timezone=preferred
以在应用程序的设定时区下接收报告(请参阅下面的注释)
2. 否则,将在默认的UTC时区中接收数据。
币别(可选)
- 用于接收所选币别的收入和成本数据,系统默认的是美元 。这是由帐户管理员进行设置的。
currency=preferred
- 用于接收所选币别的收入和成本数据
备注
通常,Pull API URL不需要进行编码(encode)。但是,如果使用具有非URL兼容值的参数,则需要对它们进行URL编码。例如,小时和时区参数。
API 安全性
所有Pull API链接都使用安全加密的https连接。
更多细节请查看此处。
Pull API 链接示例
报告类别 | 报告类型 | 链接 |
---|---|---|
P360 - Aggregated Advanced Detection Reports |
Partners Report | https://hq1.appsflyer.com/master/p360/reports/v4?api_token=<API Token>&app_id=<APP_ID>&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=pid,af_siteid&kpis=protect360_total_installs,install_fraud_new_devices_installs,install_fraud_new_devices_installs_rate,install_fraud_new_devices_loyal_user_rate,install_fraud_lat_devices_installs,install_fraud_lat_devices_install_rate,install_fraud_lat_devices_loyal_user_rate,install_fraud_suspicious_devices_installs,install_fraud_suspicious_devices_install_rate,install_fraud_suspicious_devices_loyal_user_rate,install_fraud_clean_device_installs,install_fraud_clean_device_install_rate,install_fraud_clean_device_loyal_user_rate,clicks,cr,click_flood_under_5_min_rate,click_flood_from_5_to_60_min_rate,click_flood_over_60_min_rate,contribution_rate,install_hijacking_up_to_10_sec_rate,install_hijacking_10_to_30_sec_rate,install_hijacking_over_30_sec_rate |
Partners Daily Reports | https://hq1.appsflyer.com/master/p360/reports/v4?api_token=<API-TOKEN>&app_id=<APP_ID>&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=pid,af_siteid,install_time&kpis=protect360_total_installs,install_fraud_new_devices_installs,install_fraud_new_devices_installs_rate,install_fraud_new_devices_loyal_user_rate,install_fraud_lat_devices_installs,install_fraud_lat_devices_install_rate,install_fraud_lat_devices_loyal_user_rate,install_fraud_suspicious_devices_installs,install_fraud_suspicious_devices_install_rate,install_fraud_suspicious_devices_loyal_user_rate,install_fraud_clean_device_installs,install_fraud_clean_device_install_rate,install_fraud_clean_device_loyal_user_rate,clicks,cr,click_flood_under_5_min_rate,click_flood_from_5_to_60_min_rate,click_flood_over_60_min_rate,contribution_rate,install_hijacking_up_to_10_sec_rate,install_hijacking_10_to_30_sec_rate,install_hijacking_over_30_sec_rate | |
Geo Report | https://hq1.appsflyer.com/master/p360/reports/v4?api_token=<API-Token>&app_id=<APP_ID>&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=geo&kpis=protect360_total_installs,install_fraud_new_devices_installs,install_fraud_new_devices_installs_rate,install_fraud_new_devices_loyal_user_rate,install_fraud_lat_devices_installs,install_fraud_lat_devices_install_rate,install_fraud_lat_devices_loyal_user_rate,install_fraud_suspicious_devices_installs,install_fraud_suspicious_devices_install_rate,install_fraud_suspicious_devices_loyal_user_rate,install_fraud_clean_device_installs,install_fraud_clean_device_install_rate,install_fraud_clean_device_loyal_user_rate,clicks,cr,click_flood_under_5_min_rate,click_flood_from_5_to_60_min_rate,click_flood_over_60_min_rate,contribution_rate,install_hijacking_up_to_10_sec_rate,install_hijacking_10_to_30_sec_rate,install_hijacking_over_30_sec_rate | |
Geo Daily Report | https://hq1.appsflyer.com/master/p360/reports/v4?api_token=<API-TOKEN>&app_id=<APP_ID>&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=geo,install_time&kpis=protect360_total_installs,install_fraud_new_devices_installs,install_fraud_new_devices_installs_rate,install_fraud_new_devices_loyal_user_rate,install_fraud_lat_devices_installs,install_fraud_lat_devices_install_rate,install_fraud_lat_devices_loyal_user_rate,install_fraud_suspicious_devices_installs,install_fraud_suspicious_devices_install_rate,install_fraud_suspicious_devices_loyal_user_rate,install_fraud_clean_device_installs,install_fraud_clean_device_install_rate,install_fraud_clean_device_loyal_user_rate,clicks,cr,click_flood_under_5_min_rate,click_flood_from_5_to_60_min_rate,click_flood_over_60_min_rate,contribution_rate,install_hijacking_up_to_10_sec_rate,install_hijacking_10_to_30_sec_rate,install_hijacking_over_30_sec_rate | |
Partners Campaign Report | https://hq1.appsflyer.com/master/p360/reports/v4?api_token=<API_TOKEN>&app_id=<APP_ID>&from=yyyy-mm-dd&to=yyyy-mm-dd&groupings=pid,af_siteid,c&kpis=protect360_total_installs,install_fraud_new_devices_installs,install_fraud_new_devices_installs_rate,install_fraud_new_devices_loyal_user_rate,install_fraud_lat_devices_installs,install_fraud_lat_devices_install_rate,install_fraud_lat_devices_loyal_user_rate,install_fraud_suspicious_devices_installs,install_fraud_suspicious_devices_install_rate,install_fraud_suspicious_devices_loyal_user_rate,install_fraud_clean_device_installs,install_fraud_clean_device_install_rate,install_fraud_clean_device_loyal_user_rate,clicks,cr,click_flood_under_5_min_rate,click_flood_from_5_to_60_min_rate,click_flood_over_60_min_rate,contribution_rate,install_hijacking_up_to_10_sec_rate,install_hijacking_10_to_30_sec_rate,install_hijacking_over_30_sec_rate |
API Version (V5)
- 变动:
-
V5版本仅显示Facebook广告营销活动层级的数据,而不能显示广告系列和广告层级。
-
导出数据页面的汇总报告使用V5的API 版本。
-
- 保持不变:
-
现有的API(v4)仍可供使用
-
该版本未对文件格式或标题进行任何更改
-
注意
要使用V4汇总报告,请将v5更改为v4。
例如:V5(红色字体)应更改为v4。
https://hq.appsflyer.com/export/i{app_