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

taobao.universalbp.creative.findrequire (创建创意必要信息接口)

入参计划和单元设置信息,获取绑定创意时必须的信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
creative_require_query_v_o CreativeRequireQueryVo 必须 creativeRequireQueryVO
  • └ creative_set_mode
  • String
  • 可选
  • professional
  • 创意设置方式,minimalist:极简版,professional:专业版
  • └ creative_optimization
  • String
  • 可选
  • professional
  • 打底创意选项,black_creative:黑盒优先,white_creative:宝贝主图,user_defined_only:仅用户自定义
  • └ main_pic_video
  • String
  • 可选
  • 1
  • 主图视频开关,1:开,0:关
  • └ 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
  • └ campaign_id
  • Number
  • 可选
  • 68796878069
  • 计划id,计划已经存在场景必填,eg:添加主体、编辑计划状态等场景
  • adgroup_list
  • AdgroupVo []
  • 可选
  • 单元计划
  • └ 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溢价比例
  • └ 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
  • 可选
  • 主体类型对应的物料信息
  • └ 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
  • └ 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:合成失败
  • adzone_list
  • AdzoneVo []
  • 可选
  • 资源包集合
  • └ adzone_id
  • Number
  • 可选
  • 111287850198
  • 资源包id
  • └ adzone_name
  • String
  • 可选
  • 全屏微详情
  • 资源包名字
  • └ description
  • String
  • 可选
  • 首页及购中后的全屏微详情场景
  • 描述
  • └ img_url
  • String
  • 可选
  • https://img.alicdn.com/imgextra/i2/O1CN01PL50aZ1HTD0KEFMEq_!!6000000000758-2-tps-750-1624.png
  • 预览图片地址
  • └ 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)
  • └ 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:旺旺留资
  • └ item_selected_mode
  • String
  • 可选
  • shop
  • 选品方式,shop:全店优选,user_define:用户自定义选品,scope:范围圈选,trend:趋势选品
  • └ auto_wang_wang_picture
  • String
  • 可选
  • 1
  • 智能旺旺创意,1:开,0:关

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • creative_require_v_o
  • CreativeRequireVo
  • 结果集
  • └ is_special_category
  • Boolean
  • true
  • 是否特殊类目,true:是,false:否
  • └ has_mini_detail_video
  • Boolean
  • true
  • 是否有主图视频,true:是,false:否
  • └ creative_add_operators
  • String []
  • ['video']
  • 创意添加途径,video:视频创意,creativeCool:创意库,local:图片,template:模板创意
  • └ has_item_picture
  • Boolean
  • true
  • 是否有主副图素材,true:是,false:否
  • material_info_list
  • CreativeMaterialInfoVo []
  • 创意物料信息
  • └ material_id
  • Number
  • 714616513841
  • 物料id
  • └ is_active_item
  • Boolean
  • false
  • 是不是大促商品,true:是,false:否
  • └ is_special_category
  • Boolean
  • false
  • 是否特殊类目,true:是,false:否
  • └ has_mini_detail_video
  • Boolean
  • false
  • 是否有主图视频,true:是,false:否
  • └ mini_detail_video_id
  • Number
  • 398436114008
  • 主图视频id
  • └ has_item_picture
  • Boolean
  • true
  • 是否有主副图素材,true:是,false:否
  • └ has_auto_creative
  • Boolean
  • true
  • 是否有智能创意,true:是,false:否
  • material_image_info_list
  • MaterialImageInfoVo []
  • 物料图片信息
  • └ material_id
  • Number
  • 714616513841
  • 物料id
  • └ image_position
  • Number
  • 0
  • 主副图图片位置,主图0,副图从1开始
  • └ img_url
  • String
  • https://img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg
  • 图片链接
  • └ link_url
  • String
  • http://item.taobao.com/item.htm?id=668800719012
  • 物料链接
  • └ material_name
  • String
  • 外投宝贝测试,请不要拍
  • 物料名称
  • creative_form_infos
  • CreativeFormInfoVo []
  • 创意形式信息
  • └ type
  • String
  • 103
  • tab类型,101:竖版大图800x1200,102:竖版视频800x1200,103:竖版长图513x750,104:竖版视频512x750,105:竖版模板513x750,113:方图800x800,114:方视频800x800,115:横版大图320x90,116:横版大图240x100,117:横版大图140x120,118:横版大图730x350,119:横版大图846x220,120:横版大图780x210,121:横版大图840x90,122:横版大图180x100,124:横版大图980x200,125:横版大图820x90,126:竖版视频750x1000,127:竖版视频720x960,128:竖版视频1080x1440,129:竖版视频720x1280,130:竖版视频1080x1920
  • └ text
  • String
  • 513x750
  • 前端用 文案1
  • └ desc_info
  • String
  • 竖版模板
  • 前端用 文案2
  • └ creative_add_operators
  • String []
  • ['video']
  • 创意添加途径,video:视频创意,creativeCool:创意库,local:图片,template:模板创意
  • └ template_id
  • Number
  • 202396
  • 模板id,场景推广使用,创建创意时候写到创意上面
  • └ num_limit
  • Number
  • 12
  • 数量上限
  • └ current_creative_num
  • Number
  • 10
  • 当前计划下的创意数量
  • └ icon
  • String
  • xxxxx
  • 创意图标
  • └ content
  • String
  • xxxxx
  • 底部文案

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpCreativeFindrequireRequest req = new UniversalbpCreativeFindrequireRequest();
UniversalbpCreativeFindrequireRequest.TopServiceContext obj1 = new UniversalbpCreativeFindrequireRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpCreativeFindrequireRequest.CreativeRequireQueryVo obj2 = new UniversalbpCreativeFindrequireRequest.CreativeRequireQueryVo();
obj2.setCreativeSetMode("professional");
obj2.setCreativeOptimization("professional");
obj2.setMainPicVideo("1");
obj2.setPromotionType("item");
obj2.setSubPromotionType("item");
obj2.setCampaignId(68796878069L);
List<UniversalbpCreativeFindrequireRequest.AdgroupVo> list4 = new ArrayList<UniversalbpCreativeFindrequireRequest.AdgroupVo>();
UniversalbpCreativeFindrequireRequest.AdgroupVo obj5 = new UniversalbpCreativeFindrequireRequest.AdgroupVo();
list4.add(obj5);
obj5.setCampaignId(68796878069L);
obj5.setCampaignName("管家计划_宝贝候选集");
obj5.setAdgroupId(68793666608L);
obj5.setAdgroupName("ds460418344");
obj5.setOnlineStatus(0L);
obj5.setDisplayStatus("pause");
obj5.setAuditStatus(1L);
obj5.setAuditReason("xxxxx");
UniversalbpCreativeFindrequireRequest.AdgroupOcpcVo obj7 = new UniversalbpCreativeFindrequireRequest.AdgroupOcpcVo();
obj7.setEnableOcpc(true);
obj7.setOcpcRatio(200L);
list6.setAdgroupOcpc(obj7);
obj5.setPromotionType("item");
obj5.setSubPromotionType("item");
UniversalbpCreativeFindrequireRequest.CommonMaterialVo obj9 = new UniversalbpCreativeFindrequireRequest.CommonMaterialVo();
obj9.setMaterialId(714616513841L);
obj9.setMaterialType(1L);
obj9.setMaterialName("yiliantest测试请不要拍22");
obj9.setTitle("yiliantest测试请不要拍22");
obj9.setImgUrl("//img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg");
obj9.setLinkUrl("http://item.taobao.com/item.htm?id=715121254343");
obj9.setPrice("999900");
obj9.setBidCount(899900L);
obj9.setQuantity(10L);
obj9.setFirstStartsTime(StringUtils.parseDateTime("2023-04-26 14:51:03"));
obj9.setStarts(StringUtils.parseDateTime("2023-04-26 14:51:03"));
obj9.setCategoryId("16 50010850");
obj9.setPromotionType("item");
obj9.setSubPromotionType("item");
list8.setMaterial(obj9);
obj5.setAliveGroupId(0L);
obj5.setAliveGroupName("宝贝链接(默认)");
obj5.setBlackCreativeStatus("success");
obj2.setAdgroupList(list4);
List<UniversalbpCreativeFindrequireRequest.AdzoneVo> list11 = new ArrayList<UniversalbpCreativeFindrequireRequest.AdzoneVo>();
UniversalbpCreativeFindrequireRequest.AdzoneVo obj12 = new UniversalbpCreativeFindrequireRequest.AdzoneVo();
list11.add(obj12);
obj12.setAdzoneId(111287850198L);
obj12.setAdzoneName("全屏微详情");
obj12.setDescription("首页及购中后的全屏微详情场景");
obj12.setImgUrl("https://img.alicdn.com/imgextra/i2/O1CN01PL50aZ1HTD0KEFMEq_!!6000000000758-2-tps-750-1624.png");
obj2.setAdzoneList(list11);
obj2.setPromotionScene("promotion_scene_crowd");
obj2.setOptimizeTarget("conv");
obj2.setItemSelectedMode("shop");
obj2.setAutoWangWangPicture("1");
req.setCreativeRequireQueryVO(obj2);
UniversalbpCreativeFindrequireResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_creative_findrequire_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <creative_require_v_o>
            <is_special_category>true</is_special_category>
            <has_mini_detail_video>true</has_mini_detail_video>
            <creative_add_operators>
                <string>[&apos;video&apos;]</string>
            </creative_add_operators>
            <has_item_picture>true</has_item_picture>
            <material_info_list>
                <creative_material_info_vo>
                    <material_id>714616513841</material_id>
                    <is_active_item>false</is_active_item>
                    <is_special_category>false</is_special_category>
                    <has_mini_detail_video>false</has_mini_detail_video>
                    <mini_detail_video_id>398436114008</mini_detail_video_id>
                    <has_item_picture>true</has_item_picture>
                    <has_auto_creative>true</has_auto_creative>
                    <material_image_info_list>
                        <material_image_info_vo>
                            <material_id>714616513841</material_id>
                            <image_position>0</image_position>
                            <img_url>https://img.alicdn.com/bao/uploaded/i1/3838159498/O1CN013BTEpu2K28f5CkcgG_!!3838159498.jpg</img_url>
                            <link_url>http://item.taobao.com/item.htm?id=668800719012</link_url>
                            <material_name>外投宝贝测试,请不要拍</material_name>
                        </material_image_info_vo>
                    </material_image_info_list>
                </creative_material_info_vo>
            </material_info_list>
            <creative_form_infos>
                <creative_form_info_vo>
                    <type>103</type>
                    <text>513x750</text>
                    <desc_info>竖版模板</desc_info>
                    <creative_add_operators>
                        <string>[&apos;video&apos;]</string>
                    </creative_add_operators>
                    <template_id>202396</template_id>
                    <num_limit>12</num_limit>
                    <current_creative_num>10</current_creative_num>
                    <icon>xxxxx</icon>
                    <content>xxxxx</content>
                </creative_form_info_vo>
            </creative_form_infos>
        </creative_require_v_o>
    </result>
</universalbp_creative_findrequire_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

FAQ

返回
顶部