# ironSource Reporting API

TIP

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

# 概要

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

Reporting API (opens new window) 是 ironSource 的聚合指标数据接口，您可以通过该接口获得包括曝光、收益以及用户活跃等聚合的指标数据。

首先，您需要登录 ironSource 后台，获取必要的授权信息

首先，点击右上角的用户菜单，进入到「My Account」页面的「Reporting API」标签页，获取 Secret Key 与 Refresh Token
接下来，进入到 ironSource 后台「Ad Unit」页面，在「APPLICATIONS」列表中选中您想要接入的应用，在右侧卡片中将会展示该应用的 App Key，将其记录下来（注意 iOS 和安卓是分开的，如需接入两个平台的数据，需要配置两个方案，并输入各自的 App Key）

完成 SDK 配置后，接下来需要您登录 TE 系统后台，在「三方集成」模块中完成 ironSource Reporting API 的配置。下图是 ironSource 的配置界面：

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

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

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

您可以在集成配置模块对数据拉取的细节配置进行控制。比如入库后的事件名、拉取指标以及可选维度等。

集成配置是一个 JSON，你可以按照需要对其中的内容进行调整

- 可选维度

以下是 Reporting API 的可选维度。请注意，每个分析维度可以支持的指标都是不同的，具体对应关系，可以参考 ironSource 官网文档 (opens new window)。如需调整，请将需要的维度名写入 source.group_by 中

维度名	入库字段名	描述	是否默认	备注
date	date	数据时间	是
adUnits	adUnits	广告单元	是
app	appKey	应用 Key	是
	bundleId	应用 ID	是
	appName	应用名	是
platform	platform	应用平台	是
adSource	providerName	广告来源	是
instance	instanceName	实例名		与 segment, placement 互斥
instance	instanceId	实例 ID		与 segment, placement 互斥
country	countryCode	国家（地区）编号	是
segment	segment	用户被归到的流量分组名		与 instance, placement 互斥
placement	placement	版位		与 instance, segment 互斥
osVersion	osVersion	操作系统版本		最多四选一
connectionType	connectionType	网络连接类型
sdkVersion	sdkVersion	SDK 版本
appVersion	appVersion	应用版本
att	att	ATT 状态
idfa	idfa	IDFA 是否可用
abTest	abTest	A/B Test 标签

- 指标字段

以下是 Reporting API 支持的指标列表，默认情况下我们会拉取所有字段。需要注意，可用指标会受到分析维度的影响，实际接收到的指标会少于下表所示内容。如需调整，请将需要的字段名写入 source.metrics 中

字段名	描述
revenue	总收益
eCPM	eCPM
appFillRate	广告填充率（曝光数 / 请求数）
appRequests	广告请求数
impressions	曝光数
completions	完成数奖励视频：视频完播数 Offerwall：完成目标数
revenuePerCompletion	平均完成收益额（收益 / 完成数）
appFills	广告填充数
useRate	广告曝光填充比
activeUsers	DAU
engagedUsers	广告互动用户数
engagedUsersRate	广告互动用户占比
impressionsPerEngagedUser	广告互动用户平均广告曝光数
revenuePerActiveUser	即 ARPU 值（单位是美分）
revenuePerEngagedUser	广告互动用户 ARPU 值（单位是美分）
clicks	总点击数
clickThroughRate	点击率（CTR）
completionRate	完成特定行为的用户数，即转化数
adSourceChecks	广告源检查广告是否可用次数
adSourceResponses	广告源产生响应次数
adSourceAvailabilityRate	广告可用比例（曝光数 / 广告响应数）
sessions	Session 数
engagedSessions	有广告互动的 Session 数
impressionsPerSession	平均每 Session 曝光数
impressionPerEngagedSessions	平均每次有广告互动的 Session 的曝光数
sessionsPerActiveUser	平均每用户 Session 数

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