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

获取广告诊断信息
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 ad_diagnosis/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
adgroup_id_list*
integer[] 广告 id 列表,广告 id 个数最多 20 个,例如[123456,223411,345671]
数组最小长度 1,最大长度 20
detail_fields
string[] 诊断明细的返回字段,可选:funnel,target_detail,compete_detail,exposure_detail,click_detail,conversion_detail,cpa_detail,creative_detail,optimization
数组最大长度 255
可选值:{ }

使用说明

  1. 调用发起时,若该广告当前诊断周期内曝光信息不足,将无法返回诊断结果;(1) 当请求的所有广告均无诊断结果时,返回结果 list 为空 (2) 当请求的部分广告存在诊断结果时,则 list 只返回有结果的广告诊断记录。
  2. 当返回字段 is_potential 等于 false (非潜力广告),潜力数据详情 potential_detail 将返回 null。

请求示例


curl 'https://api.e.qq.com/v1.1/ad_diagnosis/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": 12345,
    "adgroup_id_list": [
        123,
        456
    ],
    "detail_fields": []
}'
					

应答字段

名称 类型 描述
list
struct[] 广告诊断列表
adgroup_id
int64 广告 id
diagnose_time
string 诊断时间
operate_suggestion
enum 操作建议,操作建议的枚举,[枚举详情]
learning_status
enum 学习状态,学习状态的枚举,[枚举详情]
cost_guarantee_status
enum 赔付状态,赔付状态的枚举,[枚举详情]
cost_guarantee_money
integer 赔付金额(分),大于等于 0 且小于 9223372036854775807
exposure_compete_score
string 曝光竞争力得分(1-10 分)
exposure_raise_rate
string 曝光量同比昨日
cpa_bias_today
string 当日成本偏差
cpa_bias_overall
string 最近 7 日成本偏差
is_ocpx
boolean 是否是 ocpx 广告,true 或 false
optimization_goal
string 优化目标
deep_optimization_goal
string 深度优化目标
conclusion_description
string 诊断结论,长文案描述
has_diagnose_detail
boolean 是否有诊断详情,true 或 false
operate_suggestion_desc
string 操作建议文案
learning_status_desc
string 学习状态描述
exposure_compete_score_desc
string 曝光竞争力文案
detail
struct 诊断详细信息
funnel
struct 诊断详情-漏斗分析明细
targeting_wideness_rate
struct 定向通过率分析
value
string 数值
score
string 得分
score_desc
string 得分描述
rank_category
string 行业排名
rank_second_category
string 二级行业排名
rank_overall
string 大盘排名
compete_win_rate
struct 竞争胜出率分析
value
string 数值
score
string 得分
score_desc
string 得分描述
rank_category
string 行业排名
rank_second_category
string 二级行业排名
rank_overall
string 大盘排名
exposure_count
struct 曝光量分析
value
string 数值
score
string 得分
score_desc
string 得分描述
rank_category
string 行业排名
rank_second_category
string 二级行业排名
rank_overall
string 大盘排名
ctr
struct 点击率分析
value
string 数值
score
string 得分
score_desc
string 得分描述
rank_category
string 行业排名
rank_second_category
string 二级行业排名
rank_overall
string 大盘排名
cvr
struct 转化率分析
value
string 数值
score
string 得分
score_desc
string 得分描述
rank_category
string 行业排名
rank_second_category
string 二级行业排名
rank_overall
string 大盘排名
cpa
struct 成本分析
bias_today
float 当日成本偏差
bias_overall
float 最近 7 日成本偏差
target_detail
struct 诊断详情-定向明细
expand_targeting_opened
boolean 是否开启自动扩量,true 或 false
score
integer 定向宽窄度得分
trends
struct[] 定向宽窄度趋势数据
time
string 时间
value
float 数值
conclusion
string 定向宽窄度综合结论
compete_detail
struct 诊断详情-竞争力明细
compete_attribution
struct[] 竞争失败归因列表
attribute_code
enum 归因 CODE,归因 CODE 的枚举,[枚举详情]
attribute_name
string 归因名称
ratio
float 归因占比
compete_budget_details
struct 预算竞争力明细
score
integer 预算得分
raise_account_balance_flag
boolean 是否建议账户充值,true 或 false
recommend_recharge
integer 建议充值金额(单位:分)
account_daily_cost
integer 账户今日消耗(单位:分)
account_day_budget
integer 账户日限额(单位:分)
campaign_daily_cost
integer 计划今日消耗(单位:分)
campaign_day_budget
integer 计划日限额(单位:分)
adgroup_daily_cost
integer 广告今日消耗(单位:分)
adgroup_day_budget
integer 广告日限额(单位:分)
account_balance
integer 账户余额(单位:分)
conclusion
string 预算情况综合结论
compete_bid_details
struct 出价竞争力明细
score
integer 出价得分
bid_amount
integer 当前出价(单位:分)
conclusion
string 出价竞争力综合结论
compete_user_acceptance
struct 用户接受度
score
integer 用户接受度得分
acceptance
struct[] 用户接受度归因列表
attribute_code
enum 归因 CODE,归因 CODE 的枚举,[枚举详情]
attribute_name
string 归因名称
ratio
float 归因占比
conclusion
string 用户接受度综合结论
ratio
float 用户接受度占整体的比例
compete_pctr_trends
struct 点击率趋势变化
score
integer 点击率趋势得分
self_avg
struct[] 本广告平均值趋势数据
time
string 时间
value
float 数值
self_chose_avg
struct[] 本广告胜出时均值趋势数据
time
string 时间
value
float 数值
winner_chose_avg
struct[] 本广告失败时胜出广告均值趋势数据
time
string 时间
value
float 数值
conclusion
string 点击竞争力情况综合结论
compete_pcvr_trends
struct 转化率趋势变化
score
integer 转化率趋势得分
self_avg
struct[] 本广告平均值趋势数据
time
string 时间
value
float 数值
self_chose_avg
struct[] 本广告胜出时均值趋势数据
time
string 时间
value
float 数值
winner_chose_avg
struct[] 本广告失败时胜出广告均值趋势数据
time
string 时间
value
float 数值
conclusion
string 转化竞争力情况综合结论
compete_win_adgroup
struct 账户内部竞争激烈度
score
integer 账户内部竞争激烈度得分
list
struct[] 账户内部竞争激烈度列表
rank
integer 排名
adgroup_id
int64 广告 id
adgroup_name
string 广告名称
conclusion
string 账户内部竞争激烈度综合结论
compete_surroundings
struct 流量充足度、竞争宽松度趋势变化
display_flag
boolean 是否展示竞争环境,true 或 false
traffic_sufficiency
struct 流量充足度情况
score
integer 得分(1-10 分),大于等于 1 且小于等于 10
trends
struct[] 趋势数据
time
string 时间
value
float 数值
conclusion
string 流量充足度综合结论
compete_intense
struct 竞争激烈度情况
score
integer 得分(1-10 分),大于等于 1 且小于等于 10
trends
struct[] 趋势数据
time
string 时间
value
float 数值
conclusion
string 竞争激烈度综合结论
exposure_detail
struct 诊断详情-曝光明细
effect_data
struct 效果数据(曝光)
count
integer 曝光量
category_win
float 同行业优秀者曝光量
category_avg
float 同行业平均曝光量
effect_data_trends
struct[] 曝光趋势
date
string 日期
trends
struct[] 趋势数据
time
string 时间
value
float 数值
targeting_label_contribution
struct 定向标签(曝光)贡献度
locard
struct[] 行为兴趣标签贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
audience
struct[] 自定义人群包贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
click_detail
struct 诊断详情-点击明细
effect_data
struct 效果数据(点击)
count
integer 点击量
ratio
float 点击率
category_win
float 同行业优秀者点击率
category_avg
float 同行业平均点击率
effect_data_trends
struct[] 点击趋势
targeting_label_contribution
struct 定向标签(点击)贡献度
locard
struct[] 行为兴趣标签贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
audience
struct[] 自定义人群包贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
conversion_detail
struct 诊断详情-转化明细
effect_data
struct 效果数据(转化)
count
integer 激活量
ratio
float 激活率
category_win
float 同行业优秀者激活率
category_avg
float 同行业平均激活率
effect_data_trends
struct[] 转化趋势
targeting_label_contribution
struct 定向标签(转化)贡献度
locard
struct[] 行为兴趣标签贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
audience
struct[] 自定义人群包贡献度列表
label
string 标签名称
count
integer 曝光/点击/转化量
contribution
integer 贡献度
ratio
float 占比
cpa_detail
struct 诊断详情-成本明细
effect_data
struct[] 效果数据(成本)
rank
integer 成本类型(1:浅度,2:深度)
conversion_count
integer 转化量
cvr
float 转化率(单位%)
target_cpa
float 出价(目标成本),(单位:分)
real_cpa
float 实际成本,(单位:分)
cpa_bias
float 成本偏差
industry_top_targetcpa
integer 同行业优秀者出价,(单位:分)
industry_avg_targetcpa
integer 同行业平均出价,(单位:分)
effect_data_trends
struct[] 成本趋势
rank
integer 成本类型(1:浅度,2:深度)
target_cpa
struct[] 目标成本趋势,(单位:分)
time
string 时间
value
float 数值
real_cpa
struct[] 实际成本趋势,(单位:分)
time
string 时间
value
float 数值
creative_detail
struct 诊断详情-定向明细
is_video
boolean 是否视频创意,true 或 false
is_wechat_moment
boolean 是否朋友圈广告创意,true 或 false
play_duration
string 平均有效播放时长(is_video 为 true 有效)
play_progress
string 平均有效播放进度(is_video 为 true 有效)
ctr_level
struct 点击率水平
value
string 数值
score
string 得分
rank_overall
string 大盘排位
rank_first_category
string 同行业排位
rank_second_category
string 同二级行业排位
self_trends
struct[] 本指标值趋势
time
string 时间
value
float 数值
benchmark_trends
struct[] 本指标标杆值趋势
time
string 时间
value
float 数值
effective_play_rate
struct 视频有效播放率(is_video 为 true 有效)
value
string 数值
score
string 得分
rank_overall
string 大盘排位
rank_first_category
string 同行业排位
rank_second_category
string 同二级行业排位
self_trends
struct[] 本指标值趋势
time
string 时间
value
float 数值
benchmark_trends
struct[] 本指标标杆值趋势
time
string 时间
value
float 数值
no_interest_click_rate
struct 朋友圈广告不感兴趣点击率(is_wechat_moment 为 true 有效)
value
string 数值
score
string 得分
rank_overall
string 大盘排位
rank_first_category
string 同行业排位
rank_second_category
string 同二级行业排位
self_trends
struct[] 本指标值趋势
time
string 时间
value
float 数值
benchmark_trends
struct[] 本指标标杆值趋势
time
string 时间
value
float 数值
optimization
struct 诊断详情-优化操作明细
status
struct 优化状态(0: 无需优化 'OPTIMIZE_STATUS_NONE', 1: 待优化 'OPTIMIZE_STATUS_PENDING', 2: 已优化 'OPTIMIZE_STATUS_FINISHED')
targeting
enum 拓展定向优化状态,[枚举详情]
targeting_expand
enum 拓展定向-自动扩量,[枚举详情]
targeting_locard
enum 拓展定向-更多行为兴趣定向标签,[枚举详情]
bid
enum 出价优化状态,[枚举详情]
bid_strategy
enum 出价优化-调整出价策略,[枚举详情]
bid_amount
enum 出价优化-调整出价,[枚举详情]
budget
enum 预算优化状态,[枚举详情]
daily_budget
enum 预算优化-提高日预算,[枚举详情]
account_balance
enum 预算优化-账户充值,[枚举详情]
targeting_status_desc
string 拓展定向优化状态名称
targeting_expand_status_desc
string 拓展定向-自动扩量状态名称
targeting_locard_status_desc
string 拓展定向-更多行为兴趣定向标签状态名称
bid_status_desc
string 出价优化状态名称
bid_strategy_status_desc
string 出价优化-调整出价策略状态名称
bid_amount_status_desc
string 出价优化-调整出价状态名称
budget_status_desc
string 预算优化状态名称
daily_budget_status_desc
string 预算优化-提高日预算状态名称
account_balance_status_desc
string 预算优化-账户充值状态名称
optimize_contents
struct 优化内容
targeting
struct 定向优化
open_auto_expand_flag
boolean 是否需要展示开启自动扩量,true 或 false
expand_targeting_rule
string[] 不可突破定向规则
open_expand_seed_population_flag
boolean 是否启用种子人群包,true 或 false
open_expand_seed_population_selected_flag
boolean 是否可以启用种子人群包,true 或 false
expand_seed_populations
array 种子人群包列表
add_more_locard_labels_flag
boolean 添加更多行为兴趣定向标签标记,true 或 false
locard_behaviors
struct[] 罗卡行为标签列表
id
string 标签 id
text
string 标签名称
locard_interests
struct[] 罗卡兴趣标签列表
id
string 标签 id
text
string 标签名称
bid
struct 出价优化
adjust_bid_strategy_flag
boolean 是否展示调整出价策略,true 或 false
current_bid_strategy
string 当前出价策略
optimize_bid_strategy
string 优化出价策略
adjust_bid_amount_flag
boolean 是否展示调整出价,true 或 false
current_bid_amount
integer 当前出价
optimize_bid_amount
integer 优化出价
adjust_deep_bid_amount_flag
boolean 是否展示优化目标出价,true 或 false
current_deep_bid_amount
integer 当前目标出价
optimize_deep_bid_amount
integer 优化目标出价
budget
struct 预算优化
raise_day_budget_flag
boolean 是否展示提高日预算,true 或 false
current_adgroup_day_budget
integer 广告日限额(单位:分)
current_campaign_day_budget
integer 计划日限额(单位:分)
current_account_day_budget
integer 账户日限额(单位:分)
adgroup_cost_daily
integer 广告日消耗(单位:分)
campaign_cost_daily
integer 计划日消耗(单位:分)
account_cost_daily
integer 账户日消耗(单位:分)
adgroup_balance
integer 广告余额(单位:分)
campaign_balance
integer 推广计划余额(单位:分)
account_balance
integer 账户余额(单位:分)
optimize_adgroup_day_budget_flag
boolean 是否优化了广告日限额,true 或 false
optimize_campaign_day_budget_flag
boolean 是否优化了计划日限额,true 或 false
optimize_account_day_budget_flag
boolean 是否优化了账户日限额,true 或 false
optimize_adgroup_day_budget
integer 优化广告日限额(单位:分)
optimize_campaign_day_budget
integer 优化计划日限额(单位:分)
optimize_account_day_budget
integer 优化账户日限额(单位:分)
raise_account_balance_flag
boolean 是否建议账户充值,true 或 false
recommend_recharge
integer 建议充值金额(单位:分)
auto_acquisition_status
enum 一键起量状态,一键起量状态的枚举,[枚举详情]
auto_acquisition_status_name
string 一键起量状态中文描述
auto_acquisition_status_desc
string 一键起量状态,长文案描述
auto_acquisition_begin_time
string 起量开始时间
auto_acquisition_end_time
string 起量结束时间
is_potential
boolean 是否潜力广告,true 或 false
potential_detail
struct 潜力广告信息
partition_time
string 潜力广告数据生成时间
bid_raise_ratio
integer 建议提价比例(%),大于等于 0 且小于 9223372036854775807
exposure_estimate
integer 按照潜力广告建议提价后,下小时预估曝光量,大于等于 0 且小于 9223372036854775807
exposure_raise_ratio
integer 按照潜力广告建议提价后,曝光预估提升比例(%),大于等于 0 且小于 9223372036854775807
bid_modified
boolean 是否通过潜力推荐修改浅层目标出价,true 或 false
deep_bid_modified
boolean 是否通过潜力推荐修改深度目标出价,true 或 false

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "adgroup_id": "<ADGROUP_ID>",
                "detail": true,
                "potential_detail": []
            }
        ]
    }
}

可视化调试工具