調用本介面擷取指定時間範圍內的每日播放資料均量統計,統計指標包括平均播放時間長度、平均播放次數。
介面說明
目前服務地址僅支援:華東 2(上海)。
僅支援使用了阿里雲播放器 SDK 的播放資料統計。
以北京時間(UTC+8)為基準,每天上午 9 點產生前一天的播放資料統計。
支援查詢 2018-01-01 之後的資料,資料查詢的起止時間跨度最大為 180 天。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:DescribePlayUserAvg |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| StartTime |
string |
是 |
指定查詢的起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2016-06-29T13:00:00Z |
| EndTime |
string |
是 |
指定查詢的結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
結束時間需大於起始時間,且與起始時間的最大跨度為 180 天。 |
2016-06-30T13:00:00Z |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
6C7F90B2-BDA4-4FAC-****-A38A121DFE19 |
| UserPlayStatisAvgs |
object |
||
| UserPlayStatisAvg |
array<object> |
使用者每天平均播放均值統計資料。 |
|
|
object |
|||
| Date |
string |
播放日期,格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2016-06-30T13:00:00Z |
| AvgPlayDuration |
string |
平均播放時間長度。單位:毫秒。 |
1035902.8 |
| AvgPlayCount |
string |
平均播放次數。 |
2.0 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "6C7F90B2-BDA4-4FAC-****-A38A121DFE19",
"UserPlayStatisAvgs": {
"UserPlayStatisAvg": [
{
"Date": "2016-06-30T13:00:00Z",
"AvgPlayDuration": "1035902.8",
"AvgPlayCount": "2.0"
}
]
}
}
異常返回樣本
JSON格式
{
"RequestId":"1FAFB884-D5A7-47D1-82B5-8928AA9C8720",
"HostId":"vod.cn-shanghai.aliyuncs.com",
"Code":"InvalidStartTime.Malformed",
"Message":"Specified StartTime is malformed."
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 開始時間格式錯誤。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結束時間格式錯誤。 |
| 400 | InvalidEndTime.BeyondCurrent | EndTime beyond current time. | |
| 400 | InvalidParamter | %s | |
| 400 | InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 開始時間與結束時間不匹配 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。