淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
page_size	Number	必须	100	每页大小
page_no	Number	必须	1	页码
dimensions	String	可选	ds	聚合条件
filters	String	必须	ds=20191017;hasCount=true	查询条件;ds为日期，hasCount表示是否获取数量，建议第一次获取，后续传入false以提高整个接口响应性能
return_fields	String	可选	ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt	查询结果返回的字段
report_type_id	String	必须	union_channel_content_3rd_v1	报表名称

名称	类型	示例值	描述
data_list	MapData []	map数组	结果列表
└ ds String 20190525 日期 └ cm_3rd_pub_share_fee String 1.5 达人结算预估收入 └ cm_pub_share_fee String 1.5 平台结算预估收入 └ pre_3rd_pub_share_fee String 1.5 达人预估收入 └ pre_pub_share_fee String 1.5 平台预估收入 └ alipay_amt String 10 成交金额 └ alipay_num Number 10 成交笔数 └ union_pv Number 100 联盟口径pv └ sub_adzone_id Number 1234 达人adzoneid └ sub_site_id Number 1234 达人siteid └ sub_pub_id Number 1234 达人pubid └ name String 1234 达人名称 └ pub_id Number 1234 平台pud_id └ union_uv Number 100 联盟口径uv └ red_envelope_gmt String 10 优品推广-权益成交Alipay金额 └ red_envelope_num Number 10 超级红包发放数量 └ activity_promotion_gmt String 10 优品推广成交Alipay金额 └ pre_red_envelope_media_share_fee String 10 超红媒体预估收益
report_type_id	String	union_channel_content_3rd_v1	报表名称
page_info	RptPageinfo	map	分页信息
└ total_cnt Number 1234 总数 └ page_no Number 1 页数 └ page_size Number 100 每页大小

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgReportsQueryStatRequest req = new TbkDgReportsQueryStatRequest();
req.setPageSize(100L);
req.setPageNo(1L);
req.setDimensions("ds");
req.setFilters("ds=20191017;hasCount=true");
req.setReturnFields("ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt");
req.setReportTypeId("union_channel_content_3rd_v1");
TbkDgReportsQueryStatResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgReportsQueryStatRequest req = new TbkDgReportsQueryStatRequest();
req.PageSize = 100L;
req.PageNo = 1L;
req.Dimensions = "ds";
req.Filters = "ds=20191017;hasCount=true";
req.ReturnFields = "ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt";
req.ReportTypeId = "union_channel_content_3rd_v1";
TbkDgReportsQueryStatResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgReportsQueryStatRequest;
$req->setPageSize("100");
$req->setPageNo("1");
$req->setDimensions("ds");
$req->setFilters("ds=20191017;hasCount=true");
$req->setReturnFields("ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt");
$req->setReportTypeId("union_channel_content_3rd_v1");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.tbk.dg.reports.query.stat' \
-d 'partner_id=apidoc' \
-d 'sign=35463EE2CFA713FAC80AB480863D0AB3' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+00%3A50%3A17' \
-d 'v=2.0' \
-d 'dimensions=ds' \
-d 'filters=ds%3D20191017%3BhasCount%3Dtrue' \
-d 'page_no=1' \
-d 'page_size=100' \
-d 'report_type_id=union_channel_content_3rd_v1' \
-d 'return_fields=ds%2Ccm_3rd_pub_share_fee%2Ccm_pub_share_fee%2Cpre_3rd_pub_share_fee%2Cpre_pub_share_fee%2Calipay_amt%2Calipay_num%2Cunion_pv%2Csub_adzone_id%2Csub_site_id%2Csub_pub_id%2Cname%2Cpub_id%2Cunion_uv%2Cred_envelope_gmt%2Cred_envelope_num%2Cactivity_promotion_gmt'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TbkDgReportsQueryStatRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.page_size=100
req.page_no=1
req.dimensions="ds"
req.filters="ds=20191017;hasCount=true"
req.return_fields="ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt"
req.report_type_id="union_channel_content_3rd_v1"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.tbk.dg.reports.query.stat");
add_param(pRequest,"page_size","100");
add_param(pRequest,"page_no","1");
add_param(pRequest,"dimensions","ds");
add_param(pRequest,"filters","ds=20191017;hasCount=true");
add_param(pRequest,"return_fields","ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt");
add_param(pRequest,"report_type_id","union_channel_content_3rd_v1");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.tbk.dg.reports.query.stat', {
	'page_size':'100',
	'page_no':'1',
	'dimensions':'ds',
	'filters':'ds=20191017;hasCount=true',
	'return_fields':'ds,cm_3rd_pub_share_fee,cm_pub_share_fee,pre_3rd_pub_share_fee,pre_pub_share_fee,alipay_amt,alipay_num,union_pv,sub_adzone_id,sub_site_id,sub_pub_id,name,pub_id,union_uv,red_envelope_gmt,red_envelope_num,activity_promotion_gmt',
	'report_type_id':'union_channel_content_3rd_v1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_reports_query_stat_response>
    <data_list>
        <map_data>
            <ds>20190525</ds>
            <cm_3rd_pub_share_fee>1.5</cm_3rd_pub_share_fee>
            <cm_pub_share_fee>1.5</cm_pub_share_fee>
            <pre_3rd_pub_share_fee>1.5</pre_3rd_pub_share_fee>
            <pre_pub_share_fee>1.5</pre_pub_share_fee>
            <alipay_amt>10</alipay_amt>
            <alipay_num>10</alipay_num>
            <union_pv>100</union_pv>
            <sub_adzone_id>1234</sub_adzone_id>
            <sub_site_id>1234</sub_site_id>
            <sub_pub_id>1234</sub_pub_id>
            <name>1234</name>
            <pub_id>1234</pub_id>
            <union_uv>100</union_uv>
            <red_envelope_gmt>10</red_envelope_gmt>
            <red_envelope_num>10</red_envelope_num>
            <activity_promotion_gmt>10</activity_promotion_gmt>
            <pre_red_envelope_media_share_fee>10</pre_red_envelope_media_share_fee>
        </map_data>
    </data_list>
    <report_type_id>union_channel_content_3rd_v1</report_type_id>
    <page_info>
        <total_cnt>1234</total_cnt>
        <page_no>1</page_no>
        <page_size>100</page_size>
    </page_info>
</tbk_dg_reports_query_stat_response>

{
    "tbk_dg_reports_query_stat_response":{
        "data_list":{
            "map_data":[
                {
                    "ds":"20190525",
                    "cm_3rd_pub_share_fee":"1.5",
                    "cm_pub_share_fee":"1.5",
                    "pre_3rd_pub_share_fee":"1.5",
                    "pre_pub_share_fee":"1.5",
                    "alipay_amt":"10",
                    "alipay_num":10,
                    "union_pv":100,
                    "sub_adzone_id":1234,
                    "sub_site_id":1234,
                    "sub_pub_id":1234,
                    "name":"1234",
                    "pub_id":1234,
                    "union_uv":100,
                    "red_envelope_gmt":"10",
                    "red_envelope_num":10,
                    "activity_promotion_gmt":"10",
                    "pre_red_envelope_media_share_fee":"10"
                }
            ]
        },
        "report_type_id":"union_channel_content_3rd_v1",
        "page_info":{
            "total_cnt":1234,
            "page_no":1,
            "page_size":100
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案
1001	非法的me参数值	传入正确的me参数值，含有券ID与商品ID信息
10000	该itemId对应的宝贝已下架或非淘客宝贝	更换新的itemId查询
4	查询不到对应的adzoneId，请检查adzoneId是否正确	查询不到对应的adzoneId，请检查adzoneId是否正确
30002	参数q与cat不能都为空	参数q与cat不能都为空
2	pid不正确，请检查是否输入了正确的adzoneId和siteId	pid不正确，请检查是否输入了正确的adzoneId和siteId
40001	内部调用失败	联系开发人员
50001	无结果	无结果
30001	非法的物料id	非法的物料id

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.dg.reports.query.stat (淘宝客-推广者-媒体数据报表交换-汇总数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ