menu
Is this helpful?

# Adjust Report Service API

TIP

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

# 概要

# 接口简介

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

Adjust 的 Report Service API (opens new window) 提供了聚合的指标数据,包含了成本、收益、展示、点击、转化等诸多数据。

# 集成流程

Adjust Report Service API 数据的接入流程如下:

  1. 在 Adjust 后台,获取 Adjust API 识别码与应用识别码
  2. 登录 TE 后台,进入三方集成模块,新增 Adjust Report Service API 集成方案,并完成相关配置
  3. 查看 TE 系统否成功接收数据,并完成报表搭建

# 一、获取 Adjust API 识别码与应用识别码

# 1.1 获取 Adjust API 识别码

在从 Report Service API 获取之前,您需要先获取 Adjust API 识别码。该识别码可以在 Adjust Suite 后台的「账户设置」-「我的档案」中获取,经典控制面板在「我的账户」-「您的数据标签页中找到「用户详情」,点击底部齿轮按钮获取。

下图为 Adjust Suite 的界面,API 识别码即图中的 API Token:

# 1.2 获取应用识别码

接下来您还需要获取 Adjust 的应用识别码,这样才能决定拉取的数据来自于哪个 Adjust 项目。

进入到 Adjust 后台,查找应用并点击应用选项的插入符号 (^),左侧的项目卡片中就有应用识别码(即 App Token)。另外,您还可以点击项目卡片中的「全部设置」,点击「显示应用详细信息」亦可获取应用识别码。

# 二、方案配置

获取完 Adjust 的 API 识别码与应用识别码之后,您可以登录 TE 系统,在「三方集成」模块中完成新方案的配置。下图是 Adjust Report Service API 的配置界面,请您按照本章节内容完成方案的创建:

# 2.1 授权信息配置

点击「授权信息」按钮,在弹出框内填写 API 识别码与应用识别码

# 2.2 定时拉取

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

# 2.3 拉取时区

您还可以设置拉取的数据的时区,默认为 UTC+8

# 2.4 入库设置

您可以控制数据是否以事件的形式写入,我们建议您开启事件数据入库。

# 2.5 集成配置

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

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

模块 名称 含义
sink_event event_name 入库后的事件名,可以自定义
source metrics 数据中的指标,列表类型,可以自定义
group_by 数据中的分组维度,列表类型,可以自定义

您可以按照需要,对集成配置进行修改

# 2.5.1 涵盖指标

涵盖指标对应集成配置中的 source.metrics。由于 Report Service 支持的指标相当丰富,本节仅展示部分常用指标,您可以访问 Adjust 官网文档 (opens new window)获取详细的指标列表。如需修改指标,可以将所需指标的字段名填写在 source.metrics 中。

  • 转化指标
字段 定义 公式 字段名 模版默认使用
平均 DAUs 所选时间段的平均日活跃用户 (D0 DAU + D1 DAU + DAY N DAU) / 所选时间段天数 daus
平均 MAUs 所选时间段的平均 MAU (M0 MAU + M1 MAU + MONTH N MAU) / 所选时间段月数 maus
平均 WAUs 所选时间段的平均 WAU (W0 WAU + W1 WAU + WEEK N WAU) / 所选时间段周数 waus
基本 Sessions 数 用户的 sessions 数,排除安装和再归因 - base_sessions
点击数 追踪到的点击数 - clicks
点击数 (渠道) 由渠道 API 上报的点击数 - network_clicks
点击转化率 (CCR) 安装数与点击数的比值 安装数 / 点击数 click_conversion_rate
点击率(CTR) 点击和曝光的占比 点击数 / 曝光数 ctr
离归因 发生离归因的次数 - deattributions
行使 GDPR 遗忘权的用户数 行使了欧盟 GDPR 遗忘权的用户数。Adjust 将永久删除这些用户的个人数据 - gdpr_forgets
曝光数 追踪到的广告曝光数 - impressions
曝光数 (渠道) 由渠道 API 上报广告曝光数 - network_impressions
安装曝光比 安装数与曝光数的占比 安装数 / 曝光数 impression_conversion_rate
安装数 追踪到的安装您的 App 的用户数 - installs
安装数 (渠道) 由渠道 API 上报的安装数 - network_installs
安装差异数 安装数与渠道 API 上报的安装数的差值 安装数 - 安装数 (渠道) network_installs_diff
每千次展示安装数 (IPM) 每一千次广告展示引发的安装数 1000 * 展示转化比 installs_per_mile
限制追踪设备的安装数 打开限制追踪的设备 (LAT) 的安装数 - limit_ad_tracking_installs
限制追踪设备的安装占比 限制追踪设备的安装与安装数的比值 限制追踪设备的安装数 / 安装数 limit_ad_tracking_install_rate
限制追踪设备的再归因数 打开限制追踪的设备 (LAT) 的再归因数 - limit_ad_tracking_reattributions
限制追踪设备的再归因占比 限制追踪设备的再归因数 与再归因数的比值 限制追踪设备的再归因数 / 再归因数 limit_ad_tracking_reattribution_rate
非自然量安装数 不被归因为自然量的用户的安装数 - non_organic_installs
自然量安装数 归因为自然量的用户的安装数 - organic_installs
再归因数 再归因的用户数 - reattributions
再归因的重装数 再归因的用户的重新安装数 - reattribution_reinstalls
重新安装数 重新安装的次数 需购买 Uninstall and Reinstall Growth Solution - reinstalls
总 Sessions 数 总 Sessions 数包括安装和再归因 base_sessions + installs + reattributions sessions
- 成本指标
字段 定义 公式 字段名 模版默认使用
广告支出 广告的总支出(由拉取参数决定) 点击支出 + 曝光支出 + 安装支出 cost
广告支出(归因) Adjust 追踪到的广告支出 点击支出 + 曝光支出 + 安装支出 adjust_cost
广告支出(渠道) 由渠道 API 上报的广告支出 点击支出 + 曝光支出 + 安装支出 network_cost
广告支出差异 广告支出(归因)与广告支出(渠道)的差值 广告支出(归因)- 广告支出(渠道) network_cost_diff
点击成本 广告点击消耗的成本支出 - click_cost
付费点击数 有广告支出的广告点击数 - paid_clicks
eCPI (所有安装) 所有安装的平均有效支出 广告支出 / 安装 ecpi_all
eCPI (渠道) 由渠道 API 上报的安装的平均有效支出 渠道 API 上报的广告支出 / 渠道 API 上报的安装数 network_ecpi
eCPI (付费安装) 付费安装的平均有效支出 渠道 API 上报的广告支出 / 付费安装数 ecpi
eCPM (归因) 由归因数据上报 eCPM 数据 (广告支出 / 付费曝光数) * 1000 ecpm
eCPM (渠道) 由渠道 API 上报 eCPM 数据 (渠道支出 / 渠道付费曝光) * 1000 network_ecpm
eCPC 每次点击的平均有效支出 广告支出 / 付费点击数 ecpc
曝光成本 曝光消耗的成本支出 - impression_cost
付费曝光数 有广告支出的付费曝光数 - paid_impressions
安装成本 安装消耗的成本支出 - install_cost
付费安装数 有广告支出的付费安装数 - paid_installs
- 收益指标
字段 定义 公式 字段名 模版默认使用
广告曝光数 广告的总曝光数 - ad_impressions
广告收入 广告总收入 - ad_revenue
人群累计广告收入 所选时间段内安装的用户到当前的广告收入 例:选择时间为 1/1 号~1/31 号,今天为 5/1 号,则计算 1/1 号~1/31 号安装的用户到 5/1 号的广告收入 - cohort_ad_revenue
千次展示广告收入 每一千次广告展示的平均收入 (广告收益 / 广告曝光) * 1000 ad_rpm
内购收入 内购收入 - revenue
人群累计内购收入 所选时间段内安装的用户到当前的内购收入 例:选择时间为 1/1 号~1/31 号,今天为 5/1 号,则计算 1/1 号~1/31 号安装的用户到 5/1 号的内购收入 - cohort_revenue
总收入 包含广告收入以及内购收入的总收入 广告收入 + 内购收入 all_revenue
人群累计总收入 所选时间段内安装的用户到当前的总收入 例:选择时间为 1/1 号~1/31 号,今天为 5/1 号,则计算 1/1 号~1/31 号安装的用户到 5/1 号的总收入 人群累计内购收入 + 人群累计广告收入 cohort_all_revenue
ARPU (全部) 包含所有收入的平均活跃用户收益 总收入 / 总DAU arpdau
ARPU(仅广告) 仅包含广告收入的平均活跃用户收益 广告收入 / 总DAU arpdau_ad
ARPU (仅内购) 仅包含内购收入的平均活跃用户收益 内购收入 / 总DAU arpdau_iap
毛利润 总收入减去总成本 总收入 - 总成本 gross_profit
人群毛利润 所选时段安装的用户的毛利润 人群的总收入 - 成本 cohort_gross_profit
人群ROI 所选时段安装的用户的毛利润除以成本 人群的毛利润 / 成本 return_on_investment
内购数 追踪到的内购事件数 - revenue_events
收入成本比 (RCR) 所选时段安装的用户的收入与成本的比值 人群的总收入 / 总成本 revenue_to_cost
ROAS (总收入) 计算总收入的 ROAS (广告收入 + 内购收益) / 成本 roas
ROAS (广告收入) 只计算广告收入的 ROAS 广告收入 / 成本 roas_ad
ROAS (内购收入) 只计算内购收入的 ROAS 内购收益 / 成本 roas_iap

# 2.5.2 分组维度

以下是 Report Service 支持的分组维度,对应集成配置中的 source.group_by。包括时间粒度(只可选一个),以及分组维度(可多选)。如需修改指标,可以将所需指标的字段名填写在 source.group_by 中。

  • 时间粒度
维度 数据类型 描述 示例 模版默认使用
hour 日期 ISO 格式日期值:YYYY-MM-DDTHH:MM:SS 2021-05-11T17:00:45
day 日期 日期值格式:YYYY-MM-DD 2021-05-11
- 分组维度
维度 数据类型 描述 示例 模版默认使用
os_name 字符串 操作系统 取值:android、Bada、blackberry、iOS、Linux、Mac OS、server、symbian、unknown、WebOS、Windows、windows-phone
device_type 字符串 设备类型 取值:bot、console、iPod、Mac、PC、phone、server、simulator、tablet、TV、unknown
app 字符串 应用名称 -
app_token 字符串 Adjust 中的应用 ID -
store_id 字符串 商店应用 ID com.random.app
store_type 字符串 应用安装来源商店 google_play
app_network 字符串 应用标识 格式:: 如:google_play:com.random.app
currency 字符串 币种 Euro
currency_code 字符串 3 字符的 ISO 4217 货币代码 EUR
network 字符串 广告渠道的名称 取值:Organic, AppLovin, Facebook Installs, Instagram Installs
campaign 字符串 包含推广活动名称和 ID -
campaign_network 字符串 渠道的推广活动名称 -
campaign_id_network 字符串 渠道的推广活动 ID -
adgroup 字符串 包含广告组名称和 ID -
adgroup_network 字符串 渠道的广告组名称 -
adgroup_id_network 字符串 渠道的广告组 ID -
source_network 字符串 基于渠道的可选值, 一般与 adgroup_network 相同 -
source_id_network 字符串 source_app 值 -
creative 字符串 包含素材名称和 ID -
creative_network 字符串 渠道素材名称 -
creative_id_network 字符串 渠道素材 ID -
country 字符串 国家/地区名称 United States of America
country_code 字符串 2 字符 ISO 3166 国家/地区代码 US
region 字符串 业务地区 APAC
partner_name 字符串 Adjust 系统中的合作伙伴名称 AppLovin
partner_id 字符串 Adjust 系统中的合作伙伴 ID 34

# 2.5.3 入库规则

  • 使用数据中的 day 或 hour 字段,即数据的日期,设置为聚合数据的 #event_time
  • 模板中使用的事件名为 -- adjust_report_service_ad_spend,如需修改,请调整 sink_event.event_name
  • 其余指标、维度字段均会入库

# 2.6 标准化字段

以下展示的是 Report Service API 的标准化字段:

字段 标准化字段 含义
campaign_network te_ads_object.campaign_name 广告计划名
campaign_id_network te_ads_object.campaign_id 广告计划 ID
adgroup_network te_ads_object.ad_group_name 广告组名,变现广告的 Unit 名
adgroup_id_network te_ads_object.ad_group_id 广告组 ID,变现广告的 Unit ID
creative_network te_ads_object.ad_name 广告名
creative_id_network te_ads_object.ad_id 广告 ID
partner_name te_ads_object.media_source 媒体渠道或变现渠道
store_id te_ads_object.app_id 应用 ID
app te_ads_object.app_name 应用名
os_name te_ads_object.platform 平台,即 Android、iOS 等
country_code te_ads_object.country 国家地区编码
currency_code te_ads_object.currency 成本或收益的币种
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 变现收益

# 三、后续使用

# 3.1 数据入库检查

您可以在「数据管理」页面查看事件 adjust_report_service_ad_spend 是否入库

# 3.2 单次拉取数据

如果您希望接入之前一段时间的数据,比如历史数据或者补上拉取失败的数据。可以在保存方案后再次进入方案页面,点击右上角的单次拉取按钮进行一次确定时间范围的数据拉取。需要注意的是,如果您拉取的数据的时间段与之前有重叠,比如拉取了 2023-08-01 的数据,而这一天的数据在之前已经拉取过,则最新一次拉取的数据将覆盖之前的数据: