文档中心 > API类目 > 淘宝客API

taobao.tbk.sc.vegas.send.report (淘宝客-服务商-查询红包发放个数)

服务商使用。可通过此接口查询对应推广者账号下的红包发放个数。

公共参数

请求地址：

环境	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		接口返回model
└ success Boolean false 是否成功 model RightsSendRptDto 134523^4351232 model relation_rpt_list RightsSendRelationRptDto [] 渠道关系id的发放数据的数据集 └ biz_date String 20191201 统计日期 └ relation_id Number 111 渠道关系id └ fund_num Number 200 红包发放数量 └ pid String mm_123_123_123 pid └ use_num Number 89 红包使用次数 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);
TbkScVegasSendReportRequest req = new TbkScVegasSendReportRequest();
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);
TbkScVegasSendReportResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<tbk_sc_vegas_send_report_response>
    <result>
        <success>false</success>
        <model>
            <relation_rpt_list>
                <rights_send_relation_rpt_dto>
                    <biz_date>20191201</biz_date>
                    <relation_id>111</relation_id>
                    <fund_num>200</fund_num>
                    <pid>mm_123_123_123</pid>
                    <use_num>89</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_sc_vegas_send_report_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

我要提问

返回
顶部

开放平台

淘宝客API

taobao.tbk.sc.vegas.send.report (淘宝客-服务商-查询红包发放个数)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ