DescribePlayUserAvg - 播放数据均量统计

调用DescribePlayUserAvg获取指定时间范围内的每日播放数据均量统计。

接口说明

说明
  • 目前服务地址仅支持:华东2(上海)
  • 仅支持使用了阿里云点播播放器SDK的播放数据统计。
  • 以北京时间(UTC+8)为基准,每天上午9点生成前一天的播放数据统计。
  • 支持查询2018-01-01之后的数据,数据查询的起止时间跨度最大为180天。
  • 调试

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

    调试

    授权信息

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

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

      请求参数

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

      起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

      2016-06-29T13:00:00Z
      EndTimestring

      结束时间,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

      2016-06-30T13:00:00Z

      返回参数

      名称类型描述示例值
      object
      RequestIdstring

      请求ID。

      6C7F90B2-BDA4-4FAC-****-A38A121DFE19
      UserPlayStatisAvgsarray

      用户每天平均播放均值统计数据。

      object
      Datestring

      日期。格式为:yyyyMMdd

      20170120
      AvgPlayDurationstring

      平均播放时长。单位:毫秒。

      1035902.8
      AvgPlayCountstring

      平均播放次数。

      170

      示例

      请求示例

      https://vod.{ApiRegion}.aliyuncs.com/?Action=DescribePlayUserAvg
      &StartTime=2016-06-29T13:00:00Z
      &EndTime=2016-06-30T13:00:00Z
      &<公共请求参数>
      

      正常返回示例

      JSON格式

      {
          "UserPlayStatisAvgs": {
              "UserPlayStatisAvg": [
                  {
                      "AvgPlayDuration": "1035902.8", 
                      "Date": "20171127", 
                      "AvgPlayCount": "17.0"
                  }, 
                  {
                      "AvgPlayDuration": "3113356.7", 
                      "Date": "20171128", 
                      "AvgPlayCount": "41.0"
                  }, 
                  {
                      "AvgPlayDuration": "4290368.0", 
                      "Date": "20171129", 
                      "AvgPlayCount": "59.8"
                  }
              ]
          }, 
          "RequestId": "6C7F90B2-BDA4-4FAC-****-A38A121DFE19"
      }

      XML格式

      <DescribePlayUserAvgResponse>
      	<UserPlayStatisAvgs>
      		<UserPlayStatisAvg>
      			<AvgPlayDuration>1035902.8</AvgPlayDuration>
      			<Date>20171127</Date>
      			<AvgPlayCount>17.0</AvgPlayCount>
      		</UserPlayStatisAvg>
      		<UserPlayStatisAvg>
      			<AvgPlayDuration>3113356.7</AvgPlayDuration>
      			<Date>20171128</Date>
      			<AvgPlayCount>41.0</AvgPlayCount>
      		</UserPlayStatisAvg>
      		<UserPlayStatisAvg>
      			<AvgPlayDuration>4290368.0</AvgPlayDuration>
      			<Date>20171129</Date>
      			<AvgPlayCount>59.8</AvgPlayCount>
      		</UserPlayStatisAvg>
      	</UserPlayStatisAvgs>
      	<RequestId>6C7F90B2-BDA4-4FAC-****-A38A121DFE19</RequestId>
      </DescribePlayUserAvgResponse>

      异常返回示例

      JSON格式

      {
          "RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
          "HostId":"vod.cn-shanghai.aliyuncs.com",
          "Code":"InvalidStartTime.Malformed",
          "Message":"Specified StartTime is malformed."
      }

      错误码

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

      接口错误码

      下表列举了本接口特有的错误码。

      错误代码错误信息HTTP 状态码说明
      InternalErrorThe request processing has failed due to some unknown error.500后台发生未知错误。
      InvalidStartTime.MalformedSpecified StartTime is malformed.400StartTime格式错误。使格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
      InvalidEndTime.MalformedSpecified EndTime is malformed.400EndTime格式错误。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
      InvalidEndTime.BeyondCurrentEndTime beyond current time.400EndTime不能超过当前时间。
      InvalidEndTime.MismatchStartTime or EndTime is mismatch.400StartTime和EndTime不匹配。
      阿里云首页 视频点播 相关技术圈