AppLovin Basic Reporting API

TIP

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

概要

接口简介

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

除了用户粒度的收益数据外，AppLovin 也提供了聚合指标 API，即 Basic Reporting API (opens new window)。

集成流程

1. 登录 AppLovin 后台，获取 Report Key
2. 登录 TE 后台，进入三方集成模块，新增 AppLovin Basic Reporting API 方案，并完成相关配置
3. 查看 TE 系统否成功接收数据，并完成报表搭建

一、获取 Report Key

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

二、方案配置

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

2.1 授权信息配置

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

API Key 即为刚刚获得的 Report Key

2.2 定时拉取

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

2.3 事件表入库设置

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

2.4 集成配置

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

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

模块	名称	含义
sink_event	event_name	入库后的事件名，可以自定义
source	report_types	数据拉取的层级，列表类型，建议您只填入一个元素，即一次只拉取一个层级的数据 可选值: advertiser、publisher
	metrics	数据中的指标，列表类型，不同层级支持不同的 metrics，填写时需要注意
	group_by	数据中的分组维度，列表类型，不同层级支持不同的 group_by，填写时需要注意

Basic Reporting API 提供了两种截然不同的报表，即广告主报表（advertiser）与流量主报表（publisher），以下章节将会分别介绍这两类报表如何配置：

2.4.1 广告主报表（advertiser）

广告主报表的模板如下：

{
    "sink_event":
    {
        "event_name": "applovin_advertiser"
    },
    "source":
    {
        "group_by":
        [
            "day",
            "campaign",
            "campaign_id_external",
            "creative_set",
            "creative_set_id",
            "ad_id",
            "ad",
            "ad_type",
            "campaign_ad_type",
            "campaign_package_name",
            "campaign_store_id",
            "campaign_type",
            "country",
            "device_type",
            "external_placement_id",
            "platform",
            "size",
            "traffic_source"
        ],
        "report_types":
        [
            "advertiser"
        ],
        "metrics":
        [
            "impressions",
            "clicks",
            "ctr",
            "conversions",
            "conversion_rate",
            "average_cpa",
            "average_cpc",
            "cost",
            "sales"
        ]
    }
}

• 模板中使用的时间粒度为天（广告主报表不支持按小时聚合），系统将使用数据中的 day 字段，即数据的日期，作为数据的时间
• 模板中使用的事件名为 -- applovin_advertiser
• 其余字段都将会入库
• 可选维度

以下是广告主报表可选的维度，您可以按照实际需要进行调整，请将需要字段的字段名写入 source.group_by 中

字段名	是否默认	含义
day	是	报表的日期
campaign	是	Campaign 名称
campaign_id_external	是	Campaign 的唯一标识
creative_set	是	广告组名
creative_set_id	是	广告组 ID
ad_id	是	广告 ID
ad	是	广告名称
ad_type	是	广告类型，取值如：GRAPHIC, VIDEO, REWARD, 或 PLAY
application		流量 App 名称
campaign_ad_type	是	如果是 User Acquisition Campaign，该值为 ua ，如果是 Retargeting Campaign，该值为 rt
campaign_package_name	是	推广 App 的包名，安卓端为 package name，iOS 端为 Bundle ID
campaign_store_id	是	推广 App 的应用市场 ID，安卓端为 package name，iOS 端为 iTunes ID 的数字部分
campaign_type	是	Campaign 的优化目标（PP, CPE, IAP ROAS, ad ROAS, or ROAS）
custom_page_id		与广告组关联的 iOS 自定义产品页或者 Android 商店详情页
country	是	两位英文字母的 Country Code
device_type	是	设备类型，取值如：phone, tablet 或 other
external_placement_id	是	经过编码的应用 ID
optimization_day_target		Campaign 的目标优化日期 (比如 day 0 或者 day 7)
platform	是	设备平台，取值如：android, ios, fireos, tvos
size	是	广告尺寸，取值如：INTER, BANNER, MREC, LEADER, 或 NATIVE
target_event		Campaign 的计价事件(只对 CPE Campaign 有效)
traffic_source	是	流量来源，取值为 AppLovin 或其他 exchange 渠道名

- 可选指标

以下是广告主报表可选的指标，您可以按照实际需要进行调整，请将需要字段的字段名写入 source.metrics 中

字段名	是否默认	含义
average_cpa	是	平均 CPA（安装）
average_cpc	是	平均 CPC
clicks	是	点击量
conversions	是	转化量（即安装量）
conversion_rate	是	转化率（安装量 / 点击量）
cost	是	广告成本
ctr	是	点击率
campaign_bid_goal		Campaign 的出价目标
campaign_roas_goal		Campaign 的 ROAS 目标
first_purchase		首次内购的用户数 (需要配置 Revenue 回调)
impressions	是	曝光量
sales	是	内购次数 (需要配置 Revenue 回调)

2.4.2 流量主报表（publisher）

流量主报表的模板如下：

{
    "sink_event":
    {
        "event_name": "applovin_publisher"
    },
    "source":
    {
        "group_by":
        [
            "day",
            "hour",
            "country",
            "ad_type",
            "size",
            "device_type",
            "platform",
            "application",
            "package_name",
            "store_id",
            "placement",
            "application_is_hidden",
            "zone",
            "zone_id",
            "bidding_integration"
        ],
        "report_types":
        [
            "publisher"
        ],
        "metrics":
        [
            "impressions",
            "clicks",
            "ctr",
            "revenue",
            "ecpm"
        ]
    }
}

• 模板中使用的时间粒度为小时，即数据中的 day + hour 字段，作为数据的时间
• 模板中使用的事件名为 -- applovin_publisher
• 其余字段都将会入库
• 可选维度

以下是流量主报表可选的维度，您可以按照实际需要进行调整，请将需要字段的字段名写入 source.group_by 中

字段名	是否默认	含义
day	是	报表的日期
hour	是	报表的小时值 (仅支持拉取最近 30 天的数据)，不使用此字段时，数据时间将只取 day
country	是	两位英文字母的 Country Code
ad_type	是	广告类型，取值如：GRAPHIC, PLAY, VIDEO, REWARD, 或 MRAID
size	是	广告尺寸，取值如：INTER, BANNER, MREC, LEADER, 或 NATIVE
device_type	是	设备类型，取值如：phone, tablet 或 other
platform	是	设备平台，取值如：android, ios, fireos, tvos
application	是	App 名称
package_name	是	推广 App 的包名，安卓端为 package name，iOS 端为 Bundle ID
store_id	是	推广 App 的应用市场 ID，安卓端为 package name；iOS 端为 iTunes ID 的数字部分，无法获取时取 Bundle ID
placement	是	Placement 名称
application_is_hidden	是	该 App 是否在 AppLovin 看板中被隐藏
zone	是	Zone 名称（仅当您的账号开启了 Zones）
zone_id	是	Zone ID（仅当您的账号开启了 Zones）
bidding_integration	是	集成的竞价方式（取值如 MAX 或 Admob Open Bidding）

- 可选指标

以下是广告主报表可选的指标，您可以按照实际需要进行调整，请将需要字段的字段名写入 source.metrics 中

以下是流量主报表返回的字段，您可以按照实际需要，选择返回的字段

字段名	是否默认	含义
impressions	是	曝光量
clicks	是	点击量
ctr	是	点击率
revenue	是	变现总收益
ecpm	是	ECPM

2.5 标准化字段

以下展示的是 AppLovin Basic Reporting API 的标准化字段：

• 广告主报表

原字段	标准化字段	含义
traffic_source	te_ads_object.media_source	变现渠道
campaign	te_ads_object.campaign_name	广告计划名
campaign_id_external	te_ads_object.campaign_id	广告计划 ID
creative_set	te_ads_object.ad_group_name	广告组名
creative_set_id	te_ads_object.ad_group_id	广告组 ID
ad	te_ads_object.ad_name	广告名
ad_id	te_ads_object.ad_id	广告 ID
campaign_package_name	te_ads_object.app_name	应用名
campaign_store_id	te_ads_object.app_id	应用 ID
country	te_ads_object.country	国家地区编码
platform	te_ads_object.platform	平台，即 Android、iOS 等
【USD】定值	te_ads_object.currency	投放的币种
impressions	te_ads_object.impressions	曝光量
clicks	te_ads_object.clicks	点击量
conversions	te_ads_object.installs	转化量（安装）
cost	te_ads_object.cost	买量成本

- 流量主报表

原字段	标准化字段	含义
country	te_ads_object.country	国家地区编码
platform	te_ads_object.platform	平台，即 Android、iOS 等
application	te_ads_object.app_name	应用名
package_name	te_ads_object.app_id	应用 ID
placement	te_ads_object.placement	广告位置
【USD】定值	te_ads_object.currency	变现收益的币种
impressions	te_ads_object.impressions	曝光量
clicks	te_ads_object.clicks	点击量
revenue	te_ads_object.revenue	变现收益