淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
biz_date	String	必须	20191201		统计日期
relation_id	Number	可选	111		渠道关系id
activity_id	Number	可选	1		已下线，后续不需要填写
page_no	Number	可选	1	默认值：1	页码
page_size	Number	可选	10	默认值：10	每页大小
pid	String	可选	mm_123_123_123		媒体推广pid
rpt_dim	String	可选	pid/relation		查询维度，不填写默认是pid维度
activity_category	Number	可选	1	默认值：1	查询红包类型，1-超级红包，2-福利购，3-签到红包，4-福利直降，5-幸运赢免单，不传时默认查询超级红包数据

名称	类型	示例值	描述
result	Result		返回结果
└ success Boolean true 是否成功 model RightsSendRptDTO model relation_rpt_list RightsSendRelationRptDto [] 渠道关系id的发放数据 └ biz_date String 20191201 日期 └ relation_id Number 111 渠道关系id └ fund_num Number 100 红包发放数量 └ pid String mm_123_123_123 渠道关系id关联的pid └ use_num Number 88 红包使用次数 pid_rpt_list RightsSendRelationRptDto [] pid的发放数据 └ biz_date String 20191201 日期 └ pid String mm_123_123_123 pid └ fund_num Number 100 红包发放数量 └ use_num Number 78 红包使用次数 └ msg_info String 1 msgInfo └ msg_code String 1 msgCode

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgVegasSendReportRequest req = new TbkDgVegasSendReportRequest();
req.setBizDate("20191201");
req.setRelationId(111L);
req.setActivityId(1L);
req.setPageNo(1L);
req.setPageSize(10L);
req.setPid("mm_123_123_123");
req.setRptDim("pid/relation");
req.setActivityCategory(1L);
TbkDgVegasSendReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgVegasSendReportRequest req = new TbkDgVegasSendReportRequest();
req.BizDate = "20191201";
req.RelationId = 111L;
req.ActivityId = 1L;
req.PageNo = 1L;
req.PageSize = 10L;
req.Pid = "mm_123_123_123";
req.RptDim = "pid/relation";
req.ActivityCategory = 1L;
TbkDgVegasSendReportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgVegasSendReportRequest;
$req->setBizDate("20191201");
$req->setRelationId("111");
$req->setActivityId("1");
$req->setPageNo("1");
$req->setPageSize("10");
$req->setPid("mm_123_123_123");
$req->setRptDim("pid/relation");
$req->setActivityCategory("1");
$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.vegas.send.report' \
-d 'partner_id=apidoc' \
-d 'sign=E16EA8FD4DBFDC1475D377AC933A4E9B' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+16%3A38%3A31' \
-d 'v=2.0' \
-d 'activity_category=1' \
-d 'activity_id=1' \
-d 'biz_date=20191201' \
-d 'page_no=1' \
-d 'page_size=10' \
-d 'pid=mm_123_123_123' \
-d 'relation_id=111' \
-d 'rpt_dim=pid%2Frelation'

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

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

req.biz_date="20191201"
req.relation_id=111
req.activity_id=1
req.page_no=1
req.page_size=10
req.pid="mm_123_123_123"
req.rpt_dim="pid/relation"
req.activity_category=1
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.vegas.send.report");
add_param(pRequest,"biz_date","20191201");
add_param(pRequest,"relation_id","111");
add_param(pRequest,"activity_id","1");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"pid","mm_123_123_123");
add_param(pRequest,"rpt_dim","pid/relation");
add_param(pRequest,"activity_category","1");
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.vegas.send.report', {
	'biz_date':'20191201',
	'relation_id':'111',
	'activity_id':'1',
	'page_no':'1',
	'page_size':'10',
	'pid':'mm_123_123_123',
	'rpt_dim':'pid/relation',
	'activity_category':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_vegas_send_report_response>
    <result>
        <success>true</success>
        <model>
            <relation_rpt_list>
                <rights_send_relation_rpt_dto>
                    <biz_date>20191201</biz_date>
                    <relation_id>111</relation_id>
                    <fund_num>100</fund_num>
                    <pid>mm_123_123_123</pid>
                    <use_num>88</use_num>
                </rights_send_relation_rpt_dto>
            </relation_rpt_list>
            <pid_rpt_list>
                <rights_send_relation_rpt_dto>
                    <biz_date>20191201</biz_date>
                    <pid>mm_123_123_123</pid>
                    <fund_num>100</fund_num>
                    <use_num>78</use_num>
                </rights_send_relation_rpt_dto>
            </pid_rpt_list>
        </model>
        <msg_info>1</msg_info>
        <msg_code>1</msg_code>
    </result>
</tbk_dg_vegas_send_report_response>

{
    "tbk_dg_vegas_send_report_response":{
        "result":{
            "success":true,
            "model":{
                "relation_rpt_list":{
                    "rights_send_relation_rpt_dto":[
                        {
                            "biz_date":"20191201",
                            "relation_id":111,
                            "fund_num":100,
                            "pid":"mm_123_123_123",
                            "use_num":88
                        }
                    ]
                },
                "pid_rpt_list":{
                    "rights_send_relation_rpt_dto":[
                        {
                            "biz_date":"20191201",
                            "pid":"mm_123_123_123",
                            "fund_num":100,
                            "use_num":78
                        }
                    ]
                }
            },
            "msg_info":"1",
            "msg_code":"1"
        }
    }
}

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.vegas.send.report (淘宝客-推广者-查询红包发放个数)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ