淘宝开放平台

请求地址：

环境	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	必须	20	最小值：1 最大值：100	页大小，默认20，1~100
adzone_id	Number	可选	123		mm_xxx_xxx_xxx的第三位
page_no	Number	必须	1		页码，默认1
site_id	Number	可选	123		mm_xxx_xxx_xxx的第二位
activity_id	String	必须	sxxx		活动ID，现有活动id包括： 2月手淘拉新：119013_2；3月手淘拉新：119013_3；
settle_month	String	可选	201807		结算月份，需按照活动的结算月份传入具体的值：201807

名称	类型	示例值	描述
results	Data	data	data
data Data data data └ page_no Number 1 页码 └ page_size Number 20 每页大小 └ has_next Boolean true 是否有下一页 results Data [] resultList └ activity_id String dddxx 活动ID，2月活动ID：119013_2 └ biz_date String 20180321 日期 └ reg_user_cnt Number 100 新注册用户数 └ login_user_cnt Number 99 新激活用户数 └ alipay_user_cnt Number 88 首购用户数 └ rcv_valid_user_cnt Number 66 结算有效用户数 └ rcv_user_cnt Number 77 确认收货用户数 └ alipay_user_cpa_pre_amt String 44.33 结算CPA 奖励金额：仅支持member 维度的统计 └ bind_buy_user_cpa_pre_amt String 33.22 当日激活且首购结算的CPA 金额：仅适用于八天乐，仅支持member维度的统计 └ bind_buy_valid_user_cnt Number 55 当日激活且首购的有效用户数：仅适用于八天乐，支持member，adzone维度的统计 └ bind_card_valid_user_cnt Number bindCardValidUserCnt └ re_buy_valid_user_cnt Number reBuyValidUserCnt └ valid_num Number validNum └ relation_id String 234234 渠道关系id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScNewuserOrderSumRequest req = new TbkScNewuserOrderSumRequest();
req.setPageSize(20L);
req.setAdzoneId(123L);
req.setPageNo(1L);
req.setSiteId(123L);
req.setActivityId("sxxx");
req.setSettleMonth("201807");
TbkScNewuserOrderSumResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScNewuserOrderSumRequest req = new TbkScNewuserOrderSumRequest();
req.PageSize = 20L;
req.AdzoneId = 123L;
req.PageNo = 1L;
req.SiteId = 123L;
req.ActivityId = "sxxx";
req.SettleMonth = "201807";
TbkScNewuserOrderSumResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScNewuserOrderSumRequest;
$req->setPageSize("20");
$req->setAdzoneId("123");
$req->setPageNo("1");
$req->setSiteId("123");
$req->setActivityId("sxxx");
$req->setSettleMonth("201807");
$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.newuser.order.sum' \
-d 'partner_id=apidoc' \
-d 'session=d6a7a956-6532-41f0-93cc-307b0b69ae38' \
-d 'sign=43BCB8119573F3F5B008237CA760F5E1' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+19%3A21%3A50' \
-d 'v=2.0' \
-d 'activity_id=sxxx' \
-d 'adzone_id=123' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'settle_month=201807' \
-d 'site_id=123'

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

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

req.page_size=20
req.adzone_id=123
req.page_no=1
req.site_id=123
req.activity_id="sxxx"
req.settle_month="201807"
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.newuser.order.sum");
add_param(pRequest,"page_size","20");
add_param(pRequest,"adzone_id","123");
add_param(pRequest,"page_no","1");
add_param(pRequest,"site_id","123");
add_param(pRequest,"activity_id","sxxx");
add_param(pRequest,"settle_month","201807");
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.newuser.order.sum', {
	'page_size':'20',
	'adzone_id':'123',
	'page_no':'1',
	'site_id':'123',
	'activity_id':'sxxx',
	'settle_month':'201807'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_newuser_order_sum_response>
    <results>
        <data>
            <page_no>1</page_no>
            <page_size>20</page_size>
            <has_next>true</has_next>
            <results>
                <data>
                    <activity_id>dddxx</activity_id>
                    <biz_date>20180321</biz_date>
                    <reg_user_cnt>100</reg_user_cnt>
                    <login_user_cnt>99</login_user_cnt>
                    <alipay_user_cnt>88</alipay_user_cnt>
                    <rcv_valid_user_cnt>66</rcv_valid_user_cnt>
                    <rcv_user_cnt>77</rcv_user_cnt>
                    <alipay_user_cpa_pre_amt>44.33</alipay_user_cpa_pre_amt>
                    <bind_buy_user_cpa_pre_amt>33.22</bind_buy_user_cpa_pre_amt>
                    <bind_buy_valid_user_cnt>55</bind_buy_valid_user_cnt>
                    <bind_card_valid_user_cnt></bind_card_valid_user_cnt>
                    <re_buy_valid_user_cnt></re_buy_valid_user_cnt>
                    <valid_num></valid_num>
                    <relation_id>234234</relation_id>
                </data>
            </results>
        </data>
    </results>
</tbk_sc_newuser_order_sum_response>

{
    "tbk_sc_newuser_order_sum_response":{
        "results":{
            "data":{
                "page_no":1,
                "page_size":20,
                "has_next":true,
                "results":{
                    "data":[
                        {
                            "activity_id":"dddxx",
                            "biz_date":"20180321",
                            "reg_user_cnt":100,
                            "login_user_cnt":99,
                            "alipay_user_cnt":88,
                            "rcv_valid_user_cnt":66,
                            "rcv_user_cnt":77,
                            "alipay_user_cpa_pre_amt":"44.33",
                            "bind_buy_user_cpa_pre_amt":"33.22",
                            "bind_buy_valid_user_cnt":55,
                            "bind_card_valid_user_cnt":,
                            "re_buy_valid_user_cnt":,
                            "valid_num":,
                            "relation_id":"234234"
                        }
                    ]
                }
            }
        }
    }
}

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

错误码	错误描述	解决方案
isp.tbkapi-service-unavailable	淘宝客API服务不可用	请稍后重试
isv.invalid-parameter:start_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_tk_rate	参数填写不正确	参数填写不正确
4	查询不到对应的adzoneId	请检查adzoneId是否正确
2	pid不正确	请检查是否输入了正确的adzoneId和siteId

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

淘宝客API

taobao.tbk.sc.newuser.order.sum (淘宝客-服务商-拉新活动数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ