DescribeVodMediaPlayData - ApsaraVideo VOD

Mengambil data pemutaran untuk file audio atau video pada tanggal tertentu berdasarkan ID medianya. Data tersebut mencakup jumlah pengunjung unik, rata-rata jumlah pemutaran per pengguna, total jumlah pemutaran, rata-rata durasi pemutaran per pengguna, serta total durasi pemutaran.

Deskripsi operasi

Titik akhir untuk operasi ini hanya tersedia di wilayah China (Shanghai).
Operasi ini hanya mengumpulkan data pemutaran dari ApsaraVideo Player SDK. Statistik lalu lintas untuk file hanya audio tidak didukung.
Anda hanya dapat melakukan kueri data dari 30 hari terakhir.

Penting Sebelum memanggil operasi ini, pastikan ApsaraVideo Player SDK Anda memenuhi persyaratan berikut:

ApsaraVideo Player SDK untuk Android atau iOS
- Versi SDK adalah 5.4.9.2 atau yang lebih baru.
- Lisensi untuk player SDK telah diperoleh dan dikonfigurasi. Untuk informasi selengkapnya, lihat License management.
- Fitur pelaporan log instrumentasi dari player SDK diaktifkan. Fitur ini diaktifkan secara default. Untuk informasi selengkapnya, lihat Create a player for Android dan Create a player for iOS.
ApsaraVideo Player SDK untuk Web
- Versi SDK adalah 2.16.0 atau yang lebih baru.
- Lisensi untuk layanan bernilai tambah Playback Quality Monitoring telah diminta dan dikonfigurasi. Untuk meminta lisensi, isi formulir ApsaraVideo Player SDK for Web Value-added Service Request form. Untuk informasi tentang cara mengonfigurasi lisensi, lihat properti license dalam Web client API reference.
- Fitur pelaporan log instrumentasi dari player SDK diaktifkan. Fitur ini diaktifkan secara default.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodMediaPlayData

none

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PlayDate	string	No	Tanggal pemutaran dalam format yyyyMMdd. Catatan Anda hanya dapat melakukan kueri data berdasarkan hari. Anda hanya dapat melakukan kueri data dari 30 hari terakhir.	20240322
TerminalType	string	No	Jenis terminal yang menggunakan player SDK. Gunakan parameter ini untuk melakukan kueri data pemutaran untuk jenis terminal tertentu. Nilai yang valid: Native: ApsaraVideo Player SDK untuk Android atau ApsaraVideo Player SDK untuk iOS. Web: ApsaraVideo Player SDK untuk Web.	Native
Os	string	No	Sistem operasi client. Gunakan parameter ini untuk melakukan kueri data pemutaran untuk sistem operasi tertentu. Nilai yang valid: Android iOS Windows macOS Linux	Android
Region	string	No	Wilayah layanan. Gunakan parameter ini untuk melakukan kueri data pemutaran untuk wilayah layanan tertentu. Nilai yang valid: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) ap-northeast-1: Jepang (Tokyo) ap-southeast-1: Singapura ap-southeast-5: Indonesia (Jakarta) eu-central-1: Jerman (Frankfurt)	cn-beijing
MediaId	string	No	ID aset media. Ini sama dengan ID audio atau video (VideoId). Gunakan parameter ini untuk melakukan kueri data pemutaran aset media tertentu. Anda hanya dapat menentukan satu ID media. Anda dapat memperoleh ID media dengan salah satu cara berikut: Untuk file audio atau video yang diunggah di Konsol, login ke Konsol ApsaraVideo VOD dan pilih Media Assets > Audio/Video untuk melihat ID audio atau video. Ketika Anda mengunggah file audio atau video dengan memanggil operasi CreateUploadVideo, ID audio atau video tersebut adalah nilai parameter VideoId dalam respons. Setelah file audio atau video diunggah, Anda dapat memanggil operasi SearchMedia untuk melakukan kueri ID audio atau video tersebut. ID tersebut adalah nilai parameter VideoId dalam respons.	9ae2af636ca6c10412f44891fc****
PageNo	integer	Yes	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	Yes	Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum adalah 100.	20
OrderType	string	No	Urutan pengurutan. Parameter ini harus digunakan bersama parameter `OrderName`. Gunakan parameter ini untuk mengurutkan data yang dikembalikan berdasarkan metrik tertentu. Nilai yang valid: ASC: urutan menaik. Data diurutkan dari terkecil ke terbesar. DESC: urutan menurun. Data diurutkan dari terbesar ke terkecil.	ASC
OrderName	string	No	Metrik untuk pengurutan. Parameter ini harus digunakan bersama parameter `OrderType`. Gunakan parameter ini untuk mengurutkan data yang dikembalikan berdasarkan metrik tertentu. Nilai yang valid: PlaySuccessVv: total jumlah pemutaran. PlayPerVv: rata-rata jumlah pemutaran per pengguna. PlayDuration: total durasi pemutaran. PlayDurationPerUv: rata-rata durasi pemutaran per pengguna.	PlaySuccessVv

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	25818875-5F78-4AF6-D7393642CA58****
TotalCount	integer	Total jumlah entri yang dikembalikan.	1
PageNo	integer	Nomor halaman data yang dikembalikan.	1
PageSize	integer	Jumlah entri yang dikembalikan pada setiap halaman.	20
QoeInfoList	array<object>	Daftar data yang dikembalikan.
	object	Detail data yang dikembalikan.
VideoTitle	string	Nama file audio atau video.	阿里云VOD视频标题
VideoDuration	number	Durasi file audio atau video, dalam detik.	246
MediaId	string	ID media, yaitu ID audio atau video (VideoId).	9ae2af636ca6c10412f44891fc****
DAU	number	Jumlah pengunjung unik untuk file audio atau video.	5
PlaySuccessVv	number	Total jumlah pemutaran untuk file audio atau video.	20
PlayDurationPerUv	number	Rata-rata durasi pemutaran per pengguna untuk file audio atau video, dalam detik.	120
PlayDuration	number	Total durasi pemutaran untuk file audio atau video, dalam detik.	2400
PlayPerVv	number	Rata-rata jumlah pemutaran per pengguna untuk file audio atau video.	4

Contoh

Respons sukses

JSONformat

{
  "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
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Meter.ParamError	Param Error:%s,Please Check Again.	One or more parameters are invalid.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.	An internal error occurred.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.	An internal data source error occurred.
403	Meter.AuthError	Authentication Failed,Please Try Again.	You do not have permissions to perform this operation.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.	The data is not prepared.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.