淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码
label_query_v_o	LabelQueryVo	必须	labelQueryVO
label_list LabelEntryQueryVo [] 可选标签信息 └ label_id String 可选 3000494 定向标签id └ 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 category CategoryQueryVo 可选类目信息 └ cat_id Number 可选 35 类目id └ cat_name String 可选童装/婴儿装/亲子装类目名称 └ cat_level Number 可选 1 类目级别，一级类目、二级目录 └ rec_query_time Number 可选 30 报表数据统计时长 └ material_id_list Number [] 可选 [714894818852, 714901906337, 715106275342, 714813770503, 714707465203] 宝贝id集合 └ campaign_id Number 可选 68795552573 计划id └ offset Number 可选 0 分页页数 └ page_size Number 可选 10 分页数量 └ adgroup_id Number 可选 521323123113 单元id search_category CategoryQueryVo 可选浮层里面用户选的类目 └ cat_id Number 可选 35 类目id └ cat_name String 可选童装/婴儿装/亲子装类目名称 └ cat_level Number 可选 1 类目级别，一级类目、二级目录

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 label_v_o_top_bulk_data TopBulkData 结果集 label_v_o_list LabelVo [] 批量结果集 └ target_type Number 131 定向标签类型 └ label_id Number 3000494 定向标签id └ label_name String 关键词定向标签名称 └ label_desc String 关键词定向标签描述 └ label_value String 2000112 定向标签值 └ price_dimension String OPTION 出价维度，OPTION:标签出价，多个子人群同时出价、LABEL:选项出价，以子人群为出价最小单位 option_group_list OptionGroupVo [] 标签选项分组 └ option_group_name String 性别标签分组名称 option_list OptionVo [] 标签选项 └ option_name String 人群特征继承选项名称 └ option_value String 2000123 选项值 └ option_desc String 该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。选项描述 └ tag_id Number 100000 选项id，(用于关键词推广静态标签生成人群)如基础属性人群标签组合 └ option_group_name String 性别标签分组名称 label_option_properties LabelOptionProperties 透传属性 └ dmp_option_group_id String 1001 dmp选项分组id └ cate_name String 714616513841 物料id └ cate_id String 714616513841 物料id └ properties String 扩展属性 option_list OptionVo [] 标签选项 └ option_name String 人群特征继承选项名称 └ option_value String 2000123 选项值 └ option_desc String 该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。选项描述 └ tag_id Number 100000 选项id，(用于关键词推广静态标签生成人群)如基础属性人群标签组合 └ option_group_name String 性别标签分组名称 label_option_properties LabelOptionProperties 透传属性 └ dmp_option_group_id String 1001 dmp选项分组id └ cate_name String 714616513841 物料id └ cate_id String 714616513841 物料id └ properties String 扩展属性 └ is_multi Boolean true 是否可以绑定多个定向,获取不到默认为否,true:是 false:否 label_option_properties LabelOptionProperties 透传属性 └ dmp_option_group_id String 1001 dmp选项分组id └ cate_name String 714616513841 物料id └ cate_id String 714616513841 物料id └ properties String {} 额外的属性参数 └ category_id Number 3221312321 目标类目 └ category_name String 服装类目名称 └ label_group_name String 人群人群类型，所属类型 show_tag_list ShowTagVO [] 标签tag └ code String code 标签code └ name String 标签展示文案 └ tips String xxxxx 悬浮描述 └ icon String xxxxx 图标地址 └ color String xxxxx 背景颜色 └ type String xxxxx 标签类型 └ properties String {} 扩展属性 price PriceVO Label出价溢价信息 └ bid_price String 30 出价 └ fit_bid_price String 30 建议出价 └ discount String 30 溢价 └ fit_discount String 30 建议溢价 └ count Number 1 数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpLabelFindlistRequest req = new UniversalbpLabelFindlistRequest();
UniversalbpLabelFindlistRequest.TopServiceContext obj1 = new UniversalbpLabelFindlistRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpLabelFindlistRequest.LabelQueryVo obj2 = new UniversalbpLabelFindlistRequest.LabelQueryVo();
List<UniversalbpLabelFindlistRequest.LabelEntryQueryVo> list4 = new ArrayList<UniversalbpLabelFindlistRequest.LabelEntryQueryVo>();
UniversalbpLabelFindlistRequest.LabelEntryQueryVo obj5 = new UniversalbpLabelFindlistRequest.LabelEntryQueryVo();
list4.add(obj5);
obj5.setLabelId("3000494");
obj2.setLabelList(list4);
obj2.setPromotionType("item");
obj2.setSubPromotionType("item");
UniversalbpLabelFindlistRequest.CategoryQueryVo obj6 = new UniversalbpLabelFindlistRequest.CategoryQueryVo();
obj6.setCatId(35L);
obj6.setCatName("童装/婴儿装/亲子装");
obj6.setCatLevel(1L);
obj2.setCategory(obj6);
obj2.setRecQueryTime(30L);
obj2.setMaterialIdList(new Long[] { 714894818852, 714901906337, 715106275342, 714813770503, 714707465203 };
);
obj2.setCampaignId(68795552573L);
obj2.setOffset(0L);
obj2.setPageSize(10L);
obj2.setAdgroupId(521323123113L);
UniversalbpLabelFindlistRequest.CategoryQueryVo obj7 = new UniversalbpLabelFindlistRequest.CategoryQueryVo();
obj7.setCatId(35L);
obj7.setCatName("童装/婴儿装/亲子装");
obj7.setCatLevel(1L);
obj2.setSearchCategory(obj7);
req.setLabelQueryVO(obj2);
UniversalbpLabelFindlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpLabelFindlistRequest req = new UniversalbpLabelFindlistRequest();
UniversalbpLabelFindlistRequest.TopServiceContextDomain obj1 = new UniversalbpLabelFindlistRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpLabelFindlistRequest.LabelQueryVoDomain obj2 = new UniversalbpLabelFindlistRequest.LabelQueryVoDomain();
List<UniversalbpLabelFindlistRequest.LabelEntryQueryVoDomain> list4 = new List<UniversalbpLabelFindlistRequest.LabelEntryQueryVoDomain>();
UniversalbpLabelFindlistRequest.LabelEntryQueryVoDomain obj5 = new UniversalbpLabelFindlistRequest.LabelEntryQueryVoDomain();
list4.Add(obj5);
obj5.LabelId = "3000494";
obj2.LabelList= list4;
obj2.PromotionType = "item";
obj2.SubPromotionType = "item";
UniversalbpLabelFindlistRequest.CategoryQueryVoDomain obj6 = new UniversalbpLabelFindlistRequest.CategoryQueryVoDomain();
obj6.CatId = 35L;
obj6.CatName = "童装/婴儿装/亲子装";
obj6.CatLevel = 1L;
obj2.Category= obj6;
obj2.RecQueryTime = 30L;
obj2.MaterialIdList = new long[] { 714894818852, 714901906337, 715106275342, 714813770503, 714707465203 };
;
obj2.CampaignId = 68795552573L;
obj2.Offset = 0L;
obj2.PageSize = 10L;
obj2.AdgroupId = 521323123113L;
UniversalbpLabelFindlistRequest.CategoryQueryVoDomain obj7 = new UniversalbpLabelFindlistRequest.CategoryQueryVoDomain();
obj7.CatId = 35L;
obj7.CatName = "童装/婴儿装/亲子装";
obj7.CatLevel = 1L;
obj2.SearchCategory= obj7;
req.LabelQueryVO_ = obj2;
UniversalbpLabelFindlistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpLabelFindlistRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$label_query_v_o = new LabelQueryVo;
$label_list = new LabelEntryQueryVo;
$label_list->label_id="3000494";
$label_query_v_o->label_list = $label_list;
$label_query_v_o->promotion_type="item";
$label_query_v_o->sub_promotion_type="item";
$category = new CategoryQueryVo;
$category->cat_id="35";
$category->cat_name="童装/婴儿装/亲子装";
$category->cat_level="1";
$label_query_v_o->category = $category;
$label_query_v_o->rec_query_time="30";
$label_query_v_o->material_id_list="[714894818852, 714901906337, 715106275342, 714813770503, 714707465203]";
$label_query_v_o->campaign_id="68795552573";
$label_query_v_o->offset="0";
$label_query_v_o->page_size="10";
$label_query_v_o->adgroup_id="521323123113";
$search_category = new CategoryQueryVo;
$search_category->cat_id="35";
$search_category->cat_name="童装/婴儿装/亲子装";
$search_category->cat_level="1";
$label_query_v_o->search_category = $search_category;
$req->setLabelQueryVO(json_encode($label_query_v_o));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.universalbp.label.findlist' \
-d 'partner_id=apidoc' \
-d 'session=e36ccf20-c82a-45bb-8dfa-aff8fb8080c3' \
-d 'sign=0813DCBA24D92BB7FF4FD71788870E67' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A26%3A52' \
-d 'v=2.0' \
-d 'label_query_v_o=null' \
-d 'top_service_context=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.UniversalbpLabelFindlistRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.top_service_context="数据结构示例JSON格式"
req.label_query_v_o="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.universalbp.label.findlist");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"label_query_v_o","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.universalbp.label.findlist', {
	'top_service_context':'数据结构JSON示例',
	'label_query_v_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_label_findlist_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <label_v_o_top_bulk_data>
            <label_v_o_list>
                <label_vo>
                    <target_type>131</target_type>
                    <label_id>3000494</label_id>
                    <label_name>关键词</label_name>
                    <label_desc>关键词</label_desc>
                    <label_value>2000112</label_value>
                    <price_dimension>OPTION</price_dimension>
                    <option_group_list>
                        <option_group_vo>
                            <option_group_name>性别</option_group_name>
                            <option_list>
                                <option_vo>
                                    <option_name>人群特征继承</option_name>
                                    <option_value>2000123</option_value>
                                    <option_desc>该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。</option_desc>
                                    <tag_id>100000</tag_id>
                                    <option_group_name>性别</option_group_name>
                                    <label_option_properties>
                                        <dmp_option_group_id>1001</dmp_option_group_id>
                                        <cate_name>714616513841</cate_name>
                                        <cate_id>714616513841</cate_id>
                                    </label_option_properties>
                                </option_vo>
                            </option_list>
                        </option_group_vo>
                    </option_group_list>
                    <option_list>
                        <option_vo>
                            <option_name>人群特征继承</option_name>
                            <option_value>2000123</option_value>
                            <option_desc>该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。</option_desc>
                            <tag_id>100000</tag_id>
                            <option_group_name>性别</option_group_name>
                            <label_option_properties>
                                <dmp_option_group_id>1001</dmp_option_group_id>
                                <cate_name>714616513841</cate_name>
                                <cate_id>714616513841</cate_id>
                            </label_option_properties>
                        </option_vo>
                    </option_list>
                    <is_multi>true</is_multi>
                    <label_option_properties>
                        <dmp_option_group_id>1001</dmp_option_group_id>
                        <cate_name>714616513841</cate_name>
                        <cate_id>714616513841</cate_id>
                    </label_option_properties>
                    <properties>{}</properties>
                    <category_id>3221312321</category_id>
                    <category_name>服装</category_name>
                    <label_group_name>人群</label_group_name>
                    <show_tag_list>
                        <show_tag_v_o>
                            <code>code</code>
                            <name>标签</name>
                            <tips>xxxxx</tips>
                            <icon>xxxxx</icon>
                            <color>xxxxx</color>
                            <type>xxxxx</type>
                            <properties>{}</properties>
                        </show_tag_v_o>
                    </show_tag_list>
                    <price>
                        <bid_price>30</bid_price>
                        <fit_bid_price>30</fit_bid_price>
                        <discount>30</discount>
                        <fit_discount>30</fit_discount>
                    </price>
                </label_vo>
            </label_v_o_list>
            <count>1</count>
        </label_v_o_top_bulk_data>
    </result>
</universalbp_label_findlist_response>

{
    "universalbp_label_findlist_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "label_v_o_top_bulk_data":{
                "label_v_o_list":{
                    "label_vo":[
                        {
                            "target_type":131,
                            "label_id":3000494,
                            "label_name":"关键词",
                            "label_desc":"关键词",
                            "label_value":"2000112",
                            "price_dimension":"OPTION",
                            "option_group_list":{
                                "option_group_vo":[
                                    {
                                        "option_group_name":"性别",
                                        "option_list":{
                                            "option_vo":[
                                                {
                                                    "option_name":"人群特征继承",
                                                    "option_value":"2000123",
                                                    "option_desc":"该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。",
                                                    "tag_id":100000,
                                                    "option_group_name":"性别",
                                                    "label_option_properties":{
                                                        "dmp_option_group_id":"1001",
                                                        "cate_name":"714616513841",
                                                        "cate_id":"714616513841"
                                                    }
                                                }
                                            ]
                                        }
                                    }
                                ]
                            },
                            "option_list":{
                                "option_vo":[
                                    {
                                        "option_name":"人群特征继承",
                                        "option_value":"2000123",
                                        "option_desc":"该定向人群将继承原始计划已触达的消费者特征，缩短算法搜寻合适人群的冷启动周期，建议您同时开启【智能拓展】功能，提升投放效果。",
                                        "tag_id":100000,
                                        "option_group_name":"性别",
                                        "label_option_properties":{
                                            "dmp_option_group_id":"1001",
                                            "cate_name":"714616513841",
                                            "cate_id":"714616513841"
                                        }
                                    }
                                ]
                            },
                            "is_multi":true,
                            "label_option_properties":{
                                "dmp_option_group_id":"1001",
                                "cate_name":"714616513841",
                                "cate_id":"714616513841"
                            },
                            "properties":"{}",
                            "category_id":3221312321,
                            "category_name":"服装",
                            "label_group_name":"人群",
                            "show_tag_list":{
                                "show_tag_v_o":[
                                    {
                                        "code":"code",
                                        "name":"标签",
                                        "tips":"xxxxx",
                                        "icon":"xxxxx",
                                        "color":"xxxxx",
                                        "type":"xxxxx",
                                        "properties":"{}"
                                    }
                                ]
                            },
                            "price":{
                                "bid_price":"30",
                                "fit_bid_price":"30",
                                "discount":"30",
                                "fit_discount":"30"
                            }
                        }
                    ]
                },
                "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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

万相台无界API

taobao.universalbp.label.findlist (定向标签列表(全量))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ