淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
report_type_id	String	必须	union_channel_content_basic_v1	报表名称
return_fields	String	可选	name	查询字段
filters	String	必须	ds=20180919	查询条件
dimensions	String	可选	ds	聚合条件
page_no	Number	必须	1	页码
page_size	Number	必须	20	每页大小

名称	类型	示例值	描述
page_info	RptPageinfo	map	分页信息
└ page_size Number 100 每页大小 └ page_no Number 1 页数 └ total_cnt Number 20 总数
row_list	Json	id,pub_id,name,sub_pub_id,sub_site_id,sub_adzone_id,biz_type,click,num_of_miid,alipay_num,alipay_amt,pre_pub_share_fee,pre_3rd_pub_share_fee,cm_pub_share_fee,cm_3rd_pub_share_fee,ds	行值数组
column_list	String []	id 主键,pub_id 平台pubid,name 达人名称,sub_pub_id 达人pubid,sub_site_id 达人siteid,sub_adzone_id 达人adzoneid,biz_type 业务类型,click 淘客点击（宽口径）,num_of_miid 淘客点击UV（宽口径）,alipay_num 成交笔数,alipay_amt 成交金额,pre_pub_share_fee 平台预估收入,pre_3rd_pub_share_fee 达人预估收入,cm_pub_share_fee 平台结算预估收入,cm_3rd_pub_share_fee 达人结算预估收入,ds 日期	列名数组
report_type_id	String	union_channel_content_basic_v1	报表名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgReportsQueryRequest req = new TbkDgReportsQueryRequest();
req.setReportTypeId("union_channel_content_basic_v1");
req.setReturnFields("name");
req.setFilters("ds=20180919");
req.setDimensions("ds");
req.setPageNo(1L);
req.setPageSize(20L);
TbkDgReportsQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgReportsQueryRequest req = new TbkDgReportsQueryRequest();
req.ReportTypeId = "union_channel_content_basic_v1";
req.ReturnFields = "name";
req.Filters = "ds=20180919";
req.Dimensions = "ds";
req.PageNo = 1L;
req.PageSize = 20L;
TbkDgReportsQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgReportsQueryRequest;
$req->setReportTypeId("union_channel_content_basic_v1");
$req->setReturnFields("name");
$req->setFilters("ds=20180919");
$req->setDimensions("ds");
$req->setPageNo("1");
$req->setPageSize("20");
$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' \
-d 'partner_id=apidoc' \
-d 'sign=A57A9DB7588466399F066690C9A4A612' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+16%3A16%3A13' \
-d 'v=2.0' \
-d 'dimensions=ds' \
-d 'filters=ds%3D20180919' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'report_type_id=union_channel_content_basic_v1' \
-d 'return_fields=name'

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

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

req.report_type_id="union_channel_content_basic_v1"
req.return_fields="name"
req.filters="ds=20180919"
req.dimensions="ds"
req.page_no=1
req.page_size=20
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");
add_param(pRequest,"report_type_id","union_channel_content_basic_v1");
add_param(pRequest,"return_fields","name");
add_param(pRequest,"filters","ds=20180919");
add_param(pRequest,"dimensions","ds");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","20");
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', {
	'report_type_id':'union_channel_content_basic_v1',
	'return_fields':'name',
	'filters':'ds=20180919',
	'dimensions':'ds',
	'page_no':'1',
	'page_size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_reports_query_response>
    <page_info>
        <page_size>100</page_size>
        <page_no>1</page_no>
        <total_cnt>20</total_cnt>
    </page_info>
    <row_list>id,pub_id,name,sub_pub_id,sub_site_id,sub_adzone_id,biz_type,click,num_of_miid,alipay_num,alipay_amt,pre_pub_share_fee,pre_3rd_pub_share_fee,cm_pub_share_fee,cm_3rd_pub_share_fee,ds</row_list>
    <column_list>
        <string>id  主键</string>
        <string>pub_id  平台pubid</string>
        <string>name  达人名称</string>
        <string>sub_pub_id  达人pubid</string>
        <string>sub_site_id  达人siteid</string>
        <string>sub_adzone_id 达人adzoneid</string>
        <string>biz_type  业务类型</string>
        <string>click 淘客点击（宽口径）</string>
        <string>num_of_miid  淘客点击UV（宽口径）</string>
        <string>alipay_num  成交笔数</string>
        <string>alipay_amt  成交金额</string>
        <string>pre_pub_share_fee  平台预估收入</string>
        <string>pre_3rd_pub_share_fee  达人预估收入</string>
        <string>cm_pub_share_fee  平台结算预估收入</string>
        <string>cm_3rd_pub_share_fee  达人结算预估收入</string>
        <string>ds  日期</string>
    </column_list>
    <report_type_id>union_channel_content_basic_v1</report_type_id>
</tbk_dg_reports_query_response>

{
    "tbk_dg_reports_query_response":{
        "page_info":{
            "page_size":100,
            "page_no":1,
            "total_cnt":20
        },
        "row_list":"id,pub_id,name,sub_pub_id,sub_site_id,sub_adzone_id,biz_type,click,num_of_miid,alipay_num,alipay_amt,pre_pub_share_fee,pre_3rd_pub_share_fee,cm_pub_share_fee,cm_3rd_pub_share_fee,ds",
        "column_list":{
            "string":[
                "id  主键",
                "pub_id  平台pubid",
                "name  达人名称",
                "sub_pub_id  达人pubid",
                "sub_site_id  达人siteid",
                "sub_adzone_id 达人adzoneid",
                "biz_type  业务类型",
                "click 淘客点击（宽口径）",
                "num_of_miid  淘客点击UV（宽口径）",
                "alipay_num  成交笔数",
                "alipay_amt  成交金额",
                "pre_pub_share_fee  平台预估收入",
                "pre_3rd_pub_share_fee  达人预估收入",
                "cm_pub_share_fee  平台结算预估收入",
                "cm_3rd_pub_share_fee  达人结算预估收入",
                "ds  日期"
            ]
        },
        "report_type_id":"union_channel_content_basic_v1"
    }
}

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
50001	无结果	无结果

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

淘宝客API

taobao.tbk.dg.reports.query (报表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ