AppsFlyer Pull API

TIP

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

概要

接口简介

接口名	类型	粒度	归因	成本	收益	展示	点击	转化
Pull API	API	聚合指标		✅	✅	✅	✅	✅

AppsFlyer Pull API 聚合指标接口 (opens new window)提供了不同类型的聚合指标数据，目前 TE 系统支持拉取 Partners 与 Geo 数据。

集成流程

1. 登录 AppsFlyer 后台，获取 V2.0 API Token 与 App ID
2. 登录 TE 后台，进入三方集成模块，新增 AppsFlyer Pull API 方案，并完成相关配置
3. 查看 TE 系统否成功接收数据，并完成报表搭建

一、获取 API Token 与 App ID

1.1 获取 API Token

请您登录管理员账号，并在 AppsFlyer 侧边栏菜单中找到「API Access」，并且获取用于 Pull API 的 V2.0 API Token。

1.2 获取 App ID

可以在 AppsFlyer 后台「My Apps」找到您的应用的 App ID，安卓端以com.开头，如 com.demoapp.ta，iOS 以id开头，如id12345678

二、方案配置

获取完 AppsFlyer 的 API Token 与 App ID 之后，您可以登录 TE 系统，在「三方集成」模块中完成新方案的配置。下图是 AppsFlyer Pull API 的配置界面，请您按照本章节内容完成方案的创建：

2.1 授权信息配置

点击「授权信息」按钮，在弹出框内填写 API Token 与 App ID

2.2 定时拉取

您可以在「定时拉取」模块设置 TE 系统定时拉取 AppsFlyer Pull API 数据的策略，可以选择在每天的某时拉取一段时间的数据。由于拉取的数据也会计算再数据量中，建议您在不要定时拉取太长时间的数据

2.3 入库设置

您可以控制数据是否以事件的形式写入，如果关闭，则数据将不会写入事件表，因此请不要关闭该配置。

2.4 集成配置

最后，您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的类型，拉取的维度，以及入库后的事件名等。

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

模块	名称	含义
sink_event	event_mapping	入库后的事件名，可以自定义
source	report_types	拉取的数据类型，可以自定义，但只可以选择一个。可选 partner 或 geo，分别可拉取按媒体渠道和按地区的数据
transfer	double_columns	数值类型字段定义，写在此处的字段将会以数值类型入库，需填写入库后的字段名
	fields_whitelist	字段过滤，列表类型，如果列表不为空，则 TE 系统只会入库列表中的字段，不在列表中的字段会被抛弃
extra_params	media_source	默认情况下不需要设置，仅当您需要单独拉取 Facebook 数据时需要配置，此时请填入 facebook

2.4.1 Partner 数据

本节介绍的是 Partner (opens new window) 类型的数据，该报告基于 LTV 数据，即拉取指定时间段内安装的新用户的后续数据。

字段含义	字段名	备注
数据时间	#event_time
代理	agency_pmd_af_prt
媒体渠道	media_source_pid
广告计划名	campaign_c
ARPU	arpu	指标字段，数值类型，请写入 extra_params.double_columns 中
平均 eCPI	average_ecpi
点击数	clicks
转化率	conversion_rate
CTR	ctr
Impressions	impressions
Installs	installs
Loyal Users	loyal_users
Loyal Users/Installs	loyal_users_installs
ROI	roi
Sessions	sessions
Total Cost	total_cost
Total revenue	total_revenue

由于 Facebook 的数据格式与其他媒体渠道的格式不同，因此如果您只需要拉取 Facebook 数据，则可以在 extra_params 中增加一条 "media_source":"facebook" 的配置。此时将增加以下字段：

字段含义	字段名
广告计划名	campaign_name
广告计划 ID	campaign_id
广告组 ID	adgroup_id
广告组名	adgroup_name
广告 Set ID	adset_id
广告 Set 名	adset_name

2.4.2 Geo 数据

本节介绍的是 Geo (opens new window)类型的数据，该报告基于 LTV 数据，即拉取指定时间段内安装的新用户的后续数据。

由于 Facebook 的数据格式与其他媒体渠道的格式不同，因此 TE 系统会分别拉取仅有 Facebook 数据与所有平台数据，以下是 Geo 能够获取到的字段：

字段	入库名	备注
国家地区	country
数据时间	#event_time
代理	agency_pmd_af_prt
媒体渠道	media_source_pid
广告计划名	campaign_c
ARPU	arpu	指标字段，数值类型，请写入 extra_params.double_columns 中
点击数	clicks
转化率	conversion_rate
安装数	installs
忠实用户数	loyal_users
Sessions 数	sessions
总收入	total_revenue

由于 Facebook 的数据格式与其他媒体渠道的格式不同，因此如果您只需要拉取 Facebook 数据，则可以在 extra_params 中增加一条 "media_source":"facebook" 的配置。此时将增加以下字段：

字段含义	字段名
广告计划名	campaign_name
广告计划 ID	campaign_id
广告组 ID	adgroup_id
广告组名	adgroup_name
广告 Set ID	adset_id
广告 Set 名	adset_name

2.5 数据入库规则

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

• 由于 Pull API 聚合指标接口返回的是聚合数据，因此我们将使用一个固定值作为其用户标识，您可以认为所有数据挂载在一个虚拟用户上
• 使用数据中的 Date 字段，即用户的注册时间，作为事件的 #event_time
• 数据事件名为：
  • Partner
    • appsflyer_partner_data
  • Geo
    • appsflyer_geo_data
• 其他字段将全数入库

2.6 标准化字段

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

原始字段	标准化字段	含义
media_source_pid	te_ads_object.media_source	媒体渠道
campaign_c（全平台）	te_ads_object.campaign_name	广告计划名
campaign_id（Facebook）	te_ads_object.campaign_id	（Facebook）广告计划 ID
campaign_name（Facebook）	te_ads_object.campaign_name	（Facebook）广告计划名
adset_id（Facebook）	te_ads_object.ad_group_id	（Facebook）广告组 ID
adset_name（Facebook）	te_ads_object.ad_group_name	（Facebook）广告组名
adgroup_id（Facebook）	te_ads_object.ad_id	（Facebook）广告 ID
adgroup_name（Facebook）	te_ads_object.ad_name	（Facebook）广告名
country	te_ads_object.country	国家地区编码
platform	te_ads_object.platform	平台，即 Android、iOS 等
app_id	te_ads_object.app_id	应用 ID
app_name	te_ads_object.app_name	应用名
currency	te_ads_object.currency	币种
impressions	te_ads_object.impressions	曝光量
clicks	te_ads_object.clicks	点击量
installs	te_ads_object.installs	转化量（安装）
total_cost	te_ads_object.cost	投放成本