通過媒體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 的埋點日志上報功能為默認開啟的。
- Android 播放器 SDK 或 iOS 播放器 SDK
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vod:DescribeVodMediaPlayData | none |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PlayDate | string | 否 | 播放日期，單位：天。格式為：yyyyMMdd。 說明
| 20240322 |
| TerminalType | string | 否 | 播放器 SDK 的終端類型。傳入此參數，可篩選查詢指定終端類型的所有音視頻的播放數據。取值：
| Native |
| Os | string | 否 | 播放端的操作系統。傳入此參數，可篩選查詢指定操作系統的所有音視頻的播放數據。取值：
| Android |
| Region | string | 否 | 服務地域。傳入此參數，可篩選查詢指定服務地域下的所有音視頻的播放數據。取值：
| cn-beijing |
| MediaId | string | 否 | 媒體 ID，即音/視頻 ID（VideoId）。傳入此參數，可篩選查詢指定媒體 ID 的音視頻播放數據，僅支持設置一個媒體 ID。可通過以下方式獲取：
| 9ae2af636ca6c10412f44891fc**** |
| PageNo | long | 是 | 查詢數據的當前頁碼。傳入此參數，可指定查詢數據從第幾頁開始返回。 | 1 |
| PageSize | long | 是 | 每頁顯示的數據條數。傳入此參數，可設置返回數據每頁顯示的條數。最大值為 100。 | 20 |
| OrderType | string | 否 | 排序類型，與
| ASC |
| OrderName | string | 否 | 指標名稱，與
| PlaySuccessVv |
返回參數
示例
正常返回示例
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-07 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |