DescribeVodMediaPlayData - - Centre de documentation Alibaba Cloud

Obtient les données de lecture d'un fichier audio ou vidéo à une date spécifiée par identifiant de média (identifiant audio ou vidéo), y compris le nombre de visiteurs uniques, le nombre moyen de lectures par utilisateur, le nombre total de lectures, la durée moyenne de lecture par utilisateur et la durée totale de lecture.

Description de l'opération

Actuellement, cette opération n'est disponible que dans la région Chine (Shanghai).
Seules les données de lecture collectées par le SDK ApsaraVideo Player sont prises en charge. Les statistiques de trafic pour les flux audio uniquement ne sont pas prises en charge.
Seules les données des 30 derniers jours peuvent être interrogées.

Important - Avant d'appeler cette opération, assurez-vous que le SDK ApsaraVideo Player remplit les conditions suivantes :

SDK Android Player ou SDK iOS Player
- La version du SDK Player est 5.4.9.2 ou ultérieure.
- Une licence pour le SDK Player a été obtenue et intégrée. Pour plus d'informations, consultez Gestion des licences.
- La fonctionnalité de rapport des journaux de suivi des événements du SDK Player est activée. Par défaut, cette fonctionnalité est activée dans le SDK ApsaraVideo Player. Pour plus d'informations, consultez Créer un lecteur pour Android et Créer un lecteur pour iOS.
SDK Web Player
- La version du SDK Player est 2.16.0 ou ultérieure.
- Une licence pour la Surveillance de la qualité de lecture a été obtenue et intégrée. Soumettez le formulaire de demande de service à valeur ajoutée du SDK Web Player pour faire une demande. Pour la méthode d'intégration de la licence, consultez la propriété license dans la Référence de l'API du SDK Web.
- La fonctionnalité de rapport des journaux de suivi des événements du SDK Player est activée. Par défaut, cette fonctionnalité est activée dans le SDK ApsaraVideo Player.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vod:DescribeVodMediaPlayData

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PlayDate	string	Non	La date de lecture. Unité : jour. Format : yyyyMMdd. Remarque Seules les requêtes quotidiennes sont prises en charge. Seules les données des 30 derniers jours peuvent être interrogées.	20240322
TerminalType	string	Non	Le type de terminal du SDK Player. Spécifiez ce paramètre pour effectuer une requête filtrée sur les données de lecture de tous les fichiers audio et vidéo par type de terminal. Valeurs valides : Native : SDK Android Player ou SDK iOS Player. Web : SDK Web Player.	Native
Os	string	Non	Le système d'exploitation de l'appareil de lecture. Spécifiez ce paramètre pour effectuer une requête filtrée sur les données de lecture de tous les fichiers audio et vidéo par système d'exploitation. Valeurs valides : Android iOS Windows macOS Linux	Android
Region	string	Non	La région de service. Spécifiez ce paramètre pour effectuer une requête filtrée sur les données de lecture de tous les fichiers audio et vidéo par région de service. Valeurs valides : cn-beijing : Chine (Pékin) cn-shanghai : Chine (Shanghai) cn-shenzhen : Chine (Shenzhen) ap-northeast-1 : Japon (Tokyo) ap-southeast-1 : Singapour ap-southeast-5 : Indonésie (Jakarta) eu-central-1 : Allemagne (Francfort)	cn-beijing
MediaId	string	Non	L'identifiant du média, qui correspond à l'identifiant audio ou vidéo (VideoId). Spécifiez ce paramètre pour effectuer une requête filtrée sur les données de lecture d'un fichier média spécifique. Un seul identifiant de média peut être spécifié. Vous pouvez obtenir l'identifiant du média en utilisant les méthodes suivantes : Pour les fichiers audio ou vidéo téléchargés via la console, connectez-vous à la console ApsaraVideo VOD et choisissez Fichiers média > Audio/Vidéo pour afficher l'identifiant audio ou vidéo. Lorsque vous téléchargez un fichier audio ou vidéo en appelant l'opération CreateUploadVideo, l'identifiant audio ou vidéo est la valeur du paramètre de réponse VideoId. Une fois le fichier audio ou vidéo téléchargé, vous pouvez appeler l'opération SearchMedia pour effectuer une requête filtrée sur l'identifiant audio ou vidéo, qui est la valeur du paramètre de réponse VideoId.	9ae2af636ca6c10412f44891fc****
PageNo	integer	Oui	Le numéro de page des données à renvoyer. Spécifiez ce paramètre pour définir la page à partir de laquelle les données commencent à être renvoyées.	1
PageSize	integer	Oui	Le nombre d'entrées par page. Spécifiez ce paramètre pour définir le nombre d'entrées affichées sur chaque page. Valeur maximale : 100.	20
OrderType	string	Non	L'ordre de tri. Ce paramètre est utilisé conjointement avec le paramètre OrderName. Spécifiez ce paramètre pour trier les données renvoyées par ordre croissant ou décroissant selon une métrique spécifiée. Valeurs valides : ASC : ordre croissant. Les données renvoyées sont triées de la plus petite à la plus grande. DESC : ordre décroissant. Les données renvoyées sont triées de la plus grande à la plus petite.	ASC
OrderName	string	Non	Le nom de la métrique. Ce paramètre est utilisé conjointement avec le paramètre OrderType. Spécifiez ce paramètre pour trier les données renvoyées par ordre croissant ou décroissant selon une métrique spécifiée. Valeurs valides : PlaySuccessVv : nombre total de lectures. PlayPerVv : nombre moyen de lectures par utilisateur. PlayDuration : durée totale de lecture. PlayDurationPerUv : durée moyenne de lecture par utilisateur.	PlaySuccessVv

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	25818875-5F78-4AF6-D7393642CA58****
TotalCount	integer	Le nombre total d'entrées renvoyées.	1
PageNo	integer	Le numéro de page des données renvoyées.	1
PageSize	integer	Le nombre d'entrées par page.	20
QoeInfoList	array<object>	La liste des données renvoyées.
	object	Les détails des données renvoyées.
VideoTitle	string	Le titre du fichier audio ou vidéo.	Titre de la vidéo VOD Alibaba Cloud
VideoDuration	number	La durée du fichier audio ou vidéo. Unité : secondes.	246
MediaId	string	L'identifiant du média, qui correspond à l'identifiant audio ou vidéo (VideoId).	9ae2af636ca6c10412f44891fc****
DAU	number	Le nombre de visiteurs uniques pour le fichier audio ou vidéo.	5
PlaySuccessVv	number	Le nombre total de lectures pour le fichier audio ou vidéo.	20
PlayDurationPerUv	number	La durée moyenne de lecture par utilisateur pour le fichier audio ou vidéo. Unité : secondes.	120
PlayDuration	number	La durée totale de lecture pour le fichier audio ou vidéo. Unité : secondes.	2400
PlayPerVv	number	Le nombre moyen de lectures par utilisateur pour le fichier audio ou vidéo.	4

Exemples

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "TotalCount": 1,
  "PageNo": 1,
  "PageSize": 20,
  "QoeInfoList": [
    {
      "VideoTitle": "Alibaba Cloud VOD video title",
      "VideoDuration": 246,
      "MediaId": "9ae2af636ca6c10412f44891fc****",
      "DAU": 5,
      "PlaySuccessVv": 20,
      "PlayDurationPerUv": 120,
      "PlayDuration": 2400,
      "PlayPerVv": 4
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.