文档中心 > API类目 > 万相台无界API

taobao.universalbp.new.report.query.creative (创意报表查询)

创意报表查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_service_context TopServiceContext 必须 topServiceContext
  • └ biz_code
  • String
  • 必须
  • xxxxx
  • api业务线编码
  • └ login_type
  • Number
  • 可选
  • 1
  • 1: 直客(正常)登录 2: 代理直投(叉乘账号)
  • └ member_id
  • Number
  • 可选
  • 12345
  • 代理直投时被代理商家账号, 代理直投(叉乘)时必填。 直客 时也可以填入 memberId
  • └ ext
  • String
  • 可选
  • {}
  • 扩展内容, 暂时无用
top_creative_report_query_v_o TopCreativeReportQueryVO 必须 topCreativeReportQueryVO
  • └ by_page
  • Boolean
  • 必须
  • true
  • 是否分页
  • └ split_type
  • String
  • 必须
  • hour
  • 汇总类型 sum-汇总,day-分天,week-分周,month-分月
  • └ unify_type
  • String
  • 必须
  • zhai
  • 归因口径,zhai-末次点击归因, mta-mta归因
  • └ start_time
  • String
  • 必须
  • 2023-06-06
  • 开始时间
  • └ end_time
  • String
  • 必须
  • 2023-06-12
  • 结束时间
  • └ effect_equal
  • Number
  • 必须
  • 15
  • 归因周期,1、3、7、15、30
  • └ query_domains
  • String []
  • 可选
  • [creative]
  • 聚合维度,creative-创意,date-时间
  • └ query_field_in_list
  • String []
  • 必须
  • adPv
  • 查询指标必填,与bp页面一致,具体可用值,看返回字段中reportIndex字段,下划线改为驼峰形式
  • └ biz_code_in_list
  • String []
  • 可选
  • ["onebpDisplay"]
  • 营销场景code,具体code见 account.get.can.use.bizcode 此api返回
  • └ province_id_in_list
  • Number []
  • 可选
  • [1]
  • 省份筛选
  • └ strategy_creative_id_or_name
  • String
  • 可选
  • 商品
  • 仅创意报表有效,创意筛选, 创意id或者名称
  • └ strategy_optimize_target_in_list
  • Number []
  • 可选
  • [3003]
  • 优化目标筛选
  • └ strategy_campaign_id_in_list
  • Number []
  • 可选
  • [68798644117]
  • 计划id筛选
  • └ offset
  • Number
  • 可选
  • 10
  • 偏移量
  • └ page_size
  • Number
  • 可选
  • 10
  • 页面大小
  • └ source
  • String
  • 可选
  • baseReport
  • 来源
  • └ original_biz_code_in_list
  • String []
  • 可选
  • [adStrategyDkx, adStrategyFans, adStrategyRuHui, adStrategyCrowd]
  • 原二级场景

响应参数

名称 类型 示例值 描述
top_result TopResult topResult
  • info
  • TopInfo
  • 通用前端结果的Info信息
  • 请求系统信息
  • └ ok
  • Boolean
  • true
  • 是否成功
  • └ message
  • String
  • 参数错误
  • 错误信息
  • └ error_code
  • String
  • xxxxx
  • 错误编码
  • top_report_v_o_top_bulk_data
  • TopBulkData
  • 结果集
  • └ count
  • Number
  • 10
  • 成功数量
  • top_report_v_o_list
  • TopReportVO []
  • 批量成功结果集
  • └ biz_code
  • String
  • onebpDisplay
  • 场景code
  • └ hour_id
  • String
  • 15
  • 小时ID
  • └ scene1_name
  • String
  • 人群推广
  • 场景名称
  • └ thedate
  • String
  • 2023-06-12 16:00
  • 日期
  • └ campaign_id
  • String
  • 11111111
  • 计划id
  • └ campaign_name
  • String
  • 促进成交_最大化拿量
  • 计划名称
  • └ adgroup_id
  • String
  • 11111111
  • 单元id
  • └ adgroup_name
  • String
  • 测试商品
  • 单元名称
  • └ bidword_id
  • String
  • 1111111
  • 关键词id
  • └ original_word
  • String
  • 瘦肩
  • 关键词/词包名称
  • └ bidword_pkg_id
  • String
  • 1111111
  • 关键词包id
  • └ bid_word_type
  • String
  • 词 word, 词包 wordPkg
  • 词的类型
  • └ promotion_id
  • String
  • 670425387744
  • 推广宝贝id
  • └ promotion_name
  • String
  • 测试商品
  • 推广宝贝名称
  • └ img_url
  • String
  • http://****.com
  • 推广宝贝图片地址
  • └ link_url
  • String
  • http://****.com
  • 推广宝贝跳转地址
  • └ bp_crowd_id
  • String
  • 676456456456
  • 人群id
  • └ crowd_name
  • String
  • 店铺长期价值人群
  • 人群名称
  • └ creative_id
  • String
  • 710660000650001
  • 创意id
  • └ creative_name
  • String
  • 方图1:1资源位_20230511_111045
  • 创意名称
  • └ creative_image_path
  • String
  • http://****.com
  • 创意图片地址
  • └ creative_vedio_path
  • String
  • http://****.com
  • 创意视频地址
  • └ creative_size
  • String
  • 800*800
  • 创意尺寸
  • └ black_creative_promotion_id
  • String
  • 702675398571
  • 黑盒创意的 宝贝id,当创意id为 -1 时使用
  • └ black_creative_promotion_type
  • String
  • 11
  • 黑盒创意 宝贝主体类型,当创意id为 -1 时使用
  • └ province_id
  • String
  • 599
  • 省份id
  • └ province_name
  • String
  • 中国香港
  • 省份名称
  • └ city_id
  • String
  • 599
  • 城市id
  • └ city_name
  • String
  • 中国香港
  • 城市名称
  • report_index
  • TopReportIndexVO
  • 和bp页面一致
  • 报表指标集合对象
  • └ total_charge
  • String
  • xxxxx
  • 总花费
  • └ crowd_scene_charge
  • String
  • xxxxx
  • 消费者运营花费
  • └ item_scene_charge
  • String
  • xxxxx
  • 货品运营花费
  • └ activity_scene_charge
  • String
  • xxxxx
  • 活动运营花费
  • └ display_charge
  • String
  • xxxxx
  • 人群场景花费
  • └ search_charge
  • String
  • xxxxx
  • 关键词花费
  • └ content_scene_charge
  • String
  • xxxxx
  • 内容场景花费
  • └ shop_scene_charge
  • String
  • xxxxx
  • 店铺运营场景花费
  • └ ad_pv
  • String
  • xxxxx
  • 展现量
  • └ click
  • String
  • xxxxx
  • 点击量
  • └ charge
  • String
  • xxxxx
  • 花费
  • └ ctr
  • String
  • xxxxx
  • 点击率
  • └ ecpc
  • String
  • xxxxx
  • 平均点击花费
  • └ ecpm
  • String
  • xxxxx
  • 千次展现花费
  • └ prepay_inshop_amt
  • String
  • xxxxx
  • 总预售成交金额
  • └ prepay_inshop_num
  • String
  • xxxxx
  • 总预售成交笔数
  • └ prepay_dir_amt
  • String
  • xxxxx
  • 直接预售成交金额
  • └ prepay_dir_num
  • String
  • xxxxx
  • 直接预售成交笔数
  • └ prepay_indir_amt
  • String
  • xxxxx
  • 间接预售成交金额
  • └ prepay_indir_num
  • String
  • xxxxx
  • 间接预售成交笔数
  • └ alipay_dir_amt
  • String
  • xxxxx
  • 直接成交金额
  • └ alipay_indir_amt
  • String
  • xxxxx
  • 间接成交金额
  • └ alipay_inshop_amt
  • String
  • xxxxx
  • 总成交金额
  • └ alipay_inshop_num
  • String
  • xxxxx
  • 总成交笔数
  • └ alipay_dir_num
  • String
  • xxxxx
  • 直接成交笔数
  • └ alipay_indir_num
  • String
  • xxxxx
  • 间接成交笔数
  • └ cvr
  • String
  • xxxxx
  • 成交转化率
  • └ roi
  • String
  • xxxxx
  • 投入产出比
  • └ alipay_inshop_cost
  • String
  • xxxxx
  • 总成交成本
  • └ cart_inshop_num
  • String
  • xxxxx
  • 总购物车数
  • └ cart_dir_num
  • String
  • xxxxx
  • 直接购物车数
  • └ cart_indir_num
  • String
  • xxxxx
  • 间接购物车数
  • └ cart_rate
  • String
  • xxxxx
  • 加购率
  • └ item_col_inshop_num
  • String
  • xxxxx
  • 收藏宝贝数
  • └ shop_col_dir_num
  • String
  • xxxxx
  • 收藏店铺数
  • └ shop_col_inshop_cost
  • String
  • xxxxx
  • 店铺收藏成本
  • └ col_cart_num
  • String
  • xxxxx
  • 总收藏加购数
  • └ col_cart_cost
  • String
  • xxxxx
  • 总收藏加购成本
  • └ item_col_cart
  • String
  • xxxxx
  • 宝贝收藏加购数
  • └ item_col_cart_cost
  • String
  • xxxxx
  • 宝贝收藏加购成本
  • └ col_num
  • String
  • xxxxx
  • 总收藏数
  • └ item_col_inshop_cost
  • String
  • xxxxx
  • 宝贝收藏成本
  • └ item_col_inshop_rate
  • String
  • xxxxx
  • 宝贝收藏率
  • └ cart_cost
  • String
  • xxxxx
  • 加购成本
  • └ gmv_inshop_num
  • String
  • xxxxx
  • 拍下订单笔数
  • └ gmv_inshop_amt
  • String
  • xxxxx
  • 拍下订单金额
  • └ item_col_dir_num
  • String
  • xxxxx
  • 直接收藏宝贝数
  • └ item_col_indir_num
  • String
  • xxxxx
  • 间接收藏宝贝数
  • └ coupon_shop_num
  • String
  • xxxxx
  • 优惠券领取量
  • └ shopping_num
  • String
  • xxxxx
  • 购物金充值笔数
  • └ shopping_amt
  • String
  • xxxxx
  • 购物金充值金额
  • └ ww_num
  • String
  • xxxxx
  • 旺旺咨询量
  • └ inshop_pv
  • String
  • xxxxx
  • 引导访问量
  • └ inshop_uv
  • String
  • xxxxx
  • 引导访问人数
  • └ inshop_potential_uv
  • String
  • xxxxx
  • 引导访问潜客数
  • └ inshop_potential_uv_rate
  • String
  • xxxxx
  • 引导访问潜客占比
  • └ rh_rate
  • String
  • xxxxx
  • 入会率
  • └ rh_num
  • String
  • xxxxx
  • 入会量
  • └ inshop_pv_rate
  • String
  • xxxxx
  • 引导访问率
  • └ deep_inshop_pv
  • String
  • xxxxx
  • 深度访问量
  • └ avg_access_page_num
  • String
  • xxxxx
  • 平均访问页面数
  • └ new_alipay_inshop_uv
  • String
  • xxxxx
  • 成交新客数
  • └ new_alipay_inshop_uv_rate
  • String
  • xxxxx
  • 成交新客占比
  • └ hy_sg_uv
  • String
  • xxxxx
  • 会员首购人数
  • └ hy_pay_amt
  • String
  • xxxxx
  • 会员成交金额
  • └ hy_pay_num
  • String
  • xxxxx
  • 会员成交笔数
  • └ natural_pay_amt
  • String
  • xxxxx
  • 自然流量转化金额
  • └ org_natural_pv
  • String
  • xxxxx
  • 自然流量曝光量
  • └ alipay_inshop_uv
  • String
  • xxxxx
  • 成交人数
  • └ alipay_inshop_num_avg
  • String
  • xxxxx
  • 人均成交笔数
  • └ alipay_inshop_amt_avg
  • String
  • xxxxx
  • 人均成交金额
  • └ original_scene_name
  • String
  • 人群推广
  • 原二级场景名称
  • └ original_biz_code
  • String
  • onebpDisplay
  • 原二级场景bizCode

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewReportQueryCreativeRequest req = new UniversalbpNewReportQueryCreativeRequest();
UniversalbpNewReportQueryCreativeRequest.TopServiceContext obj1 = new UniversalbpNewReportQueryCreativeRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewReportQueryCreativeRequest.TopCreativeReportQueryVO obj2 = new UniversalbpNewReportQueryCreativeRequest.TopCreativeReportQueryVO();
obj2.setByPage(true);
obj2.setSplitType("hour");
obj2.setUnifyType("zhai");
obj2.setStartTime("2023-06-06");
obj2.setEndTime("2023-06-12");
obj2.setEffectEqual(15L);
obj2.setQueryDomains("creative");
obj2.setQueryFieldInList("adPv");
obj2.setBizCodeInList(""onebpDisplay"");
obj2.setProvinceIdInList(new Long[] { 1 };
);
obj2.setStrategyCreativeIdOrName("商品");
obj2.setStrategyOptimizeTargetInList(new Long[] { 3003 };
);
obj2.setStrategyCampaignIdInList(new Long[] { 68798644117 };
);
obj2.setOffset(10L);
obj2.setPageSize(10L);
obj2.setSource("baseReport");
obj2.setOriginalBizCodeInList("adStrategyDkx, adStrategyFans, adStrategyRuHui, adStrategyCrowd");
req.setTopCreativeReportQueryVO(obj2);
UniversalbpNewReportQueryCreativeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<universalbp_new_report_query_creative_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <top_report_v_o_top_bulk_data>
            <count>10</count>
            <top_report_v_o_list>
                <top_report_v_o>
                    <biz_code>onebpDisplay</biz_code>
                    <hour_id>15</hour_id>
                    <scene1_name>人群推广</scene1_name>
                    <thedate>2023-06-12 16:00</thedate>
                    <campaign_id>11111111</campaign_id>
                    <campaign_name>促进成交_最大化拿量</campaign_name>
                    <adgroup_id>11111111</adgroup_id>
                    <adgroup_name>测试商品</adgroup_name>
                    <bidword_id>1111111</bidword_id>
                    <original_word>瘦肩</original_word>
                    <bidword_pkg_id>1111111</bidword_pkg_id>
                    <bid_word_type>词 word, 词包 wordPkg</bid_word_type>
                    <promotion_id>670425387744</promotion_id>
                    <promotion_name>测试商品</promotion_name>
                    <img_url>http://****.com</img_url>
                    <link_url>http://****.com</link_url>
                    <bp_crowd_id>676456456456</bp_crowd_id>
                    <crowd_name>店铺长期价值人群</crowd_name>
                    <creative_id>710660000650001</creative_id>
                    <creative_name>方图1:1资源位_20230511_111045</creative_name>
                    <creative_image_path>http://****.com</creative_image_path>
                    <creative_vedio_path>http://****.com</creative_vedio_path>
                    <creative_size>800*800</creative_size>
                    <black_creative_promotion_id>702675398571</black_creative_promotion_id>
                    <black_creative_promotion_type>11</black_creative_promotion_type>
                    <province_id>599</province_id>
                    <province_name>中国香港</province_name>
                    <city_id>599</city_id>
                    <city_name>中国香港</city_name>
                    <report_index>
                        <total_charge>xxxxx</total_charge>
                        <crowd_scene_charge>xxxxx</crowd_scene_charge>
                        <item_scene_charge>xxxxx</item_scene_charge>
                        <activity_scene_charge>xxxxx</activity_scene_charge>
                        <display_charge>xxxxx</display_charge>
                        <search_charge>xxxxx</search_charge>
                        <content_scene_charge>xxxxx</content_scene_charge>
                        <shop_scene_charge>xxxxx</shop_scene_charge>
                        <ad_pv>xxxxx</ad_pv>
                        <click>xxxxx</click>
                        <charge>xxxxx</charge>
                        <ctr>xxxxx</ctr>
                        <ecpc>xxxxx</ecpc>
                        <ecpm>xxxxx</ecpm>
                        <prepay_inshop_amt>xxxxx</prepay_inshop_amt>
                        <prepay_inshop_num>xxxxx</prepay_inshop_num>
                        <prepay_dir_amt>xxxxx</prepay_dir_amt>
                        <prepay_dir_num>xxxxx</prepay_dir_num>
                        <prepay_indir_amt>xxxxx</prepay_indir_amt>
                        <prepay_indir_num>xxxxx</prepay_indir_num>
                        <alipay_dir_amt>xxxxx</alipay_dir_amt>
                        <alipay_indir_amt>xxxxx</alipay_indir_amt>
                        <alipay_inshop_amt>xxxxx</alipay_inshop_amt>
                        <alipay_inshop_num>xxxxx</alipay_inshop_num>
                        <alipay_dir_num>xxxxx</alipay_dir_num>
                        <alipay_indir_num>xxxxx</alipay_indir_num>
                        <cvr>xxxxx</cvr>
                        <roi>xxxxx</roi>
                        <alipay_inshop_cost>xxxxx</alipay_inshop_cost>
                        <cart_inshop_num>xxxxx</cart_inshop_num>
                        <cart_dir_num>xxxxx</cart_dir_num>
                        <cart_indir_num>xxxxx</cart_indir_num>
                        <cart_rate>xxxxx</cart_rate>
                        <item_col_inshop_num>xxxxx</item_col_inshop_num>
                        <shop_col_dir_num>xxxxx</shop_col_dir_num>
                        <shop_col_inshop_cost>xxxxx</shop_col_inshop_cost>
                        <col_cart_num>xxxxx</col_cart_num>
                        <col_cart_cost>xxxxx</col_cart_cost>
                        <item_col_cart>xxxxx</item_col_cart>
                        <item_col_cart_cost>xxxxx</item_col_cart_cost>
                        <col_num>xxxxx</col_num>
                        <item_col_inshop_cost>xxxxx</item_col_inshop_cost>
                        <item_col_inshop_rate>xxxxx</item_col_inshop_rate>
                        <cart_cost>xxxxx</cart_cost>
                        <gmv_inshop_num>xxxxx</gmv_inshop_num>
                        <gmv_inshop_amt>xxxxx</gmv_inshop_amt>
                        <item_col_dir_num>xxxxx</item_col_dir_num>
                        <item_col_indir_num>xxxxx</item_col_indir_num>
                        <coupon_shop_num>xxxxx</coupon_shop_num>
                        <shopping_num>xxxxx</shopping_num>
                        <shopping_amt>xxxxx</shopping_amt>
                        <ww_num>xxxxx</ww_num>
                        <inshop_pv>xxxxx</inshop_pv>
                        <inshop_uv>xxxxx</inshop_uv>
                        <inshop_potential_uv>xxxxx</inshop_potential_uv>
                        <inshop_potential_uv_rate>xxxxx</inshop_potential_uv_rate>
                        <rh_rate>xxxxx</rh_rate>
                        <rh_num>xxxxx</rh_num>
                        <inshop_pv_rate>xxxxx</inshop_pv_rate>
                        <deep_inshop_pv>xxxxx</deep_inshop_pv>
                        <avg_access_page_num>xxxxx</avg_access_page_num>
                        <new_alipay_inshop_uv>xxxxx</new_alipay_inshop_uv>
                        <new_alipay_inshop_uv_rate>xxxxx</new_alipay_inshop_uv_rate>
                        <hy_sg_uv>xxxxx</hy_sg_uv>
                        <hy_pay_amt>xxxxx</hy_pay_amt>
                        <hy_pay_num>xxxxx</hy_pay_num>
                        <natural_pay_amt>xxxxx</natural_pay_amt>
                        <org_natural_pv>xxxxx</org_natural_pv>
                        <alipay_inshop_uv>xxxxx</alipay_inshop_uv>
                        <alipay_inshop_num_avg>xxxxx</alipay_inshop_num_avg>
                        <alipay_inshop_amt_avg>xxxxx</alipay_inshop_amt_avg>
                    </report_index>
                    <original_scene_name>人群推广</original_scene_name>
                    <original_biz_code>onebpDisplay</original_biz_code>
                </top_report_v_o>
            </top_report_v_o_list>
        </top_report_v_o_top_bulk_data>
    </top_result>
</universalbp_new_report_query_creative_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

返回
顶部