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

taobao.tbk.dg.reports.newquery (淘宝客-推广者-媒体数据报表交换)

报表查询API(导购)

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
page_size Number 必须 100 每页大小
page_no Number 必须 1 页码
dimensions String 可选 ds 聚合条件
filters String 必须 ds=20191013;subpid=mm_123_132_321;pubId=1234;hasCount=false;position_index=123 查询条件 ds-日期;subpid-达人pid; pubId-媒体memberid; hasCount-是否返回总数,true表示返回,建议只请求一次数量,false不返回数量 可以提高接口效率;position_index位点信息,返回的数据中最小的id
return_fields String 可选 id,pub_id,sub_pub_id,sub_site_id,sub_adzone_id,daren_id,content_id,tk_trade_create_time,click_timestamp,tb_auction_id,tb_auction_num,tb_auction_price,tb_trade_status,tk_trade_status,tb_trade_parent_id,tb_trade_id,tb_auction_category_level1,tb_auction_category,tb_auction_category_level1_name,tb_alipay_total_price,pre_3rd_pub_share_fee,tk_3rd_pub_share_fee,tk_commission_rate 查询字段
report_type_id String 必须 union_media_newlink_subpid_order_detail 订单明细传 union_media_newlink_subpid_order_detail

响应参数

名称 类型 示例值 描述
data_list MapData [] map数组 结果列表
  • └ click_id
  • String
  • 1234
  • 点击id
  • └ tb_auction_category_level1_name
  • String
  • 女装
  • 商品一级类目名称
  • └ tb_trade_id
  • Number
  • 1234
  • 子订单编号
  • └ tb_trade_parent_id
  • Number
  • 1234
  • 父订单编号
  • └ tb_trade_status
  • Number
  • 1
  • 订单状态(淘宝)
  • └ tb_auction_price
  • String
  • 1.0
  • 商品单价
  • └ tb_auction_num
  • Number
  • 10
  • 商品数
  • └ tb_auction_id
  • String
  • 1234
  • 商品id
  • └ click_timestamp
  • String
  • 2019-01-01 00:00:00
  • 订单点击时间
  • └ tk_trade_create_time
  • String
  • 2019-01-01 00:00:00
  • 订单创建时间
  • └ click_uv
  • Number
  • 10
  • 单篇内容UV_pub口径
  • └ click_pv
  • Number
  • 10
  • 单篇内容PV_pub口径
  • └ tk_commission_rate
  • String
  • 0.5
  • 预估佣金率
  • └ pre_subsidy_fee
  • String
  • 1
  • cps预估补贴
  • └ pre_commission_fee
  • String
  • 1.5
  • cps预估佣金
  • └ cm_alipay_amt
  • String
  • 10
  • cps成交金额
  • └ cm_alipay_num
  • Number
  • 1
  • cps成交笔数
  • └ ds
  • String
  • 20190525
  • 日期
  • └ cm_3rd_pub_share_fee
  • String
  • 1.5
  • 达人结算预估收入
  • └ cm_pub_share_fee
  • String
  • 1.5
  • 平台结算预估收入
  • └ pre_3rd_pub_share_fee
  • String
  • 1.5
  • 达人预估收入
  • └ pre_pub_share_fee
  • String
  • 1.5
  • 平台预估收入
  • └ alipay_amt
  • String
  • 10
  • 成交金额
  • └ alipay_num
  • Number
  • 10
  • 成交笔数
  • └ zz_uv
  • Number
  • 100
  • 主站口径uv
  • └ union_pv
  • Number
  • 100
  • 联盟口径pv
  • └ biz_type
  • String
  • 1
  • 业务类型
  • └ sub_adzone_id
  • Number
  • 1234
  • 达人adzoneid
  • └ sub_site_id
  • Number
  • 1234
  • 达人siteid
  • └ sub_pub_id
  • Number
  • 1234
  • 达人pubid
  • └ name
  • String
  • 1234
  • 达人名称
  • └ pub_id
  • Number
  • 1234
  • 平台pud_id
  • └ tb_alipay_total_price
  • String
  • 10
  • 订单支付金额
  • └ tk_3rd_pub_share_fee
  • String
  • 1.5
  • 达人结算预估收入
report_type_id String union_channel_content_basic_v1 报表名称
page_info RptPageinfo map 分页信息
  • └ total_cnt
  • Number
  • 20
  • 总数
  • └ page_no
  • Number
  • 1
  • 页数
  • └ page_size
  • Number
  • 100
  • 每页大小
position_index String 123 位点信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgReportsNewqueryRequest req = new TbkDgReportsNewqueryRequest();
req.setPageSize(100L);
req.setPageNo(1L);
req.setDimensions("ds");
req.setFilters("ds=20191013;subpid=mm_123_132_321;pubId=1234;hasCount=false;position_index=123");
req.setReturnFields("id,pub_id,sub_pub_id,sub_site_id,sub_adzone_id,daren_id,content_id,tk_trade_create_time,click_timestamp,tb_auction_id,tb_auction_num,tb_auction_price,tb_trade_status,tk_trade_status,tb_trade_parent_id,tb_trade_id,tb_auction_category_level1,tb_auction_category,tb_auction_category_level1_name,tb_alipay_total_price,pre_3rd_pub_share_fee,tk_3rd_pub_share_fee,tk_commission_rate");
req.setReportTypeId("union_media_newlink_subpid_order_detail");
TbkDgReportsNewqueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tbk_dg_reports_newquery_response>
    <data_list>
        <map_data>
            <click_id>1234</click_id>
            <tb_auction_category_level1_name>女装</tb_auction_category_level1_name>
            <tb_trade_id>1234</tb_trade_id>
            <tb_trade_parent_id>1234</tb_trade_parent_id>
            <tb_trade_status>1</tb_trade_status>
            <tb_auction_price>1.0</tb_auction_price>
            <tb_auction_num>10</tb_auction_num>
            <tb_auction_id>1234</tb_auction_id>
            <click_timestamp>2019-01-01 00:00:00</click_timestamp>
            <tk_trade_create_time>2019-01-01 00:00:00</tk_trade_create_time>
            <click_uv>10</click_uv>
            <click_pv>10</click_pv>
            <tk_commission_rate>0.5</tk_commission_rate>
            <pre_subsidy_fee>1</pre_subsidy_fee>
            <pre_commission_fee>1.5</pre_commission_fee>
            <cm_alipay_amt>10</cm_alipay_amt>
            <cm_alipay_num>1</cm_alipay_num>
            <ds>20190525</ds>
            <cm_3rd_pub_share_fee>1.5</cm_3rd_pub_share_fee>
            <cm_pub_share_fee>1.5</cm_pub_share_fee>
            <pre_3rd_pub_share_fee>1.5</pre_3rd_pub_share_fee>
            <pre_pub_share_fee>1.5</pre_pub_share_fee>
            <alipay_amt>10</alipay_amt>
            <alipay_num>10</alipay_num>
            <zz_uv>100</zz_uv>
            <union_pv>100</union_pv>
            <biz_type>1</biz_type>
            <sub_adzone_id>1234</sub_adzone_id>
            <sub_site_id>1234</sub_site_id>
            <sub_pub_id>1234</sub_pub_id>
            <name>1234</name>
            <pub_id>1234</pub_id>
            <tb_alipay_total_price>10</tb_alipay_total_price>
            <tk_3rd_pub_share_fee>1.5</tk_3rd_pub_share_fee>
        </map_data>
    </data_list>
    <report_type_id>union_channel_content_basic_v1</report_type_id>
    <page_info>
        <total_cnt>20</total_cnt>
        <page_no>1</page_no>
        <page_size>100</page_size>
    </page_info>
    <position_index>123</position_index>
</tbk_dg_reports_newquery_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>

错误码解释

错误码 错误描述 解决方案
1001 非法的me参数值 传入正确的me参数值,含有券ID与商品ID信息
10000 该itemId对应的宝贝已下架或非淘客宝贝 更换新的itemId查询
4 查询不到对应的adzoneId,请检查adzoneId是否正确 查询不到对应的adzoneId,请检查adzoneId是否正确
30002 参数q与cat不能都为空 参数q与cat不能都为空
2 pid不正确,请检查是否输入了正确的adzoneId和siteId pid不正确,请检查是否输入了正确的adzoneId和siteId
40001 内部调用失败 联系开发人员
50001 无结果 无结果
30001 非法的物料id 非法的物料id

API工具

如何获得此API

FAQ

返回
顶部