Reporting API

使用 Reporting API 来获取 JSON 或 CSV 格式的聚合推广活动数据。

请求格式

向以下基础 URL 发送 HTTP GET 请求，以生成报告请求： https://r.applovin.com/report

必要参数

参数	用途
api_key	您的 Report Key<br />您可以在 AppLovin 控制面板账户页面的 <UILabel>Keys</UILabel> 选项卡中找到 Report Key。
start<sup>1</sup>	报告开始日期<br />接受 <var>年-月-日</var> 格式的日期或 Unix 时间戳。示例：2012-10-05 或 1336608000。
end<sup>1</sup>	报告结束日期<br />接受 <var>年-月-日</var> 格式的日期或 Unix 时间戳。示例：2012-10-05、1336608000 或 now。
format	报告格式 接受 json 或 csv。详情请参阅下文请求格式。
columns	报告列 (通过逗号分隔的列表) 请参阅下方允许使用的列。示例：ad_id,day,campaign。
report_type	指示 API 返回 publisher 或 advertiser 数据 如果您省略此参数，API 就会默认返回 report_type=publisher。

¹该 API 的请求窗口为 45 天。请确保日期参数在最近 45 天内。

可选参数

参数	用途
day_column	指标默认使用实时数据；如果您想提取同期群中的指标，请将其设置为 day。
limit	您要返回的行数限制；示例：500 (使用 limit 和 offset 对结果进行分页)
offset	开始调取行的偏移位置；示例：100 (使用 limit 和 offset 对结果进行分页)
having	允许您根据数值过滤结果 该参数可接受数字列、比较运算符和逻辑运算符的 URL 编码值；示例：impressions%20%3E%200%20AND%20revenue%20%3E%200 (“展示量 > 0 并且收入 > 0”)。 请注意：这会减慢响应速度，增加超时的可能性。
not_zero	设置为 1 ，可过滤出所有数值型指标为 0 的数据结果。

允许的开发者列

列名称	包含信息
ad_type	APPOPEN、GRAPHIC、MRAID、PLAY、REWARD 或 VIDEO
application	应用名称
application_is_hidden	应用是否在控制面板中隐藏
bidding_integration	AppLovin 所参与竞价的聚合平台（MAX 表示 MAX 聚合，Google 表示 AdMob Mediation Open Bidding 或 Google Ad Manager/GAM，None 表示非竞价 / zone 接入方式）
clicks	点击量
country	两个字母组成的 ISO 国家/地区代码。
ctr	点击量 ÷ 展示量
day	报告数据日期
device_type	phone、tablet 或 other
ecpm	每千次展示的收益金额
hour	报告数据的小时 (仅适用于最近 30 天)
impressions	展示量
package_name	应用的包名或 Bundle ID
placement_type	APP_OPEN、BANNER、INTER、LEADER、MREC、NATIVE 或 REWARDED_INTER
platform	android、fireos、ios
revenue	收入
size	广告尺寸 (BANNER、INTER、LEADER、MREC 或 NATIVE)
store_id	iOS 中 iTunes ID 的数字部分或 Android 中的 package_name。<br />如果 AppLovin 无法识别 iTunes ID，则会返回 Bundle ID。
zone	Zone 名称 (若您的账户可用)
zone_id	Zone ID (若您的账户可用) 若要启用 Zone，请联系您的客户经理。

允许的广告主列

列名称	包含信息
ad	广告名称
ad_creative_type	GRAPHIC、PLAYABLE、VIDEO、 VIDEO_PLAYABLE
ad_id	广告 ID。即使广告名称发生变化，该值也不会改变
ad_rev_<var>x</var>	特定时间段内的广告收入 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
ad_roas_<var>x</var>	特定时间段内的广告支出回报 (<var>x</var> 为 0d、1d、 2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
ad_type	APPOPEN、GRAPHIC、PLAY、REWARD 或 VIDEO
app_id_external	经过哈希处理的应用程序 ID，通常被称为 “站点 ID”
application	源应用程序名称
average_cpa	平均单次转化成本
average_cpc	平均单次点击成本
bidding_and_billing_method	AppLovin 特定的竞价策略为 AUTO_BIDDING_WITH_CPM_BILLING、CAPPED_GOAL_BIDDING_WITH_CPM_BILLING、FIXED_GOAL_BIDDING_WITH_CPI_BILLING 或 FIXED_GOAL_BIDDING_WITH_CPM_BILLING (对于 AppLovin 以外的平台则为空白)
campaign	Campaign 名称
campaign_ad_type	ua 用于获客，rt 用于再营销
campaign_bid_goal	Campaign 竞价目标，以美元 ($) 表示，适用于 CPP 和 CPE Campaign。在请求此值的同时，还必须请求 campaign 列。
campaign_id_external	对 Campaign 的唯一引用。即便重命名 Campaign，该值也不会发生变化。该值与 {CAMPAIGN_ID} 点击宏相同。
campaign_package_name	所推广应用的包名或 Bundle ID
campaign_roas_goal	针对 IAP ROAS、广告 ROAS 和 ROAS Campaign 的广告支出回报 (ROAS) 目标，以百分比值 (%) 表示。在请求此值的同时，还必须请求 campaign 列。
campaign_store_id	iOS 端上的推广应用的 iTunes ID 的数字部分，否则为 camaign_package_name
campaign_type	Campaign 优化类型 (CPP、CPE、ad ROAS、IAP ROAS 或 ROAS)
clicks	点击量
conversions	转化量 (安装)
conversion_rate	转化量 ÷ 展示量
cost	广告主支出
cost_per_target_event_<var>x</var>	特定时间段内的目标事件单次事件成本 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、30d、90d 或 1y 之一)
country	两个字母组成的 ISO 国家/地区代码。
cpp_<var>x</var>	特定时间段内的单次购买成本 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、30d、90d 或 1y 之一)
creative_set	素材组名称
creative_set_id	素材组 ID。即便素材组名称发生变化，该 ID 也不会改变。
ctr	点击量 ÷ 展示量
custom_page_id	与素材组关联的 iOS 自定义产品页，或 Android 商品详情页面。
day	报告数据日期
device_type	phone、tablet 或 other
external_placement_id	经过加密的应用程序 ID (配合 API 来源竞价使用)
first_purchase	进行首次购买的用户数量 (必须设置收入回调)
hour	报告数据的小时 (仅适用于最近 30 天)
iap_rev_<var>x</var>	特定时间段内的 IAP 收入 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
iap_roas_<var>x</var>	特定时间段内的广告支出 IAP 回报 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
impressions	展示量
optimization_day_target	您选择 Campaign 优化日，示例：第 0 天或第 7 天。
placement_type	APP_OPEN、ARRAY、BANNER、CTV、INTER、LEADER、MREC、NATIVE 或 REWARDED_INTER
platform	android、fireos、ios 或 tvos
ret_<var>x</var>	特定时间段内的留存 (<var>x</var> 为 1d、3d、7d、14d 或 28d 之一)
roas_<var>x</var>	特定时间段内的总计 ROAS (<var>x</var> 为 0d、1d、2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
sales	已归因销售事件的数量 (必须设置收入回调)
sales_<var>x</var>	特定时间段内的销售量 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、30d、90d 或 1y 之一)
size	广告尺寸 (BANNER、INTER、LEADER、MREC、NATIVE 或 PRELOAD)
target_event	Campaign 定向的自定义事件 (仅适用于 CPE Campaign)
target_event_count	唯一目标事件
target_event_count_<var>x</var>	特定时间段内的唯一目标事件 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、30d、90d 或 1y 之一)
total_rev_<var>x</var>	特定时间段内的总收入 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、28d、30d、90d 或 1y 之一)
traffic_source	AppLovin 或交易平台名称
unique_purchasers_<var>x</var>	特定时间段内的唯一购买者数量 (<var>x</var> 为 0d、1d、2d、3d、7d、14d、30d、90d 或 1y 之一)

过滤列

您可以按任意列过滤报告，搜索直接匹配任意过滤器的内容。

要按列过滤，请添加以下 URL 参数：<code>filter_<var>column</var>=<var>onefilter,anotherfilter,thirdfilter</var></code>

例如，如果您只想查看 Android 平台的数据，就需要设置以下 URL 参数：filter_platform=Android

请参阅上表了解全部列。

部分列支持排除过滤器即 <code>filter_not_<var>columnname</var>=<var>onefilter,anotherfilter</var></code>。此外，custom_page_id 维度支持 filter_null_custom_page_id、filter_blank_custom_page_id、filter_not_null_custom_page_id 和 filter_not_blank_custom_page_id 选项。这些选项不需要值，比如 …&filter_not_null_custom_page_id=&filter_not_blank_custom_page_id=&…

列的排序

报告排序的方法与过滤报告的方法类似。

例如，若要按 campaign 对报告进行排序，您需要添加以下 URL 参数：sort_campaign=ASC

可接受的值为 ASC (升序) 或 DESC (降序)。所有排序均按字典顺序。

报告格式

您可以 JSON 或 CSV 格式请求报告。

时区

Reporting API 中的全部数据均采用 UTC (协调世界时)。

请求示例

广告主请求示例：

https://r.applovin.com/report?api_key=«your-report-key»&start=2015-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,conversions,conversion_rate,app_id_external,cost,sales&format=json&report_type=advertiser

开发者请求示例：

https://r.applovin.com/report?api_key=«your-report-key»&start=2016-07-01&end=2016-07-07&columns=day%2Cplatform%2Ccountry%2Capplication%2Cpackage_name%2Csize%2Cad_type%2Cimpressions%2Cclicks%2Crevenue,device_type&having=impressions%20%3E%200%20AND%20revenue%20%3E%200&format=csv