淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	描述
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>

{
    "universalbp_adzone_horizontal_findpage_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "adzone_ref_v_o_top_bulk_data":{
                "adzone_ref_v_o_list":{
                    "adzone_ref_vo":[
                        {
                            "adzone_id":111287850198,
                            "adzone_name":"全屏微详情",
                            "campaign_id":68796878069,
                            "campaign_name":"管家计划_宝贝候选集",
                            "bid_type":"max_amount",
                            "discount":0,
                            "status":"start",
                            "min_discount":12,
                            "max_discount":15,
                            "operation_list":{
                                "integer":[
                                    {
                                        "code":"12",
                                        "name":"操作",
                                        "tips":"xxxx",
                                        "disabled":"false",
                                        "properties":"{}"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "count":1
            }
        }
    }
}

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测试工具错误码查询工具 SDK下载

直通车API

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ