淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
activity_id	String	必须	119013_8		活动id，活动名称与活动ID列表，请参见https://tbk.bbs.taobao.com/detail.html?appId=45301&postId=8599277
start_time	Date	可选	2018-08-01 00:00:00	默认值：2018-08-01 00:00:00	首购完成开始时间，传入时间都会格式化为：yyyy-MM-dd 00:00:00
page_no	Number	可选	1	默认值：1	页码，默认1
page_size	Number	可选	20	默认值：20	页大小，默认20，1~100
end_time	Date	可选	2018-09-01 00:00:00	默认值：2018-09-01 00:00:00	首购完成结束时间，传入时间都会格式化为：yyyy-MM-dd 00:00:00，注意：结束时间与开始时间必须跨天

名称	类型	示例值	描述
data	PageResult	data	data
results Result [] results results └ pid String mm_xx_xx_xx pid └ first_buy_num Number 6 首购用户数 └ valid_user_num Number 3 有效用户数 └ relation_id String 23424323 渠道关系id └ page_no Number 1 页码 └ page_size Number 20 页大小 └ has_next Boolean true 是否有下一页

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgNewuserOrderEstimateRequest req = new TbkDgNewuserOrderEstimateRequest();
req.setActivityId("119013_8");
req.setStartTime(StringUtils.parseDateTime("2018-08-01 00:00:00"));
req.setPageNo(1L);
req.setPageSize(20L);
req.setEndTime(StringUtils.parseDateTime("2018-09-01 00:00:00"));
TbkDgNewuserOrderEstimateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgNewuserOrderEstimateRequest req = new TbkDgNewuserOrderEstimateRequest();
req.ActivityId = "119013_8";
req.StartTime = DateTime.Parse("2018-08-01 00:00:00");
req.PageNo = 1L;
req.PageSize = 20L;
req.EndTime = DateTime.Parse("2018-09-01 00:00:00");
TbkDgNewuserOrderEstimateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgNewuserOrderEstimateRequest;
$req->setActivityId("119013_8");
$req->setStartTime("2018-08-01 00:00:00");
$req->setPageNo("1");
$req->setPageSize("20");
$req->setEndTime("2018-09-01 00:00:00");
$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.newuser.order.estimate' \
-d 'partner_id=apidoc' \
-d 'sign=27A7157064E7BDA864A4AE136AFAD931' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+23%3A15%3A18' \
-d 'v=2.0' \
-d 'activity_id=119013_8' \
-d 'end_time=2018-09-01+00%3A00%3A00' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'start_time=2018-08-01+00%3A00%3A00'

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

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

req.activity_id="119013_8"
req.start_time="2018-08-01 00:00:00"
req.page_no=1
req.page_size=20
req.end_time="2018-09-01 00:00:00"
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.newuser.order.estimate");
add_param(pRequest,"activity_id","119013_8");
add_param(pRequest,"start_time","2018-08-01 00:00:00");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"end_time","2018-09-01 00:00:00");
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.newuser.order.estimate', {
	'activity_id':'119013_8',
	'start_time':'2018-08-01 00:00:00',
	'page_no':'1',
	'page_size':'20',
	'end_time':'2018-09-01 00:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_newuser_order_estimate_response>
    <data>
        <results>
            <result>
                <pid>mm_xx_xx_xx</pid>
                <first_buy_num>6</first_buy_num>
                <valid_user_num>3</valid_user_num>
                <relation_id>23424323</relation_id>
            </result>
        </results>
        <page_no>1</page_no>
        <page_size>20</page_size>
        <has_next>true</has_next>
    </data>
</tbk_dg_newuser_order_estimate_response>

{
    "tbk_dg_newuser_order_estimate_response":{
        "data":{
            "results":{
                "result":[
                    {
                        "pid":"mm_xx_xx_xx",
                        "first_buy_num":6,
                        "valid_user_num":3,
                        "relation_id":"23424323"
                    }
                ]
            },
            "page_no":1,
            "page_size":20,
            "has_next":true
        }
    }
}

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.dg.newuser.order.estimate (淘宝客-推广者-拉新活动首购预估数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ