video
dimension. Les video
dimension fournit des analyses par vidéo. REMARQUE : si vous souhaitez inclure une "vidéo". champs (comme video.name
) dans la réponse, vos identifiants client doivent inclure le CMS : Autorisation de lecture vidéo. Notez également que même si vous ne pouvez pas revenir video.custom_fields
, vous pouvez retourner video.custom_fields.{field_name}
Paramètres d'URL
Les rapports de l'API Analytics prennent en charge les paramètres d'URL suivants.
Paramètre | Description | Obligatoire | Valeurs | Défaut |
---|---|---|---|---|
account |
Les comptes sur lesquels vous souhaitez créer un rapport | Oui | un ou plusieurs identifiants de compte sous forme de liste délimitée par des virgules | aucun |
dimensions |
La ou les dimensions à signaler | Oui | une ou plusieurs dimensions sous forme de liste délimitée par des virgules (certaines combinaisons ne sont pas valables - utilisez l'outil interactif ici pour déterminer si une combinaison est valable) | aucun |
where |
Utilisé pour spécifier des filtres pour les rapports | non | {dimension}=={valeur} - un ou plusieurs éléments sous forme de liste délimitée par des points-virgules. La valeur sera une ou plusieurs valeurs pour la métrique primaire de cette dimension. Par exemple : video==video_id country=country-code , ou viewer=viewer_id (dans ce dernier cas, la forme du viewer_id varie selon que vous capturez et envoyez vous-même une sorte de viewer_id ou selon la valeur générée par le système d'analyse). |
aucun |
limit |
Nombre d'articles à retourner | non | entier positif | 10 |
offset |
Nombre d'éléments à ignorer | non | entier positif | 0 |
sort |
Champ sur lequel trier les éléments | non | tout champ renvoyé par la requête | Video_View |
fields |
Champs à retourner | non | varie en fonction de la dimension sur laquelle vous créez un rapport | video,video_view |
format |
Format pour renvoyer les résultats dans | non | json (par défaut) | csv | xlxs | json |
reconciled |
Si elle est incluse, elle limitera les résultats aux données historiques ou en temps réel. Les données analytiques proviennent de plusieurs sources : certaines sont envoyées par le lecteur, mais d'autres sont collectées à partir des CDN et du système Video Cloud. Afin de fournir des analyses le plus rapidement possible, nous commençons à fournir des données « en temps réel » dès qu'elles sont disponibles, puis nous ajustons les analyses ultérieurement lorsque les données de toutes les sources ont été collectées et traitées. Les données entièrement traitées sont appelées réconciliées | non | vrai | faux | true |
from |
Le début de la plage de dates de la demande | non |
L'un des éléments suivants :
Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=false. |
-30d |
to |
La fin de la plage de dates pour la demande | non |
L'un des éléments suivants :
Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=false. |
maintenant |
Champs disponibles
Les champs suivants peuvent être renvoyés pour la dimension.
ad_mode_begin
- le nombre de fois où le joueur est entré en mode publicitéad_mode_complete
- le nombre de fois où le joueur a terminé le mode publicitébytes_delivered
- nombre total d'octets délivrés aux machines clientes pour le lecteur et les médias associésengagement_score
- le score d'engagement d'une vidéoplay_request
- nombre total de fois où la lecture vidéo a été demandéeplay_rate
- le taux de lecture moyen (vues vidéo divisées par impressions) pour une vidéovideo
- l'identifiant de la vidéovideo_duration
- la durée de la vidéo (si signalée)video_engagement_1
- le nombre de vues au point de 1% de la vidéovideo_engagement_100
- le nombre total de vues au point de 100 pour cent de la durée de la vidéovideo_engagement_25
- le nombre total de vues au point de 25% de la durée de la vidéovideo_engagement_50
- le nombre total de vues au point de 50 pour cent de la durée de la vidéovideo_engagement_75
- le nombre total de vues à 75 % de la durée de la vidéo<video_impression
- le nombre total de fois où la vidéo a été chargée dans les lecteursvideo_name
- le nom de la vidéo au moment de l'impression la plus récente dans la périodevideo_percent_viewed
- la somme du pourcentage de la vidéo visionnée pour toutes les vues vidéo. Par exemple, s'il y avait deux vues au cours de la période, et que le pourcentage affiché dans une vue était de 78 % et de 59 % dans l'autre, levideo_percent_viewed
retour serait 137.video_seconds_viewed
- nombre total de secondes vues pour chaque vue vidéovideo_view
- le nombre de fois où la lecture vidéo a commencévideo.reference_id
- l'identifiant de référence de la vidéovideo.name
- le nom actuel de la vidéovideo.description
- la description actuelle de la vidéovideo.complete
- si le traitement vidéo est terminévideo.created_at
- la date/heure de création de la vidéovideo.duration
- la durée actuelle de la vidéovideo.economics
- si la vidéo est activée pour les publicitésvideo.long_description
- la description longue de la vidéovideo.state
- si la vidéo est actuellementACTIVE
ouINACTIVE
video.tags
- les tags de la vidéovideo.updated_at
- date/heure de la dernière modification de la vidéovideo.custom_fields.{field_name}
- valeur pour le champ personnalisé de la vidéo nommé{field_name}
video_download_request
- nombre de demandes de téléchargement pour une vidéo activée pour la lecture hors lignevideo_download_complete
- nombre de fois qu'une vidéo activée pour la lecture hors ligne a été complètement téléchargéevideo_download_cancellation
- nombre de fois où le téléchargement d'une vidéo activé pour la lecture hors ligne a été annulé (y compris les fois où la page a été fermée avant la fin du téléchargement)video_download_error
- nombre de fois où le téléchargement d'une vidéo activée pour la lecture hors ligne a échoué en raison d'une erreur
Filtrer les valeurs
Utilisée comme filtre, une dimension permet d'affiner les résultats.
Valeurs de filtre : ID vidéo en tant que liste délimitée par des virgules ou video.q== {video field} : {value}
Combinaison de dimensions
Pour voir avec quelles dimensions cet élément peut être combiné et quels champs sont disponibles pour la combinaison, voir Dimension et champs.
Exemples de demandes
Demande de dimension
https ://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=video
Demande de filtre
https ://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=video&where=video==4093643993001,1754276206001
Exemple de réponse
{
"item_count" : 123,
"items" : [
{
"vidéo" : "2180741085001",
"video_view" : 1
},
{
"vidéo" : "4446941108001",
"video_view" : 1
},
{
"vidéo" : "2535301903001",
"video_view" : 1
},
{
"vidéo" : "5323136098001",
"video_view" : 1
},
{
"vidéo" : "1732474228567874935",
"video_view" : 1
},
{
"vidéo" : "1723783757463121178",
"video_view" : 1
},
{
"vidéo" : "4454620114001",
"video_view" : 1
},
{
"vidéo" : "5271819050001",
"video_view" : 1
},
{
"vidéo" : "2026627035001",
"video_view" : 1
},
{
"vidéo" : "4446941103001",
"video_view" : 2
}
],
"summary" : {
"video_view" : 45136
}
}