注意:接入Api前请先熟悉api签名机制(参考接口鉴权说明), 即Api请求样例中的一些http请求头的来源
使用注意:
• 数据支持的时间从Hyperbid运营人员开通权限后开始支持生成(例如1号开通权限,最早2号才能拉取到某些时区数据,具体时间参考下面的提前任务各时区数据更新时间点),并且只保留最近30天数据。返回的内容以文件形式提供,如果当时未获取到数据请隔天再重试。注意:Hyperbid每天生成各个时区数据任务会执行两次,一次为提前任务,一次为兜底任务,提前任务的收益数据可能不完整(决定因素是不同广告平台出报表数据时间不一样,某些广告平台提前任务时可能还没有出报表数据),开发者可根据需要再拉一次兜底任务后数据
•提前任务各时区数据更新时间点:
1、utc+8:延迟1天,下午11:30点(utc+8)更新
2、utc+0:延迟1天,下午5:30点(utc+8)更新
3、utc-8:延迟2天,上午1:30点(utc+8)更新
•兜底任务各时区数据更新时间点:
1、utc+8:延迟2天,上午4点(utc+8)更新
2、utc+0:延迟2天,上午12点(utc+8)更新
3、utc-8:延迟3天,上午4点(utc+8)更新
1 请求URL
https://openapi.hyperbid.com/v1/device/report
2 请求方式
GET
3 请求参数
| 字段 | 类型 | 是否必传 | 备注 | 样例 |
|---|---|---|---|---|
| day | Int | Y | 开始日期,格式:YYYYmmdd | 20190501,仅支持1天前的日期 |
| app_id | String | Y | 开发者后台的应用ID,单选 | xxxxx |
| timezone | Int | N | 时区支持 | -8,8,0三个时区 |
请求样例:
curl --location --request GET https://openapi.hyperbid.com/v1/device/report? app_id=a606c22b789bc3&day=20210823&timezone=8' \
--header 'X-Up-Key: 877f8ae9c6e9ca82c0===b5fff594c373axxx' \
--header 'X-Up-Signature: CE12B506DBCD868C2C6F09E08C139CBC' \
--header 'X-Up-Timestamp: 1626056011000' \
--header 'Content-Type: application/json'
4 返回参数
此接口返回报表数据的下载链接,开发者获取此链接后,可直接在浏览器中下载报表数据。链接格式如下:
文件以csv形式提供,用","作为分隔符,具体参数内容如下:
| 参数 | 对应字段 | 描述 |
| 聚合单元ID | placement_id | |
| 聚合单元名称 |
placement_name |
|
| 广告类型 |
placement_format |
0: native 1: rewarded_video 2: banner, 3: interstitial 4: splash |
| 广告单元ID | unit_id | |
| Google的广告设备ID | gaid | |
| iOS的设备ID | idfa | |
| 国家 |
area |
|
| 对照组或测试组 |
is_abtest |
0:表示对照组或未开通A/B测试 1:表示测试组 |
| 对照组或测试组id | abtest_item_id | |
| 流量分组ID | segment_id | |
| 流量分组名称 | segment_name | |
| iOS的设备ID | idfv | |
| 安卓的设备ID | oaid | |
| 开发者的自定义用户ID | user_id |
|
| 广告平台ID |
network_firm_id |
|
| 广告平台名称 |
network_firm |
|
| 聚合平台ID |
mediation_id |
|
| 聚合平台名称 |
mediation_name |
|
| 开发者账号币种,USD表示美元,CNY表示人民币 |
currency |
|
| 设备的操作系统版本 |
os_version |
|
| 设备的ATT授权状态 |
att_status |
|
| 设备类型 |
device_type |
枚举值说明: 0: 非IOS设备 1: iphone 2: ipad |
| 设备品牌名 | brand | |
| 设备型号 | model | |
| 应用版本名 | app_vn | |
| 应用版本号 | app_vc | |
| 新用户类型,枚举值说明: |
new_user_type |
1: 是新用户 2: 不是新用户 |
| 渠道标识 | channel | |
| 展示数 |
impression |
|
| 点击数 |
click |
|
| 预估收益,按开发者账号币种返回的预估收益 | estimated_revenue |