淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 {} 扩展内容, 暂时无用
bidword_suggest_query_v_o	BidwordSuggestQueryVO	必须	bidwordSuggestQueryVO
└ type String 可选 kr_overall 类型,kr_overall:综合推荐,kr_flow:精准引流,kr_category:类目优质词,kr_industry:行业机会词,kr_mta:助攻词,kr_search:搜索词联想,kr_byword:以词推词,kr_bycrowd:以人群词,new_default:新建流程默认推词 └ material_id Number 可选 715017855321 宝贝id └ adgroup_id Number 可选 68793666608 单元id,单元已经存在场景必填 └ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填 └ word String 可选连衣裙词 └ crowd_id_list Number [] 可选 [111] 人群id

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 suggest_bidword_v_o_top_bulk_data TopBulkData 结果集 └ count Number 10 成功数量 suggest_bidword_v_o_list SuggestBidwordVO [] 批量成功结果集 └ word String 吵吵家关键词 └ bid_price String 1 关键词 └ avg_price String 0.47 市场平均出价 └ impression String 0-10 预估展现 └ relevance_type Number 3 相关性,1:差,2:中,3:好 └ ctr String 0.0381 点击率 └ cvr String 0.0209 点击转化率 └ impression_index Number 30 展现指数 └ competition_index String 20 竞争指数 └ search_index Number 20 搜索指数 └ qscore String 6.00 预估质量分 └ item_click Number 20 进店次数 └ transaction_shipping_total Number 20 引导下单数 └ item_click_coverage String 0.5 下单转化率 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 扩展属性 └ type Number 0 分类,0:宝贝,1:店铺 └ mta_roi String 20 助攻roi └ predict_click String 0.029 点击指数 └ market_click_rate String 0.029 市场点击率 └ market_average_bid String 0.029 市场平均出价 └ market_click_conversion_rate String 0.29 市场点击转化率 └ first_slot_impression_rate String 0.29 首坑展现率 └ lead_ad_gmv_rate String 0.046 引导GMV占比 └ trend_index String 0.046 飙升度 └ present_m_penetration_rate String 0.46 市场渗透率 └ rec_reason String 热门词推荐理由

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewBidwordSuggestkrlistRequest req = new UniversalbpNewBidwordSuggestkrlistRequest();
UniversalbpNewBidwordSuggestkrlistRequest.TopServiceContext obj1 = new UniversalbpNewBidwordSuggestkrlistRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewBidwordSuggestkrlistRequest.BidwordSuggestQueryVO obj2 = new UniversalbpNewBidwordSuggestkrlistRequest.BidwordSuggestQueryVO();
obj2.setType("kr_overall");
obj2.setMaterialId(715017855321L);
obj2.setAdgroupId(68793666608L);
obj2.setCampaignId(68796878069L);
obj2.setWord("连衣裙");
obj2.setCrowdIdList(new Long[] { 111 };
);
req.setBidwordSuggestQueryVO(obj2);
UniversalbpNewBidwordSuggestkrlistResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewBidwordSuggestkrlistRequest req = new UniversalbpNewBidwordSuggestkrlistRequest();
UniversalbpNewBidwordSuggestkrlistRequest.TopServiceContextDomain obj1 = new UniversalbpNewBidwordSuggestkrlistRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewBidwordSuggestkrlistRequest.BidwordSuggestQueryVODomain obj2 = new UniversalbpNewBidwordSuggestkrlistRequest.BidwordSuggestQueryVODomain();
obj2.Type = "kr_overall";
obj2.MaterialId = 715017855321L;
obj2.AdgroupId = 68793666608L;
obj2.CampaignId = 68796878069L;
obj2.Word = "连衣裙";
obj2.CrowdIdList = new long[] { 111 };
;
req.BidwordSuggestQueryVO_ = obj2;
UniversalbpNewBidwordSuggestkrlistResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewBidwordSuggestkrlistRequest;
$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));
$bidword_suggest_query_v_o = new BidwordSuggestQueryVO;
$bidword_suggest_query_v_o->type="kr_overall";
$bidword_suggest_query_v_o->material_id="715017855321";
$bidword_suggest_query_v_o->adgroup_id="68793666608";
$bidword_suggest_query_v_o->campaign_id="68796878069";
$bidword_suggest_query_v_o->word="连衣裙";
$bidword_suggest_query_v_o->crowd_id_list="[111]";
$req->setBidwordSuggestQueryVO(json_encode($bidword_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.bidword.suggestkrlist' \
-d 'partner_id=apidoc' \
-d 'session=f996fb36-a444-4d9a-b430-7355d5f254ee' \
-d 'sign=FC9CA9CEB73E4BCFD16C5D7F3D93D236' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A25%3A38' \
-d 'v=2.0' \
-d 'bidword_suggest_query_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

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

XML示例
JSON示例

<universalbp_new_bidword_suggestkrlist_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <suggest_bidword_v_o_top_bulk_data>
            <count>10</count>
            <suggest_bidword_v_o_list>
                <suggest_bidword_v_o>
                    <word>吵吵家</word>
                    <bid_price>1</bid_price>
                    <avg_price>0.47</avg_price>
                    <impression>0-10</impression>
                    <relevance_type>3</relevance_type>
                    <ctr>0.0381</ctr>
                    <cvr>0.0209</cvr>
                    <impression_index>30</impression_index>
                    <competition_index>20</competition_index>
                    <search_index>20</search_index>
                    <qscore>6.00</qscore>
                    <item_click>20</item_click>
                    <transaction_shipping_total>20</transaction_shipping_total>
                    <item_click_coverage>0.5</item_click_coverage>
                    <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>
                    <type>0</type>
                    <mta_roi>20</mta_roi>
                    <predict_click>0.029</predict_click>
                    <market_click_rate>0.029</market_click_rate>
                    <market_average_bid>0.029</market_average_bid>
                    <market_click_conversion_rate>0.29</market_click_conversion_rate>
                    <first_slot_impression_rate>0.29</first_slot_impression_rate>
                    <lead_ad_gmv_rate>0.046</lead_ad_gmv_rate>
                    <trend_index>0.046</trend_index>
                    <present_m_penetration_rate>0.46</present_m_penetration_rate>
                    <rec_reason>热门词</rec_reason>
                </suggest_bidword_v_o>
            </suggest_bidword_v_o_list>
        </suggest_bidword_v_o_top_bulk_data>
    </top_result>
</universalbp_new_bidword_suggestkrlist_response>

{
    "universalbp_new_bidword_suggestkrlist_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "suggest_bidword_v_o_top_bulk_data":{
                "count":10,
                "suggest_bidword_v_o_list":{
                    "suggest_bidword_v_o":[
                        {
                            "word":"吵吵家",
                            "bid_price":"1",
                            "avg_price":"0.47",
                            "impression":"0-10",
                            "relevance_type":3,
                            "ctr":"0.0381",
                            "cvr":"0.0209",
                            "impression_index":30,
                            "competition_index":"20",
                            "search_index":20,
                            "qscore":"6.00",
                            "item_click":20,
                            "transaction_shipping_total":20,
                            "item_click_coverage":"0.5",
                            "reason_tag_list":{
                                "show_tag_v_o":[
                                    {
                                        "code":"hign_cvr",
                                        "name":"高转化率",
                                        "tips":"xxxxxx",
                                        "icon":"xxxxxx",
                                        "color":"#FF4D4D",
                                        "type":"display_ocpc"
                                    }
                                ]
                            },
                            "type":0,
                            "mta_roi":"20",
                            "predict_click":"0.029",
                            "market_click_rate":"0.029",
                            "market_average_bid":"0.029",
                            "market_click_conversion_rate":"0.29",
                            "first_slot_impression_rate":"0.29",
                            "lead_ad_gmv_rate":"0.046",
                            "trend_index":"0.046",
                            "present_m_penetration_rate":"0.46",
                            "rec_reason":"热门词"
                        }
                    ]
                }
            }
        }
    }
}

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ