Skip to main content

设备层级数据报告 API

修订历史#

文档版本发布时间修订说明
v2.0-支持设备层级数据查询
v3.0-设备层级API支持自定义用户ID维度查询

1. 接口校验#

1.1 协议#

HTTP

1.2 Header公共请求参数#

需要在头部加入 Authorization: Bearer {your token}

参数说明样例
Authorization授权信息Bearer {your token}
curl -v -H "Authorization: Bearer 96d6b7ae-d522-45b4-b8ac-dc12008814ef" -d {post data} https://openapi.tradplusad.com/v2/allreport
token 的获取:后台“我的账号”-“报表API key”-点击生成key

2. 设备层级数据报告 API#

2.1.1 URL_V3 (推荐)#

https://openapi.tradplusad.com/v3/deviceReport

2.1.2 请求协议_V3#

HTTP POST
HTTP Content-Type: application/json

2.1.3请求参数_V3#

参数名类型是否必传备注样例
dateStringY日期,格式:YYYY-mm-dd,仅支持单天2020-03-01
timezoneStringN时区,枚举值,仅支持:"UTC+8"、"UTC+0"、"UTC-8"。不传默认为"UTC+0"UTC+8
currencyStringN币种:不传默认USD 仅支持USD CNYUSD
appIdStringY平台中应用ID,单选

2.1.4 返回参数_V3#

以csv文件形式返回
字段类型备注
dateTimeStampint时间戳(日期)
appIdString应用ID (tradplus)
placementIdString广告位ID (tradplus)
placementNameString广告位名字(tradplus)
adFormatInt广告位类型
adFormatNameString广告位类型名字
areaString国家地区编码(ISO 3166-1二位国家地区代码)
networkInt广告网络ID
networkNameString广告网络名字
networkPlacementIdString广告网络的广告位ID信息
networkPlacementNameString广告网络的广告源名称 (tradplus)
networkPlacementInfoString广告网络的广告位详细信息
androidIdString设备ID,androidid
gaidStringGoogle的广告设备ID
idfaStringiOS的设备ID
userIdString用户自定义上传的Custom User ID
channelString渠道
sub_channelString子渠道
impressionInt展示数(tradplus)
clickInt点击数(tradplus)
revenueFloat收益
ecpmFloat千次展示收益
oaidStringAndroid设备标识符
idfvString应用开发商标识符
os_versionString终端os版本
att_statusInt苹果ATT状态 (0:用户未决定; 1:受限制的; 2:拒绝的; 3:授权的)
  • 接口会返回三个可供下载csv文件的url,有效时长15min,超过有效时长,请重新获取

  • 三个csv文件对应我们三个计算中心的计算结果,汇总即为所有数据

  • 由于用户分布不同,会存在某个计算中心没有对应数据,属于正常情况

  • 三方API返回数据时区问题,请求当天往前推两天的数据会比较准确,或者每次请求前两天数据进行覆盖刷新

  • 人民币报表仅支持2021-02-21号及以后的数据

  • 渠道、子渠道支持2021-03-01号及以后的数据

  • 终端os版本、苹果ATT状态支持2021-06-21号及以后的数据

    > 备注:各时区数据更新时间点:

  • UTC+8 5点(北京时间)

  • UTC+0 15点(北京时间)

  • UTC-8 次日2点(北京时间)

2.1.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"
}

2.2.1 URL_V2 (已废弃)#

https://openapi.tradplusad.com/v2/deviceReport

2.2.2 请求协议_V2#

HTTP POST
HTTP Content-Type: application/json

2.2.3 请求参数_V2#

参数名类型是否必传备注样例
dateStringY日期,格式:YYYY-mm-dd,仅支持单天2020-03-01
currencyStringN币种:不传默认USD 仅支持USD CNYUSD
appIdStringY平台中应用ID,单选

2.2.4 返回参数_V2#

以csv文件形式返回
字段类型备注
dateTimeStampint时间戳(日期)
appIdString应用ID (tradplus)
placementIdString广告位ID (tradplus)
placementNameString广告位名字(tradplus)
adFormatInt广告位类型
adFormatNameString广告位类型名字
areaString国家地区编码(ISO 3166-1二位国家地区代码)
networkInt广告网络ID
networkNameString广告网络名字
networkPlacementIdString广告网络的广告位ID信息
networkPlacementNameString广告网络的广告源名称 (tradplus)
networkPlacementInfoString广告网络的广告位详细信息
androidIdString设备ID,androidid
gaidStringGoogle的广告设备ID
idfaStringiOS的设备ID
impressionInt展示数(tradplus)
clickInt点击数(tradplus)
revenueFloat收益
ecpmFloat千次展示收益
  • 接口会返回三个可供下载csv文件的url,有效时长15min,超过有效时长,请重新获取
  • 三个csv文件对应我们三个计算中心的计算结果,汇总即为所有数据
  • 由于用户分布不同,会存在某个计算中心没有对应数据,属于正常情况
  • 三方API返回数据时区问题,请求当天往前推两天的数据会比较准确,或者每次请求前两天数据进行覆盖刷新
  • 人民币报表仅支持2021-02-21号以后的数据

备注:各时区数据更新时间点:

  • UTC+8 5点(北京时间)
  • UTC+0 15点(北京时间)
  • UTC-8 次日2点(北京时间)