淘宝开放平台

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

淘宝客API

taobao.tbk.sc.cpa.activity.report (淘宝客-服务商-任务奖励效果报表)

提供给工具服务商使用的cpa活动报表查询api

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
event_id Number 必须 1 CPA活动ID，详见https://www.yuque.com/docs/share/16905f3f-3a22-4e7c-b8c3-4d23791d42f7?#
biz_date String 必须 20210818 日期(yyyyMMdd)
page_no Number 可选 1 分页页数，从1开始
query_type Number 可选 1
  • 默认值：1
    		•  数据类型：数据类型:1预估 2结算 （选择1可查询含当天实时预估统计的累计数据，选择2可查询最晚截止昨天结算的累计数据，具体逻辑以活动规则描述为准；）
    page_size Number 可选 10 分页大小
    pid String 可选 mm_123_123_123 媒体三段式id（如果传入pid则返回pid汇总数据，不传则返回member维度统计数据，pid和relationid不可同时传入）
    relation_id Number 可选 100 代理id（如果传入rid则返回rid统计数据，不传则返回member维度统计数据）

    响应参数

    名称 类型 示例值 描述
    result RpcResult {} 返回模型
    • data
    • PageResult
    • {}
    • 分页模型
    • results
    • VegasCpaReportDTO []
    • []
    • 数据列表
    • └ reward_amount
    • String
    • 100.1
    • 奖励金额；按入参是预估/结算，区分获得金额为预估or可结算结果；
    • └ union_30d_lx_uv
    • Number
    • 100
    • 符合奖励要求的累计用户数；按入参是预估/结算，区分用户数为预估or可结算结果；
    • └ relation_id
    • Number
    • 123456
    • rid，当查询数据为rid维度时返回该字段
    • └ biz_date
    • String
    • 20210301
    • 统计日期（统计活动期内，截止 统计日期 的数据）
    • └ pid
    • String
    • mm_123_123_123
    • 媒体三段式id，当查询数据为pid维度时返回该字段
    • └ query_type
    • Number
    • 1
    • 数据类型:1预估 2结算

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkScCpaActivityReportRequest req = new TbkScCpaActivityReportRequest();
    req.setEventId(1L);
    req.setBizDate("20210818");
    req.setPageNo(1L);
    req.setQueryType(1L);
    req.setPageSize(10L);
    req.setPid("mm_123_123_123");
    req.setRelationId(100L);
    TbkScCpaActivityReportResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    <tbk_sc_cpa_activity_report_response>
        <result>
            <data>
                <results>
                    <vegas_cpa_report_d_t_o>
                        <reward_amount>100.1</reward_amount>
                        <union_30d_lx_uv>100</union_30d_lx_uv>
                        <relation_id>123456</relation_id>
                        <biz_date>20210301</biz_date>
                        <pid>mm_123_123_123</pid>
                        <query_type>1</query_type>
                    </vegas_cpa_report_d_t_o>
                </results>
            </data>
        </result>
    </tbk_sc_cpa_activity_report_response>

    异常示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    <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

    我要提问
    返回
    顶部