文档中心 > API类目 > 海外-淘宝客API

taobao.ovs.tbk.newcustomer.cpa.get (淘宝客-推广者-海外新人红包首购明细查询)

淘宝客-推广者-海外新人红包首购明细查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_cpa_fp_effect_request QueryCpaFpEffectRequest 可选 N/A
  • └ unid
  • String
  • 可选
  • 0101022taobao123
  • 渠道自定义参数
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码
  • └ coupon_status
  • String
  • 可选
  • 1
  • 新人红包状态,不传默认所有状态 "1" - 新人红包领取 "2" - 新人红包核销订单付款, "3" - 新人红包首购结算,拉新成功
  • └ page_size
  • Number
  • 可选
  • 20
  • 页大小,最大不可超过100
  • └ adzone_id
  • String
  • 可选
  • 123
  • mm_xxx_xxx_xxx的第三位
  • └ start_time
  • String
  • 必须
  • 2021-04-03 01:02:04
  • 开始时间
  • └ end_time
  • String
  • 必须
  • 2021-04-03 01:02:08
  • 查询结束时间 注意:数据更新频率为T+1,即2022-09-02最早只能查询到2022-09-01 23:59:59数据 查询时间范围限制3个月
  • └ query_type
  • Number
  • 可选
  • 4
  • 查询时间类型。新人红包: 1:按照新人红包领取时间查询; 2:按照新人红包核销订单付款时间查询; 3:按照新人红包首购结算时间查询; 4:数据更新时间 默认4

响应参数

名称 类型 示例值 描述
result HSFResultDTO N/A
  • cpa_fp_effect_list
  • CpaFpEffectDTO []
  • N/A
  • └ receive_time
  • String
  • 2022-01-24 00:34:05
  • 海外新人红包领取时间
  • └ buy_time
  • String
  • 2022-01-24 00:34:05
  • 新人红包使用付款时间
  • └ success_time
  • String
  • 2022-01-24 00:34:05
  • 拉新成功时间
  • └ status
  • String
  • 1
  • 新人红包状态 "1" - 新人红包领取 "2" - 新人红包核销订单付款, "3" - 新人红包首购结算,拉新成功
  • └ unid
  • String
  • 0101022taobao123
  • 渠道自定义参数
  • └ adzone_id
  • String
  • 123
  • 来源广告位ID(pid中mm_1_2_3)中第3位
  • └ adzone_name
  • String
  • 联盟官方推广位
  • 来源广告位名称
  • └ red_envelope_id
  • String
  • 123
  • 红包ID
  • └ pay_amt
  • String
  • 1.23
  • 红包订单付款金额

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OvsTbkNewcustomerCpaGetRequest req = new OvsTbkNewcustomerCpaGetRequest();
OvsTbkNewcustomerCpaGetRequest.QueryCpaFpEffectRequest obj1 = new OvsTbkNewcustomerCpaGetRequest.QueryCpaFpEffectRequest();
obj1.setUnid("0101022taobao123");
obj1.setPageNo(1L);
obj1.setCouponStatus("1");
obj1.setPageSize(20L);
obj1.setAdzoneId("123");
obj1.setStartTime("2021-04-03 01:02:04");
obj1.setEndTime("2021-04-03 01:02:08");
obj1.setQueryType(4L);
req.setQueryCpaFpEffectRequest(obj1);
OvsTbkNewcustomerCpaGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<ovs_tbk_newcustomer_cpa_get_response>
    <result>
        <cpa_fp_effect_list>
            <cpa_fp_effect_d_t_o>
                <receive_time>2022-01-24 00:34:05</receive_time>
                <buy_time>2022-01-24 00:34:05</buy_time>
                <success_time>2022-01-24 00:34:05</success_time>
                <status>1</status>
                <unid>0101022taobao123</unid>
                <adzone_id>123</adzone_id>
                <adzone_name>联盟官方推广位</adzone_name>
                <red_envelope_id>123</red_envelope_id>
                <pay_amt>1.23</pay_amt>
            </cpa_fp_effect_d_t_o>
        </cpa_fp_effect_list>
    </result>
</ovs_tbk_newcustomer_cpa_get_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

返回
顶部