设备层级数据报告 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 &quot;Authorization: Bearer 96d6b7ae-d522-45b4-b8ac-dc12008814ef&quot; -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#

参数名	类型	是否必传	备注	样例
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.1.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:授权的)

接口会返回三个可供下载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#

参数名	类型	是否必传	备注	样例
date	String	Y	日期，格式：YYYY-mm-dd，仅支持单天	2020-03-01
currency	String	N	币种：不传默认USD 仅支持USD CNY	USD
appId	String	Y	平台中应用ID，单选

2.2.4 返回参数_V2#

以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
impression	Int	展示数（tradplus）
click	Int	点击数（tradplus）
revenue	Float	收益
ecpm	Float	千次展示收益

接口会返回三个可供下载csv文件的url,有效时长15min，超过有效时长,请重新获取
三个csv文件对应我们三个计算中心的计算结果，汇总即为所有数据
由于用户分布不同，会存在某个计算中心没有对应数据，属于正常情况
三方API返回数据时区问题，请求当天往前推两天的数据会比较准确，或者每次请求前两天数据进行覆盖刷新
人民币报表仅支持2021-02-21号以后的数据

备注：各时区数据更新时间点：
UTC+8 5点(北京时间)
UTC+0 15点(北京时间)
UTC-8 次日2点(北京时间)