阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
start_date	String	必须	2019-01-01 00:00:00	开始时间
end_date	String	必须	2019-01-10 00:00:00	结束时间
start	Number	必须	0	开始启始下标（注意不是页码，从0开始）
limit	Number	必须	500	每页条数

名称	类型	示例值	描述
results	PageResultDTO	ss	接口返回model
result_list BuyShopOrderTagDTO [] ele 系统自动生成 └ channel_no String bd_cps01 渠道号 └ track_pid String mm_26632746_817850406_109379600142 track_pid └ rid String 0000036488 rid └ create_time String 2019-01-01 11:11:11 订单日期 └ commissed Boolean true 是否结佣 └ is_coupon_draw_acc_fstord7d Number 0 是否领券后7天内首单 └ is_shop_clk7d Number 1 是否有在会场内该门店的点击记录（7天内订单，超过7天的则不计入） └ is_use_taoke_coupon14d Number 0 是否使用饿了么渠道优惠券 └ is_newuser_rebuy14d Number 1 是否新客复购单 └ is_acc_fstord7d Number 0 是否新客首单 └ coupon_amt String 2.5 券核销金额 └ order_city_name String 杭州下单的城市名称 └ pay_amt String 24.95 支付金额 └ order_id String 2116762769741060280 订单id └ extra_info String 扩展字段（order_type：new_retail（新零售）、take_out（餐饮）、 coupon（卡券）； use_order_id：卡券对应的核销外卖订单的id； use_order_time：卡券对应的核销外卖订单的订单日期） └ success Boolean true 系统自动生成 └ error_code String 系统自动生成 └ total_count Number 120 总条数 └ error_msg String 系统自动生成

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CpsreportAdGetRequest req = new CpsreportAdGetRequest();
req.setStartDate("2019-01-01 00:00:00");
req.setEndDate("2019-01-10 00:00:00");
req.setStart(0L);
req.setLimit(500L);
CpsreportAdGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CpsreportAdGetRequest req = new CpsreportAdGetRequest();
req.StartDate = "2019-01-01 00:00:00";
req.EndDate = "2019-01-10 00:00:00";
req.Start = 0L;
req.Limit = 500L;
CpsreportAdGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CpsreportAdGetRequest;
$req->setStartDate("2019-01-01 00:00:00");
$req->setEndDate("2019-01-10 00:00:00");
$req->setStart("0");
$req->setLimit("500");
$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.cpsreport.ad.get' \
-d 'partner_id=apidoc' \
-d 'sign=BDAD81D0FEA65A28868A07E489FA8206' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A36%3A22' \
-d 'v=2.0' \
-d 'end_date=2019-01-10+00%3A00%3A00' \
-d 'limit=500' \
-d 'start=0' \
-d 'start_date=2019-01-01+00%3A00%3A00'

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

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

req.start_date="2019-01-01 00:00:00"
req.end_date="2019-01-10 00:00:00"
req.start=0
req.limit=500
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.cpsreport.ad.get");
add_param(pRequest,"start_date","2019-01-01 00:00:00");
add_param(pRequest,"end_date","2019-01-10 00:00:00");
add_param(pRequest,"start","0");
add_param(pRequest,"limit","500");
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.cpsreport.ad.get', {
	'start_date':'2019-01-01 00:00:00',
	'end_date':'2019-01-10 00:00:00',
	'start':'0',
	'limit':'500'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cpsreport_ad_get_response>
    <results>
        <result_list>
            <buy_shop_order_tag_d_t_o>
                <channel_no>bd_cps01</channel_no>
                <track_pid>mm_26632746_817850406_109379600142</track_pid>
                <rid>0000036488</rid>
                <create_time>2019-01-01 11:11:11</create_time>
                <commissed>true</commissed>
                <is_coupon_draw_acc_fstord7d>0</is_coupon_draw_acc_fstord7d>
                <is_shop_clk7d>1</is_shop_clk7d>
                <is_use_taoke_coupon14d>0</is_use_taoke_coupon14d>
                <is_newuser_rebuy14d>1</is_newuser_rebuy14d>
                <is_acc_fstord7d>0</is_acc_fstord7d>
                <coupon_amt>2.5</coupon_amt>
                <order_city_name>杭州</order_city_name>
                <pay_amt>24.95</pay_amt>
                <order_id>2116762769741060280</order_id>
                <extra_info></extra_info>
            </buy_shop_order_tag_d_t_o>
        </result_list>
        <success>true</success>
        <error_code></error_code>
        <total_count>120</total_count>
        <error_msg></error_msg>
    </results>
</cpsreport_ad_get_response>

{
    "cpsreport_ad_get_response":{
        "results":{
            "result_list":{
                "buy_shop_order_tag_d_t_o":[
                    {
                        "channel_no":"bd_cps01",
                        "track_pid":"mm_26632746_817850406_109379600142",
                        "rid":"0000036488",
                        "create_time":"2019-01-01 11:11:11",
                        "commissed":true,
                        "is_coupon_draw_acc_fstord7d":0,
                        "is_shop_clk7d":1,
                        "is_use_taoke_coupon14d":0,
                        "is_newuser_rebuy14d":1,
                        "is_acc_fstord7d":0,
                        "coupon_amt":"2.5",
                        "order_city_name":"杭州",
                        "pay_amt":"24.95",
                        "order_id":"2116762769741060280",
                        "extra_info":""
                    }
                ]
            },
            "success":true,
            "error_code":"",
            "total_count":120,
            "error_msg":""
        }
    }
}

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.cpsreport.ad.get (本地生活饿了么淘客报表对外披露)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈