淘宝开放平台

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

阿里妈妈-UniDesk

taobao.unidesk.rta.ad.campaign.add (UD计划组创建接口)

UD计划组创建接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request_id String 可选 1 请求id，用于幂等唯一key，建议填写 本接口需向媒体侧提交任务耗时较长，因TOPAPI 5秒超时限制，可能会在任务执行中提示“超时”/“远程服务调用超时”/“重复请求”等报错，此时可以用相同的request_id进行幂等重试即可返回最新结果
campaign_top_dto CampaignTopDTO 必须 入参
  • └ type
  • Number
  • 必须
  • 1
  • 营销目 头条、广点通可选值 3：电商店铺推广 4：销售线索收集 快手可选值(默认) 22：提高应用活跃
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ name
  • String
  • 必须
  • 计划组名称
  • 计划组名称
  • budget
  • BudgetTopDTO
  • 必须
  • 预算
  • └ budget_type
  • Number
  • 必须
  • 1
  • 预算类型 -1：不限、1：指定预算（每天预算相同），3：分日预算(每天预算不同)，仅快手支持。
  • └ budget
  • Number
  • 可选
  • 1
  • 统一预算金额，单位：分
  • └ day_budgets
  • Number []
  • 可选
  • 50000
  • 分日预算，单位：分，周一到周日每天的数组，-1表示不限。仅快手支持
  • └ budget_optimize_switch
  • Number
  • 可选
  • 1
  • 预算择优分配 1.开启 0.关闭 使用条件 1.头条2.0，2.竞价策略为最大转化 3.指定预算 满足以上三个条件可使用
  • tencent
  • TencentCampaignTopDTO
  • 可选
  • 腾讯特有参数
  • └ smooth
  • Number
  • 可选
  • 1
  • 投放方式，1：标准投放（默认），2：加速投放
  • kuaishou
  • KuaishouCampaignTopDTO
  • 可选
  • 快手特有参数
  • └ bid_type
  • Number
  • 可选
  • 1
  • 投放方式，0：稳健投放，1：最大转化（MCB）
  • └ version
  • Number
  • 可选
  • 9999
  • 平台版本，9999：升级版API（仅巨量2.0API需传入）
  • toutiao_v2
  • ToutiaoCampaignV2TopDTO
  • 可选
  • 头条2.0特有参数
  • adzone
  • AdgroupAdzoneDTO
  • 可选
  • 投放资源位，头条2.0必填
  • └ values
  • String []
  • 可选
  • 1
  • 资源位列表，1：今日头条，2：西瓜视频，4：抖音，5：穿山甲，10：番茄小说，type=2时必填。
  • └ type
  • Number
  • 可选
  • 1
  • 资源位类型，2：媒体指定位置，4：通投智选
  • └ cast_show_type
  • Number
  • 可选
  • 1
  • 投放形式，投放资源位仅为穿山甲时需要填写，1：激励视频，2：原生，3：开屏
  • pricing
  • AdgroupPricingTopDTO
  • 可选
  • 付费出价，头条2.0必填
  • └ cast_target
  • Number
  • 可选
  • 1
  • 优化目标，1：转化量（仅bid_type=1 时支持），2：点击量，3：曝光量
  • └ pricing_type
  • Number
  • 可选
  • 1
  • 付费方式，需按“优化目标-付费方式”对应选择，展示量-2：CPM，点击量-3：CPC，其他优化目标-5：oCPM
  • └ bid_type
  • Number
  • 可选
  • 1
  • 竞价策略，0：稳定成本（默认），1：最大转化，2：最优成本
  • └ deep_bid_type
  • Number
  • 可选
  • 0
  • 深度优化方式 0 不启用 2 开启roi 投放模式为自动投放时必须开启roi
  • └ roi_goal
  • String
  • 可选
  • 0.01
  • roi系数 deep_bid_type=2时必填,取值范围0.01-100
  • cast_time
  • CastTimeTopDTO
  • 可选
  • 投放周期，头条2.0必填
  • └ 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时必填
  • target
  • AdgroupTargetTopDTO
  • 可选
  • 定向，未特殊标明的不传字段的值表示不限
  • area
  • AreaDTO
  • 可选
  • 地域定向
  • city
  • CommonDTO []
  • 可选
  • list
  • 地域信息
  • └ name
  • String
  • 可选
  • 北京
  • 地域名称
  • └ value
  • String
  • 可选
  • 11
  • 地域值
  • └ city_target
  • Number
  • 可选
  • 1
  • 城市目标人群，1：正在该地区的用户，2：居住在该地区的用户，3：到该地区旅行的用户，4：该地区内的所有用户
  • └ type
  • Number
  • 可选
  • 1
  • 地域定向类型，-1:不限，1：指定地区
  • interest_action
  • InterestActionDTO
  • 可选
  • 行为兴趣
  • action_categorie
  • ActionCategorieDTO
  • 可选
  • 行为分类
  • action_categories
  • CommonDTO []
  • 可选
  • list
  • 行为类目
  • └ num
  • String
  • 可选
  • 11
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • └ action_scene
  • String []
  • 可选
  • 1
  • 行为场景，1：电商行为场景，2：咨询行为场景，3：app行为场景
  • └ action_days
  • Number
  • 可选
  • 1
  • 行为天数，1：7天，2：15天，3：30天，4：60天，5：90天，6：180天，7：365天
  • keywords
  • CommonDTO []
  • 可选
  • list
  • 关键词
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • └ action_strength
  • Number
  • 可选
  • 0
  • 行为强度，0：不限；1：高强度
  • interest_categorie
  • InterestCategorieDTO
  • 可选
  • list
  • 行为兴趣
  • keywords
  • CommonDTO []
  • 可选
  • list
  • 关键词
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • interest_categories
  • CommonDTO []
  • 可选
  • list
  • 行为类目
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • └ type
  • Number
  • 可选
  • 1
  • 1,系统推荐 2 自定义
  • └ hide_if_converted
  • Number
  • 可选
  • 1
  • 过滤已转化用户，0(默认)：不限；1：项目； 2：广告；3：本账户。
  • └ gender
  • Number
  • 可选
  • 1
  • 性别，-1：不限，1：女，2：男
  • device
  • DeviceDTO
  • 可选
  • 设备-品牌/价格
  • └ device_brands
  • String []
  • 可选
  • 1
  • 设备品牌，1：荣耀，2：苹果，3：华为，4：小米，5：三星，6：OPPO，7：VIVO，8：魅族，9：金立，10：酷派，11：联想，12：乐视，13：中兴，14：中国移动，15：HTC，16：小辣椒，17：努比亚，18：海信，19：奇酷，20：TCL，21：索尼，22：锤子手机，23：360手机，24：一加手机，25：LG，26：摩托罗拉，27：诺基亚，28：谷歌
  • └ device_prices
  • String []
  • 可选
  • 0
  • 设备价格，第1位传最小价格（下限是0），第2位传最大价格（上限是10000）限定 500整数倍
  • └ device_types
  • String []
  • 可选
  • 1
  • 设备类型，1：智能手机， 2：平板
  • age
  • AgeDTO
  • 可选
  • 年龄
  • └ age_range
  • String []
  • 可选
  • 18
  • 年龄，-1：不限，18：18-23，24：24-30，31：31-40，41：41-49，50：50-100
  • └ type
  • Number
  • 可选
  • 2
  • 类型，-1：不限，1:选择年龄段
  • └ network
  • String []
  • 可选
  • 1
  • 网络，-1：不限，0：Wi-Fi，2：2G，3：3G，4：4G，5：5G
  • toutiao
  • ToutiaoAdgroupTargetTopDTO
  • 可选
  • 头条特有定向
  • aweme_fan_behavior
  • AwemeFanBehaviorDTO
  • 可选
  • 1
  • 抖音达人定向
  • keywords
  • CommonDTO []
  • 可选
  • list
  • 关键词
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • └ aweme_fan_days
  • Number
  • 可选
  • 1
  • 互动天数，1：15天，2：30天，3：60天
  • └ aweme_fan_scene
  • String []
  • 可选
  • 1
  • 行为场景，1：关注，2：评论，3：点赞，4：分享
  • aweme_fan_categories
  • CommonDTO []
  • 可选
  • list
  • 抖音达人账号类目
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • 值
  • platform
  • PlatformDTO []
  • 可选
  • 设备平台
  • 设备平台
  • └ type
  • Number
  • 可选
  • 1
  • 操作系统类型, -1：不限，1：Android，3：IOS 字节2.0如选择ios 则不可选手机品牌
  • └ android_version
  • Number
  • 可选
  • 4
  • 头条2.0暂不支持，安卓版本，-1:不限,4:4.x+,5:5.x+,6:6.x+,7:7.x+,8:8.x+,9:9.x+,10:10.x+
  • └ ios_version
  • Number
  • 可选
  • 7
  • 头条2.0暂不支持，iOS版本，-1：不限，7：7.x+，8：8.x+，9：9.x+，10：10.x+，11：11.x+，12：12.x+，13：13.x+
  • └ auto_extend_targets
  • String []
  • 可选
  • 1
  • 智能放量，1：年龄，2：性别，3：地域，4：行为兴趣，5：学历
  • └ delivery_mode
  • Number
  • 可选
  • 1
  • 投放模式 1 手动投放 2 自动投放,自动投放时必须开启roi深转优化,且必须关联商品
  • related_item
  • Integer
  • 可选
  • 关联商品
  • └ if_related
  • Number
  • 可选
  • 1
  • 是否关联商品 0 不启用 1 启用 投放模式为自动投放时必须启用
  • └ related_item_id
  • Number
  • 可选
  • 1
  • 关联商品id

响应参数

名称 类型 示例值 描述
result CampaignTopDTO 返回参数
  • └ id
  • Number
  • 1
  • 计划组id

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCampaignAddRequest req = new UnideskRtaAdCampaignAddRequest();
req.setRequestId("1");
UnideskRtaAdCampaignAddRequest.CampaignTopDTO obj1 = new UnideskRtaAdCampaignAddRequest.CampaignTopDTO();
obj1.setType(1L);
obj1.setAdvertiserId(1L);
obj1.setName("计划组名称");
UnideskRtaAdCampaignAddRequest.BudgetTopDTO obj2 = new UnideskRtaAdCampaignAddRequest.BudgetTopDTO();
obj2.setBudgetType(1L);
obj2.setBudget(1L);
obj2.setDayBudgets(new Long[] { 50000 };
);
obj2.setBudgetOptimizeSwitch(1L);
obj1.setBudget(obj2);
UnideskRtaAdCampaignAddRequest.TencentCampaignTopDTO obj3 = new UnideskRtaAdCampaignAddRequest.TencentCampaignTopDTO();
obj3.setSmooth(1L);
obj1.setTencent(obj3);
UnideskRtaAdCampaignAddRequest.KuaishouCampaignTopDTO obj4 = new UnideskRtaAdCampaignAddRequest.KuaishouCampaignTopDTO();
obj4.setBidType(1L);
obj1.setKuaishou(obj4);
obj1.setVersion(9999L);
UnideskRtaAdCampaignAddRequest.ToutiaoCampaignV2TopDTO obj5 = new UnideskRtaAdCampaignAddRequest.ToutiaoCampaignV2TopDTO();
UnideskRtaAdCampaignAddRequest.AdgroupAdzoneDTO obj6 = new UnideskRtaAdCampaignAddRequest.AdgroupAdzoneDTO();
obj6.setValues("1");
obj6.setType(1L);
obj5.setAdzone(obj6);
obj5.setCastShowType(1L);
UnideskRtaAdCampaignAddRequest.AdgroupPricingTopDTO obj7 = new UnideskRtaAdCampaignAddRequest.AdgroupPricingTopDTO();
obj7.setCastTarget(1L);
obj7.setPricingType(1L);
obj7.setBidType(1L);
obj7.setDeepBidType(0L);
obj7.setRoiGoal("0.01");
obj5.setPricing(obj7);
UnideskRtaAdCampaignAddRequest.CastTimeTopDTO obj8 = new UnideskRtaAdCampaignAddRequest.CastTimeTopDTO();
obj8.setTimeSeries("111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111");
obj8.setTimeType(1L);
obj8.setStartTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj8.setEndTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj5.setCastTime(obj8);
UnideskRtaAdCampaignAddRequest.AdgroupTargetTopDTO obj9 = new UnideskRtaAdCampaignAddRequest.AdgroupTargetTopDTO();
UnideskRtaAdCampaignAddRequest.AreaDTO obj10 = new UnideskRtaAdCampaignAddRequest.AreaDTO();
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list12 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj13 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list12.add(obj13);
obj13.setName("北京");
obj13.setValue("11");
obj10.setCity(list12);
obj10.setCityTarget(1L);
obj10.setType(1L);
obj9.setArea(obj10);
UnideskRtaAdCampaignAddRequest.InterestActionDTO obj14 = new UnideskRtaAdCampaignAddRequest.InterestActionDTO();
UnideskRtaAdCampaignAddRequest.ActionCategorieDTO obj15 = new UnideskRtaAdCampaignAddRequest.ActionCategorieDTO();
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list17 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj18 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list17.add(obj18);
obj18.setNum("11");
obj18.setName("名称");
obj18.setValue("1");
obj15.setActionCategories(list17);
obj15.setActionScene("1");
obj15.setActionDays(1L);
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list20 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj21 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list20.add(obj21);
obj21.setNum("1");
obj21.setName("名称");
obj21.setValue("1");
obj15.setKeywords(list20);
obj15.setActionStrength(0L);
obj14.setActionCategorie(obj15);
UnideskRtaAdCampaignAddRequest.InterestCategorieDTO obj22 = new UnideskRtaAdCampaignAddRequest.InterestCategorieDTO();
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list24 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj25 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list24.add(obj25);
obj25.setNum("1");
obj25.setName("名称");
obj25.setValue("1");
obj22.setKeywords(list24);
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list27 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj28 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list27.add(obj28);
obj28.setNum("1");
obj28.setName("名称");
obj28.setValue("1");
obj22.setInterestCategories(list27);
obj14.setInterestCategorie(obj22);
obj14.setType(1L);
obj9.setInterestAction(obj14);
obj9.setHideIfConverted(1L);
obj9.setGender(1L);
UnideskRtaAdCampaignAddRequest.DeviceDTO obj29 = new UnideskRtaAdCampaignAddRequest.DeviceDTO();
obj29.setDeviceBrands("1");
obj29.setDevicePrices("0");
obj29.setDeviceTypes("1");
obj9.setDevice(obj29);
UnideskRtaAdCampaignAddRequest.AgeDTO obj30 = new UnideskRtaAdCampaignAddRequest.AgeDTO();
obj30.setAgeRange("18");
obj30.setType(2L);
obj9.setAge(obj30);
obj9.setNetwork("1");
UnideskRtaAdCampaignAddRequest.ToutiaoAdgroupTargetTopDTO obj31 = new UnideskRtaAdCampaignAddRequest.ToutiaoAdgroupTargetTopDTO();
UnideskRtaAdCampaignAddRequest.AwemeFanBehaviorDTO obj32 = new UnideskRtaAdCampaignAddRequest.AwemeFanBehaviorDTO();
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list34 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj35 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list34.add(obj35);
obj35.setNum("1");
obj35.setName("名称");
obj35.setValue("1");
obj32.setKeywords(list34);
obj32.setAwemeFanDays(1L);
obj32.setAwemeFanScene("1");
List<UnideskRtaAdCampaignAddRequest.CommonDTO> list37 = new ArrayList<UnideskRtaAdCampaignAddRequest.CommonDTO>();
UnideskRtaAdCampaignAddRequest.CommonDTO obj38 = new UnideskRtaAdCampaignAddRequest.CommonDTO();
list37.add(obj38);
obj38.setNum("1");
obj38.setName("名称");
obj38.setValue("1");
obj32.setAwemeFanCategories(list37);
obj31.setAwemeFanBehavior(obj32);
obj9.setToutiao(obj31);
List<UnideskRtaAdCampaignAddRequest.PlatformDTO> list40 = new ArrayList<UnideskRtaAdCampaignAddRequest.PlatformDTO>();
UnideskRtaAdCampaignAddRequest.PlatformDTO obj41 = new UnideskRtaAdCampaignAddRequest.PlatformDTO();
list40.add(obj41);
obj41.setType(1L);
obj41.setAndroidVersion(4L);
obj41.setIosVersion(7L);
obj9.setPlatform(list40);
obj9.setAutoExtendTargets("1");
obj5.setTarget(obj9);
obj5.setDeliveryMode(1L);
UnideskRtaAdCampaignAddRequest.Integer obj42 = new UnideskRtaAdCampaignAddRequest.Integer();
obj42.setIfRelated(1L);
obj42.setRelatedItemId(1L);
obj5.setRelatedItem(obj42);
obj1.setToutiaoV2(obj5);
req.setCampaignTopDto(obj1);
UnideskRtaAdCampaignAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_campaign_add_response>
    <result>
        <id>1</id>
    </result>
</unidesk_rta_ad_campaign_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测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部