淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码
bid_word_add_request_v_o	BidWordAddRequestVo	必须	bidWordAddRequestVO
bidword_list WordCommandVo [] 可选关键词集合 └ bidword_id Number 可选 1124844766581 新增关键词不用填 └ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填 └ adgroup_id Number 可选 68793666608 单元id,单元已经存在场景必填 └ word String 可选鞋原创小众词 └ bid_price String 可选 2.23 关键词基础出价 └ online_status Number 可选 1 词包状态,1:在线,0:下线 └ match_scope Number 可选 4 匹配类型,1:精准匹配,4:广泛匹配

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 word_command_v_o_top_bulk_data TopBulkData 结果集 word_command_v_o_list WordCommandVo [] 批量结果集 └ bidword_id Number 1124844766581 关键词id,关键词已经存在场景必填 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填 └ adgroup_id Number 68793666608 单元id,单元已经存在场景必填 └ word String 鞋原创小众词 └ bid_price String 2.23 关键词基础出价 └ online_status Number 1 词包状态,1:在线,0:下线 └ match_scope Number 4 匹配类型,1:精准匹配,4:广泛匹配 └ count Number 1 数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpBidwordAddRequest req = new UniversalbpBidwordAddRequest();
UniversalbpBidwordAddRequest.TopServiceContext obj1 = new UniversalbpBidwordAddRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpBidwordAddRequest.BidWordAddRequestVo obj2 = new UniversalbpBidwordAddRequest.BidWordAddRequestVo();
List<UniversalbpBidwordAddRequest.WordCommandVo> list4 = new ArrayList<UniversalbpBidwordAddRequest.WordCommandVo>();
UniversalbpBidwordAddRequest.WordCommandVo obj5 = new UniversalbpBidwordAddRequest.WordCommandVo();
list4.add(obj5);
obj5.setBidwordId(1124844766581L);
obj5.setCampaignId(68796878069L);
obj5.setAdgroupId(68793666608L);
obj5.setWord("鞋原创小众");
obj5.setBidPrice("2.23");
obj5.setOnlineStatus(1L);
obj5.setMatchScope(4L);
obj2.setBidwordList(list4);
req.setBidWordAddRequestVO(obj2);
UniversalbpBidwordAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpBidwordAddRequest req = new UniversalbpBidwordAddRequest();
UniversalbpBidwordAddRequest.TopServiceContextDomain obj1 = new UniversalbpBidwordAddRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpBidwordAddRequest.BidWordAddRequestVoDomain obj2 = new UniversalbpBidwordAddRequest.BidWordAddRequestVoDomain();
List<UniversalbpBidwordAddRequest.WordCommandVoDomain> list4 = new List<UniversalbpBidwordAddRequest.WordCommandVoDomain>();
UniversalbpBidwordAddRequest.WordCommandVoDomain obj5 = new UniversalbpBidwordAddRequest.WordCommandVoDomain();
list4.Add(obj5);
obj5.BidwordId = 1124844766581L;
obj5.CampaignId = 68796878069L;
obj5.AdgroupId = 68793666608L;
obj5.Word = "鞋原创小众";
obj5.BidPrice = "2.23";
obj5.OnlineStatus = 1L;
obj5.MatchScope = 4L;
obj2.BidwordList= list4;
req.BidWordAddRequestVO_ = obj2;
UniversalbpBidwordAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpBidwordAddRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$bid_word_add_request_v_o = new BidWordAddRequestVo;
$bidword_list = new WordCommandVo;
$bidword_list->bidword_id="1124844766581";
$bidword_list->campaign_id="68796878069";
$bidword_list->adgroup_id="68793666608";
$bidword_list->word="鞋原创小众";
$bidword_list->bid_price="2.23";
$bidword_list->online_status="1";
$bidword_list->match_scope="4";
$bid_word_add_request_v_o->bidword_list = $bidword_list;
$req->setBidWordAddRequestVO(json_encode($bid_word_add_request_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.bidword.add' \
-d 'partner_id=apidoc' \
-d 'session=80f7e252-a577-49b7-8009-c69deb9998a2' \
-d 'sign=4288CAC2AB366010923C27EA77CFB2B8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A28%3A10' \
-d 'v=2.0' \
-d 'bid_word_add_request_v_o=null' \
-d 'top_service_context=null'

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

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

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

XML示例
JSON示例

<universalbp_bidword_add_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <word_command_v_o_top_bulk_data>
            <word_command_v_o_list>
                <word_command_vo>
                    <bidword_id>1124844766581</bidword_id>
                    <campaign_id>68796878069</campaign_id>
                    <adgroup_id>68793666608</adgroup_id>
                    <word>鞋原创小众</word>
                    <bid_price>2.23</bid_price>
                    <online_status>1</online_status>
                    <match_scope>4</match_scope>
                </word_command_vo>
            </word_command_v_o_list>
            <count>1</count>
        </word_command_v_o_top_bulk_data>
    </result>
</universalbp_bidword_add_response>

{
    "universalbp_bidword_add_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "word_command_v_o_top_bulk_data":{
                "word_command_v_o_list":{
                    "word_command_vo":[
                        {
                            "bidword_id":1124844766581,
                            "campaign_id":68796878069,
                            "adgroup_id":68793666608,
                            "word":"鞋原创小众",
                            "bid_price":"2.23",
                            "online_status":1,
                            "match_scope":4
                        }
                    ]
                },
                "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.bidword.add (批量添加关键词)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ