文档中心 > API类目 > 阿里妈妈-UniDesk

taobao.unidesk.rta.ad.creative.program.add (UD创意创建程序化创意接口)

UD创意创建程序化创意接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request_id String 可选 1 请求id,用于幂等唯一key,新建创意建议填写 本接口需向媒体侧提交任务耗时较长,因TOPAPI 5秒超时限制,可能会在任务执行中提示“超时”/“远程服务调用超时”/“重复请求”等报错,此时可以用相同的request_id进行幂等重试即可返回最新结果
creative_group_top_dto CreativeGroupTopDTO 必须 入参
  • creatives
  • CreativeTopDTO []
  • 必须
  • list
  • 创意内容
  • └ format
  • Number
  • 必须
  • 1
  • 广告形式,1:竖版视频,2:横版视频,3:大图横图,5:小图,6:大图竖图。竖版视频:格式要求:mp4、mpeg、3gp、avi 视频格式,建议尺寸要求:宽高比9:16,分辨率≥ 720*1280,视频码率≥516kbps,时长≥4s; 竖版视频-视频封面:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比9:16,1440*2560 ≤ 尺寸≥ 720*1280; 横版视频:格式要求:mp4、mpeg、3gp、avi 视频格式,建议尺寸要求:宽高比16:9,分辨率≥ 1280*720,视频码率≥516kbps,时长≥4s,大小≤1000M; 横版视频-视频封面:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比16:9,2560*1440 ≤ 尺寸≥ 1280*720; 大图横图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比16:9,2560*1440 ≤ 尺寸≥ 1280*720; 组图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比1.52,1368*900 ≤ 尺寸≥ 456*300; 小图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比1.52,1368*900 ≤ 尺寸≥ 456*300; 大图竖图:格式要求:jpg、jpeg、png 图片格式,尺寸要求:宽高比9:16,1440*2560 ≤ 尺寸≥ 720*1280;
  • └ img_ids
  • String []
  • 可选
  • 1
  • 图片素材id列表(组图存在多个)
  • └ video_id
  • String
  • 可选
  • 1
  • 视频素材id
  • └ video_cover_img_id
  • String
  • 可选
  • 视频素材封面id
  • 视频素材封面id
  • └ adgroup_id
  • Number
  • 可选
  • 1
  • 计划id
  • └ action_text
  • String
  • 可选
  • 行动号召文本
  • 行动号召文本
  • └ campaign_id
  • Number
  • 必须
  • 1
  • 计划组id
  • └ titles
  • String []
  • 可选
  • 1
  • 创意标题
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ tags
  • String []
  • 可选
  • 1
  • 创意标签
  • └ category
  • Number
  • 可选
  • 1
  • 创意分类
  • tencent
  • TencentCreativeGroupTopDTO
  • 可选
  • 腾讯特有参数,腾讯程序化创意创建步骤:1、创建campaign 2、创建带有adgroup参数的creative
  • └ ad_source
  • String
  • 可选
  • name
  • 品牌名称
  • └ description_options
  • String []
  • 可选
  • description
  • 创意描述
  • └ button_text
  • String
  • 可选
  • text
  • 按钮文案
  • └ name
  • String
  • 可选
  • name
  • 创意名称
  • └ item_id
  • String
  • 可选
  • 1
  • 商品id
  • └ content_type
  • Number
  • 可选
  • 1
  • 落地页推广内容:1:单品推广,2:店铺/活动等其他推广
  • └ profile_id
  • Number
  • 可选
  • 1
  • 用户头像id
  • countdown
  • CreativeCountDownTopDTO
  • 可选
  • 倒计时组件
  • └ start_time
  • String
  • 可选
  • 2023-01-01
  • 起始时间
  • └ end_time
  • String
  • 可选
  • 2023-01-01
  • 结束时间
  • └ price
  • String
  • 可选
  • 1
  • 倒计时价格展示
  • └ landing_page_id
  • Number
  • 可选
  • 1
  • 落地页id
  • └ auto_open_url
  • Number
  • 可选
  • 0
  • 是否自动生成应用直达链接:0,1
  • └ landing_page
  • String
  • 可选
  • www.taobao.com
  • 落地页链接
  • adgroup
  • AdgroupTopDTO
  • 可选
  • 计划信息,用于程序化创意的创建
  • └ smooth
  • Number
  • 可选
  • 1
  • 投放, 1 - 加速投放;2 - 平滑投放;3-优先低成本(投放时间范围只可为全天;预算不可为不限或空)
  • budget
  • BudgetTopDTO
  • 可选
  • 预算
  • └ budget_type
  • Number
  • 可选
  • 1
  • 预算类型 -1:不限、1:指定预算(每天预算相同)
  • └ budget
  • Number
  • 可选
  • 1
  • 统一预算金额,单位:分
  • └ campaign_id
  • Number
  • 可选
  • 1
  • 计划组id
  • target
  • AdgroupTargetTopDTO
  • 可选
  • 定向,未特殊标明的不传字段的值表示不限
  • area
  • AreaDTO
  • 可选
  • 地域定向
  • city
  • CommonDTO []
  • 可选
  • list
  • 地域信息
  • └ name
  • String
  • 可选
  • 北京
  • 地域名称
  • └ value
  • String
  • 可选
  • 1
  • 地域值
  • └ city_target
  • Number
  • 可选
  • 1
  • 城市目标人群,1:正在该地区的用户,2:居住在该地区的用户,3:到该地区旅行的用户,4:该地区内的所有用户
  • └ type
  • Number
  • 可选
  • 1
  • 地域定向类型,-1:不限,1:指定地区
  • └ hide_if_converted
  • Number
  • 可选
  • 1
  • 过滤已转化用户,0(默认):不限;2:同计划广告;3:同账户广告
  • └ gender
  • Number
  • 可选
  • 1
  • 性别,-1:不限,1:女,2:男
  • age
  • AgeDTO
  • 可选
  • 年龄
  • └ custom_age
  • String []
  • 可选
  • [18,30]
  • 自定义年龄段:[min,max]
  • └ type
  • Number
  • 可选
  • 1
  • -1:不限,2:自定义年龄段
  • └ network
  • String []
  • 可选
  • 1
  • 网络,-1:不限,0:Wi-Fi,2:2G,3:3G,4:4G
  • cast_time
  • CastTimeTopDTO
  • 可选
  • 投放周期
  • └ time_series
  • String
  • 可选
  • 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111
  • 时段,24*7 位 0 或 1 组成的字符串,小时粒度; 从 周一 0 点开始到周日 24 点结束,0 不投放,1 投放; 禁止全部为 0,不传或者全部为 1,表示全时段投放
  • └ time_type
  • Number
  • 可选
  • 1
  • 投放周期类型,0:从今天起长期投放,1:设置开始和结束日期
  • └ start_time
  • Date
  • 可选
  • 2022-08-25 00:00:00
  • 投放周期,开始时间 time_type=1时必填
  • └ end_time
  • Date
  • 可选
  • 2022-08-25 00:00:00
  • 投放周期,结束时间 time_type=1时必填
  • └ name
  • String
  • 可选
  • name
  • 计划名称
  • pricing
  • AdgroupPricingTopDTO
  • 可选
  • 付费出价
  • └ cast_target
  • Number
  • 可选
  • 1
  • 投放目标,1:转化量
  • └ convert_target
  • Number
  • 可选
  • 1
  • 深转账户传到达,引流账户传表单提交 转化目标,1:到达,5:表单提交
  • └ bid
  • Number
  • 可选
  • 1
  • 基础出价,单位:分
  • └ cpa_bid
  • Number
  • 可选
  • 1
  • 字段已下线 转化目标出价,单位:分
  • └ pricing_type
  • Number
  • 可选
  • 1
  • 付费方式,2:CPM,3:CPC,5:OCPM
  • └ bid_type
  • Number
  • 可选
  • 1
  • 出价方式:1:自动,2:手动
  • └ adjust_cpa
  • Number
  • 可选
  • 1
  • 字段已下线 是否调整自动出价,1:是,0:否
  • tencent
  • TencentAdgroupTopDTO
  • 可选
  • 腾讯特有参数
  • └ cast_scopes
  • String []
  • 可选
  • 1
  • 投放范围类型:1:优量汇,2:微信公众号与小程序,3:腾讯新闻,4:腾讯视频,5:腾讯看点,6:QQ、腾讯音乐及游戏,8:微信朋友圈
  • └ creative_group_display_type
  • Number
  • 可选
  • 1
  • 创意展现方式:1:优选模式,2轮播模式
  • └ derive_switch
  • Number
  • 可选
  • 1
  • 是否开启衍生创意功能:1:是,0:否
  • └ dp_link_url
  • String
  • 可选
  • tbopen://m.taobao.com/tbopen
  • 自定义deeplink,需要UDBP开通白名单功能才能使用
  • kuaishou
  • KuaishouCreativeGroupTopDTO
  • 可选
  • 快手特有参数
  • └ sticker_styles
  • String []
  • 可选
  • 1
  • 封面贴纸id,通过封面贴纸查询接口获取
  • └ sticker_titles
  • String []
  • 可选
  • 封面广告语
  • 封面广告语
  • └ creative_component_id
  • Number
  • 可选
  • 1
  • 创意组件,投放范围是快手默认时必填
  • └ name
  • String
  • 可选
  • 创意名称
  • 创意名称

响应参数

名称 类型 示例值 描述
result CreativeGroupTopDTO 返回结果
  • └ id
  • Number
  • 1
  • 创意组id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCreativeProgramAddRequest req = new UnideskRtaAdCreativeProgramAddRequest();
req.setRequestId("1");
UnideskRtaAdCreativeProgramAddRequest.CreativeGroupTopDTO obj1 = new UnideskRtaAdCreativeProgramAddRequest.CreativeGroupTopDTO();
List<UnideskRtaAdCreativeProgramAddRequest.CreativeTopDTO> list3 = new ArrayList<UnideskRtaAdCreativeProgramAddRequest.CreativeTopDTO>();
UnideskRtaAdCreativeProgramAddRequest.CreativeTopDTO obj4 = new UnideskRtaAdCreativeProgramAddRequest.CreativeTopDTO();
list3.add(obj4);
obj4.setFormat(1L);
obj4.setImgIds("1");
obj4.setVideoId("1");
obj4.setVideoCoverImgId("视频素材封面id");
obj1.setCreatives(list3);
obj1.setAdgroupId(1L);
obj1.setActionText("行动号召文本");
obj1.setCampaignId(1L);
obj1.setTitles("1");
obj1.setAdvertiserId(1L);
obj1.setTags("1");
obj1.setCategory(1L);
UnideskRtaAdCreativeProgramAddRequest.TencentCreativeGroupTopDTO obj5 = new UnideskRtaAdCreativeProgramAddRequest.TencentCreativeGroupTopDTO();
obj5.setAdSource("name");
obj5.setDescriptionOptions("description");
obj5.setButtonText("text");
obj5.setName("name");
obj5.setItemId("1");
obj5.setContentType(1L);
obj5.setProfileId(1L);
UnideskRtaAdCreativeProgramAddRequest.CreativeCountDownTopDTO obj6 = new UnideskRtaAdCreativeProgramAddRequest.CreativeCountDownTopDTO();
obj6.setStartTime("2023-01-01");
obj6.setEndTime("2023-01-01");
obj6.setPrice("1");
obj5.setCountdown(obj6);
obj5.setLandingPageId(1L);
obj5.setAutoOpenUrl(0L);
obj5.setLandingPage("www.taobao.com");
UnideskRtaAdCreativeProgramAddRequest.AdgroupTopDTO obj7 = new UnideskRtaAdCreativeProgramAddRequest.AdgroupTopDTO();
obj7.setSmooth(1L);
UnideskRtaAdCreativeProgramAddRequest.BudgetTopDTO obj8 = new UnideskRtaAdCreativeProgramAddRequest.BudgetTopDTO();
obj8.setBudgetType(1L);
obj8.setBudget(1L);
obj7.setBudget(obj8);
obj7.setCampaignId(1L);
UnideskRtaAdCreativeProgramAddRequest.AdgroupTargetTopDTO obj9 = new UnideskRtaAdCreativeProgramAddRequest.AdgroupTargetTopDTO();
UnideskRtaAdCreativeProgramAddRequest.AreaDTO obj10 = new UnideskRtaAdCreativeProgramAddRequest.AreaDTO();
List<UnideskRtaAdCreativeProgramAddRequest.CommonDTO> list12 = new ArrayList<UnideskRtaAdCreativeProgramAddRequest.CommonDTO>();
UnideskRtaAdCreativeProgramAddRequest.CommonDTO obj13 = new UnideskRtaAdCreativeProgramAddRequest.CommonDTO();
list12.add(obj13);
obj13.setName("北京");
obj13.setValue("1");
obj10.setCity(list12);
obj10.setCityTarget(1L);
obj10.setType(1L);
obj9.setArea(obj10);
obj9.setHideIfConverted(1L);
obj9.setGender(1L);
UnideskRtaAdCreativeProgramAddRequest.AgeDTO obj14 = new UnideskRtaAdCreativeProgramAddRequest.AgeDTO();
obj14.setCustomAge("18,30");
obj14.setType(1L);
obj9.setAge(obj14);
obj9.setNetwork("1");
obj7.setTarget(obj9);
UnideskRtaAdCreativeProgramAddRequest.CastTimeTopDTO obj15 = new UnideskRtaAdCreativeProgramAddRequest.CastTimeTopDTO();
obj15.setTimeSeries("111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111");
obj15.setTimeType(1L);
obj15.setStartTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj15.setEndTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj7.setCastTime(obj15);
obj7.setName("name");
UnideskRtaAdCreativeProgramAddRequest.AdgroupPricingTopDTO obj16 = new UnideskRtaAdCreativeProgramAddRequest.AdgroupPricingTopDTO();
obj16.setCastTarget(1L);
obj16.setConvertTarget(1L);
obj16.setBid(1L);
obj16.setCpaBid(1L);
obj16.setPricingType(1L);
obj16.setBidType(1L);
obj16.setAdjustCpa(1L);
obj7.setPricing(obj16);
UnideskRtaAdCreativeProgramAddRequest.TencentAdgroupTopDTO obj17 = new UnideskRtaAdCreativeProgramAddRequest.TencentAdgroupTopDTO();
obj17.setCastScopes("1");
obj17.setCreativeGroupDisplayType(1L);
obj17.setDeriveSwitch(1L);
obj7.setTencent(obj17);
obj5.setAdgroup(obj7);
obj5.setDpLinkUrl("tbopen://m.taobao.com/tbopen");
obj1.setTencent(obj5);
UnideskRtaAdCreativeProgramAddRequest.KuaishouCreativeGroupTopDTO obj18 = new UnideskRtaAdCreativeProgramAddRequest.KuaishouCreativeGroupTopDTO();
obj18.setStickerStyles("1");
obj18.setStickerTitles("封面广告语");
obj18.setCreativeComponentId(1L);
obj18.setName("创意名称");
obj1.setKuaishou(obj18);
req.setCreativeGroupTopDto(obj1);
UnideskRtaAdCreativeProgramAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_creative_program_add_response>
    <result>
    </result>
</unidesk_rta_ad_creative_program_add_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

返回
顶部