接口参考 · 查询操作
查询计划分页列表
taobao.universalbp.new.campaign.findpage
核对日期:2026-09-19。字段名称、类型与业务层级按淘宝文档整理;请求地址、鉴权和店铺选择按下方本站说明接入。
文档按上述日期核对;最新变更及详细场景规则请查看淘宝官方说明。
通过奇门云调用
- 签名地址:POST https://api.miandanni.com/api/wanxiang/sign;Content-Type: application/json。
- 客户购买的奇门云密钥用于申请签名;实际调用淘宝开放平台万相台官方 API。方法、字段、类型、层级、金额单位和场景以官方文档为准。奇门云校验客户服务、店铺归属与授权后签名,客户服务器直接请求淘宝并接收业务数据。
- 先下载 https://api.miandanni.com/examples/qimenyun_direct.py 放在业务脚本同目录,使用 Client.call。奇门云密钥不是淘宝 AppSecret;不要求客户自行计算平台签名。
- 签名申请头 Authorization: Bearer 你的奇门云密钥。JSON 为 {shopKey, method, params};shopKey 必须属于当前客户。客户 Bearer 密钥不能转发到淘宝。
- 业务参数放入 params,保留淘宝字段名、类型、层级及枚举。对象直接使用 JSON 对象;下表业务根字段不放在请求最外层。
- app_key、session、sign、timestamp、v、format 等公共字段由服务器生成。签发的本店铺 session 和签名只能用于客户服务器,不进入前端、日志或公共仓库;AppSecret 和 refresh_token 不提供给客户。
- 本站支持店铺直接登录:top_service_context.login_type 为 1,ext 为 {} 或字符串 "{}";不允许 member_id、其他账户身份或代理登录。官方表内此类字段用于说明差异,不能照抄传入。
- 业务根对象未填写的必填子项需按官方文档补全。ID 保持精度,金额单位、日期范围和枚举以具体方法官方说明为准。
- 签发成功为 {ok:true,data:{version:1,ticketId,service,method,issuedAt,request}},不表示业务已执行;客户端按合同执行 data.request。TOP fields 原样作为字符串表单发送,不改值。
- 淘宝业务响应直接返回客户程序,保留 error_response、top_result、逐项错误和 request_id;HTTP 200 仍检查 top_result.info.ok。签名阶段失败读取奇门云 error.code、message 和 details。
- 每次签名校验密钥、服务有效期、店铺归属、淘宝应用订购及授权。业务能力仍取决于淘宝资格与推广场景。签发限流不等于平台实际调用次数。
- 一次签名只生成一份请求,不自动翻页或重试。创建、调价、启停、删除会实际生效;超时或结果未知先查询实际状态。ticketId 不是平台幂等键。
- 签名不是一次性凭据,平台接受的时间窗口内可能重放;解绑、停用或到期阻止新签发,不能即时撤回已签发请求。老客户原程序继续可用。
- 每周一北京时间凌晨2:00检查官方更新,经核对验证后同步,不承诺实时同步。官方方法尚未同步时提供完整方法名和官方链接反馈,不误判为平台权限不足。
{
"shopKey": "填写你授权店铺的 shopKey",
"method": "taobao.universalbp.new.campaign.findpage",
"params": {
"top_service_context": {
"biz_code": "onebpSite",
"login_type": 1,
"ext": "{}"
},
"campaign_query_v_o": {
"offset": 0,
"page_size": 20,
"adgroup_required": true
}
}
}这是请求结构模板。空对象和占位内容需按下方字段表填写;修改接口未填入任何真实广告编号或预算。
请求业务参数
以下路径都位于请求体的 params 内。[] 表示数组元素;嵌套字段的必填标记只描述其父对象使用时的要求。
官方 top_service_context.member_id、代理登录和扩展身份不适用于本站。本站固定使用自己的已授权店铺,login_type=1、ext={}。
| 字段路径 | 类型 / 必填 | 字段含义 | 示例值 |
|---|---|---|---|
top_service_context | TopServiceContext必填含下级字段 | 推广业务上下文 | — |
top_service_context.biz_code | String必填 | 推广场景标识 | xxxxx |
top_service_context.login_type | Number可选 | 账户登录方式枚举:1、2=代理直投(叉乘账号) | 1 |
top_service_context.member_id | Number可选 | 广告账户标识代理直投(叉乘)时必填 | 12345 |
top_service_context.ext | String可选 | 扩展参数 | {} |
campaign_query_v_o | CampaignQueryVO必填含下级字段 | 计划查询条件 | — |
campaign_query_v_o.status_list | String []可选 | 筛选状态集合 | [ "start", "pause" ] |
campaign_query_v_o.need_target_crowd_list | String []可选 | 目标人群集合 | ["smartCrowd"] |
campaign_query_v_o.origin_secondary_scene_list | String []可选 | 业务条件集合 | ["promotion_scene_item"] |
campaign_query_v_o.promotion_type_list | String []可选 | 类型集合 | [ "item", "shop" ] |
campaign_query_v_o.bid_type_list | String []可选 | 出价类型列表 | ["roi_control"] |
campaign_query_v_o.campaign_name_like | String可选 | 业务字段 campaign_name_like | 计划名称 |
campaign_query_v_o.campaign_id | Number可选 | 推广计划编号 | 68796878069 |
campaign_query_v_o.campaign_id_list | Number []可选 | 计划标识列表 | [68796878069] |
campaign_query_v_o.item_id | Number可选 | 商品编号 | 752793518760 |
campaign_query_v_o.rpt_query | RptQueryVO可选含下级字段 | 查询对象 | — |
campaign_query_v_o.rpt_query.fields | String可选 | 业务字段 fields | adPv,click,charge,ctr,ecpc,ecpm |
campaign_query_v_o.rpt_query.condition_list | RptQueryConditionVO []可选含下级字段 | 列表集合 | — |
campaign_query_v_o.rpt_query.condition_list[].start_time | String可选 | 查询或投放起始时间 | 2023-10-08 |
campaign_query_v_o.rpt_query.condition_list[].end_time | String可选 | 查询或投放结束时间 | 2023-10-08 |
campaign_query_v_o.rpt_query.condition_list[].adzone_pkg_id_list | String []可选 | 标识集合 | ["114790550288", "114790550289", "114793500012", "114786650498"] |
campaign_query_v_o.rpt_query.condition_list[].is_rt | Boolean可选 | 业务字段 is_rt | true |
campaign_query_v_o.rpt_query.condition_list[].unify_type | String可选 | 转化归因口径 | zhai |
campaign_query_v_o.rpt_query.condition_list[].source_list | String []可选 | 业务条件集合 | ["campaign_detail","adgroup_list"] |
campaign_query_v_o.adgroup_required | Boolean可选 | 业务字段 adgroup_required | false |
campaign_query_v_o.offset | Number可选 | 结果起始偏移 | 10 |
campaign_query_v_o.page_size | Number可选 | 单页条数 | 10 |
campaign_query_v_o.promotion_scene_list | String []可选 | 业务条件集合 | ["promotion_scene_crowd"] |
campaign_query_v_o.optimize_target_list | String []可选 | 优化目标列表 | ["click"] |
返回业务字段
官方样例未能核实响应外层,以下保留业务字段结构,实际 JSON 路径请以接口返回和官方说明为准。
| 字段路径 | 类型 / 必填 | 字段含义 | 示例值 |
|---|---|---|---|
top_result | TopResult官方未标注必填含下级字段 | 接口业务结果 | — |
top_result.info | TopInfo官方未标注必填含下级字段 | 执行状态信息 | — |
top_result.info.ok | Boolean官方未标注必填 | 业务是否成功 | true |
top_result.info.message | String官方未标注必填 | 业务结果提示 | 参数错误 |
top_result.info.error_code | String官方未标注必填 | 业务错误标识 | xxxxx |
top_result.campaign_v_o_top_bulk_data | TopBulkData官方未标注必填含下级字段 | 计划对象 | — |
top_result.campaign_v_o_top_bulk_data.count | Number官方未标注必填 | 结果计数 | 10 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list | CampaignVO []官方未标注必填含下级字段 | 计划列表 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_biz_code | String官方未标注必填 | 业务字段 campaign_biz_code | onebpDisplay |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_group_id | Number官方未标注必填 | 计划标识 | 25696724 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_group_name | String官方未标注必填 | 业务字段 campaign_group_name | 测试 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_id | Number官方未标注必填 | 推广计划编号计划已经存在场景必填 | 68796878069 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_name | String官方未标注必填 | 推广计划名称 | 管家计划_宝贝候选集 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].promotion_scene | String官方未标注必填 | 业务字段 promotion_scene枚举: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_scene_crowd |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].promotion_goals | String官方未标注必填 | 业务字段 promotion_goals枚举:shop_item=全店宝贝推广、new_item_speed_car=新品飞车、shop_crowd=店铺人群运营、brand_crowd=品牌人群运营、traffic_shoujiao=淘系焦点图、traffic_nd=全屏微详情 | traffic_nd |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].promotion_model | String官方未标注必填 | 业务字段 promotion_model | daily:持续推广,order:套餐包 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].promotion_type | String官方未标注必填 | 业务字段 promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、content=内容、short_video=短视频、user_define=自定义 | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].promotion_type_list | String []官方未标注必填 | 类型集合 | ["item"] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].spot_continue | Number官方未标注必填 | 业务字段 spot_continue | 10 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].sub_promotion_type | String官方未标注必填 | 业务字段 sub_promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、you_hao_huo=有好货、picture=图文、short_video=短视频、live_room=直播间、live_spot=看点、tao_blocks=淘积木、user_define_url=自定义url | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].sub_promotion_type_list | String []官方未标注必填 | 类型集合 | ["item"] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].optimize_target | String官方未标注必填 | 优化目标枚举: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=旺旺留资 | conv |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].online_status | Number官方未标注必填 | 投放上下线状态枚举:-1=未进入投放状态、0=用户设置状态-下线、1=用户设置状态-上线、2=合同未生效、9=投放结束、105=待支付 | 0 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].display_status | String官方未标注必填 | 推广展示状态枚举:pause=暂停推广、start=正在推广、terminate=结束推广、wait=等待推广、pending=准备推广、wait_pay=计划未付款 | pause |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].top_status | Boolean官方未标注必填 | 是否置顶枚举:true=置顶、false=不置顶 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].top_time | Date官方未标注必填 | 时间 | 2023-06-12 12:00:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].dmc_type | String官方未标注必填 | 预算方式标识枚举:normal=日预算、total=总预算、cycle=活动周期预算、day_freeze=日预算冻结、unlimit=不限预算 | normal |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].day_budget | String官方未标注必填 | 日预算 | 100 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].smooth_option | String官方未标注必填 | 每日预算投放节奏枚举:quick=天内尽快、smooth=天内平滑 | smooth |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].total_budget | String官方未标注必填 | 累计预算 | 100 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].budget_period | Number官方未标注必填 | 业务字段 budget_period | 7 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_smooth | String官方未标注必填 | 业务字段 period_smooth枚举:quick=天内尽快、smooth=天内平滑 | smooth |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].bid_type | String官方未标注必填 | 出价类型枚举:custom_bid=手动出价、max_amount=最大化拿量、cost_control=控成本、roi_control=控投产比 | max_amount |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_ocpc | CampaignOcpcVO官方未标注必填含下级字段 | 计划对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_ocpc.enable_ocpc | String官方未标注必填 | 业务字段 enable_ocpc枚举:0=否、1=是 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].campaign_ocpc.ocpc_ratio | Number官方未标注必填 | 业务字段 ocpc_ratio | 200 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].max_price | String官方未标注必填 | 最大金额 | 0.4 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].min_price | String官方未标注必填 | 最小金额 | 0.25 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].bid_unit | String官方未标注必填 | 业务字段 bid_unit | 元/次点击 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].constraint_type | String官方未标注必填 | 业务字段 constraint_type枚举:non=无约束、click=点击成本、coll_cart=收藏加购成本(非场景推广)、cart=收藏加购成本(场景推广)、conv=成交成本(非场景推广)、deal=成交成本(场景推广)、dir_conv=直接成交成本、roi=投产比约束 | 元/次点击 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].constraint_value | String官方未标注必填 | 业务字段 constraint_value | 3 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].cold_boot | Number官方未标注必填 | 业务字段 cold_boot枚举:0=否、1=是 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].cold_boot_time | Date官方未标注必填 | 业务字段 cold_boot_time | 2023-06-11 23:56:23 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].cold_boot_stage | String官方未标注必填 | 业务字段 cold_boot_stage枚举:cold=冷启动期、mature=成熟期、acc_fail=冷启动失败、acc_success=冷启动成功、accelerate=加速中 | mature |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_discount | String官方未标注必填 | 业务字段 launch_period_discount | 100% |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_display_time | String官方未标注必填 | 业务字段 launch_period_display_time | 15:00-15:30 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time | CampaignLaunchTimeVO官方未标注必填含下级字段 | 时间对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time.start_time | Date官方未标注必填 | 查询或投放起始时间 | 2023-06-09 00:00:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time.end_time | Date官方未标注必填 | 查询或投放结束时间 | 2199-02-01 00:00:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time.launch_forever | Boolean官方未标注必填 | 业务字段 launch_forever枚举:true=是、false=否 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time.renewal_first_order_start_time | Date官方未标注必填 | 业务字段 renewal_first_order_start_time | 2023-06-09 00:00:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_time.renewal_first_order_end_time | Date官方未标注必填 | 业务字段 renewal_first_order_end_time | 2199-02-01 00:00:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_area_str_list | String []官方未标注必填 | 地域集合 | ["1","19"] 或者 ["all"] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_list | LaunchPeriodVO []官方未标注必填含下级字段 | 列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_list[].day_of_week | Number官方未标注必填 | 业务字段 day_of_week | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_list[].time_span_list | TimeSpanQueryResVO []官方未标注必填含下级字段 | 时间列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_list[].time_span_list[].time | String官方未标注必填 | 时间 | 00:00-24:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].launch_period_list[].time_span_list[].discount | Number官方未标注必填 | 出价溢价 | 100 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].crowd_filter_list | CampaignCrowdFilterVO []官方未标注必填含下级字段 | 人群列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].crowd_filter_list[].behavior | String官方未标注必填 | 业务字段 behavior枚举:purchase=购买人群、cart=加购人群、collection=收藏人群、arrival=进店人群 | shop_crowd |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].crowd_filter_list[].window | String官方未标注必填 | 业务字段 window枚举:7=7天、15=15天、30=30天、90=90天、180=180天、365=365天 | 7 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].brand_filter_list | CampaignBrandFilterVO []官方未标注必填含下级字段 | 列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].brand_filter_list[].brand_id | String官方未标注必填 | 业务对象标识 | 20067 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].brand_filter_list[].deeplink_list | String []官方未标注必填 | 业务条件集合枚举:Discover=Discover 发现、Engage=Engage 种草、Enthuse=Enthuse 互动、Perform=Perform 行动、Initial=Initial 首购、Numerous=Numerous 复购、Keen=Keen 至爱 | ["Engage"] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].deeplink_brand_list | DeeplinkBrandVO []官方未标注必填含下级字段 | 列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].deeplink_brand_list[].deeplink_brand_id | String官方未标注必填 | 业务对象标识 | 20067 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].deeplink_brand_list[].deeplink_brand_name | String官方未标注必填 | 业务字段 deeplink_brand_name | Lancome/兰蔻 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].gender_age_filter_list | CampaignGenderAgeFilterVO []官方未标注必填含下级字段 | 列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].gender_age_filter_list[].gender | String官方未标注必填 | 业务字段 gender枚举:man=男性人群、woman=女性人群 | man |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].gender_age_filter_list[].age_list | String []官方未标注必填 | 业务条件集合枚举:0=18岁以下、1=18-24岁、2=25-29岁、3=30-34岁、4=35-39岁、5=40-49岁、6=50岁以上 | [0, 1, 2, 3, 4, 5, 6] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].common_filter | String官方未标注必填 | 业务字段 common_filter | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].mini_detail | CampaignMiniDetailVO官方未标注必填含下级字段 | 业务对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].mini_detail.mini_detail_theme | String官方未标注必填 | 业务字段 mini_detail_theme枚举:1=默认主题、7=品牌定制主题、4=店铺主题、5=拉新主题、2=新品主题 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].mini_detail.private_mini_item_id_list | Number []官方未标注必填 | 商品标识集合 | [714707465203, 714901906337] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].mini_detail.private_mini_top_item_id_list | Number []官方未标注必填 | 商品标识集合 | [714707465203] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].mini_detail.private_mini_type | Number官方未标注必填 | 业务字段 private_mini_type枚举:0=黑名单、1=白名单 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].item_selected_mode | String官方未标注必填 | 业务字段 item_selected_mode枚举:shop=全店优选、user_define=用户自定义选品、scope=范围圈选、trend=趋势选品 | shop |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].shop_item_type | String官方未标注必填 | 店铺商品类型枚举:effect=效果优选、growing=全店成长、activity=活动选品、industry=行业尖货、scope=定义选品 | effect |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].shield_items | Number []官方未标注必填 | 业务字段 shield_items | [714707465203, 714901906337] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].scope_items | Number []官方未标注必填 | 业务字段 scope_items | [714707465203, 714901906337] |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list | AdgroupVO []官方未标注必填含下级字段 | 单元列表 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].gmt_create | Date官方未标注必填 | 业务字段 gmt_create | 2023-12-09 14:34:12 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].gmt_modified | Date官方未标注必填 | 业务字段 gmt_modified | 2023-12-09 14:34:12 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].campaign_id | Number官方未标注必填 | 推广计划编号计划已经存在场景必填 | 68796878069 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].campaign_name | String官方未标注必填 | 推广计划名称 | 管家计划_宝贝候选集 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_id | Number官方未标注必填 | 推广单元编号 | 68793666608 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_name | String官方未标注必填 | 推广单元名称 | ds460418344 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].online_status | Number官方未标注必填 | 投放上下线状态枚举:-1=未进入投放状态、0=用户设置状态-下线、1=用户设置状态-上线、2=合同未生效、9=投放结束、105=待支付 | 0 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].display_status | String官方未标注必填 | 推广展示状态枚举:pause=暂停推广、start=正在推广、terminate=结束推广、wait=等待推广、pending=准备推广、wait_pay=计划未付款 | pause |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].audit_status | Number官方未标注必填 | 业务字段 audit_status枚举:-1=待审核、0=后台下线状态、1=后台上线状态 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].audit_reason | String官方未标注必填 | 业务字段 audit_reason | xxxxx |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc | AdgroupOcpcVO官方未标注必填含下级字段 | 单元对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.enable_ocpc | Boolean官方未标注必填 | 业务字段 enable_ocpc枚举:false=否、true=是 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.ocpc_ratio | Number官方未标注必填 | 业务字段 ocpc_ratio | 200 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.ocpc_marketing_aim | String官方未标注必填 | 业务字段 ocpc_marketing_aim | click |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.ocpc_status | String官方未标注必填 | 业务字段 ocpc_status枚举:new_ad_openable=可开启新广告加速、new_item_openable=可开启新品冷启动、new_ad_speeding=新广告加速加速中、new_item_speeding=新品冷启动加速中、new_ad_complete=新广告加速加速完成、new_item_complete=新品冷启动加速完成 | new_ad_complete |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.enable_cold_speed_new_item | Boolean官方未标注必填 | 业务字段 enable_cold_speed_new_item枚举:true=是、false=否 | false |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].adgroup_ocpc.ecpc_option | Number官方未标注必填 | 业务字段 ecpc_option | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].promotion_type | String官方未标注必填 | 业务字段 promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、content=内容、short_video=短视频、user_define=自定义 | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].sub_promotion_type | String官方未标注必填 | 业务字段 sub_promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、you_hao_huo=有好货、picture=图文、short_video=短视频、live_room=直播间、live_spot=看点、tao_blocks=淘积木、user_define_url=自定义url | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material | CommonMaterialVO官方未标注必填含下级字段 | 素材 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.material_id | Number官方未标注必填 | 素材标识 | 714616513841 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.material_type | Number官方未标注必填 | 素材类型枚举: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=内容平台-订阅内容 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.material_name | String官方未标注必填 | 素材名称 | yiliantest测试请不要拍22 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.title | String官方未标注必填 | 展示标题 | yiliantest测试请不要拍22 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.img_url | String官方未标注必填 | 业务字段 img_url | //img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.link_url | String官方未标注必填 | 业务字段 link_url | http://item.taobao.com/item.htm?id=715121254343 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.price | String官方未标注必填 | 金额 | 999900 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.bid_count | Number官方未标注必填 | 出价数量 | 899900 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.quantity | Number官方未标注必填 | 业务字段 quantity | 10 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.first_starts_time | Date官方未标注必填 | 业务字段 first_starts_time | 2023-04-26 14:51:03 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.starts | Date官方未标注必填 | 业务字段 starts | 2023-04-26 14:51:03 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.category_id | String官方未标注必填 | 业务对象标识 | 16 50010850 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.promotion_type | String官方未标注必填 | 业务字段 promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、content=内容、short_video=短视频、user_define=自定义 | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.sub_promotion_type | String官方未标注必填 | 业务字段 sub_promotion_type枚举:item=商品、item_private_mini=独享橱窗、shop=店铺、you_hao_huo=有好货、picture=图文、short_video=短视频、live_room=直播间、live_spot=看点、tao_blocks=淘积木、user_define_url=自定义url | item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_list | ItemLifeCycleViewVO []官方未标注必填含下级字段 | 列表集合列表中最多有2个元素 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_list[].life_cycle_desc | String官方未标注必填 | 业务字段 life_cycle_desc | 新品打爆期 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_list[].color | String官方未标注必填 | 业务字段 color | #36A2FC |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_list[].tips | String官方未标注必填 | 业务字段 tips | 近30日GMV排名在叶子类目5%以内的新品 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_list[].type | Number官方未标注必填 | 类型 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_days | Number官方未标注必填 | 业务字段 life_cycle_days | 3 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_diff_with_avg | String官方未标注必填 | 业务字段 life_cycle_diff_with_avg | 较慢 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.life_cycle_diff_with_avg_tips | String官方未标注必填 | 业务字段 life_cycle_diff_with_avg_tips | 快于同类目商品经历过同样阶段变化所用时间 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.grow_desc | String官方未标注必填 | 业务字段 grow_desc | 日均再成交122.55元 可提高爆品类目排名卡位 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].material.grow_rank | Number官方未标注必填 | 业务字段 grow_rank | 1077 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].alive_group_id | Number官方未标注必填 | 业务对象标识枚举:0=宝贝链接、3=订阅店铺、5=直播、6=加购、7=收藏加购、8=入会有礼、12=关注有礼、11=直播联动、10=自定义模板、13=同店搜 | 0 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].alive_group_name | String官方未标注必填 | 业务字段 alive_group_name | 宝贝链接(默认) |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].black_creative_status | String官方未标注必填 | 业务字段 black_creative_status枚举:success=合成成功、fail=合成失败 | success |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].spot_list | SpotVO []官方未标注必填含下级字段 | 列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].spot_list[].spot_id | Number官方未标注必填 | 业务对象标识 | 3 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].spot_list[].material_name | String官方未标注必填 | 素材名称 | xxxxx |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].adgroup_list[].report_info_map | String官方未标注必填 | 业务字段 report_info_map | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].report_info_map | String官方未标注必填 | 业务字段 report_info_map | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].need_target_crowd | Number官方未标注必填 | 业务字段 need_target_crowd | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].more_campaign_switch | Boolean官方未标注必填 | 业务字段 more_campaign_switch | false |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].crowd_custom_type | Boolean官方未标注必填 | 业务字段 crowd_custom_type | false |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].crowd_extend_type | String官方未标注必填 | 业务字段 crowd_extend_type | auto |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].origin_secondary_scene | String官方未标注必填 | 业务字段 origin_secondary_scene | promotion_scene_item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].scene_id | Number官方未标注必填 | 业务对象标识 | promotion_scene_item |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].is_xinxiang | Boolean官方未标注必填 | 业务字段 is_xinxiang | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].is_guarantee | Boolean官方未标注必填 | 业务字段 is_guarantee | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].bid_type_v2 | String官方未标注必填 | 业务字段 bid_type_v2 | smart_bid |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].bid_target_v2 | String官方未标注必填 | 业务字段 bid_target_v2 | conv |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].set_single_cost_v2 | Boolean官方未标注必填 | 业务字段 set_single_cost_v2 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].shield_words | String []官方未标注必填 | 业务字段 shield_words | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_budget_list | CampaignPeriodBudgetVO []官方未标注必填含下级字段 | 预算列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_budget_list[].day_of_week | Number官方未标注必填 | 业务字段 day_of_week | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_budget_list[].time_span_list | TimeSpanVO []官方未标注必填含下级字段 | 时间列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_budget_list[].time_span_list[].discount | Number官方未标注必填 | 出价溢价 | 100 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].period_budget_list[].time_span_list[].time | String官方未标注必填 | 时间 | 00:00-24:00 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_budget_command | CampaignQuickLiftCommandVO官方未标注必填含下级字段 | 预算操作对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_budget_command.quick_lift_switch | Boolean官方未标注必填 | 业务字段 quick_lift_switch枚举:true=打开、false=关闭 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_budget_command.quick_lift_budget | String官方未标注必填 | 业务字段 quick_lift_budget | 50 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_budget_command.quick_lift_time_slot | String官方未标注必填 | 业务字段 quick_lift_time_slot | 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_budget_command.quick_lift_launch_area_list | String []官方未标注必填 | 地域集合 | all |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].quick_lift_switch | Boolean官方未标注必填 | 业务字段 quick_lift_switch枚举:true=打开、false=关闭 | true |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].multi_target | CampaignMultiTargetVO官方未标注必填含下级字段 | 目标对象 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].multi_target.multi_target_switch | Number官方未标注必填 | 业务字段 multi_target_switch枚举:0=关闭、1=开启 | 1 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].multi_target.multi_target_config_list | CampaignMultiTargetConfigVO []官方未标注必填含下级字段 | 目标列表集合 | — |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].multi_target.multi_target_config_list[].optimize_target | String官方未标注必填 | 优化目标 | 1034 |
top_result.campaign_v_o_top_bulk_data.campaign_v_o_list[].multi_target.multi_target_config_list[].multi_target_budget | String官方未标注必填 | 业务字段 multi_target_budget | 1000 |
字段核对说明
- 官方响应示例没有可核实的 JSON 外层对象,未推测 wirePath。
- 部分响应字段未出现在官方 JSON 示例中;wirePath 为 null 时请依实际返回核对。
Python 签名直连示例
下载 qimenyun_direct.py 与业务脚本放在同一目录,保留淘宝业务参数,使用奇门云密钥和 shopKey 申请签名,由客户服务器直接请求淘宝。运行前补全业务参数,无需自行计算平台签名。
# Python 3.9+,无需安装第三方依赖。
# 先下载 https://api.miandanni.com/examples/qimenyun_direct.py 放在本文件同一目录。
# 先申请签名,再由本程序直接请求淘宝;业务数据直接返回客户服务器。
import json
from getpass import getpass
from qimenyun_direct import Client, CallError, check_result
api_key = getpass("请输入奇门云密钥:").strip()
config = {"mode": "direct", "apiKey": api_key, "services": {"wanxiang": {"signEndpoint": "https://api.miandanni.com/api/wanxiang/sign"}}}
client = Client(config)
body = json.loads("{\"shopKey\":\"填写你授权店铺的 shopKey\",\"method\":\"taobao.universalbp.new.campaign.findpage\",\"params\":{\"top_service_context\":{\"biz_code\":\"onebpSite\",\"login_type\":1,\"ext\":\"{}\"},\"campaign_query_v_o\":{\"offset\":0,\"page_size\":20,\"adgroup_required\":true}}}")
body["shopKey"] = input("请输入自己的 shopKey:").strip()
try:
result = client.call("wanxiang", body)
print(client.display(result))
check_result(result)
except CallError as exc:
print(client.display(exc.payload))
raise SystemExit(str(exc)) from None
# 不自动重试。写操作超时或结果未知时,先查询实际状态。
判断成功与失败
签名阶段先检查 HTTP 状态;本站鉴权、套餐或授权失败返回 {ok:false,error:{code,message}}。签名 HTTP 200 仅说明已签发;客户端执行官方请求后,还要检查淘宝响应的 error_response、逐项错误和 top_result.info.ok;失败不能当成空列表。
执行阶段的淘宝原始 error_response、业务 info 和 request_id 直接返回客户服务器,不由奇门云统一包装。签名和授权由本站管理,业务参数、日期、分页及平台资格按淘宝原始错误排查。
error_response:TOP 网关错误;应读取错误码及细分错误码,不能按空结果处理。top_result.info:HTTP 成功仍须核对业务 ok;false 表示业务未完成。
下载本页 MD 可交给开发人员或 AI,密钥只填在自己的私密配置中。