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

taobao.tbk.dg.vegas.tlj.list.report (淘宝客-推广者-淘礼金效果数据批量)

淘宝客推广者可查询淘礼金发放和使用等效果数据,只提供近150天的数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
adzone_id Number 必须 123 推广位ID
begin_date Number 必须 1774281600000 礼金创建的起始时刻
end_date Number 必须 1774367999000 礼金创建的最后时刻
page_no Number 必须 1 页码
page_size Number 必须 10 翻页不能超过10一页

响应参数

名称 类型 示例值 描述
model InstancePageQueryResult instancePageQueryResult
  • result
  • PageResult
  • PageResult
  • result
  • InstanceDTO []
  • result
  • └ rights_id
  • String
  • 1
  • 礼金ID
  • extra
  • Extra
  • Extra
  • └ get_rate
  • String
  • 50
  • 领取率,领取淘礼金个数/创建淘礼金个数
  • └ use_rate
  • String
  • 50
  • 使用率,使用淘礼金个数/领取淘礼金个数
  • └ alipay_num
  • Number
  • 1
  • 引导付款笔数,同一个红包,若因消费者付款使用后取消订单或退货退款,产生二次红包使用行为,引导付款笔数也会记录两单
  • └ alipay_amt
  • String
  • 19.0
  • 引导付款金额,同一个红包,若因消费者付款使用后取消订单或退货退款,产生二次红包使用行为,引导付款笔数也会记录两单
  • └ pre_pub_share_fee_for_disp
  • String
  • 19.0
  • 付款佣金,下单付款,产生二次红包使用行为,会记录2次
  • └ cm_settle_amt
  • String
  • 19.0
  • 结算佣金,确认收货,产生二次红包使用行为,会记录2次
  • └ win_pv
  • Number
  • 1
  • 领取淘礼金个数
  • └ win_sum_amt
  • String
  • 10
  • 领取淘礼金金额
  • └ remaining_num
  • Number
  • 1
  • 未领取淘礼金个数,过了领取有效期或者暂停后没有被领取的红包个数
  • └ remaining_amt
  • String
  • 10
  • 未领取金额,过了领取有效期或者暂停后没有被领取的红包金额
  • └ use_num
  • Number
  • 1
  • 使用淘礼金个数,同一个红包,若因消费者付款使用后取消订单或退货退款,产生二次红包使用行为,使用淘礼金个数会重复计算
  • └ use_sum_amt
  • String
  • 10
  • 使用淘礼金金额,若红包被重复使用(1)淘礼金红包被拆分,并且产生部分退款,会保留部分退款的订单淘礼金金额;若全部退款,会保留订单全部淘礼金金额),因此,已使用金额可能大于消费者实际使用金额(使用红包后,若产生红包退回后再次使用,已使用金额会被二次计算,已使用数量不会)
  • └ refund_num
  • Number
  • 1
  • 退款淘礼金个数,红包使用后,由于订单取消,退货退款等行为带来的淘礼金红包退回数量,退款红包数量会重复计算
  • └ refund_sum_amt
  • String
  • 5.0
  • 退款淘礼金金额,红包使用后,由于订单取消,退货退款等行为行为带来的淘礼金红包退回数量 (退款红包若产生多次使用,退款红包金额会被多次计算,退款红包数量单日内不重复计算,跨天重复计算)
  • └ page_no
  • String
  • 1
  • 当前页码
  • └ page_size
  • String
  • 1
  • 每页分片
  • └ total_pages
  • String
  • 1
  • 总共页数
  • └ total_count
  • String
  • 1
  • 总共数量
  • └ position_index
  • String
  • position_index
  • position_index
msg_info String 1 msg_info
msg_code String 1 msgCode
result_success Boolean true result_success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgVegasTljListReportRequest req = new TbkDgVegasTljListReportRequest();
req.setAdzoneId(123L);
req.setBeginDate(1774281600000L);
req.setEndDate(1774367999000L);
req.setPageNo(1L);
req.setPageSize(10L);
TbkDgVegasTljListReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tbk_dg_vegas_tlj_list_report_response>
    <model>
        <result>
            <result>
                <instance_d_t_o>
                    <rights_id>1</rights_id>
                    <extra>
                        <get_rate>50</get_rate>
                        <use_rate>50</use_rate>
                        <alipay_num>1</alipay_num>
                        <alipay_amt>19.0</alipay_amt>
                        <pre_pub_share_fee_for_disp>19.0</pre_pub_share_fee_for_disp>
                        <cm_settle_amt>19.0</cm_settle_amt>
                        <win_pv>1</win_pv>
                        <win_sum_amt>10</win_sum_amt>
                        <remaining_num>1</remaining_num>
                        <remaining_amt>10</remaining_amt>
                        <use_num>1</use_num>
                        <use_sum_amt>10</use_sum_amt>
                        <refund_num>1</refund_num>
                        <refund_sum_amt>5.0</refund_sum_amt>
                    </extra>
                </instance_d_t_o>
            </result>
            <page_no>1</page_no>
            <page_size>1</page_size>
            <total_pages>1</total_pages>
            <total_count>1</total_count>
        </result>
        <position_index>position_index</position_index>
    </model>
    <msg_info>1</msg_info>
    <msg_code>1</msg_code>
    <result_success>true</result_success>
</tbk_dg_vegas_tlj_list_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

FAQ

返回
顶部