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

taobao.unidesk.rta.ad.campaign.get (UD计划组查询接口)

UD计划组查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
campaign_top_query_dto CampaignTopQueryDTO 必须 查询参数
  • └ page_no
  • Number
  • 可选
  • 1
  • 第几页
  • └ ids
  • Number []
  • 可选
  • 1
  • 计划组ids
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页多少条
  • └ advertiser_id
  • Number
  • 必须
  • 1
  • 广告主id
  • └ version
  • Number
  • 可选
  • 9999
  • 平台版本,9999:升级版API(仅巨量2.0API需传入)

响应参数

名称 类型 示例值 描述
result CampaignTopDTO [] 返回结果
  • └ type
  • Number
  • 1
  • 计划组类型,1:应用推广 3:电商店铺推广 4:销售线索收集 22:提高应用活跃(快手必须且默认)
  • └ gmt_create
  • Date
  • 12
  • 创建时间
  • └ advertiser_id
  • Number
  • 1
  • 广告主id
  • └ opt_status
  • Number
  • 1
  • 操作状态,1-开启、0-关闭
  • └ name
  • String
  • 计划
  • 计划组名称
  • └ id
  • Number
  • 1
  • 计划组id
  • budget
  • BudgetTopDTO
  • 预算
  • └ budget_type
  • Number
  • 1
  • 预算类型 -1:不限、1:指定预算(每天预算相同)、2:总预算、3:分日预算(每天预算不同)
  • └ budget
  • Number
  • 1
  • 统一预算金额,单位:分
  • └ day_budgets
  • Number []
  • 分日预算,单位:分,周一到周日每天的数组,-1表示不限
  • └ budget_optimize_switch
  • Number
  • 1
  • 预算择优分配 1.开启 0.关闭 使用条件 1.头条2.0,2.竞价策略为最大转化 3.指定预算 满足以上三个条件可使用
  • └ status
  • Number
  • 1
  • 状态, -1:删除 0:暂停 1:启用 6:余额不足 9:计划超预算
  • tencent
  • TencentCampaignTopDTO
  • 腾讯特有参数
  • └ smooth
  • Number
  • 1
  • 投放方式,1:标准投放(默认),2:加速投放
  • kuaishou
  • KuaishouCampaignTopDTO
  • 快手特有参数
  • └ bid_type
  • Number
  • 1
  • 投放方式,0:稳健投放,1:最大转化(MCB)
  • toutiao_v2
  • ToutiaoCampaignV2TopDTO
  • 头条2.0特有参数
  • adzone
  • AdgroupAdzoneDTO
  • 投放资源位
  • └ values
  • String []
  • 资源位列表,1:今日头条,2:西瓜视频,4:抖音,5:穿山甲,10:番茄小说
  • └ type
  • Number
  • 1
  • 资源位类型,2:媒体指定位置,4:通投智选
  • └ cast_show_type
  • Number
  • 1
  • 投放形式,1:激励视频,2:原生,3:开机图
  • pricing
  • AdgroupPricingTopDTO
  • 付费出价
  • └ cast_target
  • Number
  • 1
  • 优化目标,1:转化量,2:点击量,3:展示量
  • └ pricing_type
  • Number
  • 1
  • 付费方式,2:CPM,3:CPC,5:OCPM
  • └ bid_type
  • Number
  • 1
  • 竞价策略,0:稳定成本,1:最大转化投放,2:控制成本上限
  • └ deep_bid_type
  • Number
  • 1
  • 深度优化方式 0 不启用 2 开启roi
  • └ roi_goal
  • String
  • 0.01
  • roi系数 deep_bid_type=2时必填,取值范围0.01-100
  • 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
  • 投放周期,开始时间
  • └ end_time
  • Date
  • 2022-08-25 00:00:00
  • 投放周期,结束时间
  • target
  • AdgroupTargetTopDTO
  • 定向,未特殊标明的不传字段的值表示不限
  • area
  • AreaDTO
  • 地域定向
  • city
  • CommonDTO []
  • 地域信息
  • └ 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 []
  • 行为类目
  • └ num
  • String
  • 11
  • 数量
  • └ name
  • String
  • 名称
  • 名称
  • └ value
  • String
  • 1
  • └ action_scene
  • String []
  • 行为场景,1:电商行为场景,2:咨询行为场景,3:app行为场景
  • └ action_days
  • Number
  • 1
  • 行为天数,1:7天,2:15天,3:30天,4:60天,5:90天,6:180天,7:365天
  • keywords
  • CommonDTO []
  • 关键词
  • └ num
  • String
  • 1
  • 数量
  • └ name
  • String
  • 名称
  • 名称
  • └ value
  • String
  • 1
  • └ action_strength
  • Number
  • 0
  • 行为强度,0:不限;1:高强度
  • interest_categorie
  • InterestCategorieDTO
  • 行为兴趣
  • keywords
  • CommonDTO []
  • 关键词
  • └ num
  • String
  • 1
  • 数量
  • └ name
  • String
  • 名称
  • 名称
  • └ value
  • String
  • 1
  • interest_categories
  • CommonDTO []
  • 行为类目
  • └ num
  • String
  • 1
  • 数量
  • └ name
  • String
  • 名称
  • 名称
  • └ value
  • String
  • 1
  • └ type
  • Number
  • 1
  • 1,系统推荐 2 自定义
  • └ hide_if_converted
  • Number
  • 1
  • 过滤已转化用户,0(默认):不限;1:广告组2:广告计划;3:本账户;4:公司主体;5:APP
  • └ gender
  • Number
  • 1
  • 性别,-1:不限,1:女,2:男
  • device
  • DeviceDTO
  • list
  • 设备-品牌/价格
  • └ device_brands
  • String []
  • 设备品牌,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_prices
  • String []
  • 设备价格,最小价格-最大价格
  • └ device_types
  • String []
  • 设备类型,1:智能手机, 2:平板
  • └ auto_extend_targets
  • String []
  • 智能放量,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
  • └ custom_age
  • String []
  • 自定义年龄段,数组size=2,第一位传最小值、第二位传最大值
  • └ type
  • Number
  • 2
  • 类型,-1:不限,1:选择年龄段,2:自定义年龄段
  • └ network
  • String []
  • 网络,-1:不限,0:Wi-Fi,1:移动网络,2:2G,3:3G,4:4G
  • toutiao
  • ToutiaoAdgroupTargetTopDTO
  • 头条特有定向
  • aweme_fan_behavior
  • AwemeFanBehaviorDTO
  • 抖音达人定向
  • keywords
  • CommonDTO []
  • 关键词
  • └ 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 []
  • 抖音达人账号类目
  • └ num
  • String
  • 1
  • 数量
  • └ name
  • String
  • 名称
  • 名称
  • └ value
  • String
  • 1
  • platform
  • PlatformDTO
  • 设备平台
  • └ type
  • Number
  • 1
  • 操作系统类型, -1:不限,1:Android,3:IOS
  • └ delivery_mode
  • Number
  • 1
  • 投放模式 1 手动投放 2 自动投放,自动投放时必须开启roi深转优化,且必须关联商品
  • related_item
  • RelatedItemTopDTO
  • 关联商品
  • └ if_related
  • Number
  • 1
  • 是否关联商品 0 不启用 1 启用 投放模式为自动投放时必须启用
  • └ related_item_id
  • Number
  • 1
  • 关联商品id
total Number 1 总条数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCampaignGetRequest req = new UnideskRtaAdCampaignGetRequest();
UnideskRtaAdCampaignGetRequest.CampaignTopQueryDTO obj1 = new UnideskRtaAdCampaignGetRequest.CampaignTopQueryDTO();
obj1.setPageNo(1L);
obj1.setIds(new Long[] { 1 };
);
obj1.setPageSize(10L);
obj1.setAdvertiserId(1L);
obj1.setVersion(9999L);
req.setCampaignTopQueryDto(obj1);
UnideskRtaAdCampaignGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_campaign_get_response>
    <result>
        <campaign_top_d_t_o>
            <type>1</type>
            <gmt_create>12</gmt_create>
            <advertiser_id>1</advertiser_id>
            <opt_status>1</opt_status>
            <name>计划</name>
            <id>1</id>
            <budget>
                <budget_type>1</budget_type>
                <budget>1</budget>
                <budget_optimize_switch>1</budget_optimize_switch>
            </budget>
            <status>1</status>
            <tencent>
                <smooth>1</smooth>
            </tencent>
            <kuaishou>
                <bid_type>1</bid_type>
            </kuaishou>
            <toutiao_v2>
                <adzone>
                    <type>1</type>
                </adzone>
                <cast_show_type>1</cast_show_type>
                <pricing>
                    <cast_target>1</cast_target>
                    <pricing_type>1</pricing_type>
                    <bid_type>1</bid_type>
                    <deep_bid_type>1</deep_bid_type>
                    <roi_goal>0.01</roi_goal>
                </pricing>
                <cast_time>
                    <time_series>111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111</time_series>
                    <time_type>1</time_type>
                    <start_time>2022-08-25 00:00:00</start_time>
                    <end_time>2022-08-25 00:00:00</end_time>
                </cast_time>
                <target>
                    <area>
                        <city>
                            <common_d_t_o>
                                <name>北京</name>
                                <value>11</value>
                            </common_d_t_o>
                        </city>
                        <city_target>1</city_target>
                        <type>1</type>
                    </area>
                    <interest_action>
                        <action_categorie>
                            <action_categories>
                                <common_d_t_o>
                                    <num>11</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </action_categories>
                            <action_days>1</action_days>
                            <keywords>
                                <common_d_t_o>
                                    <num>1</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </keywords>
                            <action_strength>0</action_strength>
                        </action_categorie>
                        <interest_categorie>
                            <keywords>
                                <common_d_t_o>
                                    <num>1</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </keywords>
                            <interest_categories>
                                <common_d_t_o>
                                    <num>1</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </interest_categories>
                        </interest_categorie>
                        <type>1</type>
                    </interest_action>
                    <hide_if_converted>1</hide_if_converted>
                    <gender>1</gender>
                    <device>
                    </device>
                    <age>
                        <age_range>
                            <string>18</string>
                        </age_range>
                        <type>2</type>
                    </age>
                    <toutiao>
                        <aweme_fan_behavior>
                            <keywords>
                                <common_d_t_o>
                                    <num>1</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </keywords>
                            <aweme_fan_days>1</aweme_fan_days>
                            <aweme_fan_scene>
                                <string>1</string>
                            </aweme_fan_scene>
                            <aweme_fan_categories>
                                <common_d_t_o>
                                    <num>1</num>
                                    <name>名称</name>
                                    <value>1</value>
                                </common_d_t_o>
                            </aweme_fan_categories>
                        </aweme_fan_behavior>
                    </toutiao>
                    <platform>
                        <type>1</type>
                    </platform>
                </target>
                <delivery_mode>1</delivery_mode>
                <related_item>
                    <if_related>1</if_related>
                    <related_item_id>1</related_item_id>
                </related_item>
            </toutiao_v2>
        </campaign_top_d_t_o>
    </result>
    <total>1</total>
</unidesk_rta_ad_campaign_get_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

返回
顶部