Reporting API

使用 Reporting API 来获取 JSON 或 CSV 格式的聚合 Campaign 数据。

请求格式

向以下基础 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	通过逗号分隔的报告列列表<br />请参阅下列允许使用的列。示例：day,campaign。
report_type	advertiser (必要)

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

可选参数

参数	用途
day_column	指标默认使用实时数据；如果您想提取同期群中的指标，请将其设置为 day (指标会归因于服务时间)。
limit	返回的行数限制；例如：500
offset	开始获取行数的偏移量；例如：100
having	允许对数值进行复杂过滤操作。<br />该参数可接受数字列、比较运算符和逻辑运算符的 URL 编码值，示例：impressions%20%3E%200%20AND%20cost%20%3E%200 ( “展示量 > 0 并且成本 > 0” ）。<br />提示：这会减慢响应速度，增加超时的可能性。
not_zero	设置为 1 ，可过滤出所有数值型指标为 0 的数据结果。

推荐列

列名称	包含信息
campaign	Campaign 名称
campaign_id_external	对 Campaign 的唯一引用<br />即使重命名 Campaign 名称，这也不会改变，与 {CAMPAIGN_ID} 点击宏的值相同。
cost	广告主支出
country	两个字母的国家/地区代码
creative_set	素材组名称
creative_set_id	素材组 ID。即便素材组名称发生变化，该 ID 也不会改变。
day	报告数据日期
hour	报告数据的小时 (仅适用于最近 30 天)

可选列

列名称	包含信息
ad_creative_type	GRAPHIC、GRAPHIC_PLAY、PLAYABLE、VIDEO、VIDEO_GRAPHIC 或 VIDEO_PLAYABLE
ad_type	APPOPEN、GRAPHIC、PLAY、REWARD 或 VIDEO
average_cpc	平均单次点击成本
campaign_bid_goal	Campaign 竞价目标，以美元 ($) 表示，适用于 CPP 和 CPE Campaign。在请求此值的同时，还必须请求 campaign 列。
chka_0d	自展示时间起 24 小时内发生的归因结账
chka_1d	自展示时间起 48 小时内发生的归因结账
chka_2d	自展示时间起 72 小时内发生的归因结账
chka_3d	自展示时间起 96 小时内发生的归因结账
chka_7d	自展示时间起 192 小时内发生的归因结账
chka_usd_0d	自展示时间起 24 小时内发生的归因结账总收入
chka_usd_1d	自展示时间起 48 小时内发生的归因结账总收入
chka_usd_2d	自展示时间起 72 小时内发生的归因结账总收入
chka_usd_3d	自展示时间起 96 小时内发生的归因结账总收入
chka_usd_7d	自展示时间起 192 小时内发生的归因结账总收入
clicks	点击量
cost_per_chka_0d	自展示时间起 24 小时内的 CPP
cost_per_chka_1d	自展示时间起 48 小时内的 CPP
cost_per_chka_2d	自展示时间起 72 小时内的 CPP
cost_per_chka_3d	自展示时间起 96 小时内的 CPP
cost_per_chka_7d	自展示时间起 192 小时内的 CPP
ctr	点击量 ÷ 展示量
custom_page_id	特定的登陆页
impressions	展示量
placement_type	APP_OPEN、ARRAY、BANNER、CTV、INTER、LEADER、MREC、NATIVE 或 REWARDED_INTER
platform	android、ios、fireos 或 tvos
roas_0d	自展示时间起 24 小时内生成的结账 ROAS
roas_1d	自展示时间起 48 小时内生成的结账 ROAS
roas_2d	自展示时间起 72 小时内生成的结账 ROAS
roas_3d	自展示时间起 96 小时内生成的结账 ROAS
roas_7d	自展示时间起 192 小时内生成的结账 ROAS
sales	归因销售事件的数量
size	广告尺寸 (BANNER、INTER、LEADER、MREC、NATIVE 或 PRELOAD)

过滤列

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

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

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

请参阅上表了解全部列。

Some columns support negative filters via <code>filter_not_columnname=<var>onefilter,anotherfilter</var></code>. The custom_page_id column also supports filter_null_custom_page_id, filter_blank_custom_page_id, filter_not_null_custom_page_id, and filter_not_blank_custom_page_id options. These options do not require a value, i.e. …&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=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser