淘宝开放平台 - 文档中心

请求地址：

环境	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 可选 {} 扩展内容, 暂时无用
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 出价约束 └ constraint_value String 可选 3 出价约束值 └ promotion_type String 可选 item 主体类型 └ item_selected_mode String 可选 user_define 选品方式 adzone_list AdzoneRefCommandVO [] 可选资源位 └ adzone_id Number 可选 111287850198 资源包id └ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ discount Number 可选 3 资源位/包溢价 └ status String 可选 start 状态,start:投放,pause:暂停 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:否 word_list WordCommandVO [] 可选词 └ bidword_id Number 可选 1124844766581 关键词id,关键词已经存在场景必填 └ campaign_id Number 可选 68796878069 计划id,计划已经存在场景必填 └ adgroup_id Number 可选 68793666608 单元id,单元已经存在场景必填 └ word String 可选鞋原创小众词 └ bid_price String 可选 2.23 关键词基础出价 └ suggest_trace_id String 可选 xxxxx 关键词出价建议traceId └ online_status Number 可选 1 词包状态,1:在线,0:下线 └ match_scope Number 可选 4 匹配类型,1:精准匹配,4:广泛匹配 └ search_upgrade_pxb Number 可选 0 搜索升级 └ need_target_crowd Number 可选 1 有无目标人群 └ algo_prediction_extra_info String 可选 {} 指标扩展信息 └ item_rec_strategy String [] 可选 ["effect_gmv","effect_coll"] 选品方向 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 物料地址 goal_life_cycle_list ItemLifeCycleViewVO [] 可选 [{color: "#FFA53D", bizCode: null, lifeCycleDesc: "冷启期", type: 1, tips: "近30日GMV排名在叶子类目55%以下的新品"}] 货品序列化越迁目标 └ life_cycle_desc String 可选新品打爆期周期文案 └ color String 可选 #36A2FC 文案颜色 └ tips String 可选近30日GMV排名在叶子类目5%以内的新品周期提示文案 └ type Number 可选 1 生命周期类型 └ dmc_type_element String 可选 dayBudget 组件类型

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 effect_predict_v_o EffectPredictVO 结果集 └ pv Number 1621 展现量 └ pv_low Number 1297 展现量下限 └ pv_high Number 1945 展现量上限 └ click Number 97 点击量 └ click_low Number 78 点击量下限 └ click_high Number 117 点击量上限 └ conv Number 13 成交量 └ conv_low Number 10 成交量下限 └ conv_high Number 15 成交量上限 └ wconv Number 27 弱转化量 └ wconv_low Number 22 弱转化量下限 └ wconv_high Number 33 弱转化量上限 └ mem Number 0 入会量 └ mem_low Number 0 入会量下限 └ mem_high Number 1 入会量上限 └ cost String 823.83 消耗，单位元 └ cost_low String 659.06 消耗下限，单位元 └ cost_high String 988.60 消耗下限，单位元 └ cart Number 10 加购 └ cart_low Number 5 加购下限 └ cart_high Number 15 加购上限 └ uv_aim_low Number 5 预估目标uv数下限 └ uv_aim_high Number 15 预估目标uv数上限 └ gmv String 6845.21 预估成交额元 └ gmv_low String 5476.17 预估成交额下限元 └ gmv_high String 8214.26 预估成交额上限元 └ success_ratio_high String 0.9 抢位成功率上限 └ success_ratio_low String 0.8 抢位成功率下限 └ gmv_diff_percent String 0.67 gmv差异百分比

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewAlgoGeteffectpredictionRequest req = new UniversalbpNewAlgoGeteffectpredictionRequest();
UniversalbpNewAlgoGeteffectpredictionRequest.TopServiceContext obj1 = new UniversalbpNewAlgoGeteffectpredictionRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoQueryVO obj2 = new UniversalbpNewAlgoGeteffectpredictionRequest.AlgoQueryVO();
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoCampaignQueryVO obj3 = new UniversalbpNewAlgoGeteffectpredictionRequest.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.setConstraintValue("3");
obj3.setPromotionType("item");
obj3.setItemSelectedMode("user_define");
List<UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVO> list5 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVO obj6 = new UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVO();
list5.add(obj6);
obj6.setAdzoneId(111287850198L);
obj6.setCampaignId(68796878069L);
obj6.setDiscount(3L);
obj6.setStatus("start");
obj3.setAdzoneList(list5);
List<UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVO> list8 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVO obj9 = new UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVO();
list8.add(obj9);
obj9.setDayOfWeek(1L);
List<UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVO> list12 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVO obj13 = new UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVO();
list12.add(obj13);
obj13.setDiscount(100L);
obj13.setTime("00:00-24:00");
list10.setTimeSpanList(list12);
obj3.setLaunchPeriodList(list8);
obj3.setLaunchAreaStrList(""all"");
UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchTimeCommandVO obj14 = new UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchTimeCommandVO();
obj14.setStartTime(StringUtils.parseDateTime("2023-06-09 00:00:00"));
obj14.setEndTime(StringUtils.parseDateTime("2199-02-01 00:00:00"));
obj14.setLaunchForever(true);
obj3.setLaunchTime(obj14);
List<UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVO> list16 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVO obj17 = new UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVO();
list16.add(obj17);
obj17.setBidwordId(1124844766581L);
obj17.setCampaignId(68796878069L);
obj17.setAdgroupId(68793666608L);
obj17.setWord("鞋原创小众");
obj17.setBidPrice("2.23");
obj17.setSuggestTraceId("xxxxx");
obj17.setOnlineStatus(1L);
obj17.setMatchScope(4L);
obj3.setWordList(list16);
obj3.setSearchUpgradePxb(0L);
obj3.setNeedTargetCrowd(1L);
obj3.setAlgoPredictionExtraInfo("{}");
obj3.setItemRecStrategy(""effect_gmv","effect_coll"");
obj2.setCampaign(obj3);
List<UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVO> list19 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVO obj20 = new UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVO();
list19.add(obj20);
UniversalbpNewAlgoGeteffectpredictionRequest.AdgroupMaterialCommandVO obj22 = new UniversalbpNewAlgoGeteffectpredictionRequest.AdgroupMaterialCommandVO();
obj22.setMaterialId(714616513841L);
obj22.setMaterialName("yiliantest测试请不要拍22");
obj22.setPromotionType("item");
obj22.setSubPromotionType("item");
obj22.setLinkUrl("http://shop191070507.taobao.com/index.htm");
List<UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVO> list24 = new ArrayList<UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVO>();
UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVO obj25 = new UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVO();
list24.add(obj25);
obj25.setLifeCycleDesc("新品打爆期");
obj25.setColor("#36A2FC");
obj25.setTips("近30日GMV排名在叶子类目5%以内的新品");
obj25.setType(1L);
obj22.setGoalLifeCycleList(list24);
list21.setMaterial(obj22);
obj2.setAdgroupList(list19);
obj2.setDmcTypeElement("dayBudget");
req.setAlgoQueryVO(obj2);
UniversalbpNewAlgoGeteffectpredictionResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewAlgoGeteffectpredictionRequest req = new UniversalbpNewAlgoGeteffectpredictionRequest();
UniversalbpNewAlgoGeteffectpredictionRequest.TopServiceContextDomain obj1 = new UniversalbpNewAlgoGeteffectpredictionRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoQueryVODomain obj2 = new UniversalbpNewAlgoGeteffectpredictionRequest.AlgoQueryVODomain();
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoCampaignQueryVODomain obj3 = new UniversalbpNewAlgoGeteffectpredictionRequest.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.ConstraintValue = "3";
obj3.PromotionType = "item";
obj3.ItemSelectedMode = "user_define";
List<UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVODomain> list5 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVODomain obj6 = new UniversalbpNewAlgoGeteffectpredictionRequest.AdzoneRefCommandVODomain();
list5.Add(obj6);
obj6.AdzoneId = 111287850198L;
obj6.CampaignId = 68796878069L;
obj6.Discount = 3L;
obj6.Status = "start";
obj3.AdzoneList= list5;
List<UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVODomain> list8 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVODomain obj9 = new UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchPeriodCommandVODomain();
list8.Add(obj9);
obj9.DayOfWeek = 1L;
List<UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVODomain> list11 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVODomain obj12 = new UniversalbpNewAlgoGeteffectpredictionRequest.TimeSpanVODomain();
list11.Add(obj12);
obj12.Discount = 100L;
obj12.Time = "00:00-24:00";
obj9.TimeSpanList= list11;
obj3.LaunchPeriodList= list8;
obj3.LaunchAreaStrList = ""all"";
UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchTimeCommandVODomain obj13 = new UniversalbpNewAlgoGeteffectpredictionRequest.CampaignLaunchTimeCommandVODomain();
obj13.StartTime = DateTime.Parse(2023-06-09 00:00:00");
obj13.EndTime = DateTime.Parse(2199-02-01 00:00:00");
obj13.LaunchForever = true;
obj3.LaunchTime= obj13;
List<UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVODomain> list15 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVODomain obj16 = new UniversalbpNewAlgoGeteffectpredictionRequest.WordCommandVODomain();
list15.Add(obj16);
obj16.BidwordId = 1124844766581L;
obj16.CampaignId = 68796878069L;
obj16.AdgroupId = 68793666608L;
obj16.Word = "鞋原创小众";
obj16.BidPrice = "2.23";
obj16.SuggestTraceId = "xxxxx";
obj16.OnlineStatus = 1L;
obj16.MatchScope = 4L;
obj3.WordList= list15;
obj3.SearchUpgradePxb = 0L;
obj3.NeedTargetCrowd = 1L;
obj3.AlgoPredictionExtraInfo = "{}";
obj3.ItemRecStrategy = ""effect_gmv","effect_coll"";
obj2.Campaign= obj3;
List<UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVODomain> list18 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVODomain obj19 = new UniversalbpNewAlgoGeteffectpredictionRequest.AlgoAdgroupQueryVODomain();
list18.Add(obj19);
UniversalbpNewAlgoGeteffectpredictionRequest.AdgroupMaterialCommandVODomain obj20 = new UniversalbpNewAlgoGeteffectpredictionRequest.AdgroupMaterialCommandVODomain();
obj20.MaterialId = 714616513841L;
obj20.MaterialName = "yiliantest测试请不要拍22";
obj20.PromotionType = "item";
obj20.SubPromotionType = "item";
obj20.LinkUrl = "http://shop191070507.taobao.com/index.htm";
List<UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVODomain> list22 = new List<UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVODomain>();
UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVODomain obj23 = new UniversalbpNewAlgoGeteffectpredictionRequest.ItemLifeCycleViewVODomain();
list22.Add(obj23);
obj23.LifeCycleDesc = "新品打爆期";
obj23.Color = "#36A2FC";
obj23.Tips = "近30日GMV排名在叶子类目5%以内的新品";
obj23.Type = 1L;
obj20.GoalLifeCycleList= list22;
obj19.Material= obj20;
obj2.AdgroupList= list18;
obj2.DmcTypeElement = "dayBudget";
req.AlgoQueryVO_ = obj2;
UniversalbpNewAlgoGeteffectpredictionResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewAlgoGeteffectpredictionRequest;
$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));
$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->constraint_value="3";
$campaign->promotion_type="item";
$campaign->item_selected_mode="user_define";
$adzone_list = new AdzoneRefCommandVO;
$adzone_list->adzone_id="111287850198";
$adzone_list->campaign_id="68796878069";
$adzone_list->discount="3";
$adzone_list->status="start";
$campaign->adzone_list = $adzone_list;
$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;
$word_list = new WordCommandVO;
$word_list->bidword_id="1124844766581";
$word_list->campaign_id="68796878069";
$word_list->adgroup_id="68793666608";
$word_list->word="鞋原创小众";
$word_list->bid_price="2.23";
$word_list->suggest_trace_id="xxxxx";
$word_list->online_status="1";
$word_list->match_scope="4";
$campaign->word_list = $word_list;
$campaign->search_upgrade_pxb="0";
$campaign->need_target_crowd="1";
$campaign->algo_prediction_extra_info="{}";
$campaign->item_rec_strategy="[\"effect_gmv\",\"effect_coll\"]";
$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";
$goal_life_cycle_list = new ItemLifeCycleViewVO;
$goal_life_cycle_list->life_cycle_desc="新品打爆期";
$goal_life_cycle_list->color="#36A2FC";
$goal_life_cycle_list->tips="近30日GMV排名在叶子类目5%以内的新品";
$goal_life_cycle_list->type="1";
$material->goal_life_cycle_list = $goal_life_cycle_list;
$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);

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.algo.geteffectprediction' \
-d 'partner_id=apidoc' \
-d 'session=d68ad061-cff1-4ea7-b5ce-7fe5f58b4a78' \
-d 'sign=8F0C4C19D5C1A6FCD52EE1782766813F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A31%3A09' \
-d 'v=2.0' \
-d 'algo_query_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

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

XML示例
JSON示例

<universalbp_new_algo_geteffectprediction_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <effect_predict_v_o>
            <pv>1621</pv>
            <pv_low>1297</pv_low>
            <pv_high>1945</pv_high>
            <click>97</click>
            <click_low>78</click_low>
            <click_high>117</click_high>
            <conv>13</conv>
            <conv_low>10</conv_low>
            <conv_high>15</conv_high>
            <wconv>27</wconv>
            <wconv_low>22</wconv_low>
            <wconv_high>33</wconv_high>
            <mem>0</mem>
            <mem_low>0</mem_low>
            <mem_high>1</mem_high>
            <cost>823.83</cost>
            <cost_low>659.06</cost_low>
            <cost_high>988.60</cost_high>
            <cart>10</cart>
            <cart_low>5</cart_low>
            <cart_high>15</cart_high>
            <uv_aim_low>5</uv_aim_low>
            <uv_aim_high>15</uv_aim_high>
            <gmv>6845.21</gmv>
            <gmv_low>5476.17</gmv_low>
            <gmv_high>8214.26</gmv_high>
            <success_ratio_high>0.9</success_ratio_high>
            <success_ratio_low>0.8</success_ratio_low>
            <gmv_diff_percent>0.67</gmv_diff_percent>
        </effect_predict_v_o>
    </top_result>
</universalbp_new_algo_geteffectprediction_response>

{
    "universalbp_new_algo_geteffectprediction_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "effect_predict_v_o":{
                "pv":1621,
                "pv_low":1297,
                "pv_high":1945,
                "click":97,
                "click_low":78,
                "click_high":117,
                "conv":13,
                "conv_low":10,
                "conv_high":15,
                "wconv":27,
                "wconv_low":22,
                "wconv_high":33,
                "mem":0,
                "mem_low":0,
                "mem_high":1,
                "cost":"823.83",
                "cost_low":"659.06",
                "cost_high":"988.60",
                "cart":10,
                "cart_low":5,
                "cart_high":15,
                "uv_aim_low":5,
                "uv_aim_high":15,
                "gmv":"6845.21",
                "gmv_low":"5476.17",
                "gmv_high":"8214.26",
                "success_ratio_high":"0.9",
                "success_ratio_low":"0.8",
                "gmv_diff_percent":"0.67"
            }
        }
    }
}

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.algo.geteffectprediction (成效预估)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ