淘宝开放平台

登录
文档中心 > API类目 > 直通车API

直通车API

taobao.universalbp.campaign.findpage (查询计划分页列表)

分页查询场景内的计划列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
campaign_query_v_o CampaignQueryVo 必须 campaignQueryVO
  • └ status_list
  • String []
  • 可选
  • [ "start", "pause" ]
  • 筛选项-主体类型
  • └ promotion_type_list
  • String []
  • 可选
  • [ "item", "shop" ]
  • 筛选项-主体类型
  • └ campaign_id
  • Number
  • 可选
  • 68796878069
  • 计划id
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小
  • rpt_query
  • RptQueryVO
  • 可选
  • 数据报表查询条件
  • └ fields
  • String
  • 可选
  • adPV
  • 查询指标字段
  • condition_list
  • RptQueryConditionVO []
  • 可选
  • 报表查询条件
  • └ start_time
  • String
  • 可选
  • 2023-10-08
  • 开始时间
  • └ end_time
  • String
  • 可选
  • 2023-10-08
  • 结束时间
  • └ adzone_pkg_id_list
  • String []
  • 可选
  • ["114790550288", "114790550289", "114793500012", "114786650498"]
  • 流量来源（资源位包id）
  • └ is_rt
  • Boolean
  • 可选
  • true
  • 是否查询实时报表，true查实时、false查离线，不传则默认查离线
  • └ unify_type
  • String
  • 可选
  • zhai
  • 归因类型（万相台需要此条件）
  • └ campaign_id_list
  • Number []
  • 可选
  • [68796878069]
  • 检索项-计划id批量
  • └ adgroup_required
  • Boolean
  • 可选
  • false
  • 是否需要查询单元

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • campaign_v_o_top_bulk_data
  • TopBulkData
  • 结果集
  • campaign_v_o_list
  • CampaignVo []
  • 批量结果集
  • └ 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）
  • └ 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"]
  • 主体类型，支持一个计划下存在多种类型
  • └ 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:不置顶
  • └ 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:加速中
  • └ launch_period_discount
  • String
  • 100%
  • 分时折扣比例（取当前时刻对应的实际折扣，格式：80%）
  • └ launch_period_display_time
  • String
  • 15:00-15:30
  • 分时折扣展示时段（取当前时刻对应的半小时区间，格式：09:00-09:30）
  • 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:否
  • └ 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:,1,2,3,4,5,6
  • mini_detail
  • CampaignMiniDetailVo
  • 橱窗相关
  • └ 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]
  • 宝贝优选里面的指定宝贝
  • └ top_time
  • Date
  • 2023-06-12 12:00:00
  • 置顶时间
  • └ report_info
  • String
  • 报表数据
  • └ count
  • Number
  • 1
  • 数量

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpCampaignFindpageRequest req = new UniversalbpCampaignFindpageRequest();
UniversalbpCampaignFindpageRequest.TopServiceContext obj1 = new UniversalbpCampaignFindpageRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpCampaignFindpageRequest.CampaignQueryVo obj2 = new UniversalbpCampaignFindpageRequest.CampaignQueryVo();
obj2.setStatusList("
  "start",
  "pause"
");
obj2.setPromotionTypeList("
  "item",
  "shop"
");
obj2.setCampaignId(68796878069L);
obj2.setOffset(0L);
obj2.setPageSize(20L);
UniversalbpCampaignFindpageRequest.RptQueryVO obj3 = new UniversalbpCampaignFindpageRequest.RptQueryVO();
obj3.setFields("adPV");
List<UniversalbpCampaignFindpageRequest.RptQueryConditionVO> list5 = new ArrayList<UniversalbpCampaignFindpageRequest.RptQueryConditionVO>();
UniversalbpCampaignFindpageRequest.RptQueryConditionVO obj6 = new UniversalbpCampaignFindpageRequest.RptQueryConditionVO();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList(""114790550288", "114790550289", "114793500012", "114786650498"");
obj6.setIsRt(true);
obj6.setUnifyType("zhai");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
obj2.setCampaignIdList(new Long[] { 68796878069 };
);
obj2.setAdgroupRequired(false);
req.setCampaignQueryVO(obj2);
UniversalbpCampaignFindpageResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_campaign_findpage_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <campaign_v_o_top_bulk_data>
            <campaign_v_o_list>
                <campaign_vo>
                    <biz_code>onebpDisplay</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>
                    <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>
                    <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>
                    <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>
                    <launch_period_discount>100%</launch_period_discount>
                    <launch_period_display_time>15:00-15:30</launch_period_display_time>
                    <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>
                    </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_vo>
                            <day_of_week>1</day_of_week>
                            <time_span_list>
                                <time_span_query_res_vo>
                                    <time>00:00-24:00</time>
                                    <discount>100</discount>
                                </time_span_query_res_vo>
                            </time_span_list>
                        </launch_period_vo>
                    </launch_period_list>
                    <crowd_filter_list>
                        <campaign_crowd_filter_vo>
                            <behavior>shop_crowd</behavior>
                            <window>7</window>
                        </campaign_crowd_filter_vo>
                    </crowd_filter_list>
                    <brand_filter_list>
                        <campaign_brand_filter_vo>
                            <brand_id>20067</brand_id>
                            <deeplink_list>
                                <string>[&quot;Engage&quot;]</string>
                            </deeplink_list>
                        </campaign_brand_filter_vo>
                    </brand_filter_list>
                    <deeplink_brand_list>
                        <deeplink_brand_vo>
                            <deeplink_brand_id>20067</deeplink_brand_id>
                            <deeplink_brand_name>Lancome/兰蔻</deeplink_brand_name>
                        </deeplink_brand_vo>
                    </deeplink_brand_list>
                    <gender_age_filter_list>
                        <campaign_gender_age_filter_vo>
                            <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_vo>
                    </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>
                    <top_time>2023-06-12 12:00:00</top_time>
                </campaign_vo>
            </campaign_v_o_list>
            <count>1</count>
        </campaign_v_o_top_bulk_data>
    </result>
</universalbp_campaign_findpage_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工具

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

如何获得此API

FAQ

我要提问
返回
顶部