联盟广告位报表接口
全部接口
V1.1
loading
V1.1
loading
| 所属权限 | Ads Insight |
| 请求地址 | report/ad_union |
| 请求方法 | 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 | 过滤字段结构，promoted_object_type,promoted_object_id,union_position_id |
|
promoted_object_type
|
enum[] | 推广目标类型列表，推广目标类型个数不大于 1 个, 如：["PROMOTED_OBJECT_TYPE_APP_ANDROID"] 最多 1 个，[枚举详情] 数组长度为 1 枚举列表：{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_LINK, PROMOTED_OBJECT_TYPE_ECOMMERCE, PROMOTED_OBJECT_TYPE_LINK_WECHAT, PROMOTED_OBJECT_TYPE_LEAD_AD } |
|
promoted_object_id
|
string[] | 推广目标 id 列表，推广目标 id 个数不大于 100 个, 如：["51213","51214","51215"] 最多 100 个 数组最小长度 1，最大长度 100 字段长度最小 1 字节，长度最大 128 字节 |
|
union_position_id
|
integer[] | 广告位 id 列表，广告位个数不大于 20 个, 如：["51213","51214","51215"] 最多 20 个 数组最小长度 1，最大长度 20 |
|
date_range*
|
struct | 日期范围 |
|
start_date*
|
string | 开始日期，日期格式：YYYY-MM-DD，且小于等于 end_date 字段长度为 10 字节 |
|
end_date*
|
string | 结束日期，日期格式：YYYY-MM-DD，且大于等于 start_date 字段长度为 10 字节 |
|
group_by
|
string[] | 聚合参数，例：["date"]，group by 取值仅限于 union_position_id,date,industry_parent_id,placement_type 这些字段 数组最小长度 1，最大长度 5 字段长度最大 255 字节 |
|
order_by
|
struct[] | 排序参数 数组最小长度 0，最大长度 12 |
|
sort_field*
|
string | 排序字段，需为 fields 字段中指定返回字段的子集，字段类型为数值类的指标均支持排序 字段长度最小 3 字节，长度最大 255 字节 |
|
sort_type*
|
enum | 排序方式，[枚举详情] 枚举列表：{ ASCENDING, DESCENDING } |
|
page
|
integer | 搜索页码，默认值：1 最小值 1，最大值 99999 |
|
page_size
|
integer | 一页显示的数据条数，默认值：10 最小值 1，最大值 100 |
|
fields*
|
string[] | 指定返回的字段列表 数组最小长度 1，最大长度 512 字段长度最小 1 字节，长度最大 64 字节 |
|
async
|
integer | 是否创建异步报表任务，1：是，0：否 最小值 0，最大值 1 |
|
adq_accounts_upgrade_enabled
|
boolean | 针对腾讯广告平台广告账户是否使用升级的新调用方式，true：使用升级的新方式，可以调用新指标体系； false：不使用，仅能调用旧指标体系，不传则默认值 false ； 可选值：{ true, false } |
使用说明
- 本接口支持联盟广告位报表数据的获取。
- group_by 的使用规则如下：
1）为保证接口响应时间，建议查询时间跨度不超过 7 天
2）group by 中指定的字段，才会在 list 中返回
3）group by 中指定 placement_type 时，list 返回中会附加 placement_name 字段
4）group by 中指定 industry_parent_id 时，list 返回中会附加 industry_parent_name 字段。- async 参数表示创建异步报表，指定为 1 时，返回异步任务 id，可通过 [异步报表任务]获取任务数据。
- 每账号（account_id）限制最多 5 分钟创建 1 个异步报表任务。
- 该接口所有涉及金额的字段，单位为分。
- 报表数据量限制：page * pageSize 小于等于 20000, 超过 20000 条数据，请使用创建异步报表任务接口。
请求示例
curl 'https://api.e.qq.com/v1.1/report/ad_union?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering={
"promoted_object_type": [],
"promoted_object_id": [],
"union_position_id": []
}' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'group_by=[]' \
-d 'order_by=[]' \
-d 'page=1' \
-d 'page_size=10' \
-d 'fields=[]'
应答字段
| 名称 | 类型 | 描述 |
|---|---|---|
|
task_id
|
integer | 任务 id |
|
list
|
struct[] | 返回信息列表 |
|
date
|
string | 日期，日期格式：YYYY-MM-DD |
|
union_position_id
|
integer | 广告位 id |
|
placement_name
|
string | 广告位类型名称 |
|
industry_parent_name
|
string | 媒体行业名称 |
|
view_count
|
float | 曝光量 |
|
download_count
|
float | APP 下载完成量 |
|
activated_count
|
float | APP 激活总量 |
|
activated_rate
|
float | APP 下载激活率 |
|
thousand_display_price
|
float | 千次展现均价 |
|
valid_click_count
|
float | 点击量 |
|
ctr
|
float | 点击率 |
|
cpc
|
float | 点击均价 |
|
cost
|
float | 花费 |
|
key_page_view_cost
|
float | 关键页面访问成本 |
|
coupon_click_count
|
float | （游戏）礼包兑换按钮点击 |
|
coupon_issue_count
|
float | （游戏）礼包（券）发放量 |
|
coupon_get_count
|
float | （游戏）礼包（券）领取量 |
|
commodity_page_view_count_combined
|
float | 商品页浏览量 |
|
commodity_page_view_cost_combined
|
float | 商品页浏览成本 |
|
commodity_page_view_rate_combined
|
float | 商品页浏览率 |
|
page_consult_count
|
float | 在线咨询量 |
|
page_consult_cost
|
float | 在线咨询成本 |
|
page_phone_call_direct_count
|
float | 电话直拨量 |
|
page_phone_call_direct_cost
|
float | 电话直拨成本 |
|
page_phone_call_back_count
|
float | 电话回拨量 |
|
page_phone_call_back_cost
|
float | 电话回拨成本 |
|
own_page_navigation_count
|
float | 自有页导航量 |
|
own_page_navi_cost
|
float | 自有页导航成本 |
|
page_reservation_count
|
float | 表单预约量 |
|
page_reservation_rate
|
float | 表单预约率 |
|
page_reservation_cost
|
float | 表单预约成本(次数) |
|
page_reservation_cost_with_people
|
float | 表单预约成本(人数) |
|
checkout_count_combined
|
float | 付费行为量 |
|
checkout_cost_combined
|
float | 付费行为成本 |
|
order_amount
|
float | 订单金额 |
|
order_roi
|
float | 下单花费回报(ROI) |
|
deliver_count
|
float | 订单发货量 |
|
deliver_cost
|
float | 订单发货成本 |
|
sign_in_count
|
float | 订单签收量 |
|
sign_in_cost
|
float | 订单签收成本 |
|
click_checkout_rate_combined
|
float | 点击付费率 |
|
activate_checkout_rate_combined
|
float | 激活付费率 |
|
download_rate
|
float | APP 下载率 |
|
download_cost
|
float | APP 下载成本 |
|
install_count
|
float | APP 安装量 |
|
install_cost
|
float | APP 安装成本 |
|
click_activated_rate
|
float | APP 点击激活率 |
|
activated_cost
|
float | APP 激活成本 |
|
retention_count
|
float | 次日留存人数（APP） |
|
retention_rate
|
float | 次日留存率（APP） |
|
retention_cost
|
float | 次日留存成本（APP） |
|
key_page_view_count
|
float | 关键页面访问量 |
|
register_count_combined
|
float | 注册量 |
|
register_rate_combined
|
float | 注册率 |
|
register_cost_combined
|
float | 注册成本 |
|
application_count_combined
|
float | 金融完件量 |
|
application_cost_combined
|
float | 金融完件成本 |
|
add_to_cart_count_combined
|
float | 加入购物车量 |
|
add_to_cart_cost_combined
|
float | 加入购物车成本 |
|
add_to_cart_amount_combined
|
float | 加入购物车金额 |
|
order_count_combined
|
float | 下单量 |
|
order_rate_combined
|
float | 下单率 |
|
order_cost_combined
|
float | 下单成本 |
|
order_amount_combined
|
float | 下单金额 |
|
order_unit_price_combined
|
float | 下单单价 |
|
checkout_amount_combined
|
float | 付费金额 |
|
follow_count
|
float | 关注量 |
|
forward_count
|
float | 转发量 |
|
read_count
|
float | 阅读量 |
|
praise_count
|
float | 点赞量 |
|
comment_count
|
float | 评论量 |
|
ad_paying_users_combined
|
float | 广告变现人数 |
|
ad_pur_val_combined
|
float | 广告变现金额 |
|
game_create_role_count
|
float | 游戏内创建角色量 |
|
game_authorize_count
|
float | 游戏授权量 |
|
game_tutorial_finish_count
|
float | 游戏完成新手教程量 |
|
effective_leads_count
|
float | 有效线索量 |
|
effective_cost
|
float | 有效线索成本 |
|
page_phone_call_direct_rate
|
float | 电话直拨率 |
|
page_phone_call_back_rate
|
float | 电话回拨率 |
|
page_consult_rate
|
float | 在线咨询率 |
|
deliver_rate
|
float | 订单发货率 |
|
install_rate
|
float | APP 安装率 |
|
arppu_cost_combined
|
float | 付费 ARPPU |
|
activate_arppu_cost_combined
|
float | 付费 ARPPU（激活） |
|
register_arppu_cost_combined
|
float | 付费 ARPPU（注册） |
|
ad_pur_arppu_cost_combined
|
float | 广告变现 ARPPU |
|
activate_ad_pur_arppu_cost_combined
|
float | 广告变现 ARPPU（激活） |
|
register_ad_pur_arppu_cost_combined
|
float | 广告变现 ARPPU（注册） |
|
cheout_fd
|
float | 首日付费金额 |
|
cheout_td
|
float | 3 日付费金额 |
|
cheout_ow
|
float | 7 日付费金额 |
|
cheout_tw
|
float | 14 日付费金额 |
|
cheout_om
|
float | 30 日付费金额 |
|
cheout_fd_reward
|
float | 首日广告花费回报(ROI) |
|
cheout_td_reward
|
float | 3 日广告花费回报(ROI) |
|
cheout_ow_reward
|
float | 7 日广告花费回报(ROI) |
|
cheout_tw_reward
|
float | 14 日广告花费回报(ROI) |
|
cheout_om_reward
|
float | 30 日广告花费回报(ROI) |
|
cheout_total_reward
|
float | 累计广告花费回报(ROI) |
|
first_pay_count
|
float | 首次付费行为人数 |
|
first_pay_rate
|
float | 首次激活付费率 |
|
pre_cre_combined
|
float | 金融预授信量 |
|
pre_cre_val_combined
|
float | 金融预授金额 |
|
cre_combined
|
float | 金融授信量 |
|
cre_val_combined
|
float | 金融授信金额 |
|
withdr_dep_combined
|
float | 金融提现行为量 |
|
withdr_dep_val_combined
|
float | 金融提现金额 |
|
first_pay_cost
|
float | 首次付费成本 |
|
conversions_count
|
float | 目标转化量 |
|
conversions_rate
|
float | 目标转化率 |
|
conversions_cost
|
float | 目标转化成本 |
|
deep_conversions_count
|
float | 深度目标转化量 |
|
deep_conversions_rate
|
float | 深度目标转化率 |
|
deep_conversions_cost
|
float | 深度转化成本 |
|
first_memcard_count_combined
|
float | 首次购买会员人数 |
|
first_memcard_rate_combined
|
float | 首次购买会员率 |
|
first_memcard_cost_combined
|
float | 首次购买会员成本 |
|
memcard_count_combined
|
float | 购买会员次数 |
|
reservation_uv
|
float | 表单预约人数 |
|
cre_cost_combined
|
float | 金融授信成本 |
|
pre_cre_cost_combined
|
float | 金融预授信成本 |
|
mini_game_paying_count
|
float | 小游戏付费次数 |
|
mini_game_paying_amount
|
float | 小游戏付费金额 |
|
mini_game_first_paying_users
|
float | 小游戏首次付费人数 |
|
mini_game_create_role_users
|
float | 游戏内创建角色人数 |
|
mini_game_create_role_cost
|
float | 游戏内创建角色成本 |
|
mini_game_key_page_viewers
|
float | 小游戏关键页面访问人数 |
|
mini_game_key_page_view_cost
|
float | 小游戏关键页面访问成本 |
|
mini_game_paying_amount_by_upload
|
float | 小游戏付费金额（平台上报） |
|
mini_game_paying_count_by_upload
|
float | 小游戏付费次数（平台上报） |
|
purchase_amount_with_coupon
|
float | 平台页卡券购买量 |
|
purchase_amount_with_coupon_cost
|
float | 平台页卡券购买成本 |
|
mini_game_paying_amount_click_d1_by_upload
|
float | 小游戏点击首日付费金额（平台上报） |
|
key_page_view_rate
|
float | 关键页面访问率 |
|
activate_register_rate
|
float | 激活注册率 |
|
page_info
|
struct | 分页配置信息 |
|
page
|
integer | 搜索页码 |
|
page_size
|
integer | 一页显示的数据条数 |
|
total_number
|
integer | 总条数 |
|
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}可视化调试工具
问题仍未解决？
请前往腾讯广告反馈中心在线提交问题，我们的人工客服将为你服务
