淘宝开放平台

请求地址：

环境	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 可选 {} 扩展内容, 暂时无用
campaign_query_v_o	CampaignQueryVO	必须	campaignQueryVO
└ status_list String [] 可选 [ "start", "pause" ] 筛选项-主体类型 └ promotion_scene_list String [] 可选 ["promotion_scene_crowd"] 计划类型 └ need_target_crowd_list String [] 可选 ["smartCrowd"] 有无目标人群筛选 └ origin_secondary_scene_list String [] 可选 ["promotion_scene_item"] 原二级场景筛选 └ promotion_type_list String [] 可选 [ "item", "shop" ] 筛选项-主体类型 └ bid_type_list String [] 可选 ["roi_control"] 出价方式 └ optimize_target_list String [] 可选 ["click"] 优化目标 └ campaign_name_like String 可选计划名称计划名称 └ campaign_id Number 可选 68796878069 计划id └ campaign_id_list Number [] 可选 [68796878069] 计划id集合 └ item_id Number 可选 752793518760 宝贝id └ adgroup_required Boolean 可选 false 是否需要查询单元 └ offset Number 可选 10 偏移量 └ page_size Number 可选 10 页面大小

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 top_campaign_v_o TopCampaignVO 结果集 campaign CampaignVO 计划实体 └ campaign_biz_code String onebpDisplay 业务身份,枚举信息同'account.get.can.use.bizcode'服务返回结果 └ campaign_group_id Number 25696724 计划组id └ campaign_group_name String 测试计划组名称 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ campaign_name String 管家计划_宝贝候选集计划名称 └ promotion_scene String promotion_scene_crowd 推广场景,promotion_scene_crowd:人群方舟,promotion_scene_item:店铺宝贝运营,promotion_scene_traffic:宝藏场景,AD_STRATEGY_LAXIN:策略中心拉新场景,AD_STRATEGY_SHANGXINLI:策略中心上新礼场景,AD_STRATEGY_FRESH_BOX:策略中心小黑盒场景,AD_STRATEGY_LAXIN_XINXIANG:策略中心拉新新享一笔钱场景,AD_STRATEGY_RUHUI_NEW:策略中心入会快新会员场景,AD_STRATEGY_RUHUI_OLD:策略中心入会快老会员场景,AD_STRATEGY_LIUZI:策略中心留资快场景,AD_STRATEGY_YURE:策略中心活动加速场景,AD_STRATEGY_HUODONG_ESCORT:活动全周期护航计划,AD_STRATEGY_CROWD_INDUSTRY:策略中心行业人群通,AD_STRATEGY_WHOLE_SHOP_SMART:策略中心全店放心推-智能托管,AD_STRATEGY_WHOLE_SHOP_CUSTOM:策略中心全店放心推-自定义,AD_STRATEGY_EVEN_BUDGET:策略中心均匀曝光场景,AD_STRATEGY_SXK_GUARANTEE:万相台上新快确定性保障,AD_STRATEGY_HPJS_GUARANTEE:万相台货品加速确定性保障,AD_STRATEGY_HPJS_TIME_LIMIT:万相台货品加速限时加速,AD_STRATEGY_FANS_HEADLINES:万相台粉丝头条,WXT_AGENCY_XST_CPC:服务商版一键起量（CPC）,WXT_AGENCY_XST_CPA:服务商版客源多（CPA）,WXT_AGENCY_SHEQUN:服务商版社群（CPA+CPS） └ market_scene String wxt_live_max_view :最大化拿量营销场景 └ promotion_goals String traffic_nd 推广目标,shop_item:全店宝贝推广,new_item_speed_car:新品飞车,shop_crowd:店铺人群运营,brand_crowd:品牌人群运营,traffic_shoujiao:淘系焦点图,traffic_nd:全屏微详情 └ promotion_model String daily:持续推广,order:套餐包推广类型 └ promotion_type String item 推广主体类型,item:商品,item_private_mini:独享橱窗,shop:店铺,content:内容,short_video:短视频,user_define:自定义; └ promotion_type_list String [] ["item"] 主体类型，支持一个计划下存在多种类型 └ spot_continue Number 10 看点是否续投 └ 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 └ sub_promotion_type_list String [] ["item"] 子主体类型，支持一个计划下存在多种类型 └ optimize_target String conv 优化目标，conv:促进成交,coll_cart:促进加购,click:促进点击,deal_count:促进成交笔数,exposure_pv:促进曝光,mini_view:促进橱窗宝贝浏览个数,mini_interactive:促进橱窗宝贝互动,ad_strategy_wangwang:策略中心旺旺咨询,shop_potential:提升潜客人数,shop_interest_new:提升兴趣新客人数,shop_purchase_new:提升首购新客人数,shop_visit_new:提升访问新客人数,shop_repurchase:提升复购人数,high_cvr:提升高转换人群成交人数,deeplink_d:提升品牌发现人数-D,deeplink_e1:提升品牌种草人数-E,deeplink_e2:提升品牌互动人数-E,deeplink_p:提升品牌行动人数-P,deeplink_i:提升品牌首购人数-I,deeplink_n:提升品牌复购人数-N,deeplink_k:提升品牌挚爱人数-K,hf_grass_plant:预热种草,hf_impoundment:预售蓄水,hf_harvest:爆发收割,nd_click:提高互动量,nd_cart:提高加购量,nd_deal:提高成交量,ad_strategy_ruhui_count:策略中心入会快新会员场景入会量目标,ad_strategy_lzl:策略中心留资快留资量目标,ad_strategy_try:策略中心派样量,ad_strategy_view:策略中心优化展现,ad_strategy_auto_trans:策略中心自动流转,ad_strategy_trial_order:策略中心表单获客成本,ad_strategy_liuzi_cost:策略中心广义留资目标,ad_strategy_cool_start:策略中心自动冷启动,ad_strategy_cool_start_mini_aim:策略中心冷启动分阶段目标流转,wxt_agency_ai:A转I人群流转,wxt_agency_smart:自定义场景,form_submit:表单提交,trial_order:试用下单,wangwang_liuzi:旺旺留资 └ online_status Number 0 投放状态,-1:未进入投放状态,0:用户设置状态-下线,1:用户设置状态-上线,2:合同未生效,9:投放结束,105:待支付 └ display_status String pause 前端展示状态,pause:暂停推广,start:正在推广,terminate:结束推广,wait:等待推广,pending:准备推广,wait_pay:计划未付款 └ top_status Boolean true 置顶状态,true:置顶，false:不置顶 └ top_time Date 2023-06-12 12:00:00 置顶时间 └ dmc_type String normal 预算类型,normal:日预算,total:总预算,cycle:活动周期预算,day_freeze:日预算冻结,unlimit:不限预算 └ day_budget String 100 日预算金额 └ smooth_option String smooth 日预算投放方式, quick:天内尽快,smooth:天内平滑 └ total_budget String 100 周期预算金额 └ budget_period Number 7 周期预算周期天数 └ period_smooth String smooth 周期预算投放方式, quick:天内尽快,smooth:天内平滑 └ bid_type String max_amount 出价方式,custom_bid:手动出价,max_amount:最大化拿量,cost_control:控成本,roi_control:控投产比 campaign_ocpc CampaignOcpcVO ocpc出价 └ enable_ocpc String 1 OCPC是否开启，0:否，1:是 └ ocpc_ratio Number 200 OCPC溢价比例 └ max_price String 0.4 手动出价时，最大金额 └ min_price String 0.25 手动出价时，最小金额 └ bid_unit String 元/次点击出价单位 └ constraint_type String 元/次点击出价约束类型,non:无约束,click:点击成本,coll_cart:收藏加购成本(非场景推广),cart:收藏加购成本(场景推广),conv:成交成本(非场景推广),deal:成交成本(场景推广),dir_conv:直接成交成本,roi:投产比约束 └ constraint_value String 3 出价约束值 └ cold_boot Number 1 冷启动标识，0:否，1:是 └ cold_boot_time Date 2023-06-11 23:56:23 冷启动时间 └ cold_boot_stage String mature 当前计划冷启动阶段，cold:冷启动期,mature:成熟期,acc_fail:冷启动失败,acc_success:冷启动成功,accelerate:加速中 └ speed_type String xxxxx 投放速度 quick 尽快投放 smooth 均匀投放 smart 智能投放 └ launch_period_discount String 100% 分时折扣比例（取当前时刻对应的实际折扣，格式：80%） └ launch_period_display_time String 15:00-15:30 分时折扣展示时段（取当前时刻对应的半小时区间，格式：09:00-09:30） └ launch_period_type String xxxxx 时段折扣类型,allTimeDiscount:不限时段,exposureTime:固定时长,timeDiscount:固定时段,只有超级直播场景能使用该字段 launch_time CampaignLaunchTimeVO 计划投放时间 └ start_time Date 2023-06-09 00:00:00 计划开始时间 └ end_time Date 2199-02-01 00:00:00 计划结束时间 └ launch_forever Boolean true 是否长期投放,true:是,false:否 └ renewal_first_order_start_time Date 2023-06-09 00:00:00 计划开始时间 └ renewal_first_order_end_time Date 2199-02-01 00:00:00 计划结束时间 └ launch_area_str_list String [] ["1","19"] 或者 ["all"] 地域码 launch_period_list LaunchPeriodVO [] 投放折扣时段设置 └ day_of_week Number 1 本周的第x天 time_span_list TimeSpanQueryResVO [] 第x天各时段的折扣情况 └ time String 00:00-24:00 折扣时间段 └ discount Number 100 折扣 crowd_filter_list CampaignCrowdFilterVO [] 人群过滤 └ behavior String shop_crowd 行为,purchase:购买人群,cart:加购人群,collection:收藏人群,arrival:进店人群 └ window String 7 时间窗口,7:7天,15:15天,30:30天,90:90天,180:180天,365:365天 brand_filter_list CampaignBrandFilterVO [] 品牌过滤 └ brand_id String 20067 品牌id └ deeplink_list String [] ["Engage"] deeplink维度过滤,Discover:Discover 发现,Engage:Engage 种草,Enthuse:Enthuse 互动,Perform:Perform 行动,Initial:Initial 首购,Numerous:Numerous 复购,Keen:Keen 至爱 deeplink_brand_list DeeplinkBrandVO [] 品牌正向过滤 └ deeplink_brand_id String 20067 品牌id └ deeplink_brand_name String Lancome/兰蔻品牌名字 gender_age_filter_list CampaignGenderAgeFilterVO [] 性别年龄过滤 └ gender String man 性别,man:男性人群,woman:女性人群 └ age_list String [] [0, 1, 2, 3, 4, 5, 6] 年龄段,0:18岁以下,1:18-24岁,2:25-29岁,3:30-34岁,4:35-39岁,5:40-49岁,6:50岁以上 mini_detail CampaignMiniDetailCommandVO 橱窗相关 └ mini_detail_theme String 1 橱窗主题,1:默认主题,7:品牌定制主题,4:店铺主题,5:拉新主题,2:新品主题 └ private_mini_item_id_list Number [] [714707465203, 714901906337] 橱窗宝贝id列表 └ private_mini_top_item_id_list Number [] [714707465203] 橱窗宝贝里面置顶的id列表 └ private_mini_type Number 1 手动选宝贝还是智能,0:黑名单,1:白名单 └ item_selected_mode String shop 选品方式,shop:全店优选,user_define:用户自定义选品,scope:范围圈选,trend:趋势选品 └ shop_item_type String effect 优选集合,effect:效果优选,growing:全店成长,activity:活动选品,industry:行业尖货,scope:定义选品 └ shield_items Number [] [714707465203, 714901906337] 自动化选品时屏蔽宝贝 └ scope_items Number [] [714707465203, 714901906337] 宝贝优选里面的指定宝贝 adgroup_list AdgroupVO [] 单元实体 └ gmt_create Date 2023-12-09 14:34:12 创建时间 └ gmt_modified Date 2023-12-09 14:34:12 修改时间 └ campaign_id Number 68796878069 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景 └ campaign_name String 管家计划_宝贝候选集计划名称 └ adgroup_id Number 68793666608 单元id └ adgroup_name String ds460418344 单元名称 └ online_status Number 0 投放状态,-1:未进入投放状态,0:用户设置状态-下线,1:用户设置状态-上线,2:合同未生效,9:投放结束,105:待支付 └ display_status String pause 前端展示状态,pause:暂停推广,start:正在推广,terminate:结束推广,wait:等待推广,pending:准备推广,wait_pay:计划未付款 └ audit_status Number 1 风控审核状态,-1:待审核,0:后台下线状态,1:后台上线状态 └ audit_reason String xxxxx 审核拒绝原因 adgroup_ocpc AdgroupOcpcVO 单元智能出价信息 └ enable_ocpc Boolean true OCPC是否开启，false:否，true:是 └ ocpc_ratio Number 200 OCPC溢价比例 └ ocpc_marketing_aim String click OCPC目标选项 └ ocpc_status String new_ad_complete 当前状态,new_ad_openable:可开启新广告加速,new_item_openable:可开启新品冷启动,new_ad_speeding:新广告加速中,new_item_speeding:新品冷启动加速中,new_ad_complete:新广告加速完成,new_item_complete:新品冷启动加速完成 └ enable_cold_speed_new_item Boolean false 是否开启新品创意，true:是，false:否 └ ecpc_option Number 1 ecpc开关 └ 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 material CommonMaterialVO 通用主体VO 主体类型对应的物料信息 └ material_id Number 714616513841 物料id └ material_type Number 1 物料类型,1:淘宝宝贝,2:淘宝店铺,3:cms LandingPage页面,4:cms 分流总页面,5:自定义,201:PC店铺LandingPage页面,202:无线店铺LandingPage页面,203:内容LandingPage页面,204:淘宝直播,210:淘宝直播用户ID,205:有好货,209:无线店铺Tab3页面,212:超级品牌日LandingPage页面,211:超级发布会LandingPage页面,301:ICBU商品,302:ICBU PC店铺LandingPage页面,303:ICBU PC店铺,8:用户ID,9:信息流淘积木用户ID,10:口碑用户ID,206:店铺优惠券,207:商品优惠券,208:直播单品,309:直播间商品半屏卡,304:1688商品,305:内容平台-短视频,306:附近门店-用户ID,307:饿了么-菜品,401:LAZADA商品,501:飞猪酒店,502:飞猪商品,503:飞猪短信,601:淘积木页面,1001:AE宝贝,1101:淘宝宝贝SKU,310:内容平台-订阅内容 └ material_name String yiliantest测试请不要拍22 物料名称 └ title String yiliantest测试请不要拍22 标题 └ img_url String //img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg 图片地址 └ link_url String http://item.taobao.com/item.htm?id=715121254343 跳转链接 └ price String 999900 价格 └ bid_count Number 899900 销量 └ quantity Number 10 库存 └ first_starts_time Date 2023-04-26 14:51:03 首次上架时间 └ starts Date 2023-04-26 14:51:03 最近上架时间 └ category_id String 16 50010850 主站类目路径，空格分隔多级 └ 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 life_cycle_list ItemLifeCycleViewVO [] 新品冷启期生命周期指标-越迁阶段列表,列表中最多有2个元素。在页面上展示的时候，按照元素的索引，从左到右依次展示即 └ life_cycle_desc String 新品打爆期周期文案 └ color String #36A2FC 文案颜色 └ tips String 近30日GMV排名在叶子类目5%以内的新品周期提示文案 └ type Number 1 生命周期类型 └ life_cycle_days Number 3 生命周期指标-天数 └ life_cycle_diff_with_avg String 较慢生命周期指标-同叶子类目均值对比 └ life_cycle_diff_with_avg_tips String 快于同类目商品经历过同样阶段变化所用时间生命周期指标-同叶子类目均值对比提示文案 └ grow_desc String 日均再成交122.55元可提高爆品类目排名卡位商品成长指标-成长文案 └ grow_rank Number 1077 商品成长指标-成交排名 └ alive_group_id Number 0 视频组件id,0:宝贝链接,3:订阅店铺,5:直播,6:加购,7:收藏加购,8:入会有礼,12:关注有礼,11:直播联动,10:自定义模板,13:同店搜 └ alive_group_name String 宝贝链接(默认) 视频组件名称 └ black_creative_status String success 智能创意生成状态,success:合成成功,fail:合成失败 spot_list SpotVO [] 看点列表 └ spot_id Number 1 看点id └ material_name String 物料名称物料名称 └ title String 物料标题物料标题 └ link_url String https://h5.m.taobao.com/**timemove 物料的相关链接 └ img_url String https://img.alicdn.com/**.jpg 物料的图片URL └ live_id Number 474297730705 直播id └ live_title String 直播间隔一小时抽免单直播标题 └ material_id Number 474847464897 物料id └ status Number 4 状态 └ material_type Number 3 类型 └ audit_reason String 1 审核未通过的原因 └ material_tag_id Number 40 物料标签id └ quantity Number 20 数量 └ bid_count Number 20 竞标次数 └ item_id Number 474847464777 商品id └ outer_status Number 10 外部状态标识 └ live_cover_img String https://gw.alicdn.com/.jpg 直播的封面URL └ audit_status Number 1 审核状态 └ live_start_time Date 2024-08-02 07:44:22 直播开始时间 └ video_ori_url String https://livecaing.alicdn.com/*** 视频URL └ pv Number 35 页面浏览量 └ trade_amt Number 147 交易金额 └ live_start_time_str String 2024-08-02 07:44:22 直播开始时间 └ need_target_crowd Number 1 有无目标人群 └ more_campaign_switch Boolean false 是否打开更多设置 └ crowd_custom_type Boolean false 人群模块展开收起 └ crowd_extend_type String auto 扩展策略 └ origin_secondary_scene String promotion_scene_item 原二级场景 └ scene_id Number 371 营销场景Id └ is_xinxiang Boolean true 是否是新享计划 └ is_guarantee Boolean true 是否是对赌计划 └ bid_type_v2 String smart_bid 智能出价升级，出价类型 └ bid_target_v2 String conv 出价目标 └ set_single_cost_v2 Boolean true 是否设置单次成本

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewCampaignGetRequest req = new UniversalbpNewCampaignGetRequest();
UniversalbpNewCampaignGetRequest.TopServiceContext obj1 = new UniversalbpNewCampaignGetRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewCampaignGetRequest.CampaignQueryVO obj2 = new UniversalbpNewCampaignGetRequest.CampaignQueryVO();
obj2.setStatusList("
  "start",
  "pause"
");
obj2.setPromotionSceneList(""promotion_scene_crowd"");
obj2.setNeedTargetCrowdList(""smartCrowd"");
obj2.setOriginSecondarySceneList(""promotion_scene_item"");
obj2.setPromotionTypeList("
  "item",
  "shop"
");
obj2.setBidTypeList(""roi_control"");
obj2.setOptimizeTargetList(""click"");
obj2.setCampaignNameLike("计划名称");
obj2.setCampaignId(68796878069L);
obj2.setCampaignIdList(new Long[] { 68796878069 };
);
obj2.setItemId(752793518760L);
obj2.setAdgroupRequired(false);
obj2.setOffset(10L);
obj2.setPageSize(10L);
req.setCampaignQueryVO(obj2);
UniversalbpNewCampaignGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewCampaignGetRequest req = new UniversalbpNewCampaignGetRequest();
UniversalbpNewCampaignGetRequest.TopServiceContextDomain obj1 = new UniversalbpNewCampaignGetRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewCampaignGetRequest.CampaignQueryVODomain obj2 = new UniversalbpNewCampaignGetRequest.CampaignQueryVODomain();
obj2.StatusList = "
  "start",
  "pause"
";
obj2.PromotionSceneList = ""promotion_scene_crowd"";
obj2.NeedTargetCrowdList = ""smartCrowd"";
obj2.OriginSecondarySceneList = ""promotion_scene_item"";
obj2.PromotionTypeList = "
  "item",
  "shop"
";
obj2.BidTypeList = ""roi_control"";
obj2.OptimizeTargetList = ""click"";
obj2.CampaignNameLike = "计划名称";
obj2.CampaignId = 68796878069L;
obj2.CampaignIdList = new long[] { 68796878069 };
;
obj2.ItemId = 752793518760L;
obj2.AdgroupRequired = false;
obj2.Offset = 10L;
obj2.PageSize = 10L;
req.CampaignQueryVO_ = obj2;
UniversalbpNewCampaignGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewCampaignGetRequest;
$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));
$campaign_query_v_o = new CampaignQueryVO;
$campaign_query_v_o->status_list="[
  \"start\",
  \"pause\"
]";
$campaign_query_v_o->promotion_scene_list="[\"promotion_scene_crowd\"]";
$campaign_query_v_o->need_target_crowd_list="[\"smartCrowd\"]";
$campaign_query_v_o->origin_secondary_scene_list="[\"promotion_scene_item\"]";
$campaign_query_v_o->promotion_type_list="[
  \"item\",
  \"shop\"
]";
$campaign_query_v_o->bid_type_list="[\"roi_control\"]";
$campaign_query_v_o->optimize_target_list="[\"click\"]";
$campaign_query_v_o->campaign_name_like="计划名称";
$campaign_query_v_o->campaign_id="68796878069";
$campaign_query_v_o->campaign_id_list="[68796878069]";
$campaign_query_v_o->item_id="752793518760";
$campaign_query_v_o->adgroup_required="false";
$campaign_query_v_o->offset="10";
$campaign_query_v_o->page_size="10";
$req->setCampaignQueryVO(json_encode($campaign_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.campaign.get' \
-d 'partner_id=apidoc' \
-d 'session=78c3f70e-6b63-45f4-ad45-ee2c3ebec198' \
-d 'sign=92B30C5BA5EC17745C02D1447A73922D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+16%3A03%3A31' \
-d 'v=2.0' \
-d 'campaign_query_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

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

XML示例
JSON示例

<universalbp_new_campaign_get_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_campaign_v_o>
            <campaign>
                <campaign_biz_code>onebpDisplay</campaign_biz_code>
                <campaign_group_id>25696724</campaign_group_id>
                <campaign_group_name>测试</campaign_group_name>
                <campaign_id>68796878069</campaign_id>
                <campaign_name>管家计划_宝贝候选集</campaign_name>
                <promotion_scene>promotion_scene_crowd</promotion_scene>
                <market_scene>wxt_live_max_view :最大化拿量</market_scene>
                <promotion_goals>traffic_nd</promotion_goals>
                <promotion_model>daily:持续推广,order:套餐包</promotion_model>
                <promotion_type>item</promotion_type>
                <promotion_type_list>
                    <string>[&quot;item&quot;]</string>
                </promotion_type_list>
                <spot_continue>10</spot_continue>
                <sub_promotion_type>item</sub_promotion_type>
                <sub_promotion_type_list>
                    <string>[&quot;item&quot;]</string>
                </sub_promotion_type_list>
                <optimize_target>conv</optimize_target>
                <online_status>0</online_status>
                <display_status>pause</display_status>
                <top_status>true</top_status>
                <top_time>2023-06-12 12:00:00</top_time>
                <dmc_type>normal</dmc_type>
                <day_budget>100</day_budget>
                <smooth_option>smooth</smooth_option>
                <total_budget>100</total_budget>
                <budget_period>7</budget_period>
                <period_smooth>smooth</period_smooth>
                <bid_type>max_amount</bid_type>
                <campaign_ocpc>
                    <enable_ocpc>1</enable_ocpc>
                    <ocpc_ratio>200</ocpc_ratio>
                </campaign_ocpc>
                <max_price>0.4</max_price>
                <min_price>0.25</min_price>
                <bid_unit>元/次点击</bid_unit>
                <constraint_type>元/次点击</constraint_type>
                <constraint_value>3</constraint_value>
                <cold_boot>1</cold_boot>
                <cold_boot_time>2023-06-11 23:56:23</cold_boot_time>
                <cold_boot_stage>mature</cold_boot_stage>
                <speed_type>xxxxx</speed_type>
                <launch_period_discount>100%</launch_period_discount>
                <launch_period_display_time>15:00-15:30</launch_period_display_time>
                <launch_period_type>xxxxx</launch_period_type>
                <launch_time>
                    <start_time>2023-06-09 00:00:00</start_time>
                    <end_time>2199-02-01 00:00:00</end_time>
                    <launch_forever>true</launch_forever>
                    <renewal_first_order_start_time>2023-06-09 00:00:00</renewal_first_order_start_time>
                    <renewal_first_order_end_time>2199-02-01 00:00:00</renewal_first_order_end_time>
                </launch_time>
                <launch_area_str_list>
                    <string>[&quot;1&quot;</string>
                    <string>&quot;19&quot;] 或者 [&quot;all&quot;]</string>
                </launch_area_str_list>
                <launch_period_list>
                    <launch_period_v_o>
                        <day_of_week>1</day_of_week>
                        <time_span_list>
                            <time_span_query_res_v_o>
                                <time>00:00-24:00</time>
                                <discount>100</discount>
                            </time_span_query_res_v_o>
                        </time_span_list>
                    </launch_period_v_o>
                </launch_period_list>
                <crowd_filter_list>
                    <campaign_crowd_filter_v_o>
                        <behavior>shop_crowd</behavior>
                        <window>7</window>
                    </campaign_crowd_filter_v_o>
                </crowd_filter_list>
                <brand_filter_list>
                    <campaign_brand_filter_v_o>
                        <brand_id>20067</brand_id>
                        <deeplink_list>
                            <string>[&quot;Engage&quot;]</string>
                        </deeplink_list>
                    </campaign_brand_filter_v_o>
                </brand_filter_list>
                <deeplink_brand_list>
                    <deeplink_brand_v_o>
                        <deeplink_brand_id>20067</deeplink_brand_id>
                        <deeplink_brand_name>Lancome/兰蔻</deeplink_brand_name>
                    </deeplink_brand_v_o>
                </deeplink_brand_list>
                <gender_age_filter_list>
                    <campaign_gender_age_filter_v_o>
                        <gender>man</gender>
                        <age_list>
                            <string>[0</string>
                            <string>1</string>
                            <string>2</string>
                            <string>3</string>
                            <string>4</string>
                            <string>5</string>
                            <string>6]</string>
                        </age_list>
                    </campaign_gender_age_filter_v_o>
                </gender_age_filter_list>
                <mini_detail>
                    <mini_detail_theme>1</mini_detail_theme>
                    <private_mini_item_id_list>
                        <number>[714707465203</number>
                        <number>714901906337]</number>
                    </private_mini_item_id_list>
                    <private_mini_top_item_id_list>
                        <number>[714707465203]</number>
                    </private_mini_top_item_id_list>
                    <private_mini_type>1</private_mini_type>
                </mini_detail>
                <item_selected_mode>shop</item_selected_mode>
                <shop_item_type>effect</shop_item_type>
                <shield_items>
                    <number>[714707465203</number>
                    <number>714901906337]</number>
                </shield_items>
                <scope_items>
                    <number>[714707465203</number>
                    <number>714901906337]</number>
                </scope_items>
                <adgroup_list>
                    <adgroup_v_o>
                        <gmt_create>2023-12-09 14:34:12</gmt_create>
                        <gmt_modified>2023-12-09 14:34:12</gmt_modified>
                        <campaign_id>68796878069</campaign_id>
                        <campaign_name>管家计划_宝贝候选集</campaign_name>
                        <adgroup_id>68793666608</adgroup_id>
                        <adgroup_name>ds460418344</adgroup_name>
                        <online_status>0</online_status>
                        <display_status>pause</display_status>
                        <audit_status>1</audit_status>
                        <audit_reason>xxxxx</audit_reason>
                        <adgroup_ocpc>
                            <enable_ocpc>true</enable_ocpc>
                            <ocpc_ratio>200</ocpc_ratio>
                            <ocpc_marketing_aim>click</ocpc_marketing_aim>
                            <ocpc_status>new_ad_complete</ocpc_status>
                            <enable_cold_speed_new_item>false</enable_cold_speed_new_item>
                            <ecpc_option>1</ecpc_option>
                        </adgroup_ocpc>
                        <promotion_type>item</promotion_type>
                        <sub_promotion_type>item</sub_promotion_type>
                        <material>
                            <material_id>714616513841</material_id>
                            <material_type>1</material_type>
                            <material_name>yiliantest测试请不要拍22</material_name>
                            <title>yiliantest测试请不要拍22</title>
                            <img_url>//img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg</img_url>
                            <link_url>http://item.taobao.com/item.htm?id=715121254343</link_url>
                            <price>999900</price>
                            <bid_count>899900</bid_count>
                            <quantity>10</quantity>
                            <first_starts_time>2023-04-26 14:51:03</first_starts_time>
                            <starts>2023-04-26 14:51:03</starts>
                            <category_id>16 50010850</category_id>
                            <promotion_type>item</promotion_type>
                            <sub_promotion_type>item</sub_promotion_type>
                            <life_cycle_list>
                                <item_life_cycle_view_v_o>
                                    <life_cycle_desc>新品打爆期</life_cycle_desc>
                                    <color>#36A2FC</color>
                                    <tips>近30日GMV排名在叶子类目5%以内的新品</tips>
                                    <type>1</type>
                                </item_life_cycle_view_v_o>
                            </life_cycle_list>
                            <life_cycle_days>3</life_cycle_days>
                            <life_cycle_diff_with_avg>较慢</life_cycle_diff_with_avg>
                            <life_cycle_diff_with_avg_tips>快于同类目商品经历过同样阶段变化所用时间</life_cycle_diff_with_avg_tips>
                            <grow_desc>日均再成交122.55元 可提高爆品类目排名卡位</grow_desc>
                            <grow_rank>1077</grow_rank>
                        </material>
                        <alive_group_id>0</alive_group_id>
                        <alive_group_name>宝贝链接(默认)</alive_group_name>
                        <black_creative_status>success</black_creative_status>
                        <spot_list>
                            <spot_v_o>
                                <spot_id>1</spot_id>
                                <material_name>物料名称</material_name>
                                <title>物料标题</title>
                                <link_url>https://h5.m.taobao.com/****timemove</link_url>
                                <img_url>https://img.alicdn.com/******.jpg</img_url>
                                <live_id>474297730705</live_id>
                                <live_title>直播间隔一小时抽免单</live_title>
                                <material_id>474847464897</material_id>
                                <status>4</status>
                                <material_type>3</material_type>
                                <audit_reason>1</audit_reason>
                                <material_tag_id>40</material_tag_id>
                                <quantity>20</quantity>
                                <bid_count>20</bid_count>
                                <item_id>474847464777</item_id>
                                <outer_status>10</outer_status>
                                <live_cover_img>https://gw.alicdn.com/****.jpg</live_cover_img>
                                <audit_status>1</audit_status>
                                <live_start_time>2024-08-02 07:44:22</live_start_time>
                                <video_ori_url>https://livecaing.alicdn.com/*****</video_ori_url>
                                <pv>35</pv>
                                <trade_amt>147</trade_amt>
                                <live_start_time_str>2024-08-02 07:44:22</live_start_time_str>
                            </spot_v_o>
                        </spot_list>
                    </adgroup_v_o>
                </adgroup_list>
                <need_target_crowd>1</need_target_crowd>
                <more_campaign_switch>false</more_campaign_switch>
                <crowd_custom_type>false</crowd_custom_type>
                <crowd_extend_type>auto</crowd_extend_type>
                <origin_secondary_scene>promotion_scene_item</origin_secondary_scene>
                <scene_id>371</scene_id>
                <is_xinxiang>true</is_xinxiang>
                <is_guarantee>true</is_guarantee>
                <bid_type_v2>smart_bid</bid_type_v2>
                <bid_target_v2>conv</bid_target_v2>
                <set_single_cost_v2>true</set_single_cost_v2>
            </campaign>
        </top_campaign_v_o>
    </top_result>
</universalbp_new_campaign_get_response>

{
    "universalbp_new_campaign_get_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "top_campaign_v_o":{
                "campaign":{
                    "campaign_biz_code":"onebpDisplay",
                    "campaign_group_id":25696724,
                    "campaign_group_name":"测试",
                    "campaign_id":68796878069,
                    "campaign_name":"管家计划_宝贝候选集",
                    "promotion_scene":"promotion_scene_crowd",
                    "market_scene":"wxt_live_max_view :最大化拿量",
                    "promotion_goals":"traffic_nd",
                    "promotion_model":"daily:持续推广,order:套餐包",
                    "promotion_type":"item",
                    "promotion_type_list":{
                        "string":[
                            "[\"item\"]"
                        ]
                    },
                    "spot_continue":10,
                    "sub_promotion_type":"item",
                    "sub_promotion_type_list":{
                        "string":[
                            "[\"item\"]"
                        ]
                    },
                    "optimize_target":"conv",
                    "online_status":0,
                    "display_status":"pause",
                    "top_status":true,
                    "top_time":"2023-06-12 12:00:00",
                    "dmc_type":"normal",
                    "day_budget":"100",
                    "smooth_option":"smooth",
                    "total_budget":"100",
                    "budget_period":7,
                    "period_smooth":"smooth",
                    "bid_type":"max_amount",
                    "campaign_ocpc":{
                        "enable_ocpc":"1",
                        "ocpc_ratio":200
                    },
                    "max_price":"0.4",
                    "min_price":"0.25",
                    "bid_unit":"元\/次点击",
                    "constraint_type":"元\/次点击",
                    "constraint_value":"3",
                    "cold_boot":1,
                    "cold_boot_time":"2023-06-11 23:56:23",
                    "cold_boot_stage":"mature",
                    "speed_type":"xxxxx",
                    "launch_period_discount":"100%",
                    "launch_period_display_time":"15:00-15:30",
                    "launch_period_type":"xxxxx",
                    "launch_time":{
                        "start_time":"2023-06-09 00:00:00",
                        "end_time":"2199-02-01 00:00:00",
                        "launch_forever":true,
                        "renewal_first_order_start_time":"2023-06-09 00:00:00",
                        "renewal_first_order_end_time":"2199-02-01 00:00:00"
                    },
                    "launch_area_str_list":{
                        "string":[
                            "[\"1\"",
                            "\"19\"] 或者 [\"all\"]"
                        ]
                    },
                    "launch_period_list":{
                        "launch_period_v_o":[
                            {
                                "day_of_week":1,
                                "time_span_list":{
                                    "time_span_query_res_v_o":[
                                        {
                                            "time":"00:00-24:00",
                                            "discount":100
                                        }
                                    ]
                                }
                            }
                        ]
                    },
                    "crowd_filter_list":{
                        "campaign_crowd_filter_v_o":[
                            {
                                "behavior":"shop_crowd",
                                "window":"7"
                            }
                        ]
                    },
                    "brand_filter_list":{
                        "campaign_brand_filter_v_o":[
                            {
                                "brand_id":"20067",
                                "deeplink_list":{
                                    "string":[
                                        "[\"Engage\"]"
                                    ]
                                }
                            }
                        ]
                    },
                    "deeplink_brand_list":{
                        "deeplink_brand_v_o":[
                            {
                                "deeplink_brand_id":"20067",
                                "deeplink_brand_name":"Lancome\/兰蔻"
                            }
                        ]
                    },
                    "gender_age_filter_list":{
                        "campaign_gender_age_filter_v_o":[
                            {
                                "gender":"man",
                                "age_list":{
                                    "string":[
                                        "[0",
                                        " 1",
                                        " 2",
                                        " 3",
                                        " 4",
                                        " 5",
                                        " 6]"
                                    ]
                                }
                            }
                        ]
                    },
                    "mini_detail":{
                        "mini_detail_theme":"1",
                        "private_mini_item_id_list":{
                            "number":[
                                [714707465203,
                                 714901906337]
                            ]
                        },
                        "private_mini_top_item_id_list":{
                            "number":[
                                [714707465203]
                            ]
                        },
                        "private_mini_type":1
                    },
                    "item_selected_mode":"shop",
                    "shop_item_type":"effect",
                    "shield_items":{
                        "number":[
                            [714707465203,
                             714901906337]
                        ]
                    },
                    "scope_items":{
                        "number":[
                            [714707465203,
                             714901906337]
                        ]
                    },
                    "adgroup_list":{
                        "adgroup_v_o":[
                            {
                                "gmt_create":"2023-12-09 14:34:12",
                                "gmt_modified":"2023-12-09 14:34:12",
                                "campaign_id":68796878069,
                                "campaign_name":"管家计划_宝贝候选集",
                                "adgroup_id":68793666608,
                                "adgroup_name":"ds460418344",
                                "online_status":0,
                                "display_status":"pause",
                                "audit_status":1,
                                "audit_reason":"xxxxx",
                                "adgroup_ocpc":{
                                    "enable_ocpc":true,
                                    "ocpc_ratio":200,
                                    "ocpc_marketing_aim":"click",
                                    "ocpc_status":"new_ad_complete",
                                    "enable_cold_speed_new_item":false,
                                    "ecpc_option":1
                                },
                                "promotion_type":"item",
                                "sub_promotion_type":"item",
                                "material":{
                                    "material_id":714616513841,
                                    "material_type":1,
                                    "material_name":"yiliantest测试请不要拍22",
                                    "title":"yiliantest测试请不要拍22",
                                    "img_url":"\/\/img.alicdn.com\/bao\/uploaded\/i1\/3838159498\/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg",
                                    "link_url":"http:\/\/item.taobao.com\/item.htm?id=715121254343",
                                    "price":"999900",
                                    "bid_count":899900,
                                    "quantity":10,
                                    "first_starts_time":"2023-04-26 14:51:03",
                                    "starts":"2023-04-26 14:51:03",
                                    "category_id":"16 50010850",
                                    "promotion_type":"item",
                                    "sub_promotion_type":"item",
                                    "life_cycle_list":{
                                        "item_life_cycle_view_v_o":[
                                            {
                                                "life_cycle_desc":"新品打爆期",
                                                "color":"#36A2FC",
                                                "tips":"近30日GMV排名在叶子类目5%以内的新品",
                                                "type":1
                                            }
                                        ]
                                    },
                                    "life_cycle_days":3,
                                    "life_cycle_diff_with_avg":"较慢",
                                    "life_cycle_diff_with_avg_tips":"快于同类目商品经历过同样阶段变化所用时间",
                                    "grow_desc":"日均再成交122.55元 可提高爆品类目排名卡位",
                                    "grow_rank":1077
                                },
                                "alive_group_id":0,
                                "alive_group_name":"宝贝链接(默认)",
                                "black_creative_status":"success",
                                "spot_list":{
                                    "spot_v_o":[
                                        {
                                            "spot_id":1,
                                            "material_name":"物料名称",
                                            "title":"物料标题",
                                            "link_url":"https:\/\/h5.m.taobao.com\/****timemove",
                                            "img_url":"https:\/\/img.alicdn.com\/******.jpg",
                                            "live_id":474297730705,
                                            "live_title":"直播间隔一小时抽免单",
                                            "material_id":474847464897,
                                            "status":4,
                                            "material_type":3,
                                            "audit_reason":"1",
                                            "material_tag_id":40,
                                            "quantity":20,
                                            "bid_count":20,
                                            "item_id":474847464777,
                                            "outer_status":10,
                                            "live_cover_img":"https:\/\/gw.alicdn.com\/****.jpg",
                                            "audit_status":1,
                                            "live_start_time":"2024-08-02 07:44:22",
                                            "video_ori_url":"https:\/\/livecaing.alicdn.com\/*****",
                                            "pv":35,
                                            "trade_amt":147,
                                            "live_start_time_str":"2024-08-02 07:44:22"
                                        }
                                    ]
                                }
                            }
                        ]
                    },
                    "need_target_crowd":1,
                    "more_campaign_switch":false,
                    "crowd_custom_type":false,
                    "crowd_extend_type":"auto",
                    "origin_secondary_scene":"promotion_scene_item",
                    "scene_id":371,
                    "is_xinxiang":true,
                    "is_guarantee":true,
                    "bid_type_v2":"smart_bid",
                    "bid_target_v2":"conv",
                    "set_single_cost_v2":true
                }
            }
        }
    }
}

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.get (查询单个计划详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ