淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码 └ login_type Number 可选 1 1: 直客(正常)登录 2: 代理直投(叉乘账号) └ member_id Number 可选 12345 代理直投时被代理商家账号, 代理直投（叉乘）时必填。直客时也可以填入 memberId └ ext String 可选 {} 扩展内容, 暂时无用
word_package_suggest_query_v_o	WordPackageSuggestQueryVO	必须	wordPackageSuggestQueryVO
└ material_id Number 可选 715017855321 宝贝id └ type String 可选 trendTheme 类型,overall:综合推荐,trendtheme:趋势词包,automatch:流量智选,extend:流量扩展,highquality:优质卖点词包推荐(用于卖点词包报告),new_default:新建流程默认推荐词包; └ campaign_id Number 可选 68792485515 计划id └ adgroup_id Number 可选 68792986520 单元id

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 suggest_word_package_v_o_top_bulk_data TopBulkData 结果集 └ count Number 10 成功数量 suggest_word_package_v_o_list SuggestWordPackageVO [] 批量成功结果集 └ word_package_id Number 191014 词包id └ word_package_type Number 20 词包类型,0:流量智选,20:卖点词包 └ word_package_name String 碎花词包名称 └ online_status Number 1 1:在线,0:下线 └ bid_price String 1 建议出价 └ impression String 10-20 预估展现 └ multi_factor String 10.0 流量放大系数 └ theme_word_list String [] ["碎花"] 主题词 └ simple_word_list String [] ["碎花裙", "碎花连衣裙", "碎花连衣裙女", "法式碎花裙"] 关键词举例 └ relevance_type Number 3 相关性,1:差,2:中,3:好 strategy_list WordPackageStrategyVO [] 词包策略信息 └ strategy_id Number 2 词包策略,0:流量智选,1:好词优选,2:捡漏,2:卖点词包,3:类目优选 └ strategy_name String 好词优选词包策略名称 └ word_package_type Number 20 词包类型,0:流量智选,1:好词优选,19:捡漏,20:卖点词包,21:类目优选 └ bid_price String 2.23 关键词基础出价 └ online_status Number 1 策略状态,1:在线,0:下线 └ adgroup_id Number 68793666608 单元id └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ report_info_map String 报表数据 reason_tag_list ShowTagVO [] 通用标签 └ code String hign_cvr 标签code └ name String 高转化率展示文案 └ tips String xxxxxx 悬浮描述 └ icon String xxxxxx 标签左侧图标地址 └ color String #FF4D4D 背景颜色 └ type String display_ocpc 标签类型 └ properties String 扩展属性

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewWordpackageSuggestkrlistRequest req = new UniversalbpNewWordpackageSuggestkrlistRequest();
UniversalbpNewWordpackageSuggestkrlistRequest.TopServiceContext obj1 = new UniversalbpNewWordpackageSuggestkrlistRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewWordpackageSuggestkrlistRequest.WordPackageSuggestQueryVO obj2 = new UniversalbpNewWordpackageSuggestkrlistRequest.WordPackageSuggestQueryVO();
obj2.setMaterialId(715017855321L);
obj2.setType("trendTheme");
obj2.setCampaignId(68792485515L);
obj2.setAdgroupId(68792986520L);
req.setWordPackageSuggestQueryVO(obj2);
UniversalbpNewWordpackageSuggestkrlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewWordpackageSuggestkrlistRequest req = new UniversalbpNewWordpackageSuggestkrlistRequest();
UniversalbpNewWordpackageSuggestkrlistRequest.TopServiceContextDomain obj1 = new UniversalbpNewWordpackageSuggestkrlistRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewWordpackageSuggestkrlistRequest.WordPackageSuggestQueryVODomain obj2 = new UniversalbpNewWordpackageSuggestkrlistRequest.WordPackageSuggestQueryVODomain();
obj2.MaterialId = 715017855321L;
obj2.Type = "trendTheme";
obj2.CampaignId = 68792485515L;
obj2.AdgroupId = 68792986520L;
req.WordPackageSuggestQueryVO_ = obj2;
UniversalbpNewWordpackageSuggestkrlistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewWordpackageSuggestkrlistRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$top_service_context->login_type="1";
$top_service_context->member_id="12345";
$top_service_context->ext="{}";
$req->setTopServiceContext(json_encode($top_service_context));
$word_package_suggest_query_v_o = new WordPackageSuggestQueryVO;
$word_package_suggest_query_v_o->material_id="715017855321";
$word_package_suggest_query_v_o->type="trendTheme";
$word_package_suggest_query_v_o->campaign_id="68792485515";
$word_package_suggest_query_v_o->adgroup_id="68792986520";
$req->setWordPackageSuggestQueryVO(json_encode($word_package_suggest_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.new.wordpackage.suggestkrlist' \
-d 'partner_id=apidoc' \
-d 'session=a60cd055-5cc7-48cc-91d9-fd2012b12f9d' \
-d 'sign=93BBDC59E44D83074F998F7F04ABDBA6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A28%3A09' \
-d 'v=2.0' \
-d 'top_service_context=TopServiceContext' \
-d 'word_package_suggest_query_v_o=null'

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

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

req.top_service_context="TopServiceContext"
req.word_package_suggest_query_v_o=""
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.new.wordpackage.suggestkrlist");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"word_package_suggest_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.new.wordpackage.suggestkrlist', {
	'top_service_context':'数据结构JSON示例',
	'word_package_suggest_query_v_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_new_wordpackage_suggestkrlist_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <suggest_word_package_v_o_top_bulk_data>
            <count>10</count>
            <suggest_word_package_v_o_list>
                <suggest_word_package_v_o>
                    <word_package_id>191014</word_package_id>
                    <word_package_type>20</word_package_type>
                    <word_package_name>碎花</word_package_name>
                    <online_status>1</online_status>
                    <bid_price>1</bid_price>
                    <impression>10-20</impression>
                    <multi_factor>10.0</multi_factor>
                    <theme_word_list>
                        <string>[&quot;碎花&quot;]</string>
                    </theme_word_list>
                    <simple_word_list>
                        <string>[&quot;碎花裙&quot;</string>
                        <string>&quot;碎花连衣裙&quot;</string>
                        <string>&quot;碎花连衣裙女&quot;</string>
                        <string>&quot;法式碎花裙&quot;]</string>
                    </simple_word_list>
                    <relevance_type>3</relevance_type>
                    <strategy_list>
                        <word_package_strategy_v_o>
                            <strategy_id>2</strategy_id>
                            <strategy_name>好词优选</strategy_name>
                            <word_package_type>20</word_package_type>
                            <bid_price>2.23</bid_price>
                            <online_status>1</online_status>
                            <adgroup_id>68793666608</adgroup_id>
                            <campaign_id>68796878069</campaign_id>
                        </word_package_strategy_v_o>
                    </strategy_list>
                    <reason_tag_list>
                        <show_tag_v_o>
                            <code>hign_cvr</code>
                            <name>高转化率</name>
                            <tips>xxxxxx</tips>
                            <icon>xxxxxx</icon>
                            <color>#FF4D4D</color>
                            <type>display_ocpc</type>
                        </show_tag_v_o>
                    </reason_tag_list>
                </suggest_word_package_v_o>
            </suggest_word_package_v_o_list>
        </suggest_word_package_v_o_top_bulk_data>
    </top_result>
</universalbp_new_wordpackage_suggestkrlist_response>

{
    "universalbp_new_wordpackage_suggestkrlist_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "suggest_word_package_v_o_top_bulk_data":{
                "count":10,
                "suggest_word_package_v_o_list":{
                    "suggest_word_package_v_o":[
                        {
                            "word_package_id":191014,
                            "word_package_type":20,
                            "word_package_name":"碎花",
                            "online_status":1,
                            "bid_price":"1",
                            "impression":"10-20",
                            "multi_factor":"10.0",
                            "theme_word_list":{
                                "string":[
                                    "[\"碎花\"]"
                                ]
                            },
                            "simple_word_list":{
                                "string":[
                                    "[\"碎花裙\"",
                                    " \"碎花连衣裙\"",
                                    " \"碎花连衣裙女\"",
                                    " \"法式碎花裙\"]"
                                ]
                            },
                            "relevance_type":3,
                            "strategy_list":{
                                "word_package_strategy_v_o":[
                                    {
                                        "strategy_id":2,
                                        "strategy_name":"好词优选",
                                        "word_package_type":20,
                                        "bid_price":"2.23",
                                        "online_status":1,
                                        "adgroup_id":68793666608,
                                        "campaign_id":68796878069
                                    }
                                ]
                            },
                            "reason_tag_list":{
                                "show_tag_v_o":[
                                    {
                                        "code":"hign_cvr",
                                        "name":"高转化率",
                                        "tips":"xxxxxx",
                                        "icon":"xxxxxx",
                                        "color":"#FF4D4D",
                                        "type":"display_ocpc"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        }
    }
}

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.new.wordpackage.suggestkrlist (关键词包建议)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ