文档中心 > API类目 > 万相台无界API

taobao.universalbp.bidword.delete (批量删除关键词)

入参词id列表，出参删除成功数量。当成功数量小于入参数量时，通过“taobao.universalbp.bidword.findlist”查询剩余有效词

公共参数

请求地址：

环境	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业务线编码
data_list	String	必须	5,3	list

响应参数

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 top_bulk_data TopBulkData 结果集 └ data_list String [] 10,20 批量结果集 └ count Number 1 数量

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpBidwordDeleteRequest req = new UniversalbpBidwordDeleteRequest();
UniversalbpBidwordDeleteRequest.TopServiceContext obj1 = new UniversalbpBidwordDeleteRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
req.setDataList("5,3");
UniversalbpBidwordDeleteResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpBidwordDeleteRequest req = new UniversalbpBidwordDeleteRequest();
UniversalbpBidwordDeleteRequest.TopServiceContextDomain obj1 = new UniversalbpBidwordDeleteRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
req.DataList = "5,3";
UniversalbpBidwordDeleteResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpBidwordDeleteRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$req->setDataList("5,3");
$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.delete' \
-d 'partner_id=apidoc' \
-d 'session=2ae83e4a-ebd2-432d-87ab-b34e1e4bd2bd' \
-d 'sign=C668F24B8D022755794F9EDDE262538F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A31%3A06' \
-d 'v=2.0' \
-d 'data_list=5%2C3' \
-d 'top_service_context=null'

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

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

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

响应示例

XML示例
JSON示例

<universalbp_bidword_delete_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_bulk_data>
            <data_list>
                <string>10</string>
                <string>20</string>
            </data_list>
            <count>1</count>
        </top_bulk_data>
    </result>
</universalbp_bidword_delete_response>

{
    "universalbp_bidword_delete_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "top_bulk_data":{
                "data_list":{
                    "string":[
                        "10",
                        "20"
                    ]
                },
                "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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

万相台无界API

taobao.universalbp.bidword.delete (批量删除关键词)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ