文档中心 > API类目 > 直通车API

taobao.universalbp.report.chargesum (账户花费数据汇总)

消耗汇总

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
report_query_v_o ReportQueryVo 可选 reportQueryVO
  • └ split_type
  • String
  • 可选
  • hour
  • 汇总类型 sum-汇总,hour-分时,day-分天,week-分周,month-分月
  • └ unify_type
  • String
  • 可选
  • zhai
  • 归因口径,zhai-末次点击归因, mta-mta归因
  • └ start_time
  • String
  • 可选
  • 2023-06-06
  • 开始时间
  • └ end_time
  • String
  • 可选
  • 2023-06-12
  • 结束时间
  • └ effect_equal
  • Number
  • 可选
  • 15
  • 归因周期,1、3、7、15、30
  • └ biz_code_in_list
  • String []
  • 可选
  • [onebpDisplay]
  • 场景筛选code
  • └ query_domains
  • String []
  • 可选
  • [account, campaign]
  • 聚合维度,可用值和选择对应报表类型一致
  • └ query_field_in_list
  • String []
  • 可选
  • adPv
  • 需要下载的指标数据
  • └ rpt_type
  • String
  • 可选
  • xxxxx
  • 报表类型
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小
  • └ by_page
  • Boolean
  • 可选
  • true
  • 是否分页

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • top_charge_sum_v_o
  • TopChargeSumVo
  • 结果集
  • └ total_charge
  • String
  • 2690.00
  • 总花费
  • └ crowd_scene_charge
  • String
  • 2690.00
  • 消费者运营花费
  • └ item_scene_charge
  • String
  • 2690.00
  • 货品运营花费
  • └ activity_scene_charge
  • String
  • 2690.00
  • 活动场景消耗
  • └ display_charge
  • String
  • 2690.00
  • 人群场景
  • └ search_charge
  • String
  • 2690.00
  • 关键词场景
  • └ content_scene_charge
  • String
  • 2690.00
  • 内容场景
  • └ shop_scene_charge
  • String
  • 2690.00
  • 店铺运营消耗
  • └ multi_aim_scene_charge
  • String
  • 2690.00
  • 多目标智投

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpReportChargesumRequest req = new UniversalbpReportChargesumRequest();
UniversalbpReportChargesumRequest.TopServiceContext obj1 = new UniversalbpReportChargesumRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpReportChargesumRequest.ReportQueryVo obj2 = new UniversalbpReportChargesumRequest.ReportQueryVo();
obj2.setSplitType("hour");
obj2.setUnifyType("zhai");
obj2.setStartTime("2023-06-06");
obj2.setEndTime("2023-06-12");
obj2.setEffectEqual(15L);
obj2.setBizCodeInList("onebpDisplay");
obj2.setQueryDomains("account, campaign");
obj2.setQueryFieldInList("adPv");
obj2.setRptType("xxxxx");
obj2.setOffset(0L);
obj2.setPageSize(20L);
obj2.setByPage(true);
req.setReportQueryVO(obj2);
UniversalbpReportChargesumResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_report_chargesum_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_charge_sum_v_o>
            <total_charge>2690.00</total_charge>
            <crowd_scene_charge>2690.00</crowd_scene_charge>
            <item_scene_charge>2690.00</item_scene_charge>
            <activity_scene_charge>2690.00</activity_scene_charge>
            <display_charge>2690.00</display_charge>
            <search_charge>2690.00</search_charge>
            <content_scene_charge>2690.00</content_scene_charge>
            <shop_scene_charge>2690.00</shop_scene_charge>
            <multi_aim_scene_charge>2690.00</multi_aim_scene_charge>
        </top_charge_sum_v_o>
    </result>
</universalbp_report_chargesum_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

返回
顶部