淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
search_option	RidReportOption	可选			入参
└ biz_date String 可选 2020-01-01 请求日期（天维度） └ relation_id String 可选 123 渠道关系id └ biz_month String 可选 2020-06 请求日期（月维度，暂不支持）

名称	类型	示例值	描述
result	Result		返回结果封装对象
data Data 1234 真正的业务数据结构 └ promo_uv String 0 非自购订单购买用户数(选定时间内去重) └ promo_alipay_amt String 0 非自购订单金额 └ individual_uv String 1 自购订单购买用户数(选定时间内去重) └ promo_alipay_num String 0 非自购订单笔数 └ purchase_uv String 1 购买用户数(选定时间内去重) └ purchase_alipay_num String 2 购买订单笔数 └ individual_alipay_num String 1 自购订单笔数 └ purchase_alipay_amt String 13 购买订单金额 └ individual_alipay_amt String 0 自购订单金额 └ success Boolean true 是否成功 └ result_code Number 200 接口返回值信息 └ biz_error_desc String demo 业务错误描述 └ result_msg String demo 返回信息 └ biz_error_code Number 0 业务错误码 101, 102,103

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgRidReportGetRequest req = new TbkDgRidReportGetRequest();
TbkDgRidReportGetRequest.RidReportOption obj1 = new TbkDgRidReportGetRequest.RidReportOption();
obj1.setBizDate("2020-01-01");
obj1.setRelationId("123");
obj1.setBizMonth("2020-06");
req.setSearchOption(obj1);
TbkDgRidReportGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgRidReportGetRequest req = new TbkDgRidReportGetRequest();
TbkDgRidReportGetRequest.RidReportOptionDomain obj1 = new TbkDgRidReportGetRequest.RidReportOptionDomain();
obj1.BizDate = "2020-01-01";
obj1.RelationId = "123";
obj1.BizMonth = "2020-06";
req.SearchOption_ = obj1;
TbkDgRidReportGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgRidReportGetRequest;
$search_option = new RidReportOption;
$search_option->biz_date="2020-01-01";
$search_option->relation_id="123";
$search_option->biz_month="2020-06";
$req->setSearchOption(json_encode($search_option));
$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.rid.report.get' \
-d 'partner_id=apidoc' \
-d 'sign=E7E19227F6A9D40B4800A4F747F18850' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+03%3A36%3A34' \
-d 'v=2.0' \
-d 'search_option=null'

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

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

req.search_option=""
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.rid.report.get");
add_param(pRequest,"search_option","数据结构JSON示例");
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.rid.report.get', {
	'search_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_rid_report_get_response>
    <result>
        <data>
            <promo_uv>0</promo_uv>
            <promo_alipay_amt>0</promo_alipay_amt>
            <individual_uv>1</individual_uv>
            <promo_alipay_num>0</promo_alipay_num>
            <purchase_uv>1</purchase_uv>
            <purchase_alipay_num>2</purchase_alipay_num>
            <individual_alipay_num>1</individual_alipay_num>
            <purchase_alipay_amt>13</purchase_alipay_amt>
            <individual_alipay_amt>0</individual_alipay_amt>
        </data>
        <success>true</success>
        <result_code>200</result_code>
        <biz_error_desc>demo</biz_error_desc>
        <result_msg>demo</result_msg>
        <biz_error_code>0</biz_error_code>
    </result>
</tbk_dg_rid_report_get_response>

{
    "tbk_dg_rid_report_get_response":{
        "result":{
            "data":{
                "promo_uv":"0",
                "promo_alipay_amt":"0",
                "individual_uv":"1",
                "promo_alipay_num":"0",
                "purchase_uv":"1",
                "purchase_alipay_num":"2",
                "individual_alipay_num":"1",
                "purchase_alipay_amt":"13",
                "individual_alipay_amt":"0"
            },
            "success":true,
            "result_code":200,
            "biz_error_desc":"demo",
            "result_msg":"demo",
            "biz_error_code":0
        }
    }
}

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.rid.report.get (淘宝客-推广者-渠道管理rid推广效果)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ