文档中心 > API类目 > 直通车API

taobao.universalbp.crowd.horizontal.findpage (横向管理列表区专用,会拼接报表、可操作性项等信息)

分页查询人群绑定关系

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
crowd_bind_query_v_o CrowdBindQueryVo 必须 crowdBindQueryVO
  • └ offset
  • Number
  • 可选
  • 0
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 20
  • 页面大小
  • └ campaign_id_list
  • Number []
  • 可选
  • [68792788657]
  • 计划id集合
  • └ campaign_id
  • Number
  • 可选
  • 68796878069
  • 计划id,计划已经存在场景必填
  • └ adgroup_id_list
  • Number []
  • 可选
  • [68798447504]
  • 单元id集合,单元已经存在场景必填
  • rpt_query
  • RptQueryVo
  • 可选
  • 报表数据查询条件
  • └ fields
  • String
  • 可选
  • adPv
  • 查询指标字段
  • condition_list
  • RptQueryConditionVo []
  • 可选
  • 报表查询条件
  • └ start_time
  • String
  • 可选
  • 2023-10-08
  • 开始时间
  • └ end_time
  • String
  • 可选
  • 2023-10-08
  • 结束时间
  • └ adzone_pkg_id_list
  • String []
  • 可选
  • ["114790550288", "114790550289", "114793500012", "114786650498"]
  • 流量来源(资源位包id)
  • └ is_rt
  • Boolean
  • 可选
  • true
  • 是否查询实时报表,true查实时、false查离线,不传则默认查离线
  • └ unify_type
  • String
  • 可选
  • zhai
  • 归因类型

响应参数

名称 类型 示例值 描述
result TopResult 结果体
  • info
  • TopInfo
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • crowd_ref_v_o_top_bulk_data
  • TopBulkData
  • 结果集
  • crowd_ref_v_o_list
  • CrowdRefVo []
  • 批量结果集
  • └ campaign_id
  • Number
  • 68799007001
  • 计划id
  • └ adgroup_id
  • Number
  • 68796878061
  • 单元id
  • └ crowd_id
  • Number
  • 5526396502
  • 人群主键id
  • └ online_status
  • Number
  • 1
  • 定向状态,0:下线 1:上线
  • crowd
  • CrowdVo
  • 人群
  • └ crowd_id
  • Number
  • 5526396502
  • 人群主键id
  • └ crowd_name
  • String
  • 目标人群扩展
  • 人群名称
  • └ crowd_value
  • String
  • 2191820003
  • 人群值
  • └ target_type
  • Number
  • 130
  • 定向类型
  • label
  • LabelVo
  • 定向标签
  • └ target_type
  • Number
  • 131
  • 定向标签类型
  • └ label_id
  • Number
  • 3000494
  • 定向标签id
  • └ label_name
  • String
  • 关键词
  • 定向标签名称
  • └ label_desc
  • String
  • 关键词
  • 定向标签描述
  • └ label_value
  • String
  • 2000112
  • 定向标签值
  • └ price_dimension
  • String
  • OPTION
  • 出价维度,OPTION:标签出价,多个子人群同时出价、LABEL:选项出价,以子人群为出价最小单位
  • option_group_list
  • OptionGroupVo []
  • 标签选项分组
  • └ option_group_name
  • String
  • 性别
  • 标签分组名称
  • option_list
  • OptionVo []
  • 标签选项
  • └ option_name
  • String
  • 人群特征继承
  • 选项名称
  • └ option_value
  • String
  • 2000123
  • 选项值
  • └ option_desc
  • String
  • 该定向人群将继承原始计划已触达的消费者特征,缩短算法搜寻合适人群的冷启动周期,建议您同时开启【智能拓展】功能,提升投放效果。
  • 选项描述
  • └ tag_id
  • Number
  • 100000
  • 选项id,(用于关键词推广静态标签生成人群)如基础属性人群标签组合
  • └ option_group_name
  • String
  • 性别
  • 标签分组名称
  • label_option_properties
  • LabelOptionProperties
  • 透传属性
  • └ dmp_option_group_id
  • String
  • 1001
  • dmp选项分组id
  • └ cate_name
  • String
  • 714616513841
  • 物料id
  • └ cate_id
  • String
  • 714616513841
  • 物料id
  • option_list
  • OptionVo []
  • 标签选项
  • └ option_name
  • String
  • 人群特征继承
  • 选项名称
  • └ option_value
  • String
  • 2000123
  • 选项值
  • └ option_desc
  • String
  • 该定向人群将继承原始计划已触达的消费者特征,缩短算法搜寻合适人群的冷启动周期,建议您同时开启【智能拓展】功能,提升投放效果。
  • 选项描述
  • └ tag_id
  • Number
  • 100000
  • 选项id,(用于关键词推广静态标签生成人群)如基础属性人群标签组合
  • └ option_group_name
  • String
  • 性别
  • 标签分组名称
  • label_option_properties
  • LabelOptionProperties
  • 透传属性
  • └ dmp_option_group_id
  • String
  • 1001
  • dmp选项分组id
  • └ cate_name
  • String
  • 714616513841
  • 物料id
  • └ cate_id
  • String
  • 714616513841
  • 物料id
  • └ is_multi
  • Boolean
  • true
  • 是否可以绑定多个定向,获取不到 默认为否,true:是 false:否
  • label_option_properties
  • LabelOptionProperties
  • 透传属性
  • └ dmp_option_group_id
  • String
  • 1001
  • dmp选项分组id
  • └ cate_name
  • String
  • 714616513841
  • 物料id
  • └ cate_id
  • String
  • 714616513841
  • 物料id
  • └ label_group_name
  • String
  • 人群类型,所属类型
  • 达摩盘人群
  • └ lookalike_multiple
  • String
  • 1
  • 扩展倍数。低中高对应不同的倍数,由产品定义具体值,未来业务可支持滑动条。注意:倍数是指最终人数/种子人数,比如种子人群100万,扩展比种子多了50万,也就是总共150万,这时候扩展倍数是1.5而不是0.5
  • extend_seed_crowd_list
  • ExtendSeedCrowdRefVo []
  • 种子人群关联信息
  • crowd
  • ExtendSeedCrowdVo
  • 种子人群信息
  • └ crowd_id
  • Number
  • 5536708993
  • 人群主键id
  • └ crowd_name
  • String
  • 喜欢店铺新品的访客
  • 人群名称
  • label
  • ExtendSeedLabelVo
  • 种子人群label信息
  • └ target_type
  • Number
  • 131
  • 定向标签类型
  • └ label_id
  • Number
  • 3000494
  • 定向标签id
  • └ label_name
  • String
  • 关键词
  • 定向标签名称
  • └ price_dimension
  • String
  • OPTION
  • 出价维度,OPTION:标签出价,多个子人群同时出价、LABEL:选项出价,以子人群为出价最小单位
  • └ is_multi
  • Boolean
  • true
  • 是否可以绑定多个定向,获取不到 默认为否,true:是 false:否
  • option_list
  • ExtendSeedOptionVo []
  • 选项值信息
  • └ option_name
  • String
  • 人群特征继承
  • 选项名称
  • └ option_value
  • String
  • 2000123
  • 选项值
  • └ tag_id
  • Number
  • 100000
  • 选项id,(用于关键词推广静态标签生成人群)如基础属性人群标签组合
  • sub_crowd_list
  • SubCrowdVo []
  • 子人群信息
  • └ subcrowd_name
  • String
  • 目标人群扩展
  • 子定向名称
  • └ subcrowd_value
  • String
  • 2191820003
  • 子定向值
  • price
  • PriceVo
  • 出价
  • └ bid_price
  • String
  • 30
  • 出价
  • └ fit_bid_price
  • String
  • 30
  • 建议出价
  • └ discount
  • String
  • 30
  • 溢价
  • └ fit_discount
  • String
  • 30
  • 建议溢价
  • └ report_info
  • String
  • 报表数据
  • └ count
  • Number
  • 1
  • 数量

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpCrowdHorizontalFindpageRequest req = new UniversalbpCrowdHorizontalFindpageRequest();
UniversalbpCrowdHorizontalFindpageRequest.TopServiceContext obj1 = new UniversalbpCrowdHorizontalFindpageRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
req.setTopServiceContext(obj1);
UniversalbpCrowdHorizontalFindpageRequest.CrowdBindQueryVo obj2 = new UniversalbpCrowdHorizontalFindpageRequest.CrowdBindQueryVo();
obj2.setOffset(0L);
obj2.setPageSize(20L);
obj2.setCampaignIdList(new Long[] { 68792788657 };
);
obj2.setCampaignId(68796878069L);
obj2.setAdgroupIdList(new Long[] { 68798447504 };
);
UniversalbpCrowdHorizontalFindpageRequest.RptQueryVo obj3 = new UniversalbpCrowdHorizontalFindpageRequest.RptQueryVo();
obj3.setFields("adPv");
List<UniversalbpCrowdHorizontalFindpageRequest.RptQueryConditionVo> list5 = new ArrayList<UniversalbpCrowdHorizontalFindpageRequest.RptQueryConditionVo>();
UniversalbpCrowdHorizontalFindpageRequest.RptQueryConditionVo obj6 = new UniversalbpCrowdHorizontalFindpageRequest.RptQueryConditionVo();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList(""114790550288", "114790550289", "114793500012", "114786650498"");
obj6.setIsRt(true);
obj6.setUnifyType("zhai");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
req.setCrowdBindQueryVO(obj2);
UniversalbpCrowdHorizontalFindpageResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_crowd_horizontal_findpage_response>
    <result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <crowd_ref_v_o_top_bulk_data>
            <crowd_ref_v_o_list>
                <crowd_ref_vo>
                    <campaign_id>68799007001</campaign_id>
                    <adgroup_id>68796878061</adgroup_id>
                    <crowd_id>5526396502</crowd_id>
                    <online_status>1</online_status>
                    <crowd>
                        <crowd_id>5526396502</crowd_id>
                        <crowd_name>目标人群扩展</crowd_name>
                        <crowd_value>2191820003</crowd_value>
                        <target_type>130</target_type>
                        <label>
                            <target_type>131</target_type>
                            <label_id>3000494</label_id>
                            <label_name>关键词</label_name>
                            <label_desc>关键词</label_desc>
                            <label_value>2000112</label_value>
                            <price_dimension>OPTION</price_dimension>
                            <option_group_list>
                                <option_group_vo>
                                    <option_group_name>性别</option_group_name>
                                    <option_list>
                                        <option_vo>
                                            <option_name>人群特征继承</option_name>
                                            <option_value>2000123</option_value>
                                            <option_desc>该定向人群将继承原始计划已触达的消费者特征,缩短算法搜寻合适人群的冷启动周期,建议您同时开启【智能拓展】功能,提升投放效果。</option_desc>
                                            <tag_id>100000</tag_id>
                                            <option_group_name>性别</option_group_name>
                                            <label_option_properties>
                                                <dmp_option_group_id>1001</dmp_option_group_id>
                                                <cate_name>714616513841</cate_name>
                                                <cate_id>714616513841</cate_id>
                                            </label_option_properties>
                                        </option_vo>
                                    </option_list>
                                </option_group_vo>
                            </option_group_list>
                            <option_list>
                                <option_vo>
                                    <option_name>人群特征继承</option_name>
                                    <option_value>2000123</option_value>
                                    <option_desc>该定向人群将继承原始计划已触达的消费者特征,缩短算法搜寻合适人群的冷启动周期,建议您同时开启【智能拓展】功能,提升投放效果。</option_desc>
                                    <tag_id>100000</tag_id>
                                    <option_group_name>性别</option_group_name>
                                    <label_option_properties>
                                        <dmp_option_group_id>1001</dmp_option_group_id>
                                        <cate_name>714616513841</cate_name>
                                        <cate_id>714616513841</cate_id>
                                    </label_option_properties>
                                </option_vo>
                            </option_list>
                            <is_multi>true</is_multi>
                            <label_option_properties>
                                <dmp_option_group_id>1001</dmp_option_group_id>
                                <cate_name>714616513841</cate_name>
                                <cate_id>714616513841</cate_id>
                            </label_option_properties>
                            <label_group_name>人群类型,所属类型</label_group_name>
                        </label>
                        <lookalike_multiple>1</lookalike_multiple>
                        <extend_seed_crowd_list>
                            <extend_seed_crowd_ref_vo>
                                <crowd>
                                    <crowd_id>5536708993</crowd_id>
                                    <crowd_name>喜欢店铺新品的访客</crowd_name>
                                    <label>
                                        <target_type>131</target_type>
                                        <label_id>3000494</label_id>
                                        <label_name>关键词</label_name>
                                        <price_dimension>OPTION</price_dimension>
                                        <is_multi>true</is_multi>
                                        <option_list>
                                            <extend_seed_option_vo>
                                                <option_name>人群特征继承</option_name>
                                                <option_value>2000123</option_value>
                                                <tag_id>100000</tag_id>
                                            </extend_seed_option_vo>
                                        </option_list>
                                    </label>
                                </crowd>
                            </extend_seed_crowd_ref_vo>
                        </extend_seed_crowd_list>
                        <sub_crowd_list>
                            <sub_crowd_vo>
                                <subcrowd_name>目标人群扩展</subcrowd_name>
                                <subcrowd_value>2191820003</subcrowd_value>
                            </sub_crowd_vo>
                        </sub_crowd_list>
                    </crowd>
                    <price>
                        <bid_price>30</bid_price>
                        <fit_bid_price>30</fit_bid_price>
                        <discount>30</discount>
                        <fit_discount>30</fit_discount>
                    </price>
                </crowd_ref_vo>
            </crowd_ref_v_o_list>
            <count>1</count>
        </crowd_ref_v_o_top_bulk_data>
    </result>
</universalbp_crowd_horizontal_findpage_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

返回
顶部