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

taobao.universalbp.adzone.horizontal.findpage (查看资源包列表)

查看已存在的计划上设置的资源包列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
adzone_ref_query_v_o AdzoneRefQueryVo 必须 adzoneRefQueryVO
  • └ campaign_id_list
  • Number []
  • 必须
  • [68792788657]
  • 计划id集合
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小
  • rpt_query
  • RptQueryVO
  • 可选
  • 报表数据查询条件
  • └ fields
  • String
  • 可选
  • adPv,click,charge,ctr,epc,ecpm
  • 查询指标字段
  • condition_list
  • RptQueryConditionVO []
  • 可选
  • 报表查询条件
  • └ start_time
  • String
  • 可选
  • 2023-10-08
  • 开始时间
  • └ end_time
  • String
  • 可选
  • 2023-10-08
  • 结束时间
  • └ adzone_pkg_id_list
  • String []
  • 可选
  • []
  • 流量来源(资源位包id)
  • └ is_rt
  • Boolean
  • 可选
  • true
  • 是否查询实时报表,true查实时、false查离线,不传则默认查离线
  • └ source_list
  • String []
  • 可选
  • ["capmaign_detail","adzone_list"]
  • 来源

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • adzone_ref_v_o_top_bulk_data
  • TopBulkData
  • 结果集
  • adzone_ref_v_o_list
  • AdzoneRefVo []
  • 批量结果集
  • └ adzone_id
  • Number
  • 111287850198
  • 资源包id
  • └ adzone_name
  • String
  • 全屏微详情
  • 资源包名字
  • └ campaign_id
  • Number
  • 68796878069
  • 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景
  • └ campaign_name
  • String
  • 管家计划_宝贝候选集
  • 计划名称
  • └ bid_type
  • String
  • max_amount
  • 出价方式,custom_bid:手动出价,max_amount:最大化拿量,cost_control:控成本,roi_control:控投产比
  • └ discount
  • Number
  • 0
  • 资源位/包 溢价
  • └ status
  • String
  • start
  • 状态,start:投放,pause:暂停
  • └ min_discount
  • Number
  • 12
  • 资源位支持的最低溢价
  • └ max_discount
  • Number
  • 15
  • 资源位支持的最高溢价
  • operation_list
  • Integer []
  • []
  • 操作按钮列表
  • └ code
  • String
  • 12
  • 操作项code
  • └ name
  • String
  • 操作
  • 操作项名称
  • └ tips
  • String
  • xxxx
  • 悬浮提示
  • └ disabled
  • String
  • false
  • 是否可操作
  • └ properties
  • String
  • {}
  • 扩展属性
  • └ report_info
  • String
  • 报表数据
  • └ count
  • Number
  • 1
  • 数量

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpAdzoneHorizontalFindpageRequest req = new UniversalbpAdzoneHorizontalFindpageRequest();
UniversalbpAdzoneHorizontalFindpageRequest.TopServiceContext obj1 = new UniversalbpAdzoneHorizontalFindpageRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpAdzoneHorizontalFindpageRequest.AdzoneRefQueryVo obj2 = new UniversalbpAdzoneHorizontalFindpageRequest.AdzoneRefQueryVo();
obj2.setCampaignIdList(new Long[] { 68792788657 };
);
obj2.setOffset(0L);
obj2.setPageSize(20L);
UniversalbpAdzoneHorizontalFindpageRequest.RptQueryVO obj3 = new UniversalbpAdzoneHorizontalFindpageRequest.RptQueryVO();
obj3.setFields("adPv,click,charge,ctr,epc,ecpm");
List<UniversalbpAdzoneHorizontalFindpageRequest.RptQueryConditionVO> list5 = new ArrayList<UniversalbpAdzoneHorizontalFindpageRequest.RptQueryConditionVO>();
UniversalbpAdzoneHorizontalFindpageRequest.RptQueryConditionVO obj6 = new UniversalbpAdzoneHorizontalFindpageRequest.RptQueryConditionVO();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList("");
obj6.setIsRt(true);
obj6.setSourceList(""capmaign_detail","adzone_list"");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
req.setAdzoneRefQueryVO(obj2);
UniversalbpAdzoneHorizontalFindpageResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_adzone_horizontal_findpage_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <adzone_ref_v_o_top_bulk_data>
            <adzone_ref_v_o_list>
                <adzone_ref_vo>
                    <adzone_id>111287850198</adzone_id>
                    <adzone_name>全屏微详情</adzone_name>
                    <campaign_id>68796878069</campaign_id>
                    <campaign_name>管家计划_宝贝候选集</campaign_name>
                    <bid_type>max_amount</bid_type>
                    <discount>0</discount>
                    <status>start</status>
                    <min_discount>12</min_discount>
                    <max_discount>15</max_discount>
                    <operation_list>
                        <integer>
                            <code>12</code>
                            <name>操作</name>
                            <tips>xxxx</tips>
                            <disabled>false</disabled>
                            <properties>{}</properties>
                        </integer>
                    </operation_list>
                </adzone_ref_vo>
            </adzone_ref_v_o_list>
            <count>1</count>
        </adzone_ref_v_o_top_bulk_data>
    </result>
</universalbp_adzone_horizontal_findpage_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

返回
顶部