淘宝开放平台 - 文档中心

请求地址：

环境	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	CampaignBudgetCommandVo	必须	list
└ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填 └ dmc_type String 可选 normal 预算类型,normal:日预算,total:总预算,cycle:活动周期预算,day_freeze:日预算冻结,unlimit:不限预算 └ day_budget Number 可选 100 日预算金额 └ smooth_option String 可选 smooth 日预算投放方式, quick:天内尽快,smooth:天内平滑 └ total_budget Number 可选 100 周期预算金额 └ period_smooth String 可选 7 周期预算周期天数 launch_time CampaignLaunchTimeCommandVo 可选计划投放时间 └ start_time Date 可选 2023-06-09 00:00:00 计划开始时间 └ end_time Date 可选 2199-02-01 00:00:00 计划结束时间 └ launch_forever Boolean 可选 true 是否长期投放,true:是,false:否 budget_schedule_data BudgetScheduleDataSiteVo 可选活动周期预算,场景推广使用 └ activity_type String 可选 OFFICAL 活动类型,OFFICAL:官方活动,CUSTOM:自定义活动 main_activity TmcCampaignVo 可选活动信息 └ id Number 可选 1 活动id └ name String 可选活动期活动名称 └ start_time String 可选 2023-07-05 开始时间 └ end_time String 可选 2023-07-14 结束时间 └ schedule_type String 可选 AUTO 活动类型,AUTO:智能分配,STAGE:按阶段分配 activity_budget_list ActivityBudgetVo [] 可选活动预算信息 └ id Number 可选 1 活动id └ name String 可选活动期名称 └ start_time String 可选 2023-07-05 开始时间 └ end_time String 可选 2023-07-14 结束时间 └ activity_dmc Number 可选 510 周期预算 └ is_budget_schedule_open Boolean 可选 true 活动周期预算开关关闭

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 campaign_budget_update_result_v_o_top_part_data TopPartData 结果集 └ count Number 1 数量 campaign_budget_update_result_v_o_list CampaignBudgetUpdateResultVo [] 批量成功结果集 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ error_count Number 1 失败数量 error_details TopFailResult [] 失败结果集 └ code String xxxxx 业务失败编码 └ msg String xxxxx 业务失败原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpCampaignBudgetBatchupdateRequest req = new UniversalbpCampaignBudgetBatchupdateRequest();
UniversalbpCampaignBudgetBatchupdateRequest.TopServiceContext obj1 = new UniversalbpCampaignBudgetBatchupdateRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpCampaignBudgetBatchupdateRequest.CampaignBudgetCommandVo obj2 = new UniversalbpCampaignBudgetBatchupdateRequest.CampaignBudgetCommandVo();
obj2.setCampaignId(68796878069L);
obj2.setDmcType("normal");
obj2.setDayBudget(100L);
obj2.setSmoothOption("smooth");
obj2.setTotalBudget(100L);
obj2.setPeriodSmooth("7");
UniversalbpCampaignBudgetBatchupdateRequest.CampaignLaunchTimeCommandVo obj3 = new UniversalbpCampaignBudgetBatchupdateRequest.CampaignLaunchTimeCommandVo();
obj3.setStartTime(StringUtils.parseDateTime("2023-06-09 00:00:00"));
obj3.setEndTime(StringUtils.parseDateTime("2199-02-01 00:00:00"));
obj3.setLaunchForever(true);
obj2.setLaunchTime(obj3);
UniversalbpCampaignBudgetBatchupdateRequest.BudgetScheduleDataSiteVo obj4 = new UniversalbpCampaignBudgetBatchupdateRequest.BudgetScheduleDataSiteVo();
obj4.setActivityType("OFFICAL");
UniversalbpCampaignBudgetBatchupdateRequest.TmcCampaignVo obj5 = new UniversalbpCampaignBudgetBatchupdateRequest.TmcCampaignVo();
obj5.setId(1L);
obj5.setName("活动期");
obj5.setStartTime("2023-07-05");
obj5.setEndTime("2023-07-14");
obj4.setMainActivity(obj5);
obj4.setScheduleType("AUTO");
List<UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVo> list7 = new ArrayList<UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVo>();
UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVo obj8 = new UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVo();
list7.add(obj8);
obj8.setId(1L);
obj8.setName("活动期");
obj8.setStartTime("2023-07-05");
obj8.setEndTime("2023-07-14");
obj8.setActivityDmc(510L);
obj4.setActivityBudgetList(list7);
obj2.setBudgetScheduleData(obj4);
obj2.setIsBudgetScheduleOpen(true);
req.setDataList(obj2);
UniversalbpCampaignBudgetBatchupdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpCampaignBudgetBatchupdateRequest req = new UniversalbpCampaignBudgetBatchupdateRequest();
UniversalbpCampaignBudgetBatchupdateRequest.TopServiceContextDomain obj1 = new UniversalbpCampaignBudgetBatchupdateRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpCampaignBudgetBatchupdateRequest.CampaignBudgetCommandVoDomain obj2 = new UniversalbpCampaignBudgetBatchupdateRequest.CampaignBudgetCommandVoDomain();
obj2.CampaignId = 68796878069L;
obj2.DmcType = "normal";
obj2.DayBudget = 100L;
obj2.SmoothOption = "smooth";
obj2.TotalBudget = 100L;
obj2.PeriodSmooth = "7";
UniversalbpCampaignBudgetBatchupdateRequest.CampaignLaunchTimeCommandVoDomain obj3 = new UniversalbpCampaignBudgetBatchupdateRequest.CampaignLaunchTimeCommandVoDomain();
obj3.StartTime = DateTime.Parse(2023-06-09 00:00:00");
obj3.EndTime = DateTime.Parse(2199-02-01 00:00:00");
obj3.LaunchForever = true;
obj2.LaunchTime= obj3;
UniversalbpCampaignBudgetBatchupdateRequest.BudgetScheduleDataSiteVoDomain obj4 = new UniversalbpCampaignBudgetBatchupdateRequest.BudgetScheduleDataSiteVoDomain();
obj4.ActivityType = "OFFICAL";
UniversalbpCampaignBudgetBatchupdateRequest.TmcCampaignVoDomain obj5 = new UniversalbpCampaignBudgetBatchupdateRequest.TmcCampaignVoDomain();
obj5.Id = 1L;
obj5.Name = "活动期";
obj5.StartTime = "2023-07-05";
obj5.EndTime = "2023-07-14";
obj4.MainActivity= obj5;
obj4.ScheduleType = "AUTO";
List<UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVoDomain> list7 = new List<UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVoDomain>();
UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVoDomain obj8 = new UniversalbpCampaignBudgetBatchupdateRequest.ActivityBudgetVoDomain();
list7.Add(obj8);
obj8.Id = 1L;
obj8.Name = "活动期";
obj8.StartTime = "2023-07-05";
obj8.EndTime = "2023-07-14";
obj8.ActivityDmc = 510L;
obj4.ActivityBudgetList= list7;
obj2.BudgetScheduleData= obj4;
obj2.IsBudgetScheduleOpen = true;
req.DataList_ = obj2;
UniversalbpCampaignBudgetBatchupdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpCampaignBudgetBatchupdateRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$data_list = new CampaignBudgetCommandVo;
$data_list->campaign_id="68796878069";
$data_list->dmc_type="normal";
$data_list->day_budget="100";
$data_list->smooth_option="smooth";
$data_list->total_budget="100";
$data_list->period_smooth="7";
$launch_time = new CampaignLaunchTimeCommandVo;
$launch_time->start_time="2023-06-09 00:00:00";
$launch_time->end_time="2199-02-01 00:00:00";
$launch_time->launch_forever="true";
$data_list->launch_time = $launch_time;
$budget_schedule_data = new BudgetScheduleDataSiteVo;
$budget_schedule_data->activity_type="OFFICAL";
$main_activity = new TmcCampaignVo;
$main_activity->id="1";
$main_activity->name="活动期";
$main_activity->start_time="2023-07-05";
$main_activity->end_time="2023-07-14";
$budget_schedule_data->main_activity = $main_activity;
$budget_schedule_data->schedule_type="AUTO";
$activity_budget_list = new ActivityBudgetVo;
$activity_budget_list->id="1";
$activity_budget_list->name="活动期";
$activity_budget_list->start_time="2023-07-05";
$activity_budget_list->end_time="2023-07-14";
$activity_budget_list->activity_dmc="510";
$budget_schedule_data->activity_budget_list = $activity_budget_list;
$data_list->budget_schedule_data = $budget_schedule_data;
$data_list->is_budget_schedule_open="true";
$req->setDataList(json_encode($data_list));
$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.campaign.budget.batchupdate' \
-d 'partner_id=apidoc' \
-d 'session=a8ac1e2d-5394-4c7e-8e74-cc9163fd50d9' \
-d 'sign=ED7991D25DA893B477E9299A092475BC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A31%3A06' \
-d 'v=2.0' \
-d 'data_list=null' \
-d 'top_service_context=null'

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

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

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

XML示例
JSON示例

<universalbp_campaign_budget_batchupdate_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <campaign_budget_update_result_v_o_top_part_data>
            <count>1</count>
            <campaign_budget_update_result_v_o_list>
                <campaign_budget_update_result_vo>
                    <campaign_id>68796878069</campaign_id>
                </campaign_budget_update_result_vo>
            </campaign_budget_update_result_v_o_list>
            <error_count>1</error_count>
            <error_details>
                <top_fail_result>
                    <code>xxxxx</code>
                    <msg>xxxxx</msg>
                </top_fail_result>
            </error_details>
        </campaign_budget_update_result_v_o_top_part_data>
    </result>
</universalbp_campaign_budget_batchupdate_response>

{
    "universalbp_campaign_budget_batchupdate_response":{
        "result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "campaign_budget_update_result_v_o_top_part_data":{
                "count":1,
                "campaign_budget_update_result_v_o_list":{
                    "campaign_budget_update_result_vo":[
                        {
                            "campaign_id":68796878069
                        }
                    ]
                },
                "error_count":1,
                "error_details":{
                    "top_fail_result":[
                        {
                            "code":"xxxxx",
                            "msg":"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.campaign.budget.batchupdate (批量更新计划预算)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ