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

taobao.unidesk.rta.ad.campaign.update (UD计划组修改接口)

UD计划组修改接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request_id String 可选 1 请求id,用于幂等唯一key,建议填写 本接口需向媒体侧提交任务耗时较长,因TOPAPI 5秒超时限制,可能会在任务执行中提示“超时”/“远程服务调用超时”/“重复请求”等报错,此时可以用相同的request_id进行幂等重试即可返回最新结果
campaign_top_dto CampaignTopDTO 必须 入参
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ name
  • String
  • 可选
  • 计划组名称
  • 计划组名称
  • budget
  • BudgetTopDTO
  • 可选
  • 预算
  • └ budget_type
  • Number
  • 可选
  • 1
  • 预算类型 -1:不限、1:指定预算(每天预算相同)、2:总预算、3:分日预算(每天预算不同)
  • └ budget
  • Number
  • 可选
  • 1
  • 统一预算金额,单位:分
  • └ day_budgets
  • Number []
  • 可选
  • 50000
  • 分日预算,单位:分,周一到周日每天的数组,-1表示不限
  • └ id
  • Number
  • 必须
  • 1
  • 计划组id
  • toutiao_v2
  • ToutiaoCampaignV2TopDTO
  • 可选
  • 头条2.0特有参数
  • 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
  • 投放周期,开始时间
  • └ end_time
  • Date
  • 可选
  • 2022-08-25 00:00:00
  • 投放周期,结束时间
  • 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:谷歌,100:其他
  • └ device_price_type
  • String []
  • 可选
  • 1
  • 头条2.0暂不支持,设备价格类型方式:,0:手动定义
  • └ device_prices
  • String []
  • 可选
  • 1
  • 设备价格,第1位传最小价格(下限是0),第2位传最大价格(上限是10000)限定 500整数倍
  • └ device_types
  • String []
  • 可选
  • 1
  • 设备类型,1:智能手机, 2:平板
  • └ auto_extend_targets
  • String []
  • 可选
  • 1
  • 智能放量,1:年龄,2:性别,3:地域,4:行为兴趣,5:学历
  • 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
  • toutiao
  • ToutiaoAdgroupTargetTopDTO
  • 可选
  • 头条特有定向
  • aweme_fan_behavior
  • AwemeFanBehaviorDTO
  • 可选
  • 抖音达人定向
  • keywords
  • CommonDTO []
  • 可选
  • list
  • 关键词
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • └ aweme_fan_days
  • Number
  • 可选
  • 1
  • 互动天数,1:15天,2:30天,3:60天
  • aweme_fan_categories
  • CommonDTO []
  • 可选
  • 1
  • 抖音达人账号类目
  • └ num
  • String
  • 可选
  • 1
  • 数量
  • └ name
  • String
  • 可选
  • 名称
  • 名称
  • └ value
  • String
  • 可选
  • 1
  • └ aweme_fan_scene
  • String []
  • 可选
  • 1
  • 行为场景,1:关注,2:评论,3:点赞,4:分享
  • platform
  • PlatformDTO []
  • 可选
  • 设备平台
  • └ type
  • Number
  • 可选
  • 1
  • 操作系统类型, -1:不限,1:Android,3: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+
  • pricing
  • AdgroupPricingTopDTO
  • 可选
  • 付费出价
  • └ roi_goal
  • String
  • 可选
  • 0.01
  • roi系数
  • └ version
  • Number
  • 可选
  • 9999
  • 平台版本,9999:升级版API(仅巨量2.0API需传入)

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCampaignUpdateRequest req = new UnideskRtaAdCampaignUpdateRequest();
req.setRequestId("1");
UnideskRtaAdCampaignUpdateRequest.CampaignTopDTO obj1 = new UnideskRtaAdCampaignUpdateRequest.CampaignTopDTO();
obj1.setAdvertiserId(1L);
obj1.setName("计划组名称");
UnideskRtaAdCampaignUpdateRequest.BudgetTopDTO obj2 = new UnideskRtaAdCampaignUpdateRequest.BudgetTopDTO();
obj2.setBudgetType(1L);
obj2.setBudget(1L);
obj2.setDayBudgets(new Long[] { 50000 };
);
obj1.setBudget(obj2);
obj1.setId(1L);
UnideskRtaAdCampaignUpdateRequest.ToutiaoCampaignV2TopDTO obj3 = new UnideskRtaAdCampaignUpdateRequest.ToutiaoCampaignV2TopDTO();
UnideskRtaAdCampaignUpdateRequest.CastTimeTopDTO obj4 = new UnideskRtaAdCampaignUpdateRequest.CastTimeTopDTO();
obj4.setTimeSeries("111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111");
obj4.setTimeType(1L);
obj4.setStartTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj4.setEndTime(StringUtils.parseDateTime("2022-08-25 00:00:00"));
obj3.setCastTime(obj4);
UnideskRtaAdCampaignUpdateRequest.AdgroupTargetTopDTO obj5 = new UnideskRtaAdCampaignUpdateRequest.AdgroupTargetTopDTO();
UnideskRtaAdCampaignUpdateRequest.AreaDTO obj6 = new UnideskRtaAdCampaignUpdateRequest.AreaDTO();
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list8 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj9 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list8.add(obj9);
obj9.setName("北京");
obj9.setValue("11");
obj6.setCity(list8);
obj6.setCityTarget(1L);
obj6.setType(1L);
obj5.setArea(obj6);
UnideskRtaAdCampaignUpdateRequest.InterestActionDTO obj10 = new UnideskRtaAdCampaignUpdateRequest.InterestActionDTO();
UnideskRtaAdCampaignUpdateRequest.ActionCategorieDTO obj11 = new UnideskRtaAdCampaignUpdateRequest.ActionCategorieDTO();
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list13 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj14 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list13.add(obj14);
obj14.setNum("11");
obj14.setName("名称");
obj14.setValue("1");
obj11.setActionCategories(list13);
obj11.setActionScene("1");
obj11.setActionDays(1L);
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list16 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj17 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list16.add(obj17);
obj17.setNum("1");
obj17.setName("名称");
obj17.setValue("1");
obj11.setKeywords(list16);
obj11.setActionStrength(0L);
obj10.setActionCategorie(obj11);
UnideskRtaAdCampaignUpdateRequest.InterestCategorieDTO obj18 = new UnideskRtaAdCampaignUpdateRequest.InterestCategorieDTO();
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list20 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj21 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list20.add(obj21);
obj21.setNum("1");
obj21.setName("名称");
obj21.setValue("1");
obj18.setKeywords(list20);
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list23 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj24 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list23.add(obj24);
obj24.setNum("1");
obj24.setName("名称");
obj24.setValue("1");
obj18.setInterestCategories(list23);
obj10.setInterestCategorie(obj18);
obj10.setType(1L);
obj5.setInterestAction(obj10);
obj5.setHideIfConverted(1L);
obj5.setGender(1L);
UnideskRtaAdCampaignUpdateRequest.DeviceDTO obj25 = new UnideskRtaAdCampaignUpdateRequest.DeviceDTO();
obj25.setDeviceBrands("1");
obj25.setDevicePriceType("1");
obj25.setDevicePrices("1");
obj25.setDeviceTypes("1");
obj5.setDevice(obj25);
obj5.setAutoExtendTargets("1");
UnideskRtaAdCampaignUpdateRequest.AgeDTO obj26 = new UnideskRtaAdCampaignUpdateRequest.AgeDTO();
obj26.setAgeRange("18");
obj26.setType(2L);
obj5.setAge(obj26);
obj5.setNetwork("1");
UnideskRtaAdCampaignUpdateRequest.ToutiaoAdgroupTargetTopDTO obj27 = new UnideskRtaAdCampaignUpdateRequest.ToutiaoAdgroupTargetTopDTO();
UnideskRtaAdCampaignUpdateRequest.AwemeFanBehaviorDTO obj28 = new UnideskRtaAdCampaignUpdateRequest.AwemeFanBehaviorDTO();
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list30 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj31 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list30.add(obj31);
obj31.setNum("1");
obj31.setName("名称");
obj31.setValue("1");
obj28.setKeywords(list30);
obj28.setAwemeFanDays(1L);
List<UnideskRtaAdCampaignUpdateRequest.CommonDTO> list33 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.CommonDTO>();
UnideskRtaAdCampaignUpdateRequest.CommonDTO obj34 = new UnideskRtaAdCampaignUpdateRequest.CommonDTO();
list33.add(obj34);
obj34.setNum("1");
obj34.setName("名称");
obj34.setValue("1");
obj28.setAwemeFanCategories(list33);
obj28.setAwemeFanScene("1");
obj27.setAwemeFanBehavior(obj28);
obj5.setToutiao(obj27);
List<UnideskRtaAdCampaignUpdateRequest.PlatformDTO> list36 = new ArrayList<UnideskRtaAdCampaignUpdateRequest.PlatformDTO>();
UnideskRtaAdCampaignUpdateRequest.PlatformDTO obj37 = new UnideskRtaAdCampaignUpdateRequest.PlatformDTO();
list36.add(obj37);
obj37.setType(1L);
obj37.setAndroidVersion(4L);
obj37.setIosVersion(7L);
obj5.setPlatform(list36);
obj3.setTarget(obj5);
UnideskRtaAdCampaignUpdateRequest.AdgroupPricingTopDTO obj38 = new UnideskRtaAdCampaignUpdateRequest.AdgroupPricingTopDTO();
obj38.setRoiGoal("0.01");
obj3.setPricing(obj38);
obj1.setToutiaoV2(obj3);
obj1.setVersion(9999L);
req.setCampaignTopDto(obj1);
UnideskRtaAdCampaignUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_campaign_update_response>
    <result>
        <id>1</id>
    </result>
</unidesk_rta_ad_campaign_update_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

返回
顶部