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

视频流失分析接口
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 report/video_frame
请求方法 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
field*
string 过滤字段
可选值:{ material_id }
operator*
enum 操作符,操作符仅支持 IN
可选值:{ IN }
values*
string[] 字段取值,数组最小长度 1,最大长度 10
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
数组最小长度 0,最大长度 1
可选值:{ date }

请求示例


curl 'https://api.e.qq.com/v1.1/report/video_frame?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[]' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'group_by=[]' 
					

应答字段

名称 类型 描述
list
struct[] 列表对象
metrics
struct 数据指标
video_outer_play_index
float 播放时长分布指数
video_outer_click_index
float 点击指数
video_offset_index
float 流失指数
dimension
struct 维度数据
second
integer 视频第 N 秒
material_id
string 素材 id,小于 1024 个英文字符
date
string 日期,日期格式:YYYY-MM-DD
account_id
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "metrics": [],
                "dimension": {
                    "account_id": "<ACCOUNT_ID>"
                }
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具