接口文档SDK业务专题开发者工具

关键词报表接口
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 bidword_rpt/get
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
filtering
struct[] 过滤条件
数组最小长度 1,最大长度 9
field*
string 字段名
operator*
enum 操作符
values*
string[] 字段取值
group_by
string[] 聚合参数,见 [聚合规则]
数组最小长度 1,最大长度 4
字段长度最大 255 字节
order_by
struct[] 排序字段
数组最小长度 1,最大长度 2
sort_field*
string 排序字段
可选值:{ cpc, ctr, cost, view_count, valid_click_count, conversions_count, conversions_by_click_count, conversions_by_display_count, conversions_rate, conversions_by_display_rate, conversions_by_click_rate, conversions_cost, conversions_by_display_cost, conversions_by_click_cost, deep_conversions_count, deep_conversions_rate, deep_conversions_cost, thousand_display_price }
sort_type*
enum 排序方式,[枚举详情]
枚举列表:{ ASCENDING, DESCENDING }
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 20000
rpt_filter
struct 报表过滤器
time_range*
struct 日期范围,只能查询近两年内的数据,日期跨度最大为 365 天,日期格式,如:{"start_date":"2011-01-01","end_date":"2011-01-02"}
start_date*
string 查询日期,日期格式,如 20140301 或者 2014-03-01
字段长度最小 8 字节,长度最大 10 字节
end_date*
string 查询日期,日期格式,如 20140301 或者 2014-03-01
字段长度最小 8 字节,长度最大 10 字节
time_dimension*
integer 时间维度,1-按小时维度,会自动增加 groupby:day 和 hour ; 2-按天维度,自动增加 groupby:date ; 3-按整体维度; 4-按时段维度,自动增加 groupby:hour
最小值 1,最大值 4
time_line
enum 时间口径,[枚举详情]
枚举列表:{ REQUEST_TIME, REPORTING_TIME, ACTIVE_TIME }
biz_filter
struct 关键词过滤器
bidword_id_list
integer[] 关键词 id 列表
数组最小长度 0,最大长度 500
最小值 0,最大值 9200000000000000000
campaign_type
enum 计划类型,[枚举详情]
枚举列表:{ CAMPAIGN_TYPE_NORMAL, CAMPAIGN_TYPE_WECHAT_MOMENTS, CAMPAIGN_TYPE_SEARCH, CAMPAIGN_TYPE_FREETRADE, CAMPAIGN_TYPE_CONTENT_PROMOTION }
bidword_list
string[] 关键词列表
数组最小长度 0,最大长度 1000
字段长度最小@min_size 字节,长度最大@max_size 字节
query_type
integer[] 查询类型参数
数组最小长度 1,最大长度 3
最小值 1,最大值 3
fields
string[] 指定返回的字段列表
数组最小长度 1,最大长度 1024
字段长度最小 1 字节,长度最大 64 字节
use_unified_report
boolean 请求参数
可选值:{ true, false }

使用说明

  1. 本接口支持关键词报表数据的获取。
  2. group_by 的使用规则如下:
    1)为保证接口响应时间,建议查询时间跨度不超过 7 天
    2)group by 中指定的字段,才会在 list 中返回
    3)group by 中指定 bidword_id 时,list 返回中会附加 bidword 字段
    4)group by 中指定 campaign_id 时,list 返回中会附加 campaign_name 字段
    5)group by 中指定 adgroup_id 时,list 返回中会附加 adgroup_name 字段。
  3. 该接口所有涉及金额的字段,单位为元。

请求示例


curl 'https://api.e.qq.com/v1.1/bidword_rpt/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'group_by=[]' \
-d 'order_by=[]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'rpt_filter={
    "time_range": []
}' \
-d 'biz_filter={
    "bidword_id_list": [],
    "bidword_list": []
}' \
-d 'query_type=[]' \
-d 'fields=[]' 
					

应答字段

名称 类型 描述
conf
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数
list
struct[] 返回信息列表
bidword_id
integer 关键词 id
bidword
string 关键词
stats_date
string 日期,groupby 有 date 按照天聚合时,才会返回数据
campaign_id
int64 推广计划 id,当获取广告主维度报表时,该值无意义
campaign_name
string 推广计划名称(字段长度最小 1 个等宽字符,长度最大 60 等宽字符(即字段最大长度为 60 个中文字或全角标点,120 个英文字或半角标点。一个等宽字符等价于一个中文,等价于两个英文。),不可与名下其他推广计划重名
adgroup_id
int64 广告组 id,当获取广告主维度、推广计划维度报表时,该值无意义
adgroup_name
string 广告组名称
time
string 日期,groupby 有 hour 按照小时聚合时,才会返回数据
placement_group_id
integer 版位 id
placement_group_name
string 版位名称,groupby 有 placement_group_id 时,才会返回数据
cpc
string 点击均价
ctr
string 点击率
cost
string 花费
view_count
string 曝光量
valid_click_count
string 点击量
conversions_count
string 目标转化量
conversions_by_click_count
string 目标转化量(点击归因)
conversions_by_display_count
string 目标转化量(曝光归因)
conversions_rate
string 目标转化率
conversions_by_display_rate
string 目标转化率(曝光归因)
conversions_by_click_rate
string 目标转化率(点击归因)
conversions_cost
string 目标转化成本
conversions_by_display_cost
string 目标转化成本(曝光归因)
conversions_by_click_cost
string 目标转化成本(点击归因)
deep_conversions_count
string 深度目标转化量
deep_conversions_rate
string 深度目标转化率
deep_conversions_cost
string 深度转化成本
thousand_display_price
string 千次展现均价
match_type
integer 匹配类型
match_type_name
string 匹配类型名称,groupby 有 match_type 时,才会返回数据
contract_type
integer 合约类型
contract_type_name
string 合约类型
ad_id
int64 广告 id
ad_name
string 广告名称,小于 120 个英文字符,同一账户下名称不允许重复。
biz_follow_count
string 公众号关注次数
biz_follow_uv
string 公众号关注人数
live_stream_avg_time
string 直播间人均观看时长(秒)
live_stream_exp_uv
string 视频号直播观看人数
video_live_heart_user_count
string 视频号直播点赞人数
video_live_comment_user_count
string 视频号直播评论人数
video_live_share_user_count
string 视频号直播分享人数
video_live_click_commodity_user_count
string 视频号直播商品点击人数
zone_header_click_count
string 顶部运营位-点击次数
basic_info_client_count
string 官方信息区-点击次数
account_info_click_count
string 官方账号区-点击次数
activity_info_click_count
string 热门活动区-点击次数
biz_reg_uv
string 公众号内注册人数
biz_reservation_uv
string 公众号内填单人数
biz_order_uv
string 公众号内下单人数
biz_page_apply_uv
string 公众号内进件人数
biz_credit_uv
string 公众号内授信人数
biz_withdraw_deposits_uv
string 公众号内提现人数
biz_pre_credit_uv
string 公众号内预授信人数
biz_reg_order_amount
string 公众号内注册订单金额
biz_reservation_count
string 公众号内填单次数
biz_reservation_amount
string 公众号内填单金额
biz_order_count
string 公众号内下单次数
biz_order_amount
string 公众号内下单金额
biz_1d_order_count
string 首日公众号内下单次数
biz_1d_order_amount
string 首日公众号内下单金额
biz_purchase_count
string 公众号内付费次数
biz_purchase_amount
string 公众号内付费金额
biz_consult_count
string 公众号内发消息人数
biz_reading_count
string 阅读粉丝量
biz_page_apply_count
string 公众号内进件次数
biz_credit_count
string 公众号内授信次数
biz_deposit_count
string 公众号内提现次数
biz_1d_purchase_count
string 公众号内首日付费次数
biz_1d_purchase_amount
string 公众号内首日付费金额
biz_3d_purchase_count
string 公众号内 3 日付费次数
biz_3d_purchase_amount
string 公众号内 3 日付费金额
biz_7d_purchase_count
string 公众号内 7 日付费次数
biz_7d_purchase_amount
string 公众号内 7 日付费金额
biz_15d_purchase_count
string 公众号内 15 日付费次数
biz_15d_purchase_amount
string 公众号内 15 日付费金额
biz_30d_purchase_count
string 公众号内 30 日付费次数
biz_30d_purchase_amount
string 公众号内 30 日付费金额
biz_pre_credit_pv
string 公众号内预授信次数
video_follow_count
string 视频号关注
video_heart_count
string 视频号视频点赞
video_comment_count
string 视频号视频评论
video_live_subscribe_count
string 视频号直播预约
video_live_exp_count
string 视频号直播观看
video_live_heart_count
string 视频号直播点赞
video_live_comment_count
string 视频号直播评论
video_live_share_count
string 视频号直播分享
video_live_cick_commodity_count
string 视频号直播商品点击
video_live_commodity_bubble_exp_count
string 视频号直播转化组件曝光次数(气泡)
live_stream_commodity_bubble_clk_pv
string 视频号直播转化组件点击次数(气泡)
live_stream_commodity_shop_bag_clk_pv
string 视频号直播转化组件点击次数(购物袋)
live_stream_commodity_shop_list_exp_pv
string 视频号直播转化组件曝光次数(购物袋)
live_stream_order_pv
string 直播下单次数
clk_redpocket_btn_get_pv
string 官方信息区-红包领取点击次数
clk_redpocket_btn_share_pv
string 官方信息区-红包分享点击次数
clk_redpocket_btn_jump_pv
string 官方信息区-红包跳转落地页次数
clk_goods_header_pv
string 品牌背景-点击次数
clk_goods_info_pv
string 主推商品-点击次数
clk_goods_recommend_pv
string 相关商品-点击次数
clk_middle_showwindow_pv
string 中部橱窗-点击量
clk_footer_pv
string 底部功能区-点击量
clk_middle_goods_pv
string 系列商品-点击量
clk_middle_btn_pv
string 中部按钮-点击量
clk_middle_section_pv
string 栏目-点击量
clk_middle_gridview_pv
string 宫格-点击量
page_reservation_count
string 公众号内填单次数
reservation_amount
string 公众号内填单金额
order_pv
string 公众号内下单次数
order_amount
string 公众号内下单金额
order_follow_1d_pv
string 首日公众号内下单次数
order_follow_1d_amount
string 首日公众号内下单金额
purchase_pv
string 公众号内付费次数
purchase_amount
string 公众号内付费金额
apply_pv
string 公众号内进件次数
credit_pv
string 公众号内授信次数
withdraw_deposit_pv
string 公众号内提现次数
cheout_pv_1d
string 公众号内首日付费次数
cheout_fd
string 公众号内首日付费金额
cheout_pv_3d
string 公众号内 3 日付费次数
cheout_td
string 公众号内 3 日付费金额
cheout_pv_7d
string 公众号内 7 日付费次数
cheout_ow
string 公众号内 7 日付费金额
purchase_clk_15d_pv
string 公众号内 15 日付费次数
cheout_15d
string 公众号内 15 日付费金额
purchase_clk_30d_pv
string 公众号内 30 日付费次数
cheout_om
string 公众号内 30 日付费金额
pre_credit_pv
string 公众号内预授信次数
exp_avg_rank
string 上方位平均排名
exp_overall_top_pv
string 上方位曝光次数
clk_top_pv
string 上方位点击次数
real_cost_top
string 上方位花费
total
struct 总计返回结构
cpc
string 点击均价
ctr
string 点击率
cost
string 花费
view_count
string 曝光量
valid_click_count
string 点击量
conversions_count
string 目标转化量
conversions_by_click_count
string 目标转化量(点击归因)
conversions_by_display_count
string 目标转化量(曝光归因)
conversions_rate
string 目标转化率
conversions_by_display_rate
string 目标转化率(曝光归因)
conversions_by_click_rate
string 目标转化率(点击归因)
conversions_cost
string 目标转化成本
conversions_by_display_cost
string 目标转化成本(曝光归因)
conversions_by_click_cost
string 目标转化成本(点击归因)
deep_conversions_count
string 深度目标转化量
deep_conversions_rate
string 深度目标转化率
deep_conversions_cost
string 深度转化成本
thousand_display_price
string 千次展现均价
biz_follow_count
string 公众号关注次数
biz_follow_uv
string 公众号关注人数
live_stream_avg_time
string 直播间人均观看时长(秒)
live_stream_exp_uv
string 视频号直播观看人数
video_live_heart_user_count
string 视频号直播点赞人数
video_live_comment_user_count
string 视频号直播评论人数
video_live_share_user_count
string 视频号直播分享人数
video_live_click_commodity_user_count
string 视频号直播商品点击人数
zone_header_click_count
string 顶部运营位-点击次数
basic_info_client_count
string 官方信息区-点击次数
account_info_click_count
string 官方账号区-点击次数
activity_info_click_count
string 热门活动区-点击次数
biz_reg_uv
string 公众号内注册人数
biz_reservation_uv
string 公众号内填单人数
biz_order_uv
string 公众号内下单人数
biz_page_apply_uv
string 公众号内进件人数
biz_credit_uv
string 公众号内授信人数
biz_withdraw_deposits_uv
string 公众号内提现人数
biz_pre_credit_uv
string 公众号内预授信人数
biz_reg_order_amount
string 公众号内注册订单金额
biz_reservation_count
string 公众号内填单次数
biz_reservation_amount
string 公众号内填单金额
biz_order_count
string 公众号内下单次数
biz_order_amount
string 公众号内下单金额
biz_1d_order_count
string 首日公众号内下单次数
biz_1d_order_amount
string 首日公众号内下单金额
biz_purchase_count
string 公众号内付费次数
biz_purchase_amount
string 公众号内付费金额
biz_consult_count
string 公众号内发消息人数
biz_reading_count
string 阅读粉丝量
biz_page_apply_count
string 公众号内进件次数
biz_credit_count
string 公众号内授信次数
biz_deposit_count
string 公众号内提现次数
biz_1d_purchase_count
string 公众号内首日付费次数
biz_1d_purchase_amount
string 公众号内首日付费金额
biz_3d_purchase_count
string 公众号内 3 日付费次数
biz_3d_purchase_amount
string 公众号内 3 日付费金额
biz_7d_purchase_count
string 公众号内 7 日付费次数
biz_7d_purchase_amount
string 公众号内 7 日付费金额
biz_15d_purchase_count
string 公众号内 15 日付费次数
biz_15d_purchase_amount
string 公众号内 15 日付费金额
biz_30d_purchase_count
string 公众号内 30 日付费次数
biz_30d_purchase_amount
string 公众号内 30 日付费金额
biz_pre_credit_pv
string 公众号内预授信次数
video_follow_count
string 视频号关注
video_heart_count
string 视频号视频点赞
video_comment_count
string 视频号视频评论
video_live_subscribe_count
string 视频号直播预约
video_live_exp_count
string 视频号直播观看
video_live_heart_count
string 视频号直播点赞
video_live_comment_count
string 视频号直播评论
video_live_share_count
string 视频号直播分享
video_live_cick_commodity_count
string 视频号直播商品点击
video_live_commodity_bubble_exp_count
string 视频号直播转化组件曝光次数(气泡)
live_stream_commodity_bubble_clk_pv
string 视频号直播转化组件点击次数(气泡)
live_stream_commodity_shop_bag_clk_pv
string 视频号直播转化组件点击次数(购物袋)
live_stream_commodity_shop_list_exp_pv
string 视频号直播转化组件曝光次数(购物袋)
live_stream_order_pv
string 直播下单次数
clk_redpocket_btn_get_pv
string 官方信息区-红包领取点击次数
clk_redpocket_btn_share_pv
string 官方信息区-红包分享点击次数
clk_redpocket_btn_jump_pv
string 官方信息区-红包跳转落地页次数
clk_goods_header_pv
string 品牌背景-点击次数
clk_goods_info_pv
string 主推商品-点击次数
clk_goods_recommend_pv
string 相关商品-点击次数
clk_middle_showwindow_pv
string 中部橱窗-点击量
clk_footer_pv
string 底部功能区-点击量
clk_middle_goods_pv
string 系列商品-点击量
clk_middle_btn_pv
string 中部按钮-点击量
clk_middle_section_pv
string 栏目-点击量
clk_middle_gridview_pv
string 宫格-点击量
page_reservation_count
string 公众号内填单次数
reservation_amount
string 公众号内填单金额
order_pv
string 公众号内下单次数
order_amount
string 公众号内下单金额
order_follow_1d_pv
string 首日公众号内下单次数
order_follow_1d_amount
string 首日公众号内下单金额
purchase_pv
string 公众号内付费次数
purchase_amount
string 公众号内付费金额
apply_pv
string 公众号内进件次数
credit_pv
string 公众号内授信次数
withdraw_deposit_pv
string 公众号内提现次数
cheout_pv_1d
string 公众号内首日付费次数
cheout_fd
string 公众号内首日付费金额
cheout_pv_3d
string 公众号内 3 日付费次数
cheout_td
string 公众号内 3 日付费金额
cheout_pv_7d
string 公众号内 7 日付费次数
cheout_ow
string 公众号内 7 日付费金额
purchase_clk_15d_pv
string 公众号内 15 日付费次数
cheout_15d
string 公众号内 15 日付费金额
purchase_clk_30d_pv
string 公众号内 30 日付费次数
cheout_om
string 公众号内 30 日付费金额
pre_credit_pv
string 公众号内预授信次数
exp_avg_rank
string 上方位平均排名
exp_overall_top_pv
string 上方位曝光次数
clk_top_pv
string 上方位点击次数
real_cost_top
string 上方位花费
reportv3_list
array 返回信息列表

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "conf": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        },
        "list": [
            {
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "adgroup_name": "推广广告",
                "ad_id": "<AD_ID>"
            }
        ],
        "total": [],
        "reportv3_list": []
    }
}

可视化调试工具