淘宝开放平台 - 文档中心

请求地址：

环境	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_single_query_v_o	BidwordSingleQueryVO	必须	bidwordSingleQueryVO
└ campaign_id Number 可选 68764632161 计划id └ adgroup_id Number 可选 68805630167 单元id └ bidword_id Number 可选 1131759830446 词id

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 black_word_v_o_top_bulk_data TopBulkData 结果集 └ count Number 10 成功数量 black_word_v_o_list BlackWordVO [] 批量成功结果集 └ adgroup_id Number 71384876528 单元id └ campaign_id Number 71310517234 计划id └ black_word_id Number 1512269026393 屏蔽词id └ word String 小米连衣裙词 └ match_scope Number 1 匹配类型，中心词屏蔽：2，精确词匹配：1 └ block_query_type String OTHER 品牌词：BRAND，价值词：VALUE，助攻词：MTA，机会词：OPPO, 其他词：OTHER └ is_high_light Number 0 是否高亮，1-高亮，0-不高亮

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewBlackwordFindRequest req = new UniversalbpNewBlackwordFindRequest();
UniversalbpNewBlackwordFindRequest.TopServiceContext obj1 = new UniversalbpNewBlackwordFindRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewBlackwordFindRequest.BidwordSingleQueryVO obj2 = new UniversalbpNewBlackwordFindRequest.BidwordSingleQueryVO();
obj2.setCampaignId(68764632161L);
obj2.setAdgroupId(68805630167L);
obj2.setBidwordId(1131759830446L);
req.setBidwordSingleQueryVO(obj2);
UniversalbpNewBlackwordFindResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewBlackwordFindRequest req = new UniversalbpNewBlackwordFindRequest();
UniversalbpNewBlackwordFindRequest.TopServiceContextDomain obj1 = new UniversalbpNewBlackwordFindRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewBlackwordFindRequest.BidwordSingleQueryVODomain obj2 = new UniversalbpNewBlackwordFindRequest.BidwordSingleQueryVODomain();
obj2.CampaignId = 68764632161L;
obj2.AdgroupId = 68805630167L;
obj2.BidwordId = 1131759830446L;
req.BidwordSingleQueryVO_ = obj2;
UniversalbpNewBlackwordFindResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewBlackwordFindRequest;
$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_single_query_v_o = new BidwordSingleQueryVO;
$bidword_single_query_v_o->campaign_id="68764632161";
$bidword_single_query_v_o->adgroup_id="68805630167";
$bidword_single_query_v_o->bidword_id="1131759830446";
$req->setBidwordSingleQueryVO(json_encode($bidword_single_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.blackword.find' \
-d 'partner_id=apidoc' \
-d 'session=09e19546-222d-4266-99fc-6d9fa7314771' \
-d 'sign=167902FA25CCFA12761E584E518745D8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A21%3A33' \
-d 'v=2.0' \
-d 'bidword_single_query_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

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

XML示例
JSON示例

<universalbp_new_blackword_find_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <black_word_v_o_top_bulk_data>
            <count>10</count>
            <black_word_v_o_list>
                <black_word_v_o>
                    <adgroup_id>71384876528</adgroup_id>
                    <campaign_id>71310517234</campaign_id>
                    <black_word_id>1512269026393</black_word_id>
                    <word>小米连衣裙</word>
                    <match_scope>1</match_scope>
                    <block_query_type>OTHER</block_query_type>
                    <is_high_light>0</is_high_light>
                </black_word_v_o>
            </black_word_v_o_list>
        </black_word_v_o_top_bulk_data>
    </top_result>
</universalbp_new_blackword_find_response>

{
    "universalbp_new_blackword_find_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "black_word_v_o_top_bulk_data":{
                "count":10,
                "black_word_v_o_list":{
                    "black_word_v_o":[
                        {
                            "adgroup_id":71384876528,
                            "campaign_id":71310517234,
                            "black_word_id":1512269026393,
                            "word":"小米连衣裙",
                            "match_scope":1,
                            "block_query_type":"OTHER",
                            "is_high_light":0
                        }
                    ]
                }
            }
        }
    }
}

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.blackword.find (屏蔽词查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ