文档

DescribeVodMediaPlayData - 音视频播放数据统计

更新时间:

通过媒体ID(即音视频ID)获取音视频在指定日期的播放数据,包括访问用户数、人均播放次数、播放总次数、人均播放时长、累计播放时长等数据。

  • 目前本接口的服务地址仅支持:华东 2(上海)
  • 仅支持统计使用了阿里云播放器 SDK 的播放数据。
  • 仅支持查询过去 30 天以内的数据。
  • 调用本接口之前,需确保阿里云播放器 SDK 满足以下条件:
    • Android 播放器 SDK 或 iOS 播放器 SDK
      • 播放器 SDK 版本为 5.4.9.2 及以上。
      • 已获取播放器 SDK 的 License 授权并接入 License,详情参见 License 管理
      • 已开启播放器 SDK 的埋点日志上报功能,正常情况下,阿里云播放器 SDK 的埋点日志上报功能为默认开启的。更多信息,请参见 Android 端创建播放器iOS 端创建播放器
    • Web 播放器 SDK
      • 播放器 SDK 版本为 2.16.0 及以上。
      • 已申请开通播放质量监控的 License 授权并接入 License,可填写Web 播放器 SDK 增值服务申请表单申请开通,License 接入方法,请参见 Web 端接口说明中的license属性。
      • 已开启播放器 SDK 的埋点日志上报功能,正常情况下,阿里云播放器 SDK 的埋点日志上报功能为默认开启的。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:DescribeVodMediaPlayDataWrite
  • 全部资源
    acs:vod:*:{#accountId}:*

请求参数

名称类型必填描述示例值
PlayDatestring

播放日期,单位:天。格式为:yyyyMMdd。

说明
  • 仅支持按天查询。
  • 仅支持查询过去 30 天以内的数据。
  • 20240322
    TerminalTypestring

    播放器 SDK 的终端类型。传入此参数,可筛选查询指定终端类型的所有音视频的播放数据。取值:

    • Native:Android 播放器 SDK 或 iOS 播放器 SDK。
    • Web:Web 播放器 SDK。
    Native
    Osstring

    播放端的操作系统。传入此参数,可筛选查询指定操作系统的所有音视频的播放数据。取值:

    • Android
    • iOS
    • Windows
    • macOS
    • Linux
    Android
    Regionstring

    服务地域。传入此参数,可筛选查询指定服务地域下的所有音视频的播放数据。取值:

    • cn-beijing:华北 2(北京)
    • cn-shanghai:华东 2(上海)
    • cn-shenzhen:华南 1(深圳)
    • ap-northeast-1:日本(东京)
    • ap-southeast-1:新加坡
    • ap-southeast-5:印度尼西亚(雅加达)
    • eu-central-1:德国(法兰克福)
    • ap-south-1:印度(孟买)
    cn-beijing
    MediaIdstring

    媒体 ID,即音/视频 ID(VideoId)。传入此参数,可筛选查询指定媒体 ID 的音视频播放数据,仅支持设置一个媒体 ID。可通过以下方式获取:

    • 通过控制台上传的音/视频,可登录视频点播控制台,选择媒资库 > 音/视频查看音/视频 ID。
    • 通过 CreateUploadVideo 接口上传音/视频时,音/视频 ID 为返回参数 VideoId 的值。
    • 音/视频上传后,可通过 SearchMedia 接口查询音/视频 ID,为请求后返回参数 VideoId 的值。
    9ae2af636ca6c10412f44891fc****
    PageNolong

    查询数据的当前页码。传入此参数,可指定查询数据从第几页开始返回。

    1
    PageSizelong

    每页显示的数据条数。传入此参数,可设置返回数据每页显示的条数。最大值为 100。

    20
    OrderTypestring

    排序类型,与OrderName参数搭配使用。传入此参数,可设置返回数据按指定指标的升序或降序进行排列。取值:

    • ASC:升序,返回的数据按从小到大向下排列。
    • DESC:降序,返回的数据按从大到小向下排列。
    ASC
    OrderNamestring

    指标名称,与OrderType参数搭配使用。传入此参数,可设置返回数据按指定指标的升序或降序进行排列。取值:

    • PlaySuccessVv:播放总次数。
    • PlayPerVv:人均播放次数:。
    • PlayDuration:累计播放时长。
    • PlayDurationPerUv:人均播放时长。
    PlaySuccessVv

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    25818875-5F78-4AF6-D7393642CA58****
    TotalCountlong

    返回数据的总条数。

    1
    PageNolong

    返回数据的页码。

    1
    PageSizelong

    每页显示的数据条数。

    20
    QoeInfoListobject []

    返回数据列表。

    VideoTitlestring

    音视频的名称。

    阿里云VOD视频标题
    VideoDurationfloat

    音视频的时长,单位:秒。

    246
    MediaIdstring

    媒体 ID,即音/视频 ID(VideoId)。

    9ae2af636ca6c10412f44891fc****
    DAUfloat

    音视频的访问用户数,单位:个。

    5
    PlaySuccessVvfloat

    音视频的播放总次数,单位:次。

    20
    PlayDurationPerUvfloat

    音视频的人均播放时长,单位:秒。

    120
    PlayDurationfloat

    音视频的累计播放时长,单位:秒。

    2400
    PlayPerVvfloat

    音视频的人均播放次数,单位:次。

    4

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
      "TotalCount": 1,
      "PageNo": 1,
      "PageSize": 20,
      "QoeInfoList": [
        {
          "VideoTitle": "阿里云VOD视频标题",
          "VideoDuration": 246,
          "MediaId": "9ae2af636ca6c10412f44891fc****",
          "DAU": 5,
          "PlaySuccessVv": 20,
          "PlayDurationPerUv": 120,
          "PlayDuration": 2400,
          "PlayPerVv": 4
        }
      ]
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-05-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:500
      删除错误码:502
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)