淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码
adgroup_query_v_o	AdgroupQueryVo	必须	adgroupQueryVO
└ campaign_id_list Number [] 必须 [68792788657] 计划id集合 └ offset Number 可选 0 偏移量 └ page_size Number 可选 20 页面大小 rpt_query RptQueryVO 可选报表数据 └ fields String 可选 adPV 查询指标字段 condition_list RptQueryConditionVO [] 可选报表查询条件 └ start_time String 可选 2023-10-08 开始时间 └ end_time String 可选 2023-10-08 结束时间 └ adzone_pkg_id_list String [] 可选 ["114790550288", "114790550289", "114793500012", "114786650498"] 流量来源（资源位包id） └ is_rt Boolean 可选 true 是否查询实时报表，true查实时、false查离线，不传则默认查离线 └ unify_type String 可选 zhai 归因类型 └ adgroup_id_list Number [] 可选 [70847259904] 单元id集合 └ item_id Number 可选 806671599436 宝贝id └ item_name_like String 可选自动化ttt1686测试请不要拍宝贝名称

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 adgroup_v_o_top_bulk_data TopBulkData 结果集 adgroup_v_o_list AdgroupVo [] 批量结果集 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ campaign_name String 管家计划_宝贝候选集计划名称 └ adgroup_id Number 68793666608 单元id └ adgroup_name String ds460418344 单元名称 └ online_status Number 0 投放状态,-1:未进入投放状态,0:用户设置状态-下线,1:用户设置状态-上线,2:合同未生效,9:投放结束,105:待支付 └ display_status String pause 前端展示状态,pause:暂停推广,start:正在推广,terminate:结束推广,wait:等待推广,pending:准备推广,wait_pay:计划未付款 └ audit_status Number 1 风控审核状态,-1:待审核,0:后台下线状态,1:后台上线状态 └ audit_reason String xxxxx 审核拒绝原因 adgroup_ocpc AdgroupOcpcVo 单元智能出价信息 └ enable_ocpc Boolean true OCPC是否开启，false:否，true:是 └ ocpc_ratio Number 200 OCPC溢价比例 └ ocpc_marketing_aim String click OCPC目标选项 └ ocpc_status String new_ad_complete 当前状态,new_ad_openable:可开启新广告加速,new_item_openable:可开启新品冷启动,new_ad_speeding:新广告加速加速中,new_item_speeding:新品冷启动加速中,new_ad_complete:新广告加速加速完成,new_item_complete:新品冷启动加速完成 └ enable_cold_speed_new_item Boolean false 是否开启新品创意，true:是，false:否 └ ecpc_option Number 1 ecpc开关 └ promotion_type String item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ sub_promotion_type String item 推广子主体类型,item:商品，item_private_mini:独享橱窗，shop:店铺，you_hao_huo:有好货，picture:图文，short_video:短视频，live_room:直播间，live_spot:看点，tao_blocks:淘积木，user_define_url:自定义url material CommonMaterialVo 主体类型对应的物料信息 └ material_id Number 714616513841 物料id └ material_type Number 1 物料类型,1:淘宝宝贝,2:淘宝店铺,3:cms LandingPage页面,4:cms 分流总页面,5:自定义,201:PC店铺LandingPage页面,202:无线店铺LandingPage页面,203:内容LandingPage页面,204:淘宝直播,210:淘宝直播用户ID,205:有好货,209:无线店铺Tab3页面,212:超级品牌日LandingPage页面,211:超级发布会LandingPage页面,301:ICBU商品,302:ICBU PC店铺LandingPage页面,303:ICBU PC店铺,8:用户ID,9:信息流淘积木用户ID,10:口碑用户ID,206:店铺优惠券,207:商品优惠券,208:直播单品,309:直播间商品半屏卡,304:1688商品,305:内容平台-短视频,306:附近门店-用户ID,307:饿了么-菜品,401:LAZADA商品,501:飞猪酒店,502:飞猪商品,503:飞猪短信,601:淘积木页面,1001:AE宝贝,1101:淘宝宝贝SKU,310:内容平台-订阅内容 └ material_name String yiliantest测试请不要拍22 物料名称 └ title String yiliantest测试请不要拍22 标题 └ img_url String //img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg 图片地址 └ link_url String http://item.taobao.com/item.htm?id=715121254343 跳转链接 └ price String 999900 价格 └ bid_count Number 899900 销量 └ quantity Number 10 库存 └ first_starts_time Date 2023-04-26 14:51:03 首次上架时间 └ starts Date 2023-04-26 14:51:03 最近上架时间 └ category_id String 16 50010850 主站类目路径，空格分隔多级 └ promotion_type String item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ sub_promotion_type String item 推广子主体类型,item:商品，item_private_mini:独享橱窗，shop:店铺，you_hao_huo:有好货，picture:图文，short_video:短视频，live_room:直播间，live_spot:看点，tao_blocks:淘积木，user_define_url:自定义url life_cycle_list ItemLifeCycleViewVo [] 新品冷启期生命周期指标-越迁阶段列表,列表中最多有2个元素。在页面上展示的时候，按照元素的索引，从左到右依次展示即 └ life_cycle_desc String 新品打爆期周期文案 └ color String #36A2FC 文案颜色 └ tips String 近30日GMV排名在叶子类目5%以内的新品周期提示文案 └ life_cycle_days Number 3 生命周期指标-天数 └ life_cycle_diff_with_avg String 较慢生命周期指标-同叶子类目均值对比 └ life_cycle_diff_with_avg_tips String 快于同类目商品经历过同样阶段变化所用时间生命周期指标-同叶子类目均值对比提示文案 └ grow_desc String 日均再成交122.55元可提高爆品类目排名卡位商品成长指标-成长文案 └ grow_rank Number 1077 商品成长指标-成交排名 └ alive_group_id Number 0 视频组件id,0:宝贝链接,3:订阅店铺,5:直播,6:加购,7:收藏加购,8:入会有礼,12:关注有礼,11:直播联动,10:自定义模板,13:同店搜 └ alive_group_name String 宝贝链接(默认) 视频组件名称 └ black_creative_status String success 智能创意生成状态,success:合成成功,fail:合成失败 └ report_info String 报表数据 └ gmt_create Date 2023-12-09 14:34:12 创建时间 └ gmt_modified Date 2023-12-09 14:34:12 修改时间 └ count Number 1 数量

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpAdgroupHorizontalFindpageRequest req = new UniversalbpAdgroupHorizontalFindpageRequest();
UniversalbpAdgroupHorizontalFindpageRequest.TopServiceContext obj1 = new UniversalbpAdgroupHorizontalFindpageRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpAdgroupHorizontalFindpageRequest.AdgroupQueryVo obj2 = new UniversalbpAdgroupHorizontalFindpageRequest.AdgroupQueryVo();
obj2.setCampaignIdList(new Long[] { 68792788657 };
);
obj2.setOffset(0L);
obj2.setPageSize(20L);
UniversalbpAdgroupHorizontalFindpageRequest.RptQueryVO obj3 = new UniversalbpAdgroupHorizontalFindpageRequest.RptQueryVO();
obj3.setFields("adPV");
List<UniversalbpAdgroupHorizontalFindpageRequest.RptQueryConditionVO> list5 = new ArrayList<UniversalbpAdgroupHorizontalFindpageRequest.RptQueryConditionVO>();
UniversalbpAdgroupHorizontalFindpageRequest.RptQueryConditionVO obj6 = new UniversalbpAdgroupHorizontalFindpageRequest.RptQueryConditionVO();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList(""114790550288", "114790550289", "114793500012", "114786650498"");
obj6.setIsRt(true);
obj6.setUnifyType("zhai");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
obj2.setAdgroupIdList(new Long[] { 70847259904 };
);
obj2.setItemId(806671599436L);
obj2.setItemNameLike("自动化ttt1686测试请不要拍");
req.setAdgroupQueryVO(obj2);
UniversalbpAdgroupHorizontalFindpageResponse 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

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

<universalbp_adgroup_horizontal_findpage_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <adgroup_v_o_top_bulk_data>
            <adgroup_v_o_list>
                <adgroup_vo>
                    <campaign_id>68796878069</campaign_id>
                    <campaign_name>管家计划_宝贝候选集</campaign_name>
                    <adgroup_id>68793666608</adgroup_id>
                    <adgroup_name>ds460418344</adgroup_name>
                    <online_status>0</online_status>
                    <display_status>pause</display_status>
                    <audit_status>1</audit_status>
                    <audit_reason>xxxxx</audit_reason>
                    <adgroup_ocpc>
                        <enable_ocpc>true</enable_ocpc>
                        <ocpc_ratio>200</ocpc_ratio>
                        <ocpc_marketing_aim>click</ocpc_marketing_aim>
                        <ocpc_status>new_ad_complete</ocpc_status>
                        <enable_cold_speed_new_item>false</enable_cold_speed_new_item>
                        <ecpc_option>1</ecpc_option>
                    </adgroup_ocpc>
                    <promotion_type>item</promotion_type>
                    <sub_promotion_type>item</sub_promotion_type>
                    <material>
                        <material_id>714616513841</material_id>
                        <material_type>1</material_type>
                        <material_name>yiliantest测试请不要拍22</material_name>
                        <title>yiliantest测试请不要拍22</title>
                        <img_url>//img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg</img_url>
                        <link_url>http://item.taobao.com/item.htm?id=715121254343</link_url>
                        <price>999900</price>
                        <bid_count>899900</bid_count>
                        <quantity>10</quantity>
                        <first_starts_time>2023-04-26 14:51:03</first_starts_time>
                        <starts>2023-04-26 14:51:03</starts>
                        <category_id>16 50010850</category_id>
                        <promotion_type>item</promotion_type>
                        <sub_promotion_type>item</sub_promotion_type>
                        <life_cycle_list>
                            <item_life_cycle_view_vo>
                                <life_cycle_desc>新品打爆期</life_cycle_desc>
                                <color>#36A2FC</color>
                                <tips>近30日GMV排名在叶子类目5%以内的新品</tips>
                            </item_life_cycle_view_vo>
                        </life_cycle_list>
                        <life_cycle_days>3</life_cycle_days>
                        <life_cycle_diff_with_avg>较慢</life_cycle_diff_with_avg>
                        <life_cycle_diff_with_avg_tips>快于同类目商品经历过同样阶段变化所用时间</life_cycle_diff_with_avg_tips>
                        <grow_desc>日均再成交122.55元 可提高爆品类目排名卡位</grow_desc>
                        <grow_rank>1077</grow_rank>
                    </material>
                    <alive_group_id>0</alive_group_id>
                    <alive_group_name>宝贝链接(默认)</alive_group_name>
                    <black_creative_status>success</black_creative_status>
                    <gmt_create>2023-12-09 14:34:12</gmt_create>
                    <gmt_modified>2023-12-09 14:34:12</gmt_modified>
                </adgroup_vo>
            </adgroup_v_o_list>
            <count>1</count>
        </adgroup_v_o_top_bulk_data>
    </result>
</universalbp_adgroup_horizontal_findpage_response>

{
    "universalbp_adgroup_horizontal_findpage_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "adgroup_v_o_top_bulk_data":{
                "adgroup_v_o_list":{
                    "adgroup_vo":[
                        {
                            "campaign_id":68796878069,
                            "campaign_name":"管家计划_宝贝候选集",
                            "adgroup_id":68793666608,
                            "adgroup_name":"ds460418344",
                            "online_status":0,
                            "display_status":"pause",
                            "audit_status":1,
                            "audit_reason":"xxxxx",
                            "adgroup_ocpc":{
                                "enable_ocpc":true,
                                "ocpc_ratio":200,
                                "ocpc_marketing_aim":"click",
                                "ocpc_status":"new_ad_complete",
                                "enable_cold_speed_new_item":false,
                                "ecpc_option":1
                            },
                            "promotion_type":"item",
                            "sub_promotion_type":"item",
                            "material":{
                                "material_id":714616513841,
                                "material_type":1,
                                "material_name":"yiliantest测试请不要拍22",
                                "title":"yiliantest测试请不要拍22",
                                "img_url":"\/\/img.alicdn.com\/bao\/uploaded\/i1\/3838159498\/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg",
                                "link_url":"http:\/\/item.taobao.com\/item.htm?id=715121254343",
                                "price":"999900",
                                "bid_count":899900,
                                "quantity":10,
                                "first_starts_time":"2023-04-26 14:51:03",
                                "starts":"2023-04-26 14:51:03",
                                "category_id":"16 50010850",
                                "promotion_type":"item",
                                "sub_promotion_type":"item",
                                "life_cycle_list":{
                                    "item_life_cycle_view_vo":[
                                        {
                                            "life_cycle_desc":"新品打爆期",
                                            "color":"#36A2FC",
                                            "tips":"近30日GMV排名在叶子类目5%以内的新品"
                                        }
                                    ]
                                },
                                "life_cycle_days":3,
                                "life_cycle_diff_with_avg":"较慢",
                                "life_cycle_diff_with_avg_tips":"快于同类目商品经历过同样阶段变化所用时间",
                                "grow_desc":"日均再成交122.55元 可提高爆品类目排名卡位",
                                "grow_rank":1077
                            },
                            "alive_group_id":0,
                            "alive_group_name":"宝贝链接(默认)",
                            "black_creative_status":"success",
                            "gmt_create":"2023-12-09 14:34:12",
                            "gmt_modified":"2023-12-09 14:34:12"
                        }
                    ]
                },
                "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.adgroup.horizontal.findpage (查询单元分页列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ