淘宝开放平台 - 文档中心

请求地址：

环境	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业务线编码
algo_query_v_o	AlgoQueryVo	必须	algoQueryVO
campaign AlgoCampaignQueryVo 可选计划维度算法请求参数 └ campaign_id Number 可选 68799007001 计划id └ promotion_model String 可选 display 推广类型 └ promotion_scene String 可选 promotion_scene_crowd 推广场景 └ promotion_goals String 可选 shop_crowd 推广目标 └ optimize_target String 可选 shop_visit_new 优化目标 └ dmc_type String 可选 normal 预算类型 └ day_budget Number 可选 60 日预算 └ total_budget Number 可选 350 周预算 └ budget_period Number 可选 1 周期 └ bid_type String 可选 roi_control 出价方式 └ constraint_type String 可选 roi 出价约束 └ promotion_type String 可选 item 主体类型 └ item_selected_mode String 可选 user_define 选品方式 launch_period_list CampaignLaunchPeriodCommandVo [] 可选投放折扣时段设置 └ day_of_week Number 可选 1 本周的第x天 time_span_list TimeSpanVo [] 可选第x天各时段的折扣情况 └ discount Number 可选 100 折扣 └ time String 可选 00:00-24:00 折扣时间段 └ launch_area_str_list String [] 可选 ["all"] 投放地域 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:否 adgroup_list AlgoAdgroupQueryVo [] 可选单元维度算法请求参数 material AdgroupMaterialCommandVo 可选主体类型对应的物料信息 └ material_id Number 可选 714616513841 物料id └ material_name String 可选 yiliantest测试请不要拍22 物料名称 └ promotion_type String 可选 item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ sub_promotion_type String 可选 item 推广子主体类型,item:商品，item_private_mini:独享橱窗，shop:店铺，you_hao_huo:有好货，picture:图文，short_video:短视频，live_room:直播间，live_spot:看点，tao_blocks:淘积木，user_define_url:自定义url └ link_url String 可选 http://shop191070507.taobao.com/index.htm 物料地址 └ dmc_type_element String 可选 dayBudget 组件类型

名称	类型	示例值	描述
result	TopResult		结果体
info TopInfo 请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 budget_suggest_v_o BudgetSuggestVo 结果集 └ budget_left Number 200 预算左值 └ budget_middle Number 220 预算中值 └ budget_right Number 260 预算右值 └ budget_upper Number 260 预算上限(元) └ budget_lower Number 200 预算下限(元) └ algo_budget Number 220 直接销量达成：给出的预算 └ reason String 根据同类目投放情况，建议每日预算不低于<span class='font-number bold color-3'>200</span>元算法建议文案 └ budget_default Number 200 默认预算 └ budget_min Number 100 默认最低值

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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpAlgoGetbudgetsuggestionRequest req = new UniversalbpAlgoGetbudgetsuggestionRequest();
UniversalbpAlgoGetbudgetsuggestionRequest.TopServiceContext obj1 = new UniversalbpAlgoGetbudgetsuggestionRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoQueryVo obj2 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoQueryVo();
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoCampaignQueryVo obj3 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoCampaignQueryVo();
obj3.setCampaignId(68799007001L);
obj3.setPromotionModel("display");
obj3.setPromotionScene("promotion_scene_crowd");
obj3.setPromotionGoals("shop_crowd");
obj3.setOptimizeTarget("shop_visit_new");
obj3.setDmcType("normal");
obj3.setDayBudget(60L);
obj3.setTotalBudget(350L);
obj3.setBudgetPeriod(1L);
obj3.setBidType("roi_control");
obj3.setConstraintType("roi");
obj3.setPromotionType("item");
obj3.setItemSelectedMode("user_define");
List<UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVo> list5 = new ArrayList<UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVo>();
UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVo obj6 = new UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVo();
list5.add(obj6);
obj6.setDayOfWeek(1L);
List<UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVo> list9 = new ArrayList<UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVo>();
UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVo obj10 = new UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVo();
list9.add(obj10);
obj10.setDiscount(100L);
obj10.setTime("00:00-24:00");
list7.setTimeSpanList(list9);
obj3.setLaunchPeriodList(list5);
obj3.setLaunchAreaStrList(""all"");
UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchTimeCommandVo obj11 = new UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchTimeCommandVo();
obj11.setStartTime(StringUtils.parseDateTime("2023-06-09 00:00:00"));
obj11.setEndTime(StringUtils.parseDateTime("2199-02-01 00:00:00"));
obj11.setLaunchForever(true);
obj3.setLaunchTime(obj11);
obj2.setCampaign(obj3);
List<UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVo> list13 = new ArrayList<UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVo>();
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVo obj14 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVo();
list13.add(obj14);
UniversalbpAlgoGetbudgetsuggestionRequest.AdgroupMaterialCommandVo obj16 = new UniversalbpAlgoGetbudgetsuggestionRequest.AdgroupMaterialCommandVo();
obj16.setMaterialId(714616513841L);
obj16.setMaterialName("yiliantest测试请不要拍22");
obj16.setPromotionType("item");
obj16.setSubPromotionType("item");
obj16.setLinkUrl("http://shop191070507.taobao.com/index.htm");
list15.setMaterial(obj16);
obj2.setAdgroupList(list13);
obj2.setDmcTypeElement("dayBudget");
req.setAlgoQueryVO(obj2);
UniversalbpAlgoGetbudgetsuggestionResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpAlgoGetbudgetsuggestionRequest req = new UniversalbpAlgoGetbudgetsuggestionRequest();
UniversalbpAlgoGetbudgetsuggestionRequest.TopServiceContextDomain obj1 = new UniversalbpAlgoGetbudgetsuggestionRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
req.TopServiceContext_ = obj1;
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoQueryVoDomain obj2 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoQueryVoDomain();
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoCampaignQueryVoDomain obj3 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoCampaignQueryVoDomain();
obj3.CampaignId = 68799007001L;
obj3.PromotionModel = "display";
obj3.PromotionScene = "promotion_scene_crowd";
obj3.PromotionGoals = "shop_crowd";
obj3.OptimizeTarget = "shop_visit_new";
obj3.DmcType = "normal";
obj3.DayBudget = 60L;
obj3.TotalBudget = 350L;
obj3.BudgetPeriod = 1L;
obj3.BidType = "roi_control";
obj3.ConstraintType = "roi";
obj3.PromotionType = "item";
obj3.ItemSelectedMode = "user_define";
List<UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVoDomain> list5 = new List<UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVoDomain>();
UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVoDomain obj6 = new UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchPeriodCommandVoDomain();
list5.Add(obj6);
obj6.DayOfWeek = 1L;
List<UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVoDomain> list8 = new List<UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVoDomain>();
UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVoDomain obj9 = new UniversalbpAlgoGetbudgetsuggestionRequest.TimeSpanVoDomain();
list8.Add(obj9);
obj9.Discount = 100L;
obj9.Time = "00:00-24:00";
obj6.TimeSpanList= list8;
obj3.LaunchPeriodList= list5;
obj3.LaunchAreaStrList = ""all"";
UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchTimeCommandVoDomain obj10 = new UniversalbpAlgoGetbudgetsuggestionRequest.CampaignLaunchTimeCommandVoDomain();
obj10.StartTime = DateTime.Parse(2023-06-09 00:00:00");
obj10.EndTime = DateTime.Parse(2199-02-01 00:00:00");
obj10.LaunchForever = true;
obj3.LaunchTime= obj10;
obj2.Campaign= obj3;
List<UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVoDomain> list12 = new List<UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVoDomain>();
UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVoDomain obj13 = new UniversalbpAlgoGetbudgetsuggestionRequest.AlgoAdgroupQueryVoDomain();
list12.Add(obj13);
UniversalbpAlgoGetbudgetsuggestionRequest.AdgroupMaterialCommandVoDomain obj14 = new UniversalbpAlgoGetbudgetsuggestionRequest.AdgroupMaterialCommandVoDomain();
obj14.MaterialId = 714616513841L;
obj14.MaterialName = "yiliantest测试请不要拍22";
obj14.PromotionType = "item";
obj14.SubPromotionType = "item";
obj14.LinkUrl = "http://shop191070507.taobao.com/index.htm";
obj13.Material= obj14;
obj2.AdgroupList= list12;
obj2.DmcTypeElement = "dayBudget";
req.AlgoQueryVO_ = obj2;
UniversalbpAlgoGetbudgetsuggestionResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpAlgoGetbudgetsuggestionRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$req->setTopServiceContext(json_encode($top_service_context));
$algo_query_v_o = new AlgoQueryVo;
$campaign = new AlgoCampaignQueryVo;
$campaign->campaign_id="68799007001";
$campaign->promotion_model="display";
$campaign->promotion_scene="promotion_scene_crowd";
$campaign->promotion_goals="shop_crowd";
$campaign->optimize_target="shop_visit_new";
$campaign->dmc_type="normal";
$campaign->day_budget="60";
$campaign->total_budget="350";
$campaign->budget_period="1";
$campaign->bid_type="roi_control";
$campaign->constraint_type="roi";
$campaign->promotion_type="item";
$campaign->item_selected_mode="user_define";
$launch_period_list = new CampaignLaunchPeriodCommandVo;
$launch_period_list->day_of_week="1";
$time_span_list = new TimeSpanVo;
$time_span_list->discount="100";
$time_span_list->time="00:00-24:00";
$launch_period_list->time_span_list = $time_span_list;
$campaign->launch_period_list = $launch_period_list;
$campaign->launch_area_str_list="[\"all\"]";
$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";
$campaign->launch_time = $launch_time;
$algo_query_v_o->campaign = $campaign;
$adgroup_list = new AlgoAdgroupQueryVo;
$material = new AdgroupMaterialCommandVo;
$material->material_id="714616513841";
$material->material_name="yiliantest测试请不要拍22";
$material->promotion_type="item";
$material->sub_promotion_type="item";
$material->link_url="http://shop191070507.taobao.com/index.htm";
$adgroup_list->material = $material;
$algo_query_v_o->adgroup_list = $adgroup_list;
$algo_query_v_o->dmc_type_element="dayBudget";
$req->setAlgoQueryVO(json_encode($algo_query_v_o));
$resp = $c->execute($req, $sessionKey);

XML示例
JSON示例

<universalbp_algo_getbudgetsuggestion_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <budget_suggest_v_o>
            <budget_left>200</budget_left>
            <budget_middle>220</budget_middle>
            <budget_right>260</budget_right>
            <budget_upper>260</budget_upper>
            <budget_lower>200</budget_lower>
            <algo_budget>220</algo_budget>
            <reason>根据同类目投放情况，建议每日预算不低于&lt;span class=&apos;font-number bold color-3&apos;&gt;200&lt;/span&gt;元</reason>
            <budget_default>200</budget_default>
            <budget_min>100</budget_min>
        </budget_suggest_v_o>
    </result>
</universalbp_algo_getbudgetsuggestion_response>

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>

错误码	错误描述	解决方案

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

开放平台

万相台无界API

taobao.universalbp.algo.getbudgetsuggestion (预算预估)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ