# AppLovin Revenue Reporting API

TIP

请注意，第三方数据集成产生的数据会被纳入集群的消耗数据量

# 概要

接口名	类型	粒度	归因	成本	收益	展示	点击	转化
Revenue Reporting API	API	聚合数据			✅	✅

AppLovin 还提供了专门针对 Max 变现聚合指标 API，即 Revenue Reporting API (opens new window)。

需要接入 AppLovin Basic Reporting API 数据，您需要先获取 Report Key。请您登录 AppLovin 后台，在「Account」-「Key」中获取 Report Key，请将该 Key 妥善保管

当您获得 Report Key 后，您可以登录 TE 系统，在「三方集成」模块中完成新方案的配置。下图是 AppLovin Revenue Reporting API 的配置界面，请您按照本章节内容完成方案的创建：

点击「授权信息」按钮，在弹出框内填写您在授权工作中获取到的信息

API Key 即为刚刚获得的 Report Key

您可以在「定时拉取」模块设置 TE 系统定时拉取 AppLovin Revenue Reporting API 数据的策略，可以选择在每天的某时或者每小时拉取一段时间的数据。

打开「事件表入库设置」开关后，回传的数据都将写入到事件表中，我们建议您开启事件数据入库。

您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的时间聚合粒度，拉取的指标字段与维度，以及入库后的事件名等。

集成配置中的内容是一个 JSON，您可以按照以下内容进行自定义配置：

模块	名称	含义
sink_event	event_name	入库后的事件名，可以自定义
source	metrics	数据中的指标，列表类型，不同层级支持不同的 metrics，填写时需要注意
source	group_by	数据中的分组维度，列表类型，不同层级支持不同的 group_by，填写时需要注意

- 分组维度

以下是支持的分组维度，如果需要调整，可以修改 source.group_by

字段	是否默认	说明
day	是	广告曝光的日期
hour	是	报表的小时值 (仅当拉取最近 30 天时存在该字段)
has_idfa	是	是否可以获取用户的广告 ID，如果用户开启了 LAT 或者 GDPR 适用区域内关闭了数据跟踪，则该值为 0，否则为 1
max_ad_unit	是	MAX 广告名
max_ad_unit_id	是	MAX 广告 ID
max_ad_unit_test	是	广告测试组的名称
network_placement	是	Ad Network 的 Placement 名
max_placement		在 SDK 中自定义的 Placement 名
network	是	广告展示的 Ad Network，取值可参考（[MAX Mediation Documentation (](https://dash.applovin.com/documentation/mediation/features/ad-unit-automation-api#ad-networks)[applovin.com](https://dash.applovin.com/documentation/mediation/features/ad-unit-automation-api#ad-networks)[)](https://dash.applovin.com/documentation/mediation/features/ad-unit-automation-api#ad-networks)）
package_name	是	包名，安卓端的 App Package Name 和 iOS 端的 Bundle ID (iOS)
platform	是	平台
ad_format	是	广告类型：`INTER`, `BANNER`, `REWARD`
ad_unit_waterfall_name	是	广告 Waterfall 的名称
application	是	应用名称
country	是	两位字母的 Country Code
custom_network_name	是	自定义的广告 Ad Network 名称
device_type	是	设备类型：`PHONE`, `TABLET`
store_id		推广 App 的应用市场 ID，安卓端为 package name，iOS 端为 iTunes ID 的数字部分

- 指标字段

以下是支持的指标字段，如果需要调整，可以修改 source.metrics

字段	是否默认	说明
impressions	是	广告曝光量
estimated_revenue	是	预估的总收益（美元）
attempts	是	Ad Network 的广告尝试拉取数（仅当分组中拉取字段中存在 network 或 network_placement 时可用，存在 max_placement 时不可用）
ecpm	是	预估的 eCPM（美元）
fill_rate	是	广告填充率 = 广告响应数 / 尝试拉取数（仅当分组中拉取字段中存在 network 或 network_placement 时可用，存在 max_placement 时不可用）
responses	是	广告响应数（仅当分组中拉取字段中存在 network 或 network_placement 时可用，存在 max_placement 时不可用）
requests		广告请求数（当存在 network 或 network_placement、max_placement 时不可用）

默认情况下，我们会将拉取的数据以事件形式写入 TE 项目中：

不存在 hour 字段时（即 30 天前的数据），使用数据中的 day 字段，即数据的日期，设置为聚合数据的 #event_time；存在 hour 的情况下，会拼接 day 和 hour 字段为聚合数据的 #event_time
数据事件名为 -- applovin_maxreport
其余字段都将会入库

以下事件属性会进行标准化处理：