设备层级数据报告 API
修订历史
| 文档版本 | 发布时间 | 修订说明 |
|---|---|---|
| v4.0 | 2022-9-15 | 设备层级API支持TP预估收入查询 |
| v3.0 | - | 设备层级API支持自定义用户ID维度查询 |
| v2.0 | - | 支持设备层级数据查询 |
注意事项
- 接口会返回四个可供下载csv文件的url,有效时长15min，超过有效时长,请重新获取
- 四个csv文件对应我们四个计算中心的计算结果，汇总即为所有数据
- 由于用户分布不同，会存在某个计算中心没有对应数据，属于正常情况
因三方广告网络API存在数据时区问题，为确保数据的一致性，可以当天请求前天的数据，或者每次请求前两天数据进行数据覆盖刷新- 不支持获取一年前的历史数据，若有需要请联系您的客户经理。
- v4.0 Api 仅提供 2022-09-12 号及以后的报表数据
各时区数据更新时间点：
- UTC+8：5点(北京时间)
- UTC+0：15点(北京时间)
- UTC-8：次日2点(北京时间)
1. 接口校验
1.1 协议
HTTP
1.2 Header公共请求参数
需要在头部加入 Authorization: Bearer {your token}
| 参数 | 说明 | 样例 |
|---|---|---|
| Authorization | 授权信息 | Bearer {your token} |
curl --location --request POST 'https://openapi.tradplusad.com/v3/deviceReport' \
--header 'Authorization: Bearer 0C2FP316-0D66-5CDE-AD57-F48JS33DB9DC' \
--header 'Content-Type: application/json' \
--data-raw '{
"date" : "2022-09-15",
"timezone" : "UTC+0",
"currency" : "USD",
"appId" : "6640E7E3BDAC951B8F28D4C8C50E50B5"
}'
token 的获取：后台“我的账号”-“报表API key”-点击生成key`
2. 设备层级数据报告 API v4.0
2.1 URL
https://openapi.tradplusad.com/v4/deviceReport
2.2 请求协议
HTTP POST HTTP Content-Type: application/json
2.3请求参数
| 参数名 | 类型 | 是否必传 | 备注 | 样例 |
|---|---|---|---|---|
| date | String | Y | 日期，格式：YYYY-mm-dd，仅支持单天 | 2020-03-01 |
| timezone | String | N | 时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0" | UTC+8 |
| currency | String | N | 币种：不传默认USD 仅支持USD CNY | USD |
| appId | String | Y | 平台中应用ID，单选 |
2.4 返回参数
以csv文件形式返回，每一列对应的指标如下：
| 字段 | 类型 | 备注 |
|---|---|---|
| dateTimeStamp | int | 时间戳（日期） |
| appId | String | 应用ID （tradplus） |
| placementId | String | 广告位ID （tradplus） |
| placementName | String | 广告位名字（tradplus） |
| adFormat | Int | 广告位类型 |
| adFormatName | String | 广告位类型名字 |
| area | String | 国家地区编码(ISO 3166-1二位国家地区代码) |
| network | Int | 广告网络ID |
| networkName | String | 广告网络名字 |
| networkPlacementId | String | 广告网络的广告位ID信息 |
| networkPlacementName | String | 广告网络的广告源名称 （tradplus） |
| networkPlacementInfo | String | 广告网络的广告位详细信息 |
| androidId | String | 设备ID，androidid |
| gaid | String | Google的广告设备ID |
| idfa | String | iOS的设备ID |
| userId | String | 用户自定 义上传的Custom User ID |
| channel | String | 渠道 |
| sub_channel | String | 子渠道 |
| impression | Int | 展示数（tradplus） |
| click | Int | 点击数（tradplus） |
| revenue | Float | 收益 |
| ecpm | Float | 千次展示收益 |
| oaid | String | Android设备标识符 |
| idfv | String | 应用开发商标识符 |
| os_version | String | 终端os版本 |
| att_status | Int | 苹果ATT状态 (0:用户未决定; 1:受限制的; 2:拒绝的; 3:授权的) |
| tp_revenue | Float | TP预估收益 |
2.5 样例
请求样例：
{
"date" : "2022-09-15",
"timezone" : "UTC+0",
"currency" : "USD",
"appId" : "6640E7E3BDAC951B8F28D4C8C50E50B5"
}
响应样例：
//如果链接内容为空，表示没有该计算中心的数据
{
"url_cn": "https://tradplus-tracking-data-cn.oss-cn-shanghai.aliyuncs.com/user_api_v4%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=R4x8c34%2Ft3pmv%2FennYc%2Fxuv%2FWrU%3D",
"url_en": "https://tradplus-tracking-data-de.oss-eu-central-1.aliyuncs.com/user_api_v4%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=yulxcBdh%2F3%2BzjJP9HVVG5SeQ%2FDY%3D",
"url_in": "https://tradplus-tracking-data-in.oss-ap-south-1.aliyuncs.com/user_api_v4%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=FhlFPsyWmV88NHxAvMJK5SAbKXk%3D",
"url_sg": "https://tradplus-tracking-data-sg.oss-ap-south-1.aliyuncs.com/user_api_v4%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=FhlFPsyWmV88NHxAvMJK5SAbKXk%3D"
}
3. 设备层级数据报告 API v3.0
3.1 URL_V3
https://openapi.tradplusad.com/v3/deviceReport
3.2 请求协议_V3
HTTP POST HTTP Content-Type: application/json
3.3请求参数_V3
| 参数名 | 类型 | 是否必传 | 备注 | 样例 |
|---|---|---|---|---|
| date | String | Y | 日期，格式：YYYY-mm-dd，仅支持单天 | 2020-03-01 |
| timezone | String | N | 时区，枚举值，仅支持："UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0" | UTC+8 |
| currency | String | N | 币种：不传默认USD 仅支持USD CNY | USD |
| appId | String | Y | 平台中应用ID，单选 |
3.4 返回参数_V3
以csv文件形式返回，每一列对应的指标如下：
| 字段 | 类型 | 备注 |
|---|---|---|
| dateTimeStamp | int | 时间戳（日期） |
| appId | String | 应用ID （tradplus） |
| placementId | String | 广告位ID （tradplus） |
| placementName | String | 广告位名字（tradplus） |
| adFormat | Int | 广告位类型 |
| adFormatName | String | 广告位类型名字 |
| area | String | 国家地区编码(ISO 3166-1二位国家地区代码) |
| network | Int | 广告网络ID |
| networkName | String | 广告网络名字 |
| networkPlacementId | String | 广告网络的广告位ID信息 |
| networkPlacementName | String | 广告网络的广告源名称 （tradplus） |
| networkPlacementInfo | String | 广告网络的广告位详细信息 |
| androidId | String | 设备ID，androidid |
| gaid | String | Google的广告设备ID |
| idfa | String | iOS的设备ID |
| userId | String | 用户自定义上传 的Custom User ID |
| channel | String | 渠道 |
| sub_channel | String | 子渠道 |
| impression | Int | 展示数（tradplus） |
| click | Int | 点击数（tradplus） |
| revenue | Float | 收益 |
| ecpm | Float | 千次展示收益 |
| oaid | String | Android设备标识符 |
| idfv | String | 应用开发商标识符 |
| os_version | String | 终端os版本 |
| att_status | Int | 苹果ATT状态 (0:用户未决定; 1:受限制的; 2:拒绝的; 3:授权的) |
3.5 样例
请求样例：
{
"date" : "2021-07-1",
"timezone" : "UTC+0",
"currency" : "USD",
"appId" : "6640E7E3BDAC951B8F28D4C8C50E50B5"
}
响应样例：
{
"url_cn": "https://tradplus-tracking-data-cn.oss-cn-shanghai.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=R4x8c34%2Ft3pmv%2FennYc%2Fxuv%2FWrU%3D",
"url_en": "https://tradplus-tracking-data-de.oss-eu-central-1.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=yulxcBdh%2F3%2BzjJP9HVVG5SeQ%2FDY%3D",
"url_in": "https://tradplus-tracking-data-in.oss-ap-south-1.aliyuncs.com/user_api_v3%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=FhlFPsyWmV88NHxAvMJK5SAbKXk%3D",
"url_sg": "https://tradplus-tracking-data-sg.oss-ap-south-1.aliyuncs.com/user_api_v4%2F20210625%2F6640E7E3BDAC951B8F28D4C8C50E50B5.csv?Expires=1631502408&OSSAccessKeyId=LTAI4G15mptjxrMChg6SV1pF&Signature=FhlFPsyWmV88NHxAvMJK5SAbKXk%3D"
}