淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 {} 扩展内容, 暂时无用
one_click_v_o	OneClickVO	必须	oneClickVO
└ item_id_list Number [] 可选 [761693282576] 宝贝id集合 diff_campaign_list DiffCampaignVO [] 可选互斥计划信息 └ campaign_id Number 可选 68796878069 计划id └ material_id_list Number [] 可选 [714706341071] 物料id集合 └ diff_campaign_id Number 可选 71432039559 互斥计划id └ diff_biz_code String 可选 onebpSearch 互斥计划bizCode └ diff_real_biz_code String 可选 onebpSearch 互斥计划真实bizCode └ diff_biz_code_name String 可选关键词推广互斥计划场景 └ diff_campaign_name String 可选关键词推广_20240820_151627 互斥计划的名称 └ campaign_id_list Number [] 可选 [68792788657] 计划id集合 campaign_list DiffCampaignQueryVO [] 可选互斥计划查询信息 └ campaign_id Number 可选 68792788657 计划id └ material_id_list Number [] 可选 [714706341071] 物料id集合

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewCampaignOneclickRequest req = new UniversalbpNewCampaignOneclickRequest();
UniversalbpNewCampaignOneclickRequest.TopServiceContext obj1 = new UniversalbpNewCampaignOneclickRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewCampaignOneclickRequest.OneClickVO obj2 = new UniversalbpNewCampaignOneclickRequest.OneClickVO();
obj2.setItemIdList(new Long[] { 761693282576 };
);
List<UniversalbpNewCampaignOneclickRequest.DiffCampaignVO> list4 = new ArrayList<UniversalbpNewCampaignOneclickRequest.DiffCampaignVO>();
UniversalbpNewCampaignOneclickRequest.DiffCampaignVO obj5 = new UniversalbpNewCampaignOneclickRequest.DiffCampaignVO();
list4.add(obj5);
obj5.setCampaignId(68796878069L);
obj5.setMaterialIdList(new Long[] { 714706341071 };
);
obj5.setDiffCampaignId(71432039559L);
obj5.setDiffBizCode("onebpSearch");
obj5.setDiffRealBizCode("onebpSearch");
obj5.setDiffBizCodeName("关键词推广");
obj5.setDiffCampaignName("关键词推广_20240820_151627");
obj2.setDiffCampaignList(list4);
obj2.setCampaignIdList(new Long[] { 68792788657 };
);
List<UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVO> list7 = new ArrayList<UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVO>();
UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVO obj8 = new UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVO();
list7.add(obj8);
obj8.setCampaignId(68792788657L);
obj8.setMaterialIdList(new Long[] { 714706341071 };
);
obj2.setCampaignList(list7);
req.setOneClickVO(obj2);
UniversalbpNewCampaignOneclickResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewCampaignOneclickRequest req = new UniversalbpNewCampaignOneclickRequest();
UniversalbpNewCampaignOneclickRequest.TopServiceContextDomain obj1 = new UniversalbpNewCampaignOneclickRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewCampaignOneclickRequest.OneClickVODomain obj2 = new UniversalbpNewCampaignOneclickRequest.OneClickVODomain();
obj2.ItemIdList = new long[] { 761693282576 };
;
List<UniversalbpNewCampaignOneclickRequest.DiffCampaignVODomain> list4 = new List<UniversalbpNewCampaignOneclickRequest.DiffCampaignVODomain>();
UniversalbpNewCampaignOneclickRequest.DiffCampaignVODomain obj5 = new UniversalbpNewCampaignOneclickRequest.DiffCampaignVODomain();
list4.Add(obj5);
obj5.CampaignId = 68796878069L;
obj5.MaterialIdList = new long[] { 714706341071 };
;
obj5.DiffCampaignId = 71432039559L;
obj5.DiffBizCode = "onebpSearch";
obj5.DiffRealBizCode = "onebpSearch";
obj5.DiffBizCodeName = "关键词推广";
obj5.DiffCampaignName = "关键词推广_20240820_151627";
obj2.DiffCampaignList= list4;
obj2.CampaignIdList = new long[] { 68792788657 };
;
List<UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVODomain> list7 = new List<UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVODomain>();
UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVODomain obj8 = new UniversalbpNewCampaignOneclickRequest.DiffCampaignQueryVODomain();
list7.Add(obj8);
obj8.CampaignId = 68792788657L;
obj8.MaterialIdList = new long[] { 714706341071 };
;
obj2.CampaignList= list7;
req.OneClickVO_ = obj2;
UniversalbpNewCampaignOneclickResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewCampaignOneclickRequest;
$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));
$one_click_v_o = new OneClickVO;
$one_click_v_o->item_id_list="[761693282576]";
$diff_campaign_list = new DiffCampaignVO;
$diff_campaign_list->campaign_id="68796878069";
$diff_campaign_list->material_id_list="[714706341071]";
$diff_campaign_list->diff_campaign_id="71432039559";
$diff_campaign_list->diff_biz_code="onebpSearch";
$diff_campaign_list->diff_real_biz_code="onebpSearch";
$diff_campaign_list->diff_biz_code_name="关键词推广";
$diff_campaign_list->diff_campaign_name="关键词推广_20240820_151627";
$one_click_v_o->diff_campaign_list = $diff_campaign_list;
$one_click_v_o->campaign_id_list="[68792788657]";
$campaign_list = new DiffCampaignQueryVO;
$campaign_list->campaign_id="68792788657";
$campaign_list->material_id_list="[714706341071]";
$one_click_v_o->campaign_list = $campaign_list;
$req->setOneClickVO(json_encode($one_click_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.campaign.oneclick' \
-d 'partner_id=apidoc' \
-d 'session=237bcd03-767e-4f9c-8396-3ab888f76714' \
-d 'sign=8873DF95C1EA9FAF55A36EBBF00C8475' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A32%3A30' \
-d 'v=2.0' \
-d 'one_click_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

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

XML示例
JSON示例

<universalbp_new_campaign_oneclick_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
    </top_result>
</universalbp_new_campaign_oneclick_response>

{
    "universalbp_new_campaign_oneclick_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            }
        }
    }
}

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.campaign.oneclick (一键暂停)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ