淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
site_id	Number	可选	1423		淘客siteId

名称	类型	示例值	描述
is_success	Boolean	true	执行成功
biz_error_desc	String	无权限	错误提示信息
biz_error_code	Number	21	错误码
total_count	Number	12	对应pid个数
result	TkPidDTO []		淘客PID信息
└ pid String mm_1423_1432_1423 pid └ name String 爱淘宝推广位推广位名称

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScAdzoneQueryRequest req = new TbkScAdzoneQueryRequest();
req.setSiteId(1423L);
TbkScAdzoneQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScAdzoneQueryRequest req = new TbkScAdzoneQueryRequest();
req.SiteId = 1423L;
TbkScAdzoneQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScAdzoneQueryRequest;
$req->setSiteId("1423");
$resp = $c->execute($req, $sessionKey);

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.sc.adzone.query' \
-d 'partner_id=apidoc' \
-d 'session=f313e4e0-4b5f-4ec2-8ac2-48c1477f749d' \
-d 'sign=374C2221CB45011484DEC9F5923A4C24' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-14+17%3A36%3A17' \
-d 'v=2.0' \
-d 'site_id=1423'

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

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

req.site_id=1423
try:
	resp= req.getResponse(sessionkey)
	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.sc.adzone.query");
add_param(pRequest,"site_id","1423");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.sc.adzone.query', {
	'site_id':'1423'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_adzone_query_response>
    <is_success>true</is_success>
    <biz_error_desc>无权限</biz_error_desc>
    <biz_error_code>21</biz_error_code>
    <total_count>12</total_count>
    <result>
        <tk_pid_d_t_o>
            <pid>mm_1423_1432_1423</pid>
            <name>爱淘宝推广位</name>
        </tk_pid_d_t_o>
    </result>
</tbk_sc_adzone_query_response>

{
    "tbk_sc_adzone_query_response":{
        "is_success":true,
        "biz_error_desc":"无权限",
        "biz_error_code":21,
        "total_count":12,
        "result":{
            "tk_pid_d_t_o":[
                {
                    "pid":"mm_1423_1432_1423",
                    "name":"爱淘宝推广位"
                }
            ]
        }
    }
}

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

错误码	错误描述	解决方案

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

开放平台

淘宝客API

taobao.tbk.sc.adzone.query (淘宝客-服务商-联盟推广位查询API)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ