淘宝开放平台

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

万相台无界API

taobao.universalbp.new.algo.geteffectprediction (成效预估)

成效预估

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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());

响应示例

  • XML示例
  • JSON示例
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
<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>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

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

如何获得此API

FAQ

我要提问
返回
顶部