VideoOverAutoLog - 自动播放时长上报--内容定制-火山引擎

文档中心

立即注册

导航

VideoOverAutoLog - 自动播放时长上报

最近更新时间：2024.05.28 18:13:35首次发布时间：2024.05.28 18:13:35

该接口用于视频播放结束事件上报。

使用场景

一般结束播放方式与开始播放方式对应。

自动开始播放，上报VideoPlayAutoLog，结束播放（包含手动操作结束或自动播放结束方式）都上报VideoOverAutoLog。

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=VideoOverAutoLog&Version=2021-01-01
请求头：ServiceName:content

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	VideoOverAutoLog	要执行的操作，取值：VideoOverAutoLog。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号。
AccessToken	String	是	AT6zTZuXzffKpxxxerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。
GroupId	String	是	7366891164987048482	内容id。
EventTime	String	是	1716457710	事件发生时间，十位时间戳，单位：秒。表示视频结束播放的时间。
Percent	String	是	50	最大播放进度。视频最大的播放进度，拖动进度条也算，取值范围1～100。计算方法：取进度条时长 / 视频总时长100；多次播放，取 Max(percent)。举例1: 如果用户已经看完100%，但又继续让视频重复播放，即便第二遍没播放完成，percent仍报100；举例2: 点击视频A播放（视频总时长60s），现拖动进度条到视频的45s处，然后再拖回视频的15s处，percent是45/60100=75。
Duration	String	是	1000	播放时长，单位：毫秒，表示本次播放的时长。注意注意不要累加上次播放的时长；这里指实际播放的物理时长，播放超过1遍，累加每次播放时长；计算方法：结束时间戳 - 开始时间戳 - 暂停时长；注意：拖动进度条不算时长，暂停不算时长。
ReqId	String	是	20220721103117010210043037253714CD	请求唯一标识。表示该内容具体是从哪一次请求返回的，便于数据分析。该值对应公共响应参数中的RequestId。
RootGid	String	否	7304704552752808499	进入视频内流场景的首个视频id。在内流的自动播放和滑动播放场景需要上报该参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Result	String	success	上报结果，success：成功。

请求示例

GET /?Action=VideoOverAutoLog&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzffKpxxxerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&GroupId=7366891164987048482&EventTime=1716457710&Percent=50&Duration=1000&ReqId=20220721103117010210043037253714CD HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=VideoOverAutoLog&Version=2021-01-01
X-Date: 20240527T084838Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240527/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240527164845156211043182ED21B5",
    "Action": "VideoOverAutoLog",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": "success"
}

错误码

您可访问公共错误码，获取更多错误码信息。