文档中心 > API类目 > 本地生活API

taobao.cpsreport.ad.get (本地生活饿了么淘客报表对外披露)

本地生活饿了么淘客报表对外披露

公共参数

请求地址：

环境	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());

响应示例

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>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部