# AppsFlyer Master API
TIP
请注意，第三方数据集成产生的数据会被纳入集群的消耗数据量
# 概要
# 接口简介
| 接口名 | 类型 | 粒度 | 归因 | 成本 | 收益 | 展示 | 点击 | 转化 |
|---|---|---|---|---|---|---|---|---|
| Master API | API | 聚合指标 | ✅ | ✅ | ✅ | ✅ |
Master API (opens new window) 支持自定义分析维度以及聚合指标，相较于 Pull API 聚合指标接口而言，灵活性更强。
# 集成流程
- 登录 AppsFlyer 后台，获取 V2.0 API Token 与 App ID
- 登录 TE 后台，进入三方集成模块，新增 AppsFlyer Master API 方案，并完成相关配置
- 查看 TE 系统否成功接收数据，并完成报表搭建
# 一、获取 API Token 与 App ID
# 1.1 获取 API Token
请您登录管理员账号，并在 AppsFlyer 侧边栏菜单中找到「API Access」，并且获取用于 Master 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 Master API 的配置界面，请您按照本章节内容完成方案的创建：
# 2.1 授权信息配置
点击「授权信息」按钮，在弹出框内填写 API Token 与 App ID
# 2.2 定时拉取
您可以在「定时拉取」模块设置 TE 系统定时拉取 AppsFlyer Master API 数据的策略，可以选择在每天的某时拉取一段时间的数据。由于拉取的数据也会计算再数据量中，建议您在不要定时拉取太长时间的数据
# 2.3 拉取时区
您还可以设置拉取的数据的时区，默认为 UTC+0
# 2.4 入库设置
您可以控制数据是否以事件的形式写入，如果关闭，则数据将不会写入事件表，因此请不要关闭该配置。
# 2.5 集成配置
最后，您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的类型，拉取的维度，以及入库后的事件名等。
集成配置中的内容是一个 JSON，您可以按照以下内容进行自定义配置：
| 模块 | 名称 | 含义 |
|---|---|---|
| sink_event | event_name | 入库后的事件名，可以自定义 |
| source | metrics | 数据中的指标维度，列表类型，可以自定义 |
| group_by | 数据中的分组维度，列表类型，可以自定义 |
以下列举的是分组维度，如果您需要调整，可以修改 source.group_by，调整时请使用字段名。
| 字段含义 | 字段名 | 入库名 | 默认 |
|---|---|---|---|
| App ID | app_id | app_id | ✓ |
| Media Source | pid | media_source | ✓ |
| Agency | af_prt | partner | ✓ |
| Campaign | c | campaign | ✓ |
| Adset | af_adset | adset | ✓ |
| Ad | af_ad | ad | ✓ |
| Channel | af_channel | channel | ✓ |
| Publisher ID | af_siteid | publisher_id_af_siteid | ✓ |
| Keywords | af_keywords | keywords | |
| Is Primary Attribution | is_primary | is_primary_attribution | |
| Campaign ID | af_c_id | campaign_id | |
| Adset ID | af_adset_id | adset_id | |
| Ad ID | af_ad_id | ad_id | |
| Install Time | install_time | install_time | ✓ |
| Touch Type | attributed_touch_type | touch_type | ✓ |
| GEO | geo | geo | ✓ |
Master API 包含了多种类型的指标，以下列举的是 Master API 的部分常用字段，如需了解全量字段，可以访问 AppsFlyer 官网文档 (opens new window)：
WARNING
请注意，部分指标支持的维度字段不同，如需调整，建议联系 TE 工作人员进行操作
如果您需要调整，可以修改 source.metrics
| 入库名 | 描述 | 默认 |
|---|---|---|
| impressions | 曝光数 | ✓ |
| clicks | 点击数 | ✓ |
| installs | 安装数 | ✓ |
| cr | 转化率 | ✓ |
| sessions | Session 数 | ✓ |
| loyal_users | 忠实用户安装数 | ✓ |
| loyal_users_rate | 忠实用户比例 | ✓ |
| cost | 总成本 | ✓ |
| revenue | 总收益 | ✓ |
| roi | ROI | ✓ |
| arpu_ltv | 平均生命周期价值 | ✓ |
| average_ecpi | 平均eCPI | ✓ |
| uninstalls | 卸载数 | ✓ |
| uninstalls_rate | 卸载率 | ✓ |
| retention_day_[x] | 第 N 天留存用户数（N = 0,1,2,3,4,5,6,7,15,30） | |
| retention_rate_day_[x] | 第 N 天留存用户率（N = 0,1,2,3,4,5,6,7,15,30） | |
| cohort_day_[x]_total_revenue_per_user | 第 N 日累积收益（N = 1,2,3,4,5,6,7,15,30,40,50,60,70,80,90） | |
| cohort_day_[x]_revenue_per_user | 第 N 日当天收益（N = 1,2,3,4,5,6,7,15,30,40,50,60,70,80,90） | |
| cohort_[x]_days_total_revenue_per_user | 同第 N 日累积收益（N = 1,2,3,4,5,6,7,15,30,40,50,60,70,80,90） |
# 2.6 数据入库规则
默认情况下，我们会将拉取的数据以事件形式写入 TE 项目中：
- 由于 Master API 聚合指标接口返回的是聚合数据，因此我们将使用一个固定值作为其用户标识，您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 install_time 字段，即用户的注册时间，作为事件的 #event_time
- 数据事件名为：appsflyer_master_data
- 其他字段将全数入库
# 2.7 标准化字段
以下事件属性会进行标准化处理：
| 原始字段 | 标准化字段 | 含义 |
|---|---|---|
| media_source | te_ads_object.media_source | 媒体渠道 |
| campaign | te_ads_object.campaign_name | 广告计划名 |
| campaign_id | te_ads_object.campaign_id | 广告计划 ID |
| adset | te_ads_object.ad_group_name | 广告组名 |
| adset_id | te_ads_object.ad_group_id | 广告组 ID |
| ad | te_ads_object.ad_name | 广告名 |
| ad_id | te_ads_object.ad_id | 广告 ID |
| app_id | te_ads_object.app_id | 应用 ID |
| geo | te_ads_object.country | 国家地区编码 |
| impressions | te_ads_object.impressions | 曝光量 |
| clicks | te_ads_object.clicks | 点击量 |
| installs | te_ads_object.installs | 转化量（安装） |
| cost | te_ads_object.cost | 投放成本 |
| revenue | te_ads_object.revenue | 变现收益 |