AppLovin Cohort API 集成方案

TIP

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

概要

接口简介

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

AppLovin 的 Cohort API 可以返回类似于留存分析模型的新增后 N 日数据，包括新增后 N 日的变现、曝光等数据，详情可以参考 Cohort API 文档 (opens new window)。

集成流程

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

一、获取 Report Key

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

二、方案配置

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

2.1 授权信息配置

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

API Key 即为刚刚获得的 Report Key

2.2 定时拉取

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

2.3 事件表入库设置

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

2.4 集成配置

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

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

模块	名称	含义
sink_event	event_mapping	入库后的事件名，可以自定义
source	report_types	拉取数据的报表类型，由于不同报表类型的数据差异过大，所以只允许您填写一个报表类型，如果写入多个，则只有列表中的第一个报表类型会拉取
	metrics	数据中的指标，列表类型，不同报表类型支持不同的 metrics，填写时需要注意
	group_by	数据中的分组维度，列表类型，不同报表类型支持不同的 group_by，填写时需要注意

2.4.1 revenue 报表

• 模板

以下是 revenue 报表的模板，如果您希望拉取 revenue 报表，可以复制以下 JSON 并粘贴到集成配置中，并进行自定义调整：

{
  "sink_event": {
    "event_mapping": {
      "revenue": "applovin_revenue_cohort_data",
      "session": "applovin_session_cohort_data",
      "imp": "applovin_imp_cohort_data"
    }
  },
  "source": {
    "group_by": [
      "day",
      "application",
      "package_name",
      "platform",
      "country"
    ],
    "report_types": [
      "revenue"
    ],
    "metrics": [
      "pub_revenue_0",
      "iap_pub_revenue_0",
      "ads_pub_revenue_0",
      "reward_pub_revenue_0",
      "inter_pub_revenue_0",
      "banner_pub_revenue_0",
      "mrec_pub_revenue_0",
      "rpi_0",
      "iap_rpi_0",
      "ads_rpi_0",
      "reward_rpi_0",
      "inter_rpi_0",
      "banner_rpi_0",
      "mrec_rpi_0"
    ]
  }
}

• 分组维度

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

字段	说明	取值样例
day	数据日期	2019/3/25
application	应用名称	My App
package_name	应用包名或 Bundle ID	com.my.test.app
platform	应用平台，取值：android, fireos, ios	android
country	两位字母的 Country Code	gb

- 指标字段

以下是支持的指标字段，如果需要调整，可以修改 source.metrics，请将 X 替换为需要的日期（可选值 0, 1, 2, 3, 4, 5, 6, 7, 10, 14, 18, 21, 24, 27, 30, 45）

字段	说明	取值样例
pub_revenue_X	安装后的 X 日的总收益	39.35
iap_pub_revenue_X	安装后的 X 日内购收益	21.23
ads_pub_revenue_X	安装后的 X 日广告收益	18.12
reward_pub_revenue_X	安装后的 X 日激励视频广告收益	9.12
inter_pub_revenue_X	安装后的 X 日插屏广告收益	6.1
banner_pub_revenue_X	安装后的 X 日 Banner 广告收益	2.54
mrec_pub_revenue_X	安装后的 X 日 MREC （中型矩型）广告收益	0.48
rpi_X	安装后的 X 日每安装总收益	0.15
iap_rpi_X	安装后的 X 日每安装内购收益	0.08
ads_rpi_X	安装后的 X 日每安装广告收益	0.07
reward_rpi_X	安装后的 X 日每安装激励视频广告收益	0.05
inter_rpi_X	安装后的 X 日每安装插屏广告收益	0.04
banner_rpi_X	安装后的 X 日每安装 Banner 广告收益	0.03
mrec_rpi_X	安装后的 X 日每安装 MREC （中型矩型）广告收益	0.02

#

2.4.2 imp 报表

• 模板

以下是 imp 报表的模板，如果您希望拉取 imp 报表，可以复制以下 JSON 并粘贴到集成配置中，并进行自定义调整：

{
  "sink_event": {
    "event_mapping": {
      "revenue": "applovin_revenue_cohort_data",
      "session": "applovin_session_cohort_data",
      "imp": "applovin_imp_cohort_data"
    }
  },
  "source": {
    "group_by": [
      "day",
      "application",
      "package_name",
      "platform",
      "country"
    ],
    "report_types": [
      "imp"
    ],
    "metrics": [
      "installs",
      "user_count_0",
      "imp_0",
      "imp_per_user_0",
      "inter_imp_0",
      "inter_imp_per_user_0",
      "reward_imp_0",
      "reward_imp_per_user_0",
      "banner_imp_0",
      "banner_imp_per_user_0",
      "mrec_imp_0",
      "mrec_imp_per_user_0"      
    ]
  }
}

• 分组维度

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

字段	说明	取值样例
day	数据日期	2019/3/25
application	应用名称	My App
package_name	应用包名或 Bundle ID	com.my.test.app
platform	应用平台，取值：android, fireos, ios	android
country	两位字母的 Country Code	gb

- 指标字段

以下是支持的指标字段，如果需要调整，可以修改 source.metrics，请将 X 替换为需要的日期（可选值 0, 1, 2, 3, 4, 5, 6, 7, 10, 14, 18, 21, 24, 27, 30, 45）

字段	说明	取值样例
installs	新增安装数	2842
user_count_X	安装后的 X 日的总活跃用户数	612
imp_X	安装后的 X 日的广告总曝光数	6120
imp_per_user_X	安装后的 X 日的平均每用户广告曝光数：imp_X / user_count_X	10
inter_imp_X	安装后的 X 日的插屏广告曝光数	1224
inter_imp_per_user_X	安装后的 X 日的平均每用户插屏广告曝光数：inter_imp_X / user_count_X	2
reward_imp_X	安装后的 X 日的激励视频广告曝光数	1836
reward_imp_per_user_X	安装后的 X 日的平均每用户激励视频广告曝光数：reward_imp_X / user_count_X	3
banner_imp_X	安装后的 X 日的 Banner 广告曝光数	2448
banner_imp_per_user_X	安装后的 X 日的平均每用户 Banner 广告曝光数：banner_imp_X / user_count_X	4
mrec_imp_X	安装后的 X 日 MREC （中型矩型）曝光数	612
mrec_imp_per_user_X	安装后的 X 日的平均每用户 MREC （中型矩型）广告曝光数：mrec_imp_X / user_count_X	1

2.4.3 session 报表

• 模板

以下是 session 报表的模板，如果您希望拉取 session 报表，可以复制以下 JSON 并粘贴到集成配置中，并进行自定义调整：

{
  "sink_event": {
    "event_mapping": {
      "revenue": "applovin_revenue_cohort_data",
      "session": "applovin_session_cohort_data",
      "imp": "applovin_imp_cohort_data"
    }
  },
  "source": {
    "group_by": [
      "day",
      "application",
      "package_name",
      "platform",
      "country"
    ],
    "report_types": [
      "session"
    ],
    "metrics": [
      "installs",
      "daily_usage_0",
      "session_count_0",
      "user_count_0",
      "session_length_0",
      "retention_0"
    ]
  }
}

• 分组维度

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

字段	说明	取值样例
day	数据日期	2019/3/25
application	应用名称	My App
package_name	应用包名或 Bundle ID	com.my.test.app
platform	应用平台，取值：android, fireos, ios	android
country	两位字母的 Country Code	gb

- 指标字段

以下是支持的指标字段，如果需要调整，可以修改 source.metrics，请将 X 替换为需要的日期（可选值 0, 1, 2, 3, 4, 5, 6, 7, 10, 14, 18, 21, 24, 27, 30, 45）

字段	说明	取值样例
installs	新增安装数	2842
daily_usage_X	安装后的 X 日的用户平均在线时长（秒）	501
session_count_X	安装后的 X 日的总 Session 数	1240
user_count_X	安装后的 X 日的总活跃用户数	401
session_length_X	安装后的 X 日的用户平均 Session 时长（秒）：daily_usage_X / session_count_X	0.404
retention_X	安装后的 X 日的留存率：user_count_X / installs	0.141

2.5 数据入库规则

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

• 使用数据中的 day 字段，即数据的日期，设置为聚合数据的 #event_time
• 数据事件名为：
  • applovin_revenue_cohort_data
  • applovin_imp_cohort_data
  • applovin_session_cohort_data
• 其余字段都将会入库

2.6 标准化字段

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

原始字段	标准化字段	含义
package_name	te_ads_object.app_id	应用 ID
application	te_ads_object.app_name	应用名
platform	te_ads_object.platform	平台，即 Android、iOS 等
country	te_ads_object.country	国家地区编码
【USD】定值	te_ads_object.currency	变现收益的币种
installs	te_ads_object.installs	安装量